diff --git a/README.en.md b/README.en.md index 9e9955eb2b5ad2b785e432d68a69e9b4d6f72b01..d00fdd42a9633618cf2d0f601ed952c4847e393a 100644 --- a/README.en.md +++ b/README.en.md @@ -77,6 +77,11 @@ npm install -g typescript cd arkanalyzer npm install ``` +5. [Optional] Generate the latest API documentation, which will be created at [link](docs/api_docs/globals.md). Additionally, for ArkAnalyzer quick start, please refer to [link](docs/quickstart.pdf). + +```shell +npm run gendoc +``` ## Commit codes Follow the code repository standards of Openharmony-Sig, refer to the [link](docs/HowToCreatePR.md#english) diff --git a/README.md b/README.md index 13d57082c3445478dd582bdeaecb0ea9b34f7bb3..a97785b3f0c1a67b4d336b77fe0715b91c0ec8ae 100644 --- a/README.md +++ b/README.md @@ -84,6 +84,10 @@ npm install -g typescript ```shell npm install ``` +5. 【可选】生成最新API文档,文档生成在[链接](docs/api_docs/globals.md)。此外,ArkAnalyzer快速入门请参考[链接](docs/quickstart.pdf)。 +```shell +npm run gendoc +``` ## ArkAnalyzer 代码上库 遵守openharmony-sig代码上库规范, 操作方法请参考:[链接](docs/HowToCreatePR.md#中文) diff --git a/docs/api_docs/README.md b/docs/api_docs/README.md new file mode 100644 index 0000000000000000000000000000000000000000..f87a165e9ee622a44937cb90531addab015b5f0c --- /dev/null +++ b/docs/api_docs/README.md @@ -0,0 +1,86 @@ +**ArkAnalyzer** + +*** + +# sig_programanalysis + +English | [简体中文](_media/README.md) + +## SIG Group Work Objectives and Scope + +### Work Objectives + +* Sig_programanalysis aims to carry out program analysis technology exploration, key technology identification, and competitiveness building for OpenHarmony systems and apps, striving to become the gathering place for OpenHarmony system and app analysis capabilities and an incubation place for related engineering tools. + +* Sig_programanalysis will build a basic program analysis framework for OpenHarmony apps, and subsequently based on it to provide application developers with out-of-the-box defect scanning and analysis tools, making it possible to automatically vet code for scenarios such as IDE, CI/CD pipelines, etc. + +### Work Scope + +* Responsible for building and maintaining the key technology map of program analysis, as well as the decomposition of functional modules in the field, interface definition, and maintenance management. + +* Responsible for the architecture design, open source development, and project maintenance of projects related to program analysis. + +### Projects + +Sig_programanalysis currently incubates the following projects. Everyone is welcome to participate (you can apply to participate in the co-construction of existing projects, or you can apply to create a new program analysis project). + +* ArkAnalyzer: +The Static Analysis Framework for ArkTS-based OpenHarmony Apps. + +* ArkCheck: +Checking OpenHarmony Apps for Potential Code-level Defects + +## SIG Members + +### Leader + +- [lilicoding](https://gitee.com/lilicoding) + +### Committers +- [kubigao](https://gitee.com/kubigao) +- [yifei-xue](https://gitee.com/yifei_xue) +- [kubrick-hjh](https://gitee.com/kubrick-hjh) +- [speed9](https://gitee.com/speeds) +- [bbsun](https://gitee.com/bbsun) +- [chn](https://gitee.com/chn) +- [Elouan](https://gitee.com/Elouan) +- [Rnine](https://gitee.com/Rnine) +- [workspace_cb](https://gitee.com/workspace_cb) +- [longyuC](https://gitee.com/longyuC) +- [xyji95](https://gitee.com/xyji95) +- [xulingyun-red](https://gitee.com/xulingyun-red) + +### Meetings + - Meeting Time: Bi-weekly meeting, Thursday 19:30 Beijing time + - Meeting Application:[Link](https://shimo.im/forms/B1Awd60W7bU51g3m/fill) + - Meeting Link: Welink or Others + - Meeting Notification: [Subscribe to](https://lists.openatom.io/postorius/lists/dev.openharmony.io) mailing list dev@openharmony.io for the meeting link + - Meeting Summary: [Archive link address](https://gitee.com/openharmony-sig/sig-content) + +### Contact + +- Mailing list: [dev@openharmony.io](https://lists.openatom.io/postorius/lists/dev@openharmony.io/) + +*** +# ArkAnalyzer: Static Program Analysis Framework for the ArkTS Language +## Develope environment setup +1. [Download Visual Studio Code](https://code.visualstudio.com/download) or other IDEA; +2. [Download Node.js](https://nodejs.org/en/download/current) and install it. Node.js is a runtime environment for JavaScript, which comes with its own package manager, npm. +3. Install Typescript via npm: +```shell +npm install -g typescript +``` +4. Install dependency libraries +```shell +cd arkanalyzer +npm install +``` + +## Commit codes +Follow the code repository standards of Openharmony-Sig, refer to the [link](_media/HowToCreatePR.md#english) + +## Debug +Modify the `args` parameter array in the debug configuration file `.vscode/launch.json` to the path of the test file you want to debug, and then start the debugging process. + +## Add test cases +Place all new test codes in the `tests` directory. Corresponding sample code and other resource files should be placed in the ``tests\resources` directory, and create different folders for each testing scenario. diff --git a/docs/api_docs/_media/HowToCreatePR.md b/docs/api_docs/_media/HowToCreatePR.md new file mode 100644 index 0000000000000000000000000000000000000000..1135fa7f8bc31b081c59afcc5c029a5c6168b710 --- /dev/null +++ b/docs/api_docs/_media/HowToCreatePR.md @@ -0,0 +1,55 @@ +# 中文 +本指导是对[openharmony-sig提交代码规范](https://gitee.com/openharmony-sig/sig-content/blob/master/Infrastructure/docs/manual/gitee%E6%8F%90pr%E5%B8%B8%E8%A7%84%E6%93%8D%E4%BD%9C.md)的扩充 + +开发者对仓库修改,统一采用向对应仓库提PR的方式来做修改。提PR的方式有两种: +1. fork工作仓方式:相关的gitee操作请参考此[链接](https://gitee.com/help/articles/4128#article-header0)。 +2. 评审模式:直接向主仓push代码,gitee自动生成PR。相关的操作参考此[链接](https://gitee.com/help/articles/4346)。 + +以下为一次提交代码的步骤: +1. **最重要**:提交代码时一定要记得使用git commit -s -m添加signed-off信息,且signed-off中涉及到的邮箱已经在[链接](https://dco.openharmony.io/sign/Z2l0ZWUlMkZvcGVuX2hhcm1vbnk=)中签署DCO + +2. 使用`git push origin <分支名>`将指定分支的本地仓库内容推到远端开发者fork仓库(fork工作仓方式)或远端主仓(评审模式) + +3. fork工作仓方式:进入远端fork 的仓库,点击新建PR,选择第2步中提交的分支。评审模式:一个PR会自动创建 + +4. 在主仓新建ISSUE,ISSUE的类型和内容根据提交的代码特性按实际填写 + +5. 在PR页面右边栏的“关联ISSUE”选择第4步创建的ISSUE(不关联无法触发门禁) + +6. 在PR页面右边栏选择审查人员 + +7. 在评论中输入`start build`,几秒后会触发门禁 + +8. 等待门禁后台审核 + + * 如果提交的PR显示DCO检查成功,等待管理员审核通过即可,如果DCO检查失败,请确认是否签署DCO。 + + * 提交以后,后台会进行自动化的法务合规、cicd的扫描,扫描结果会在提交的PR下以评论的形式展现出来 + + * 如果扫描有问题,需要根据反馈进行整改,然后再重新提交,直到审核通过 + +9. 门禁全部通过和人员审查通过后,会自动合并代码 + +*** +# ENGLISH +This guide is an expansion of the code submission standards of openharmony-sig. + +Developers should make modifications to the repository by submitting a PR (Pull Request) to the corresponding repository. There are two ways to submit a PR: + +1. Fork repository method: For related Gitee operations, please refer to this [link](https://gitee.com/help/articles/4128#article-header0). +2. Review mode: Directly push the code to the main repository, and Gitee will automatically generate a PR. For related operations, please refer to this [link](https://gitee.com/help/articles/4346). + +Here are the steps for a code submission: + +1. **Most importantly**: When committing code, always remember to use `git commit -s -m` to add signed-off information, and ensure that the email involved in the signed-off has signed the DCO (Developer Certificate of Origin) as [linked](https://dco.openharmony.io/sign/Z2l0ZWUlMkZvcGVuX2hhcm1vbnk=). +2. Use `git push origin ` to push the content of the specified branch in your local repository to the remote developer's forked repository (fork repository method) or to the remote main repository (review mode). +3. Fork repository method: Enter the remote forked repository and click on "New Pull Request", selecting the branch submitted in step 2. Review mode: A PR will be automatically created. +4. Create a new ISSUE in the main repository, and fill in the type and content of the ISSUE according to the features of the submitted code. +5. On the right side of the PR page, under "Associated ISSUE", select the ISSUE created in step 4 (it cannot trigger the gate if not associated). +6. On the right side of the PR page, select the reviewer. +7. Enter "start build" in the comments to trigger the gate after a few seconds. +8. Wait for the gate to be reviewed in the background. + * If the submitted PR shows that the DCO check is successful, wait for the administrator to review and pass. If the DCO check fails, please confirm whether you have signed the DCO. + * After submission, the background will carry out automated legal compliance and CI/CD scanning, and the results of the scan will be displayed in the form of comments under the submitted PR. + * If there are problems with the scan, they need to be rectified according to the feedback and then resubmitted until the review is passed. +9. After all gates pass and the personnel review is passed, the code will be automatically merged. \ No newline at end of file diff --git a/docs/api_docs/_media/README.md b/docs/api_docs/_media/README.md new file mode 100644 index 0000000000000000000000000000000000000000..13d57082c3445478dd582bdeaecb0ea9b34f7bb3 --- /dev/null +++ b/docs/api_docs/_media/README.md @@ -0,0 +1,98 @@ +# sig_programanalysis + +简体中文 | [English](./README.en.md) + +说明:本SIG的内容遵循OpenHarmony的PMC管理章程 [README](../../zh/pmc.md)中描述的约定。 + + +## SIG组工作目标和范围 + + + +### 工作目标 + +* 程序分析-SIG(Sig_programanalysis) 旨在面向OpenHarmony系统和原生应用开展程序分析技术洞察、关键技术识别和竞争力构建,同时成为OpenHarmony系统和应用程序分析能力的聚集地和相关工程工具的孵化地。 + +* 程序分析-SIG(Sig_programanalysis)将面向OpenHarmony应用构建基础程序分析框架并基于此为应用开发者提供开箱即用的缺陷扫描分析工具,面向IDE、流水线门禁、应用市场上架审核等场景,打造自动化工具看护能力。 + +### 工作范围 + +* 负责程序分析子领域关键根技术地图梳理,以及领域内功能模块分解、接口定义与维护管理等工作。 + +* 负责程序分析子领域相关项目的架构设计、开源开发和项目维护等工作。 + + +### 项目孵化 + +程序分析-SIG(Sig_programanalysis)正积极孵化如下项目,欢迎大家参与共享共建(可申请参与已有项目的共建,也可申请创建新的程序分析项目并联合社区启动开源共建)。 + + +* 方舟分析器(ArkAnalyzer): + 面向ArkTS的OpenHarmony应用程序分析框架。 + +* 方舟检测器(ArkCheck): + 面向OpenHarmony应用开发提供代码级缺陷自动检测(I期聚焦高性能编码规则的自动化检测) + + + +## SIG组成员 + + +### Leader + +- [lilicoding](https://gitee.com/lilicoding) + + +### Committers列表 +- [kubigao](https://gitee.com/kubigao) +- [yifei-xue](https://gitee.com/yifei_xue) +- [kubrick-hjh](https://gitee.com/kubrick-hjh) +- [speed9](https://gitee.com/speeds) +- [bbsun](https://gitee.com/bbsun) +- [chn](https://gitee.com/chn) +- [Elouan](https://gitee.com/Elouan) +- [Rnine](https://gitee.com/Rnine) +- [workspace_cb](https://gitee.com/workspace_cb) +- [longyuC](https://gitee.com/longyuC) +- [xyji95](https://gitee.com/xyji95) +- [xulingyun-red](https://gitee.com/xulingyun-red) + + +### 会议 + - 会议时间:双周例会,周四晚上19:00, UTC+8 + - 会议申报:[申报链接](https://shimo.im/forms/B1Awd60W7bU51g3m/fill) + - 会议链接:Welink或其他会议 + - 会议通知:请[订阅](https://lists.openatom.io/postorius/lists/dev.openharmony.io)邮件列表 dev@openharmony.io 获取会议链接 + - 会议纪要:[归档链接地址](https://gitee.com/openharmony-sig/sig-content) + + +### Contact (optional) + +- 邮件列表:[dev@openharmony.io](https://lists.openatom.io/postorius/lists/dev@openharmony.io/) + +*** + +# 方舟分析器:面向ArkTS语言的静态程序分析框架 +## ArkAnalyzer 环境配置 +1. 从[Download Visual Studio Code](https://code.visualstudio.com/download)下载vscode并安装,或安装其他IDE。 +2. 从[Download Node.js](https://nodejs.org/en/download/current)下载Node.js并安装,Node.js为JavaScript的运行时环境,自带包管理器npm。 +3. 通过npm安装TypeScript编译器,命令行输入 +```shell +npm install -g typescript +``` +4. 安装依赖库 +```shell +npm install +``` + +## ArkAnalyzer 代码上库 +遵守openharmony-sig代码上库规范, 操作方法请参考:[链接](docs/HowToCreatePR.md#中文) + +## ArkAnalyzer 调试 +将调试配置文件`.vscode/launch.json`中`args`参数数组修改为想要调试的文件路径,然后启动调试。 + +## 添加自验证测试用例 +新增测试代码统一放至`tests`目录下,对应的样例代码和其他资源文件统一放至`tests\resources`,按测试场景创建不同文件夹。 + +## ArkAnalyzer Issues +请参考[连接](docs/HowToHandleIssues.md)提交Issues。 diff --git a/docs/api_docs/classes/AbstractAnalysis.md b/docs/api_docs/classes/AbstractAnalysis.md new file mode 100644 index 0000000000000000000000000000000000000000..5416c2bcc79b3804f866fca74bfc0dd09d9a52a0 --- /dev/null +++ b/docs/api_docs/classes/AbstractAnalysis.md @@ -0,0 +1,269 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / AbstractAnalysis + +# Class: `abstract` AbstractAnalysis + +Defined in: src/callgraph/algorithm/AbstractAnalysis.ts:30 + +## Extended by + +- [`ClassHierarchyAnalysis`](ClassHierarchyAnalysis.md) +- [`RapidTypeAnalysis`](RapidTypeAnalysis.md) +- [`PointerAnalysis`](PointerAnalysis.md) + +## Constructors + +### new AbstractAnalysis() + +> **new AbstractAnalysis**(`s`): [`AbstractAnalysis`](AbstractAnalysis.md) + +Defined in: src/callgraph/algorithm/AbstractAnalysis.ts:37 + +#### Parameters + +##### s + +[`Scene`](Scene.md) + +#### Returns + +[`AbstractAnalysis`](AbstractAnalysis.md) + +## Properties + +### cg + +> `protected` **cg**: [`CallGraph`](CallGraph.md) + +Defined in: src/callgraph/algorithm/AbstractAnalysis.ts:32 + +*** + +### cgBuilder + +> `protected` **cgBuilder**: [`CallGraphBuilder`](CallGraphBuilder.md) + +Defined in: src/callgraph/algorithm/AbstractAnalysis.ts:33 + +*** + +### processedMethod + +> `protected` **processedMethod**: `Set`\<`number`\> + +Defined in: src/callgraph/algorithm/AbstractAnalysis.ts:35 + +*** + +### scene + +> `protected` **scene**: [`Scene`](Scene.md) + +Defined in: src/callgraph/algorithm/AbstractAnalysis.ts:31 + +*** + +### workList + +> `protected` **workList**: `number`[] = `[]` + +Defined in: src/callgraph/algorithm/AbstractAnalysis.ts:34 + +## Methods + +### addCallGraphEdge() + +> `protected` **addCallGraphEdge**(`caller`, `callee`, `cs`, `displayGeneratedMethod`): `void` + +Defined in: src/callgraph/algorithm/AbstractAnalysis.ts:147 + +#### Parameters + +##### caller + +`number` + +##### callee + +`null` | [`ArkMethod`](ArkMethod.md) + +##### cs + +[`CallSite`](CallSite.md) + +##### displayGeneratedMethod + +`boolean` + +#### Returns + +`void` + +*** + +### getCallGraph() + +> **getCallGraph**(): [`CallGraph`](CallGraph.md) + +Defined in: src/callgraph/algorithm/AbstractAnalysis.ts:45 + +#### Returns + +[`CallGraph`](CallGraph.md) + +*** + +### getClassHierarchy() + +> **getClassHierarchy**(`arkClass`): [`ArkClass`](ArkClass.md)[] + +Defined in: src/callgraph/algorithm/AbstractAnalysis.ts:59 + +#### Parameters + +##### arkClass + +[`ArkClass`](ArkClass.md) + +#### Returns + +[`ArkClass`](ArkClass.md)[] + +*** + +### getParamAnonymousMethod() + +> `protected` **getParamAnonymousMethod**(`invokeExpr`): [`MethodSignature`](MethodSignature.md)[] + +Defined in: src/callgraph/algorithm/AbstractAnalysis.ts:134 + +#### Parameters + +##### invokeExpr + +[`AbstractInvokeExpr`](AbstractInvokeExpr.md) + +#### Returns + +[`MethodSignature`](MethodSignature.md)[] + +*** + +### getScene() + +> **getScene**(): [`Scene`](Scene.md) + +Defined in: src/callgraph/algorithm/AbstractAnalysis.ts:41 + +#### Returns + +[`Scene`](Scene.md) + +*** + +### init() + +> `protected` **init**(): `void` + +Defined in: src/callgraph/algorithm/AbstractAnalysis.ts:105 + +#### Returns + +`void` + +*** + +### preProcessMethod() + +> `abstract` `protected` **preProcessMethod**(`funcID`): [`CallSite`](CallSite.md)[] + +Defined in: src/callgraph/algorithm/AbstractAnalysis.ts:50 + +#### Parameters + +##### funcID + +`number` + +#### Returns + +[`CallSite`](CallSite.md)[] + +*** + +### processMethod() + +> `protected` **processMethod**(`methodID`): [`CallSite`](CallSite.md)[] + +Defined in: src/callgraph/algorithm/AbstractAnalysis.ts:112 + +#### Parameters + +##### methodID + +`number` + +#### Returns + +[`CallSite`](CallSite.md)[] + +*** + +### resolveCall() + +> `abstract` `protected` **resolveCall**(`sourceMethod`, `invokeStmt`): [`CallSite`](CallSite.md)[] + +Defined in: src/callgraph/algorithm/AbstractAnalysis.ts:49 + +#### Parameters + +##### sourceMethod + +`number` + +##### invokeStmt + +[`Stmt`](Stmt.md) + +#### Returns + +[`CallSite`](CallSite.md)[] + +*** + +### resolveInvokeExpr() + +> **resolveInvokeExpr**(`invokeExpr`): `undefined` \| [`ArkMethod`](ArkMethod.md) + +Defined in: src/callgraph/algorithm/AbstractAnalysis.ts:52 + +#### Parameters + +##### invokeExpr + +[`AbstractInvokeExpr`](AbstractInvokeExpr.md) + +#### Returns + +`undefined` \| [`ArkMethod`](ArkMethod.md) + +*** + +### start() + +> **start**(`displayGeneratedMethod`): `void` + +Defined in: src/callgraph/algorithm/AbstractAnalysis.ts:75 + +#### Parameters + +##### displayGeneratedMethod + +`boolean` + +#### Returns + +`void` diff --git a/docs/api_docs/classes/AbstractBinopExpr.md b/docs/api_docs/classes/AbstractBinopExpr.md new file mode 100644 index 0000000000000000000000000000000000000000..876c3a39fbac6b4ac472a9849f38b53110f16737 --- /dev/null +++ b/docs/api_docs/classes/AbstractBinopExpr.md @@ -0,0 +1,311 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / AbstractBinopExpr + +# Class: `abstract` AbstractBinopExpr + +Defined in: src/core/base/Expr.ts:542 + +## Extends + +- [`AbstractExpr`](AbstractExpr.md) + +## Extended by + +- [`ArkConditionExpr`](ArkConditionExpr.md) +- [`ArkNormalBinopExpr`](ArkNormalBinopExpr.md) + +## Constructors + +### new AbstractBinopExpr() + +> **new AbstractBinopExpr**(`op1`, `op2`, `operator`): [`AbstractBinopExpr`](AbstractBinopExpr.md) + +Defined in: src/core/base/Expr.ts:549 + +#### Parameters + +##### op1 + +[`Value`](../interfaces/Value.md) + +##### op2 + +[`Value`](../interfaces/Value.md) + +##### operator + +[`BinaryOperator`](../type-aliases/BinaryOperator.md) + +#### Returns + +[`AbstractBinopExpr`](AbstractBinopExpr.md) + +#### Overrides + +[`AbstractExpr`](AbstractExpr.md).[`constructor`](AbstractExpr.md#constructors) + +## Properties + +### op1 + +> `protected` **op1**: [`Value`](../interfaces/Value.md) + +Defined in: src/core/base/Expr.ts:543 + +*** + +### op2 + +> `protected` **op2**: [`Value`](../interfaces/Value.md) + +Defined in: src/core/base/Expr.ts:544 + +*** + +### operator + +> `protected` **operator**: [`BinaryOperator`](../type-aliases/BinaryOperator.md) + +Defined in: src/core/base/Expr.ts:545 + +*** + +### type + +> `protected` **type**: [`Type`](Type.md) + +Defined in: src/core/base/Expr.ts:547 + +## Methods + +### getOp1() + +> **getOp1**(): [`Value`](../interfaces/Value.md) + +Defined in: src/core/base/Expr.ts:561 + +Returns the first operand in the binary operation expression. +For example, the first operand in `a + b;` is `a`. + +#### Returns + +[`Value`](../interfaces/Value.md) + +The first operand in the binary operation expression. + +*** + +### getOp2() + +> **getOp2**(): [`Value`](../interfaces/Value.md) + +Defined in: src/core/base/Expr.ts:574 + +Returns the second operand in the binary operation expression. +For example, the second operand in `a + b;` is `b`. + +#### Returns + +[`Value`](../interfaces/Value.md) + +The second operand in the binary operation expression. + +*** + +### getOperator() + +> **getOperator**(): [`BinaryOperator`](../type-aliases/BinaryOperator.md) + +Defined in: src/core/base/Expr.ts:597 + +Get the binary operator from the statement. +The binary operator can be divided into two categories, +one is the normal binary operator and the other is relational binary operator. + +#### Returns + +[`BinaryOperator`](../type-aliases/BinaryOperator.md) + +The binary operator from the statement. + +#### Example + +```typescript +if (expr instanceof AbstractBinopExpr) { +let op1: Value = expr.getOp1(); +let op2: Value = expr.getOp2(); +let operator: string = expr.getOperator(); +... ... +} +``` + +*** + +### getType() + +> **getType**(): [`Type`](Type.md) + +Defined in: src/core/base/Expr.ts:601 + +Return the type of this value. The interface is encapsulated in [Value](../interfaces/Value.md). +The `Type` is defined in type.ts, such as **Any**, **Unknown**, **TypeParameter**, +**UnclearReference**, **Primitive**, **Number**, **String**, etc. + +#### Returns + +[`Type`](Type.md) + +The type of this value. + +#### Example + +1. In the declaration statement, determine the left-value type and right-value type. + +```typescript +let leftValue:Value; +let rightValue:Value; +... +if (leftValue.getType() instanceof UnknownType && + !(rightValue.getType() instanceof UnknownType) && + !(rightValue.getType() instanceof UndefinedType)) { + ... +} +``` + +#### Overrides + +[`AbstractExpr`](AbstractExpr.md).[`getType`](AbstractExpr.md#gettype) + +*** + +### getUses() + +> **getUses**(): [`Value`](../interfaces/Value.md)[] + +Defined in: src/core/base/Expr.ts:608 + +Return a list of values which are contained in this [Value](../interfaces/Value.md). +Value is a core interface in ArkAnalyzer, which may represent any value or expression. + +#### Returns + +[`Value`](../interfaces/Value.md)[] + +An **array** of values used by this value. + +#### Overrides + +[`AbstractExpr`](AbstractExpr.md).[`getUses`](AbstractExpr.md#getuses) + +*** + +### inferOpType() + +> `protected` **inferOpType**(`op`, `arkMethod`): `void` + +Defined in: src/core/base/Expr.ts:621 + +#### Parameters + +##### op + +[`Value`](../interfaces/Value.md) + +##### arkMethod + +[`ArkMethod`](ArkMethod.md) + +#### Returns + +`void` + +*** + +### inferType() + +> **inferType**(`arkMethod`): [`AbstractBinopExpr`](AbstractBinopExpr.md) + +Defined in: src/core/base/Expr.ts:691 + +#### Parameters + +##### arkMethod + +[`ArkMethod`](ArkMethod.md) + +#### Returns + +[`AbstractBinopExpr`](AbstractBinopExpr.md) + +#### Overrides + +[`AbstractExpr`](AbstractExpr.md).[`inferType`](AbstractExpr.md#infertype) + +*** + +### setOp1() + +> **setOp1**(`newOp1`): `void` + +Defined in: src/core/base/Expr.ts:565 + +#### Parameters + +##### newOp1 + +[`Value`](../interfaces/Value.md) + +#### Returns + +`void` + +*** + +### setOp2() + +> **setOp2**(`newOp2`): `void` + +Defined in: src/core/base/Expr.ts:578 + +#### Parameters + +##### newOp2 + +[`Value`](../interfaces/Value.md) + +#### Returns + +`void` + +*** + +### setType() + +> `protected` **setType**(): `void` + +Defined in: src/core/base/Expr.ts:627 + +#### Returns + +`void` + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/base/Expr.ts:617 + +Returns a string representation of an object. + +#### Returns + +`string` + +#### Overrides + +[`AbstractExpr`](AbstractExpr.md).[`toString`](AbstractExpr.md#tostring) diff --git a/docs/api_docs/classes/AbstractExpr.md b/docs/api_docs/classes/AbstractExpr.md new file mode 100644 index 0000000000000000000000000000000000000000..fbc15379066b622d37decedee0ed133420e16105 --- /dev/null +++ b/docs/api_docs/classes/AbstractExpr.md @@ -0,0 +1,129 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / AbstractExpr + +# Class: `abstract` AbstractExpr + +Defined in: src/core/base/Expr.ts:47 + +## Extended by + +- [`AbstractInvokeExpr`](AbstractInvokeExpr.md) +- [`ArkNewExpr`](ArkNewExpr.md) +- [`ArkNewArrayExpr`](ArkNewArrayExpr.md) +- [`ArkDeleteExpr`](ArkDeleteExpr.md) +- [`ArkAwaitExpr`](ArkAwaitExpr.md) +- [`ArkYieldExpr`](ArkYieldExpr.md) +- [`AbstractBinopExpr`](AbstractBinopExpr.md) +- [`ArkTypeOfExpr`](ArkTypeOfExpr.md) +- [`ArkInstanceOfExpr`](ArkInstanceOfExpr.md) +- [`ArkCastExpr`](ArkCastExpr.md) +- [`ArkPhiExpr`](ArkPhiExpr.md) +- [`ArkUnopExpr`](ArkUnopExpr.md) +- [`AliasTypeExpr`](AliasTypeExpr.md) + +## Implements + +- [`Value`](../interfaces/Value.md) + +## Constructors + +### new AbstractExpr() + +> **new AbstractExpr**(): [`AbstractExpr`](AbstractExpr.md) + +#### Returns + +[`AbstractExpr`](AbstractExpr.md) + +## Methods + +### getType() + +> `abstract` **getType**(): [`Type`](Type.md) + +Defined in: src/core/base/Expr.ts:50 + +Return the type of this value. The interface is encapsulated in [Value](../interfaces/Value.md). +The `Type` is defined in type.ts, such as **Any**, **Unknown**, **TypeParameter**, +**UnclearReference**, **Primitive**, **Number**, **String**, etc. + +#### Returns + +[`Type`](Type.md) + +The type of this value. + +#### Example + +1. In the declaration statement, determine the left-value type and right-value type. + +```typescript +let leftValue:Value; +let rightValue:Value; +... +if (leftValue.getType() instanceof UnknownType && + !(rightValue.getType() instanceof UnknownType) && + !(rightValue.getType() instanceof UndefinedType)) { + ... +} +``` + +#### Implementation of + +[`Value`](../interfaces/Value.md).[`getType`](../interfaces/Value.md#gettype) + +*** + +### getUses() + +> `abstract` **getUses**(): [`Value`](../interfaces/Value.md)[] + +Defined in: src/core/base/Expr.ts:48 + +Return a list of values which are contained in this [Value](../interfaces/Value.md). +Value is a core interface in ArkAnalyzer, which may represent any value or expression. + +#### Returns + +[`Value`](../interfaces/Value.md)[] + +An **array** of values used by this value. + +#### Implementation of + +[`Value`](../interfaces/Value.md).[`getUses`](../interfaces/Value.md#getuses) + +*** + +### inferType() + +> **inferType**(`arkMethod`): [`AbstractExpr`](AbstractExpr.md) + +Defined in: src/core/base/Expr.ts:54 + +#### Parameters + +##### arkMethod + +[`ArkMethod`](ArkMethod.md) + +#### Returns + +[`AbstractExpr`](AbstractExpr.md) + +*** + +### toString() + +> `abstract` **toString**(): `string` + +Defined in: src/core/base/Expr.ts:52 + +Returns a string representation of an object. + +#### Returns + +`string` diff --git a/docs/api_docs/classes/AbstractFieldRef.md b/docs/api_docs/classes/AbstractFieldRef.md new file mode 100644 index 0000000000000000000000000000000000000000..96e9729f2c08d8e0da30fc7392e369c2dd936e56 --- /dev/null +++ b/docs/api_docs/classes/AbstractFieldRef.md @@ -0,0 +1,186 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / AbstractFieldRef + +# Class: `abstract` AbstractFieldRef + +Defined in: src/core/base/Ref.ts:123 + +## Extends + +- [`AbstractRef`](AbstractRef.md) + +## Extended by + +- [`ArkInstanceFieldRef`](ArkInstanceFieldRef.md) +- [`ArkStaticFieldRef`](ArkStaticFieldRef.md) + +## Constructors + +### new AbstractFieldRef() + +> **new AbstractFieldRef**(`fieldSignature`): [`AbstractFieldRef`](AbstractFieldRef.md) + +Defined in: src/core/base/Ref.ts:126 + +#### Parameters + +##### fieldSignature + +[`FieldSignature`](FieldSignature.md) + +#### Returns + +[`AbstractFieldRef`](AbstractFieldRef.md) + +#### Overrides + +[`AbstractRef`](AbstractRef.md).[`constructor`](AbstractRef.md#constructors) + +## Methods + +### getFieldName() + +> **getFieldName**(): `string` + +Defined in: src/core/base/Ref.ts:135 + +Returns the the field name as a **string**. + +#### Returns + +`string` + +The the field name. + +*** + +### getFieldSignature() + +> **getFieldSignature**(): [`FieldSignature`](FieldSignature.md) + +Defined in: src/core/base/Ref.ts:157 + +Returns a field signature, which consists of a class signature, +a **string** field name, and a **boolean** label indicating whether it is static or not. + +#### Returns + +[`FieldSignature`](FieldSignature.md) + +The field signature. + +#### Example + +1. Compare two Fields + +```typescript +const fieldSignature = new FieldSignature(); +fieldSignature.setFieldName(...); +const fieldRef = new ArkInstanceFieldRef(baseValue as Local, fieldSignature); +... +if (fieldRef.getFieldSignature().getFieldName() === +targetField.getFieldSignature().getFieldName()) { +... +} +``` + +*** + +### getType() + +> **getType**(): [`Type`](Type.md) + +Defined in: src/core/base/Ref.ts:165 + +Return the type of this value. The interface is encapsulated in [Value](../interfaces/Value.md). +The `Type` is defined in type.ts, such as **Any**, **Unknown**, **TypeParameter**, +**UnclearReference**, **Primitive**, **Number**, **String**, etc. + +#### Returns + +[`Type`](Type.md) + +The type of this value. + +#### Example + +1. In the declaration statement, determine the left-value type and right-value type. + +```typescript +let leftValue:Value; +let rightValue:Value; +... +if (leftValue.getType() instanceof UnknownType && + !(rightValue.getType() instanceof UnknownType) && + !(rightValue.getType() instanceof UndefinedType)) { + ... +} +``` + +#### Overrides + +[`AbstractRef`](AbstractRef.md).[`getType`](AbstractRef.md#gettype) + +*** + +### getUses() + +> `abstract` **getUses**(): [`Value`](../interfaces/Value.md)[] + +Defined in: src/core/base/Ref.ts:33 + +Return a list of values which are contained in this [Value](../interfaces/Value.md). +Value is a core interface in ArkAnalyzer, which may represent any value or expression. + +#### Returns + +[`Value`](../interfaces/Value.md)[] + +An **array** of values used by this value. + +#### Inherited from + +[`AbstractRef`](AbstractRef.md).[`getUses`](AbstractRef.md#getuses) + +*** + +### inferType() + +> **inferType**(`arkMethod`): [`AbstractRef`](AbstractRef.md) + +Defined in: src/core/base/Ref.ts:37 + +#### Parameters + +##### arkMethod + +[`ArkMethod`](ArkMethod.md) + +#### Returns + +[`AbstractRef`](AbstractRef.md) + +#### Inherited from + +[`AbstractRef`](AbstractRef.md).[`inferType`](AbstractRef.md#infertype) + +*** + +### setFieldSignature() + +> **setFieldSignature**(`newFieldSignature`): `void` + +Defined in: src/core/base/Ref.ts:161 + +#### Parameters + +##### newFieldSignature + +[`FieldSignature`](FieldSignature.md) + +#### Returns + +`void` diff --git a/docs/api_docs/classes/AbstractInvokeExpr.md b/docs/api_docs/classes/AbstractInvokeExpr.md new file mode 100644 index 0000000000000000000000000000000000000000..17ca73686fdc45b5e822d232b340a3d655ea69f0 --- /dev/null +++ b/docs/api_docs/classes/AbstractInvokeExpr.md @@ -0,0 +1,301 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / AbstractInvokeExpr + +# Class: `abstract` AbstractInvokeExpr + +Defined in: src/core/base/Expr.ts:59 + +## Extends + +- [`AbstractExpr`](AbstractExpr.md) + +## Extended by + +- [`ArkInstanceInvokeExpr`](ArkInstanceInvokeExpr.md) +- [`ArkStaticInvokeExpr`](ArkStaticInvokeExpr.md) +- [`ArkPtrInvokeExpr`](ArkPtrInvokeExpr.md) + +## Constructors + +### new AbstractInvokeExpr() + +> **new AbstractInvokeExpr**(`methodSignature`, `args`, `realGenericTypes`?): [`AbstractInvokeExpr`](AbstractInvokeExpr.md) + +Defined in: src/core/base/Expr.ts:64 + +#### Parameters + +##### methodSignature + +[`MethodSignature`](MethodSignature.md) + +##### args + +[`Value`](../interfaces/Value.md)[] + +##### realGenericTypes? + +[`Type`](Type.md)[] + +#### Returns + +[`AbstractInvokeExpr`](AbstractInvokeExpr.md) + +#### Overrides + +[`AbstractExpr`](AbstractExpr.md).[`constructor`](AbstractExpr.md#constructors) + +## Methods + +### getArg() + +> **getArg**(`index`): [`Value`](../interfaces/Value.md) + +Defined in: src/core/base/Expr.ts:98 + +Returns an argument used in the expression according to its index. + +#### Parameters + +##### index + +`number` + +the index of the argument. + +#### Returns + +[`Value`](../interfaces/Value.md) + +An argument used in the expression. + +*** + +### getArgs() + +> **getArgs**(): [`Value`](../interfaces/Value.md)[] + +Defined in: src/core/base/Expr.ts:124 + +Returns an **array** of arguments used in the expression. + +#### Returns + +[`Value`](../interfaces/Value.md)[] + +An **array** of arguments used in the expression. + +#### Example + +1. get args number. + +```typescript +const argsNum = expr.getArgs().length; +if (argsNum < 5) { +... ... +} +``` + +2. iterate arg based on expression + +```typescript +for (const arg of this.getArgs()) { +strs.push(arg.toString()); +strs.push(', '); +} +``` + +*** + +### getMethodSignature() + +> **getMethodSignature**(): [`MethodSignature`](MethodSignature.md) + +Defined in: src/core/base/Expr.ts:85 + +Get method Signature. The method signature is consist of ClassSignature and MethodSubSignature. +It is the unique flag of a method. It is usually used to compose a expression string in ArkIRTransformer. + +#### Returns + +[`MethodSignature`](MethodSignature.md) + +The class method signature, such as ArkStaticInvokeExpr. + +#### Example + +1. 3AC information composed of getMethodSignature (). + +```typescript +let strs: string[] = []; +strs.push('staticinvoke <'); +strs.push(this.getMethodSignature().toString()); +strs.push('>('); +``` + +*** + +### getRealGenericTypes() + +> **getRealGenericTypes**(): `undefined` \| [`Type`](Type.md)[] + +Defined in: src/core/base/Expr.ts:140 + +#### Returns + +`undefined` \| [`Type`](Type.md)[] + +*** + +### getType() + +> **getType**(): [`Type`](Type.md) + +Defined in: src/core/base/Expr.ts:132 + +Return the type of this value. The interface is encapsulated in [Value](../interfaces/Value.md). +The `Type` is defined in type.ts, such as **Any**, **Unknown**, **TypeParameter**, +**UnclearReference**, **Primitive**, **Number**, **String**, etc. + +#### Returns + +[`Type`](Type.md) + +The type of this value. + +#### Example + +1. In the declaration statement, determine the left-value type and right-value type. + +```typescript +let leftValue:Value; +let rightValue:Value; +... +if (leftValue.getType() instanceof UnknownType && + !(rightValue.getType() instanceof UnknownType) && + !(rightValue.getType() instanceof UndefinedType)) { + ... +} +``` + +#### Overrides + +[`AbstractExpr`](AbstractExpr.md).[`getType`](AbstractExpr.md#gettype) + +*** + +### getUses() + +> **getUses**(): [`Value`](../interfaces/Value.md)[] + +Defined in: src/core/base/Expr.ts:150 + +Return a list of values which are contained in this [Value](../interfaces/Value.md). +Value is a core interface in ArkAnalyzer, which may represent any value or expression. + +#### Returns + +[`Value`](../interfaces/Value.md)[] + +An **array** of values used by this value. + +#### Overrides + +[`AbstractExpr`](AbstractExpr.md).[`getUses`](AbstractExpr.md#getuses) + +*** + +### inferType() + +> **inferType**(`arkMethod`): [`AbstractExpr`](AbstractExpr.md) + +Defined in: src/core/base/Expr.ts:54 + +#### Parameters + +##### arkMethod + +[`ArkMethod`](ArkMethod.md) + +#### Returns + +[`AbstractExpr`](AbstractExpr.md) + +#### Inherited from + +[`AbstractExpr`](AbstractExpr.md).[`inferType`](AbstractExpr.md#infertype) + +*** + +### setArgs() + +> **setArgs**(`newArgs`): `void` + +Defined in: src/core/base/Expr.ts:128 + +#### Parameters + +##### newArgs + +[`Value`](../interfaces/Value.md)[] + +#### Returns + +`void` + +*** + +### setMethodSignature() + +> **setMethodSignature**(`newMethodSignature`): `void` + +Defined in: src/core/base/Expr.ts:89 + +#### Parameters + +##### newMethodSignature + +[`MethodSignature`](MethodSignature.md) + +#### Returns + +`void` + +*** + +### setRealGenericTypes() + +> **setRealGenericTypes**(`realTypes`): `void` + +Defined in: src/core/base/Expr.ts:144 + +#### Parameters + +##### realTypes + +`undefined` | [`Type`](Type.md)[] + +#### Returns + +`void` + +*** + +### toString() + +> `abstract` **toString**(): `string` + +Defined in: src/core/base/Expr.ts:52 + +Returns a string representation of an object. + +#### Returns + +`string` + +#### Inherited from + +[`AbstractExpr`](AbstractExpr.md).[`toString`](AbstractExpr.md#tostring) diff --git a/docs/api_docs/classes/AbstractRef.md b/docs/api_docs/classes/AbstractRef.md new file mode 100644 index 0000000000000000000000000000000000000000..3a5a92915164d45cc949cd4c94e28b766b9e266b --- /dev/null +++ b/docs/api_docs/classes/AbstractRef.md @@ -0,0 +1,109 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / AbstractRef + +# Class: `abstract` AbstractRef + +Defined in: src/core/base/Ref.ts:32 + +## Extended by + +- [`ArkArrayRef`](ArkArrayRef.md) +- [`AbstractFieldRef`](AbstractFieldRef.md) +- [`ArkParameterRef`](ArkParameterRef.md) +- [`ArkThisRef`](ArkThisRef.md) +- [`ArkCaughtExceptionRef`](ArkCaughtExceptionRef.md) +- [`GlobalRef`](GlobalRef.md) +- [`ClosureFieldRef`](ClosureFieldRef.md) + +## Implements + +- [`Value`](../interfaces/Value.md) + +## Constructors + +### new AbstractRef() + +> **new AbstractRef**(): [`AbstractRef`](AbstractRef.md) + +#### Returns + +[`AbstractRef`](AbstractRef.md) + +## Methods + +### getType() + +> `abstract` **getType**(): [`Type`](Type.md) + +Defined in: src/core/base/Ref.ts:35 + +Return the type of this value. The interface is encapsulated in [Value](../interfaces/Value.md). +The `Type` is defined in type.ts, such as **Any**, **Unknown**, **TypeParameter**, +**UnclearReference**, **Primitive**, **Number**, **String**, etc. + +#### Returns + +[`Type`](Type.md) + +The type of this value. + +#### Example + +1. In the declaration statement, determine the left-value type and right-value type. + +```typescript +let leftValue:Value; +let rightValue:Value; +... +if (leftValue.getType() instanceof UnknownType && + !(rightValue.getType() instanceof UnknownType) && + !(rightValue.getType() instanceof UndefinedType)) { + ... +} +``` + +#### Implementation of + +[`Value`](../interfaces/Value.md).[`getType`](../interfaces/Value.md#gettype) + +*** + +### getUses() + +> `abstract` **getUses**(): [`Value`](../interfaces/Value.md)[] + +Defined in: src/core/base/Ref.ts:33 + +Return a list of values which are contained in this [Value](../interfaces/Value.md). +Value is a core interface in ArkAnalyzer, which may represent any value or expression. + +#### Returns + +[`Value`](../interfaces/Value.md)[] + +An **array** of values used by this value. + +#### Implementation of + +[`Value`](../interfaces/Value.md).[`getUses`](../interfaces/Value.md#getuses) + +*** + +### inferType() + +> **inferType**(`arkMethod`): [`AbstractRef`](AbstractRef.md) + +Defined in: src/core/base/Ref.ts:37 + +#### Parameters + +##### arkMethod + +[`ArkMethod`](ArkMethod.md) + +#### Returns + +[`AbstractRef`](AbstractRef.md) diff --git a/docs/api_docs/classes/AddrPagEdge.md b/docs/api_docs/classes/AddrPagEdge.md new file mode 100644 index 0000000000000000000000000000000000000000..dd4a1e31d1309ef9f93e0ec28618d4930d3d738c --- /dev/null +++ b/docs/api_docs/classes/AddrPagEdge.md @@ -0,0 +1,197 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / AddrPagEdge + +# Class: AddrPagEdge + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:88 + +## Extends + +- [`PagEdge`](PagEdge.md) + +## Constructors + +### new AddrPagEdge() + +> **new AddrPagEdge**(`n`, `d`, `s`): [`AddrPagEdge`](AddrPagEdge.md) + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:89 + +#### Parameters + +##### n + +[`PagNode`](PagNode.md) + +##### d + +[`PagNode`](PagNode.md) + +##### s + +[`Stmt`](Stmt.md) + +#### Returns + +[`AddrPagEdge`](AddrPagEdge.md) + +#### Overrides + +[`PagEdge`](PagEdge.md).[`constructor`](PagEdge.md#constructors) + +## Properties + +### kind + +> `protected` **kind**: `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:27 + +#### Inherited from + +[`PagEdge`](PagEdge.md).[`kind`](PagEdge.md#kind) + +## Methods + +### getDotAttr() + +> **getDotAttr**(): `string` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:65 + +#### Returns + +`string` + +#### Inherited from + +[`PagEdge`](PagEdge.md).[`getDotAttr`](PagEdge.md#getdotattr) + +*** + +### getDstID() + +> **getDstID**(): `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:39 + +#### Returns + +`number` + +#### Inherited from + +[`PagEdge`](PagEdge.md).[`getDstID`](PagEdge.md#getdstid) + +*** + +### getDstNode() + +> **getDstNode**(): [`BaseNode`](BaseNode.md) + +Defined in: src/core/graph/BaseExplicitGraph.ts:47 + +#### Returns + +[`BaseNode`](BaseNode.md) + +#### Inherited from + +[`PagEdge`](PagEdge.md).[`getDstNode`](PagEdge.md#getdstnode) + +*** + +### getEndPoints() + +> **getEndPoints**(): `object` + +Defined in: src/core/graph/BaseExplicitGraph.ts:59 + +#### Returns + +`object` + +##### dst + +> **dst**: `number` + +##### src + +> **src**: `number` + +#### Inherited from + +[`PagEdge`](PagEdge.md).[`getEndPoints`](PagEdge.md#getendpoints) + +*** + +### getKind() + +> **getKind**(): `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:51 + +#### Returns + +`number` + +#### Inherited from + +[`PagEdge`](PagEdge.md).[`getKind`](PagEdge.md#getkind) + +*** + +### getSrcID() + +> **getSrcID**(): `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:35 + +#### Returns + +`number` + +#### Inherited from + +[`PagEdge`](PagEdge.md).[`getSrcID`](PagEdge.md#getsrcid) + +*** + +### getSrcNode() + +> **getSrcNode**(): [`BaseNode`](BaseNode.md) + +Defined in: src/core/graph/BaseExplicitGraph.ts:43 + +#### Returns + +[`BaseNode`](BaseNode.md) + +#### Inherited from + +[`PagEdge`](PagEdge.md).[`getSrcNode`](PagEdge.md#getsrcnode) + +*** + +### setKind() + +> **setKind**(`kind`): `void` + +Defined in: src/core/graph/BaseExplicitGraph.ts:55 + +#### Parameters + +##### kind + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`PagEdge`](PagEdge.md).[`setKind`](PagEdge.md#setkind) diff --git a/docs/api_docs/classes/AliasClassSignature.md b/docs/api_docs/classes/AliasClassSignature.md new file mode 100644 index 0000000000000000000000000000000000000000..6a0f873903675575c321ce4c7c246b35c9acc17a --- /dev/null +++ b/docs/api_docs/classes/AliasClassSignature.md @@ -0,0 +1,181 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / AliasClassSignature + +# Class: AliasClassSignature + +Defined in: src/core/model/ArkSignature.ts:176 + +## Extends + +- [`ClassSignature`](ClassSignature.md) + +## Constructors + +### new AliasClassSignature() + +> **new AliasClassSignature**(`aliasName`, `signature`): [`AliasClassSignature`](AliasClassSignature.md) + +Defined in: src/core/model/ArkSignature.ts:179 + +#### Parameters + +##### aliasName + +`string` + +##### signature + +[`ClassSignature`](ClassSignature.md) + +#### Returns + +[`AliasClassSignature`](AliasClassSignature.md) + +#### Overrides + +[`ClassSignature`](ClassSignature.md).[`constructor`](ClassSignature.md#constructors) + +## Properties + +### DEFAULT + +> `readonly` `static` **DEFAULT**: [`ClassSignature`](ClassSignature.md) + +Defined in: src/core/model/ArkSignature.ts:117 + +#### Inherited from + +[`ClassSignature`](ClassSignature.md).[`DEFAULT`](ClassSignature.md#default) + +## Methods + +### getClassName() + +> **getClassName**(): `string` + +Defined in: src/core/model/ArkSignature.ts:184 + +Get the **string** name of class from the the class signature. The default value is `""`. + +#### Returns + +`string` + +The name of this class. + +#### Overrides + +[`ClassSignature`](ClassSignature.md).[`getClassName`](ClassSignature.md#getclassname) + +*** + +### getDeclaringFileSignature() + +> **getDeclaringFileSignature**(): [`FileSignature`](FileSignature.md) + +Defined in: src/core/model/ArkSignature.ts:131 + +Returns the declaring file signature. + +#### Returns + +[`FileSignature`](FileSignature.md) + +The declaring file signature. + +#### Inherited from + +[`ClassSignature`](ClassSignature.md).[`getDeclaringFileSignature`](ClassSignature.md#getdeclaringfilesignature) + +*** + +### getDeclaringNamespaceSignature() + +> **getDeclaringNamespaceSignature**(): `null` \| [`NamespaceSignature`](NamespaceSignature.md) + +Defined in: src/core/model/ArkSignature.ts:139 + +Get the declaring namespace's signature. + +#### Returns + +`null` \| [`NamespaceSignature`](NamespaceSignature.md) + +the declaring namespace's signature. + +#### Inherited from + +[`ClassSignature`](ClassSignature.md).[`getDeclaringNamespaceSignature`](ClassSignature.md#getdeclaringnamespacesignature) + +*** + +### getType() + +> **getType**(): [`ClassType`](ClassType.md) + +Defined in: src/core/model/ArkSignature.ts:155 + +#### Returns + +[`ClassType`](ClassType.md) + +#### Inherited from + +[`ClassSignature`](ClassSignature.md).[`getType`](ClassSignature.md#gettype) + +*** + +### setClassName() + +> **setClassName**(`className`): `void` + +Defined in: src/core/model/ArkSignature.ts:151 + +#### Parameters + +##### className + +`string` + +#### Returns + +`void` + +#### Inherited from + +[`ClassSignature`](ClassSignature.md).[`setClassName`](ClassSignature.md#setclassname) + +*** + +### toMapKey() + +> **toMapKey**(): `string` + +Defined in: src/core/model/ArkSignature.ts:167 + +#### Returns + +`string` + +#### Inherited from + +[`ClassSignature`](ClassSignature.md).[`toMapKey`](ClassSignature.md#tomapkey) + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/model/ArkSignature.ts:159 + +#### Returns + +`string` + +#### Inherited from + +[`ClassSignature`](ClassSignature.md).[`toString`](ClassSignature.md#tostring) diff --git a/docs/api_docs/classes/AliasType.md b/docs/api_docs/classes/AliasType.md new file mode 100644 index 0000000000000000000000000000000000000000..8a2c4b5dac6aca63f3b7456efabd787a140f6c28 --- /dev/null +++ b/docs/api_docs/classes/AliasType.md @@ -0,0 +1,257 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / AliasType + +# Class: AliasType + +Defined in: src/core/base/Type.ts:450 + +## Extends + +- [`Type`](Type.md) + +## Implements + +- `ArkExport` + +## Constructors + +### new AliasType() + +> **new AliasType**(`name`, `originalType`, `signature`): [`AliasType`](AliasType.md) + +Defined in: src/core/base/Type.ts:456 + +#### Parameters + +##### name + +`string` + +##### originalType + +[`Type`](Type.md) + +##### signature + +[`LocalSignature`](LocalSignature.md) + +#### Returns + +[`AliasType`](AliasType.md) + +#### Overrides + +[`Type`](Type.md).[`constructor`](Type.md#constructors) + +## Properties + +### modifiers? + +> `protected` `optional` **modifiers**: `number` + +Defined in: src/core/base/Type.ts:454 + +## Methods + +### addModifier() + +> **addModifier**(`modifier`): `void` + +Defined in: src/core/base/Type.ts:504 + +#### Parameters + +##### modifier + +`number` + +#### Returns + +`void` + +*** + +### containsModifier() + +> **containsModifier**(`modifierType`): `boolean` + +Defined in: src/core/base/Type.ts:490 + +#### Parameters + +##### modifierType + +`ModifierType` + +#### Returns + +`boolean` + +#### Implementation of + +`ArkExport.containsModifier` + +*** + +### getExportType() + +> **getExportType**(): `ExportType` + +Defined in: src/core/base/Type.ts:479 + +#### Returns + +`ExportType` + +#### Implementation of + +`ArkExport.getExportType` + +*** + +### getModifiers() + +> **getModifiers**(): `number` + +Defined in: src/core/base/Type.ts:483 + +#### Returns + +`number` + +#### Implementation of + +`ArkExport.getModifiers` + +*** + +### getName() + +> **getName**(): `string` + +Defined in: src/core/base/Type.ts:463 + +#### Returns + +`string` + +#### Implementation of + +`ArkExport.getName` + +*** + +### getOriginalType() + +> **getOriginalType**(): [`Type`](Type.md) + +Defined in: src/core/base/Type.ts:471 + +#### Returns + +[`Type`](Type.md) + +*** + +### getSignature() + +> **getSignature**(): [`LocalSignature`](LocalSignature.md) + +Defined in: src/core/base/Type.ts:515 + +#### Returns + +[`LocalSignature`](LocalSignature.md) + +#### Implementation of + +`ArkExport.getSignature` + +*** + +### getTypeString() + +> **getTypeString**(): `string` + +Defined in: src/core/base/Type.ts:475 + +#### Returns + +`string` + +#### Overrides + +[`Type`](Type.md).[`getTypeString`](Type.md#gettypestring) + +*** + +### removeModifier() + +> **removeModifier**(`modifier`): `void` + +Defined in: src/core/base/Type.ts:508 + +#### Parameters + +##### modifier + +`ModifierType` + +#### Returns + +`void` + +*** + +### setModifiers() + +> **setModifiers**(`modifiers`): `void` + +Defined in: src/core/base/Type.ts:498 + +#### Parameters + +##### modifiers + +`number` + +#### Returns + +`void` + +*** + +### setOriginalType() + +> **setOriginalType**(`type`): `void` + +Defined in: src/core/base/Type.ts:467 + +#### Parameters + +##### type + +[`Type`](Type.md) + +#### Returns + +`void` + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/base/Type.ts:36 + +#### Returns + +`string` + +#### Inherited from + +[`Type`](Type.md).[`toString`](Type.md#tostring) diff --git a/docs/api_docs/classes/AliasTypeExpr.md b/docs/api_docs/classes/AliasTypeExpr.md new file mode 100644 index 0000000000000000000000000000000000000000..309124ae71db225d7ea8fcb872a6111cf92597c6 --- /dev/null +++ b/docs/api_docs/classes/AliasTypeExpr.md @@ -0,0 +1,212 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / AliasTypeExpr + +# Class: AliasTypeExpr + +Defined in: src/core/base/Expr.ts:963 + +Expression of the right hand of the type alias definition statement. + +## Example + +```typescript +let a: number = 123; +type ABC = typeof a; +``` +The AliasTypeExpr of the previous statement is with local 'a' as the 'originalObject' and 'transferWithTypeOf' is true. + +The Following case: import type with no clause name is not supported now, +whose 'originalObject' is [ImportInfo](ImportInfo.md) with 'null' 'lazyExportInfo'. +```typescript +let a = typeof import('./abc'); +``` + +## Extends + +- [`AbstractExpr`](AbstractExpr.md) + +## Constructors + +### new AliasTypeExpr() + +> **new AliasTypeExpr**(`originalObject`, `transferWithTypeOf`?): [`AliasTypeExpr`](AliasTypeExpr.md) + +Defined in: src/core/base/Expr.ts:967 + +#### Parameters + +##### originalObject + +[`AliasTypeOriginalModel`](../type-aliases/AliasTypeOriginalModel.md) + +##### transferWithTypeOf? + +`boolean` + +#### Returns + +[`AliasTypeExpr`](AliasTypeExpr.md) + +#### Overrides + +[`AbstractExpr`](AbstractExpr.md).[`constructor`](AbstractExpr.md#constructors) + +## Methods + +### getOriginalObject() + +> **getOriginalObject**(): [`AliasTypeOriginalModel`](../type-aliases/AliasTypeOriginalModel.md) + +Defined in: src/core/base/Expr.ts:975 + +#### Returns + +[`AliasTypeOriginalModel`](../type-aliases/AliasTypeOriginalModel.md) + +*** + +### getTransferWithTypeOf() + +> **getTransferWithTypeOf**(): `boolean` + +Defined in: src/core/base/Expr.ts:983 + +#### Returns + +`boolean` + +*** + +### getType() + +> **getType**(): [`Type`](Type.md) + +Defined in: src/core/base/Expr.ts:987 + +Return the type of this value. The interface is encapsulated in [Value](../interfaces/Value.md). +The `Type` is defined in type.ts, such as **Any**, **Unknown**, **TypeParameter**, +**UnclearReference**, **Primitive**, **Number**, **String**, etc. + +#### Returns + +[`Type`](Type.md) + +The type of this value. + +#### Example + +1. In the declaration statement, determine the left-value type and right-value type. + +```typescript +let leftValue:Value; +let rightValue:Value; +... +if (leftValue.getType() instanceof UnknownType && + !(rightValue.getType() instanceof UnknownType) && + !(rightValue.getType() instanceof UndefinedType)) { + ... +} +``` + +#### Overrides + +[`AbstractExpr`](AbstractExpr.md).[`getType`](AbstractExpr.md#gettype) + +*** + +### getUses() + +> **getUses**(): [`Value`](../interfaces/Value.md)[] + +Defined in: src/core/base/Expr.ts:1033 + +Returns all used values which mainly used for def-use chain analysis. + +#### Returns + +[`Value`](../interfaces/Value.md)[] + +Always returns empty array because her is the alias type definition which has no relationship with value flow. + +#### Overrides + +[`AbstractExpr`](AbstractExpr.md).[`getUses`](AbstractExpr.md#getuses) + +*** + +### inferType() + +> **inferType**(`arkMethod`): [`AbstractExpr`](AbstractExpr.md) + +Defined in: src/core/base/Expr.ts:1025 + +#### Parameters + +##### arkMethod + +[`ArkMethod`](ArkMethod.md) + +#### Returns + +[`AbstractExpr`](AbstractExpr.md) + +#### Overrides + +[`AbstractExpr`](AbstractExpr.md).[`inferType`](AbstractExpr.md#infertype) + +*** + +### setOriginalObject() + +> **setOriginalObject**(`object`): `void` + +Defined in: src/core/base/Expr.ts:979 + +#### Parameters + +##### object + +[`AliasTypeOriginalModel`](../type-aliases/AliasTypeOriginalModel.md) + +#### Returns + +`void` + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/base/Expr.ts:1037 + +Returns a string representation of an object. + +#### Returns + +`string` + +#### Overrides + +[`AbstractExpr`](AbstractExpr.md).[`toString`](AbstractExpr.md#tostring) + +*** + +### isAliasTypeOriginalModel() + +> `static` **isAliasTypeOriginalModel**(`object`): `object is AliasTypeOriginalModel` + +Defined in: src/core/base/Expr.ts:1063 + +#### Parameters + +##### object + +`any` + +#### Returns + +`object is AliasTypeOriginalModel` diff --git a/docs/api_docs/classes/AnnotationNamespaceType.md b/docs/api_docs/classes/AnnotationNamespaceType.md new file mode 100644 index 0000000000000000000000000000000000000000..46914032e8a37793e01e75e121ca5d4769c26b93 --- /dev/null +++ b/docs/api_docs/classes/AnnotationNamespaceType.md @@ -0,0 +1,131 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / AnnotationNamespaceType + +# Class: AnnotationNamespaceType + +Defined in: src/core/base/Type.ts:590 + +## Extends + +- [`AnnotationType`](AnnotationType.md) + +## Constructors + +### new AnnotationNamespaceType() + +> **new AnnotationNamespaceType**(`originType`): [`AnnotationNamespaceType`](AnnotationNamespaceType.md) + +Defined in: src/core/base/Type.ts:607 + +#### Parameters + +##### originType + +`string` + +#### Returns + +[`AnnotationNamespaceType`](AnnotationNamespaceType.md) + +#### Overrides + +[`AnnotationType`](AnnotationType.md).[`constructor`](AnnotationType.md#constructors) + +## Methods + +### getNamespaceSignature() + +> **getNamespaceSignature**(): [`NamespaceSignature`](NamespaceSignature.md) + +Defined in: src/core/base/Type.ts:599 + +#### Returns + +[`NamespaceSignature`](NamespaceSignature.md) + +*** + +### getOriginType() + +> **getOriginType**(): `string` + +Defined in: src/core/base/Type.ts:611 + +#### Returns + +`string` + +#### Overrides + +[`AnnotationType`](AnnotationType.md).[`getOriginType`](AnnotationType.md#getorigintype) + +*** + +### getTypeString() + +> **getTypeString**(): `string` + +Defined in: src/core/base/Type.ts:585 + +#### Returns + +`string` + +#### Inherited from + +[`AnnotationType`](AnnotationType.md).[`getTypeString`](AnnotationType.md#gettypestring) + +*** + +### setNamespaceSignature() + +> **setNamespaceSignature**(`signature`): `void` + +Defined in: src/core/base/Type.ts:603 + +#### Parameters + +##### signature + +[`NamespaceSignature`](NamespaceSignature.md) + +#### Returns + +`void` + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/base/Type.ts:36 + +#### Returns + +`string` + +#### Inherited from + +[`AnnotationType`](AnnotationType.md).[`toString`](AnnotationType.md#tostring) + +*** + +### getInstance() + +> `static` **getInstance**(`signature`): [`AnnotationNamespaceType`](AnnotationNamespaceType.md) + +Defined in: src/core/base/Type.ts:593 + +#### Parameters + +##### signature + +[`NamespaceSignature`](NamespaceSignature.md) + +#### Returns + +[`AnnotationNamespaceType`](AnnotationNamespaceType.md) diff --git a/docs/api_docs/classes/AnnotationType.md b/docs/api_docs/classes/AnnotationType.md new file mode 100644 index 0000000000000000000000000000000000000000..18312dea0d5cf40fc48aac6631f2f49195b4dc4e --- /dev/null +++ b/docs/api_docs/classes/AnnotationType.md @@ -0,0 +1,84 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / AnnotationType + +# Class: `abstract` AnnotationType + +Defined in: src/core/base/Type.ts:573 + +## Extends + +- [`Type`](Type.md) + +## Extended by + +- [`AnnotationNamespaceType`](AnnotationNamespaceType.md) +- [`AnnotationTypeQueryType`](AnnotationTypeQueryType.md) + +## Constructors + +### new AnnotationType() + +> `protected` **new AnnotationType**(`originType`): [`AnnotationType`](AnnotationType.md) + +Defined in: src/core/base/Type.ts:576 + +#### Parameters + +##### originType + +`string` + +#### Returns + +[`AnnotationType`](AnnotationType.md) + +#### Overrides + +[`Type`](Type.md).[`constructor`](Type.md#constructors) + +## Methods + +### getOriginType() + +> **getOriginType**(): `string` + +Defined in: src/core/base/Type.ts:581 + +#### Returns + +`string` + +*** + +### getTypeString() + +> **getTypeString**(): `string` + +Defined in: src/core/base/Type.ts:585 + +#### Returns + +`string` + +#### Overrides + +[`Type`](Type.md).[`getTypeString`](Type.md#gettypestring) + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/base/Type.ts:36 + +#### Returns + +`string` + +#### Inherited from + +[`Type`](Type.md).[`toString`](Type.md#tostring) diff --git a/docs/api_docs/classes/AnnotationTypeQueryType.md b/docs/api_docs/classes/AnnotationTypeQueryType.md new file mode 100644 index 0000000000000000000000000000000000000000..9df016f1f32d1bfcf6dbfa10d9a319f2aca2bc45 --- /dev/null +++ b/docs/api_docs/classes/AnnotationTypeQueryType.md @@ -0,0 +1,83 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / AnnotationTypeQueryType + +# Class: AnnotationTypeQueryType + +Defined in: src/core/base/Type.ts:616 + +## Extends + +- [`AnnotationType`](AnnotationType.md) + +## Constructors + +### new AnnotationTypeQueryType() + +> **new AnnotationTypeQueryType**(`originType`): [`AnnotationTypeQueryType`](AnnotationTypeQueryType.md) + +Defined in: src/core/base/Type.ts:617 + +#### Parameters + +##### originType + +`string` + +#### Returns + +[`AnnotationTypeQueryType`](AnnotationTypeQueryType.md) + +#### Overrides + +[`AnnotationType`](AnnotationType.md).[`constructor`](AnnotationType.md#constructors) + +## Methods + +### getOriginType() + +> **getOriginType**(): `string` + +Defined in: src/core/base/Type.ts:581 + +#### Returns + +`string` + +#### Inherited from + +[`AnnotationType`](AnnotationType.md).[`getOriginType`](AnnotationType.md#getorigintype) + +*** + +### getTypeString() + +> **getTypeString**(): `string` + +Defined in: src/core/base/Type.ts:585 + +#### Returns + +`string` + +#### Inherited from + +[`AnnotationType`](AnnotationType.md).[`getTypeString`](AnnotationType.md#gettypestring) + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/base/Type.ts:36 + +#### Returns + +`string` + +#### Inherited from + +[`AnnotationType`](AnnotationType.md).[`toString`](AnnotationType.md#tostring) diff --git a/docs/api_docs/classes/AnyType.md b/docs/api_docs/classes/AnyType.md new file mode 100644 index 0000000000000000000000000000000000000000..427e17cb0c4c3b0921872bf519c704a09f8a13fa --- /dev/null +++ b/docs/api_docs/classes/AnyType.md @@ -0,0 +1,59 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / AnyType + +# Class: AnyType + +Defined in: src/core/base/Type.ts:47 + +any type + +## Extends + +- [`Type`](Type.md) + +## Methods + +### getTypeString() + +> **getTypeString**(): `string` + +Defined in: src/core/base/Type.ts:58 + +#### Returns + +`string` + +#### Overrides + +[`Type`](Type.md).[`getTypeString`](Type.md#gettypestring) + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/base/Type.ts:36 + +#### Returns + +`string` + +#### Inherited from + +[`Type`](Type.md).[`toString`](Type.md#tostring) + +*** + +### getInstance() + +> `static` **getInstance**(): [`AnyType`](AnyType.md) + +Defined in: src/core/base/Type.ts:50 + +#### Returns + +[`AnyType`](AnyType.md) diff --git a/docs/api_docs/classes/ArkAliasTypeDefineStmt.md b/docs/api_docs/classes/ArkAliasTypeDefineStmt.md new file mode 100644 index 0000000000000000000000000000000000000000..a0e19ba3264fd0aa982e4971820b1f41852d071c --- /dev/null +++ b/docs/api_docs/classes/ArkAliasTypeDefineStmt.md @@ -0,0 +1,756 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / ArkAliasTypeDefineStmt + +# Class: ArkAliasTypeDefineStmt + +Defined in: src/core/base/Stmt.ts:533 + +Statement of type alias definition combines with the left hand as [AliasType](AliasType.md) and right hand as [AliasTypeExpr](AliasTypeExpr.md). + +## Example + +```typescript +type A = string; +type B = import('./abc').TypeB; + +let c = 123; +declare type C = typeof c; +``` + +## Extends + +- [`Stmt`](Stmt.md) + +## Constructors + +### new ArkAliasTypeDefineStmt() + +> **new ArkAliasTypeDefineStmt**(`aliasType`, `typeAliasExpr`): [`ArkAliasTypeDefineStmt`](ArkAliasTypeDefineStmt.md) + +Defined in: src/core/base/Stmt.ts:537 + +#### Parameters + +##### aliasType + +[`AliasType`](AliasType.md) + +##### typeAliasExpr + +[`AliasTypeExpr`](AliasTypeExpr.md) + +#### Returns + +[`ArkAliasTypeDefineStmt`](ArkAliasTypeDefineStmt.md) + +#### Overrides + +[`Stmt`](Stmt.md).[`constructor`](Stmt.md#constructors) + +## Properties + +### cfg + +> `protected` **cfg**: [`Cfg`](Cfg.md) + +Defined in: src/core/base/Stmt.ts:35 + +#### Inherited from + +[`Stmt`](Stmt.md).[`cfg`](Stmt.md#cfg) + +*** + +### metadata? + +> `optional` **metadata**: `ArkMetadata` + +Defined in: src/core/base/Stmt.ts:38 + +#### Inherited from + +[`Stmt`](Stmt.md).[`metadata`](Stmt.md#metadata) + +*** + +### operandOriginalPositions? + +> `protected` `optional` **operandOriginalPositions**: [`FullPosition`](FullPosition.md)[] + +Defined in: src/core/base/Stmt.ts:36 + +#### Inherited from + +[`Stmt`](Stmt.md).[`operandOriginalPositions`](Stmt.md#operandoriginalpositions) + +*** + +### originalPosition + +> `protected` **originalPosition**: [`LineColPosition`](LineColPosition.md) = `LineColPosition.DEFAULT` + +Defined in: src/core/base/Stmt.ts:34 + +#### Inherited from + +[`Stmt`](Stmt.md).[`originalPosition`](Stmt.md#originalposition) + +*** + +### originalText? + +> `protected` `optional` **originalText**: `string` + +Defined in: src/core/base/Stmt.ts:33 + +#### Inherited from + +[`Stmt`](Stmt.md).[`originalText`](Stmt.md#originaltext) + +*** + +### text? + +> `protected` `optional` **text**: `string` + +Defined in: src/core/base/Stmt.ts:32 + +#### Inherited from + +[`Stmt`](Stmt.md).[`text`](Stmt.md#text) + +## Methods + +### containsArrayRef() + +> **containsArrayRef**(): `boolean` + +Defined in: src/core/base/Stmt.ts:187 + +#### Returns + +`boolean` + +#### Inherited from + +[`Stmt`](Stmt.md).[`containsArrayRef`](Stmt.md#containsarrayref) + +*** + +### containsFieldRef() + +> **containsFieldRef**(): `boolean` + +Defined in: src/core/base/Stmt.ts:213 + +#### Returns + +`boolean` + +#### Inherited from + +[`Stmt`](Stmt.md).[`containsFieldRef`](Stmt.md#containsfieldref) + +*** + +### containsInvokeExpr() + +> **containsInvokeExpr**(): `boolean` + +Defined in: src/core/base/Stmt.ts:136 + +#### Returns + +`boolean` + +#### Inherited from + +[`Stmt`](Stmt.md).[`containsInvokeExpr`](Stmt.md#containsinvokeexpr) + +*** + +### getAliasName() + +> **getAliasName**(): `string` + +Defined in: src/core/base/Stmt.ts:551 + +#### Returns + +`string` + +*** + +### getAliasType() + +> **getAliasType**(): [`AliasType`](AliasType.md) + +Defined in: src/core/base/Stmt.ts:543 + +#### Returns + +[`AliasType`](AliasType.md) + +*** + +### getAliasTypeExpr() + +> **getAliasTypeExpr**(): [`AliasTypeExpr`](AliasTypeExpr.md) + +Defined in: src/core/base/Stmt.ts:547 + +#### Returns + +[`AliasTypeExpr`](AliasTypeExpr.md) + +*** + +### getArrayRef() + +> **getArrayRef**(): `undefined` \| [`ArkArrayRef`](ArkArrayRef.md) + +Defined in: src/core/base/Stmt.ts:199 + +#### Returns + +`undefined` \| [`ArkArrayRef`](ArkArrayRef.md) + +#### Inherited from + +[`Stmt`](Stmt.md).[`getArrayRef`](Stmt.md#getarrayref) + +*** + +### getCfg() + +> **getCfg**(): [`Cfg`](Cfg.md) + +Defined in: src/core/base/Stmt.ts:115 + +Get the CFG (i.e., control flow graph) of an [ArkBody](ArkBody.md) in which the statement is. +A CFG contains a set of basic blocks and statements corresponding to each basic block. +Note that, "source code" and "three-address" are two types of [Stmt](Stmt.md) in ArkAnalyzer. +Source code [Stmt](Stmt.md) represents the statement of ets/ts source code, while three-address code [Stmt](Stmt.md) +represents the statement after it has been converted into three-address code. Since the source code [Stmt](Stmt.md) does not save its CFG reference, it returns **null**, while the `getCfg()` of the third address code +[Stmt](Stmt.md) will return its CFG reference. + +#### Returns + +[`Cfg`](Cfg.md) + +The CFG (i.e., control flow graph) of an [ArkBody](ArkBody.md) in which the statement is. + +#### Example + +1. get the ArkFile based on stmt. +```typescript +const arkFile = stmt.getCfg()?.getDeclaringMethod().getDeclaringArkFile(); +``` +2. get the ArkMethod based on stmt. +```typescript +let sourceMethod: ArkMethod = stmt.getCfg()?.getDeclaringMethod(); +``` + +#### Inherited from + +[`Stmt`](Stmt.md).[`getCfg`](Stmt.md#getcfg) + +*** + +### getDef() + +> **getDef**(): `null` \| [`Value`](../interfaces/Value.md) + +Defined in: src/core/base/Stmt.ts:77 + +Return the definition which is uesd in this statement. Generally, the definition is the left value of `=` in +3AC. For example, the definition in 3AC of `value = parameter0: @project-1/sample-1.ets: AnonymousClass-0` is +`value`, and the definition in `$temp0 = staticinvoke <@_ProjectName/_FileName: xxx.create()>()` is `\$temp0`. + +#### Returns + +`null` \| [`Value`](../interfaces/Value.md) + +The definition in 3AC (may be a **null**). + +#### Example + +1. get the def in stmt. +```typescript +for (const block of this.blocks) { +for (const stmt of block.getStmts()) { + const defValue = stmt.getDef(); + ... + } +} +``` + +#### Inherited from + +[`Stmt`](Stmt.md).[`getDef`](Stmt.md#getdef) + +*** + +### getDefAndUses() + +> **getDefAndUses**(): [`Value`](../interfaces/Value.md)[] + +Defined in: src/core/base/Stmt.ts:86 + +#### Returns + +[`Value`](../interfaces/Value.md)[] + +#### Inherited from + +[`Stmt`](Stmt.md).[`getDefAndUses`](Stmt.md#getdefanduses) + +*** + +### getExpectedSuccessorCount() + +> **getExpectedSuccessorCount**(): `number` + +Defined in: src/core/base/Stmt.ts:132 + +Return the number of statements which this statement may go to + +#### Returns + +`number` + +#### Inherited from + +[`Stmt`](Stmt.md).[`getExpectedSuccessorCount`](Stmt.md#getexpectedsuccessorcount) + +*** + +### getExprs() + +> **getExprs**(): [`AliasTypeExpr`](AliasTypeExpr.md)[] + +Defined in: src/core/base/Stmt.ts:566 + +Returns an array of expressions in the statement. + +#### Returns + +[`AliasTypeExpr`](AliasTypeExpr.md)[] + +An array of expressions in the statement. + +#### Example + +1. Traverse expression of statement. + +```typescript +for (const expr of stmt.getExprs()) { + ... +} +``` + +#### Overrides + +[`Stmt`](Stmt.md).[`getExprs`](Stmt.md#getexprs) + +*** + +### getFieldRef() + +> **getFieldRef**(): `undefined` \| [`AbstractFieldRef`](AbstractFieldRef.md) + +Defined in: src/core/base/Stmt.ts:226 + +#### Returns + +`undefined` \| [`AbstractFieldRef`](AbstractFieldRef.md) + +#### Inherited from + +[`Stmt`](Stmt.md).[`getFieldRef`](Stmt.md#getfieldref) + +*** + +### getInvokeExpr() + +> **getInvokeExpr**(): `undefined` \| [`AbstractInvokeExpr`](AbstractInvokeExpr.md) + +Defined in: src/core/base/Stmt.ts:156 + +Returns the method's invocation expression (including method signature and its arguments) +in the current statement. An **undefined** will be returned if there is no method used in this statement. + +#### Returns + +`undefined` \| [`AbstractInvokeExpr`](AbstractInvokeExpr.md) + +the method's invocation expression from the statement. An **undefined** will be returned if there is + no method can be found in this statement. + +#### Example + +1. get invoke expr based on stmt. +```typescript +let invoke = stmt.getInvokeExpr(); +``` + +#### Inherited from + +[`Stmt`](Stmt.md).[`getInvokeExpr`](Stmt.md#getinvokeexpr) + +*** + +### getMetadata() + +> **getMetadata**(`kind`): `undefined` \| `ArkMetadataType` + +Defined in: src/core/base/Stmt.ts:40 + +#### Parameters + +##### kind + +`ArkMetadataKind` + +#### Returns + +`undefined` \| `ArkMetadataType` + +#### Inherited from + +[`Stmt`](Stmt.md).[`getMetadata`](Stmt.md#getmetadata) + +*** + +### getOperandOriginalPosition() + +> **getOperandOriginalPosition**(`indexOrOperand`): `null` \| [`FullPosition`](FullPosition.md) + +Defined in: src/core/base/Stmt.ts:287 + +#### Parameters + +##### indexOrOperand + +`number` | [`Value`](../interfaces/Value.md) + +#### Returns + +`null` \| [`FullPosition`](FullPosition.md) + +#### Inherited from + +[`Stmt`](Stmt.md).[`getOperandOriginalPosition`](Stmt.md#getoperandoriginalposition) + +*** + +### getOperandOriginalPositions() + +> **getOperandOriginalPositions**(): `undefined` \| [`FullPosition`](FullPosition.md)[] + +Defined in: src/core/base/Stmt.ts:283 + +#### Returns + +`undefined` \| [`FullPosition`](FullPosition.md)[] + +#### Inherited from + +[`Stmt`](Stmt.md).[`getOperandOriginalPositions`](Stmt.md#getoperandoriginalpositions) + +*** + +### getOriginalText() + +> **getOriginalText**(): `undefined` \| `string` + +Defined in: src/core/base/Stmt.ts:275 + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[`Stmt`](Stmt.md).[`getOriginalText`](Stmt.md#getoriginaltext) + +*** + +### getOriginPositionInfo() + +> **getOriginPositionInfo**(): [`LineColPosition`](LineColPosition.md) + +Defined in: src/core/base/Stmt.ts:261 + +Returns the original position of the statement. +The position consists of two parts: line number and column number. +In the source file, the former (i.e., line number) indicates which line the statement is in, +and the latter (i.e., column number) indicates the position of the statement in the line. +The position is described as `LineColPosition(lineNo,colNum)` in ArkAnalyzer, +and its default value is LineColPosition(-1,-1). + +#### Returns + +[`LineColPosition`](LineColPosition.md) + +The original location of the statement. + +#### Example + +1. Get the stmt position info to make some condition judgements. +```typescript +for (const stmt of stmts) { + if (stmt.getOriginPositionInfo().getLineNo() === -1) { + stmt.setOriginPositionInfo(originalStmt.getOriginPositionInfo()); + this.stmtToOriginalStmt.set(stmt, originalStmt); + } +} +``` + +#### Inherited from + +[`Stmt`](Stmt.md).[`getOriginPositionInfo`](Stmt.md#getoriginpositioninfo) + +*** + +### getUses() + +> **getUses**(): [`Value`](../interfaces/Value.md)[] + +Defined in: src/core/base/Stmt.ts:52 + +Return a list of values which are uesd in this statement + +#### Returns + +[`Value`](../interfaces/Value.md)[] + +#### Inherited from + +[`Stmt`](Stmt.md).[`getUses`](Stmt.md#getuses) + +*** + +### isBranch() + +> **isBranch**(): `boolean` + +Defined in: src/core/base/Stmt.ts:127 + +Return true if the following statement may not execute after this statement. +The ArkIfStmt and ArkGotoStmt will return true. + +#### Returns + +`boolean` + +#### Inherited from + +[`Stmt`](Stmt.md).[`isBranch`](Stmt.md#isbranch) + +*** + +### replaceDef() + +> **replaceDef**(`oldDef`, `newDef`): `void` + +Defined in: src/core/base/Stmt.ts:81 + +#### Parameters + +##### oldDef + +[`Value`](../interfaces/Value.md) + +##### newDef + +[`Value`](../interfaces/Value.md) + +#### Returns + +`void` + +#### Inherited from + +[`Stmt`](Stmt.md).[`replaceDef`](Stmt.md#replacedef) + +*** + +### replaceUse() + +> **replaceUse**(`oldUse`, `newUse`): `void` + +Defined in: src/core/base/Stmt.ts:56 + +#### Parameters + +##### oldUse + +[`Value`](../interfaces/Value.md) + +##### newUse + +[`Value`](../interfaces/Value.md) + +#### Returns + +`void` + +#### Inherited from + +[`Stmt`](Stmt.md).[`replaceUse`](Stmt.md#replaceuse) + +*** + +### setCfg() + +> **setCfg**(`cfg`): `void` + +Defined in: src/core/base/Stmt.ts:119 + +#### Parameters + +##### cfg + +[`Cfg`](Cfg.md) + +#### Returns + +`void` + +#### Inherited from + +[`Stmt`](Stmt.md).[`setCfg`](Stmt.md#setcfg) + +*** + +### setMetadata() + +> **setMetadata**(`kind`, `value`): `void` + +Defined in: src/core/base/Stmt.ts:44 + +#### Parameters + +##### kind + +`ArkMetadataKind` + +##### value + +`ArkMetadataType` + +#### Returns + +`void` + +#### Inherited from + +[`Stmt`](Stmt.md).[`setMetadata`](Stmt.md#setmetadata) + +*** + +### setOperandOriginalPositions() + +> **setOperandOriginalPositions**(`operandOriginalPositions`): `void` + +Defined in: src/core/base/Stmt.ts:279 + +#### Parameters + +##### operandOriginalPositions + +[`FullPosition`](FullPosition.md)[] + +#### Returns + +`void` + +#### Inherited from + +[`Stmt`](Stmt.md).[`setOperandOriginalPositions`](Stmt.md#setoperandoriginalpositions) + +*** + +### setOriginalText() + +> **setOriginalText**(`originalText`): `void` + +Defined in: src/core/base/Stmt.ts:271 + +#### Parameters + +##### originalText + +`string` + +#### Returns + +`void` + +#### Inherited from + +[`Stmt`](Stmt.md).[`setOriginalText`](Stmt.md#setoriginaltext) + +*** + +### setOriginPositionInfo() + +> **setOriginPositionInfo**(`originPositionInfo`): `void` + +Defined in: src/core/base/Stmt.ts:238 + +#### Parameters + +##### originPositionInfo + +[`LineColPosition`](LineColPosition.md) + +#### Returns + +`void` + +#### Inherited from + +[`Stmt`](Stmt.md).[`setOriginPositionInfo`](Stmt.md#setoriginpositioninfo) + +*** + +### setText() + +> **setText**(`text`): `void` + +Defined in: src/core/base/Stmt.ts:267 + +#### Parameters + +##### text + +`string` + +#### Returns + +`void` + +#### Inherited from + +[`Stmt`](Stmt.md).[`setText`](Stmt.md#settext) + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/base/Stmt.ts:555 + +#### Returns + +`string` + +#### Overrides + +[`Stmt`](Stmt.md).[`toString`](Stmt.md#tostring) diff --git a/docs/api_docs/classes/ArkArrayRef.md b/docs/api_docs/classes/ArkArrayRef.md new file mode 100644 index 0000000000000000000000000000000000000000..2e5b707b719d317a510b164e57cf0e6ea4dc5f87 --- /dev/null +++ b/docs/api_docs/classes/ArkArrayRef.md @@ -0,0 +1,226 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / ArkArrayRef + +# Class: ArkArrayRef + +Defined in: src/core/base/Ref.ts:42 + +## Extends + +- [`AbstractRef`](AbstractRef.md) + +## Constructors + +### new ArkArrayRef() + +> **new ArkArrayRef**(`base`, `index`): [`ArkArrayRef`](ArkArrayRef.md) + +Defined in: src/core/base/Ref.ts:46 + +#### Parameters + +##### base + +[`Local`](Local.md) + +##### index + +[`Value`](../interfaces/Value.md) + +#### Returns + +[`ArkArrayRef`](ArkArrayRef.md) + +#### Overrides + +[`AbstractRef`](AbstractRef.md).[`constructor`](AbstractRef.md#constructors) + +## Methods + +### getBase() + +> **getBase**(): [`Local`](Local.md) + +Defined in: src/core/base/Ref.ts:77 + +Returns the base of this array reference. Array reference refers to access to array elements. +Array references usually consist of an local variable and an index. +For example, `a[i]` is a typical array reference, where `a` is the base (i.e., local variable) +pointing to the actual memory location where the array is stored +and `i` is the index indicating access to the `i-th` element from array `a`. + +#### Returns + +[`Local`](Local.md) + +the base of this array reference. + +#### Example + +1. Get the base and the specific elements. + +```typescript +// Create an array +let myArray: number[] = [10, 20, 30, 40]; +// Create an ArrayRef object representing a reference to myArray[2] +let arrayRef = new ArkArrayRef(myArray, 2); +// Use the getBase() method to get the base of the array +let baseArray = arrayRef.getBase(); + +console.log("Base array:", baseArray); // Output: Base array: [10, 20, 30, 40] + +// Use baseArray and obeject index of ArrayRef to access to specific array elements +let element = baseArray[arrayRef.index]; +console.log("Element at index", arrayRef.index, ":", element); // Output: Element at index 2 : 30 +``` + +*** + +### getIndex() + +> **getIndex**(): [`Value`](../interfaces/Value.md) + +Defined in: src/core/base/Ref.ts:91 + +Returns the index of this array reference. +In TypeScript, an array reference means that the variable stores +the memory address of the array rather than the actual data of the array. + +#### Returns + +[`Value`](../interfaces/Value.md) + +The index of this array reference. + +*** + +### getType() + +> **getType**(): [`Type`](Type.md) + +Defined in: src/core/base/Ref.ts:99 + +Return the type of this value. The interface is encapsulated in [Value](../interfaces/Value.md). +The `Type` is defined in type.ts, such as **Any**, **Unknown**, **TypeParameter**, +**UnclearReference**, **Primitive**, **Number**, **String**, etc. + +#### Returns + +[`Type`](Type.md) + +The type of this value. + +#### Example + +1. In the declaration statement, determine the left-value type and right-value type. + +```typescript +let leftValue:Value; +let rightValue:Value; +... +if (leftValue.getType() instanceof UnknownType && + !(rightValue.getType() instanceof UnknownType) && + !(rightValue.getType() instanceof UndefinedType)) { + ... +} +``` + +#### Overrides + +[`AbstractRef`](AbstractRef.md).[`getType`](AbstractRef.md#gettype) + +*** + +### getUses() + +> **getUses**(): [`Value`](../interfaces/Value.md)[] + +Defined in: src/core/base/Ref.ts:109 + +Return a list of values which are contained in this [Value](../interfaces/Value.md). +Value is a core interface in ArkAnalyzer, which may represent any value or expression. + +#### Returns + +[`Value`](../interfaces/Value.md)[] + +An **array** of values used by this value. + +#### Overrides + +[`AbstractRef`](AbstractRef.md).[`getUses`](AbstractRef.md#getuses) + +*** + +### inferType() + +> **inferType**(`arkMethod`): [`AbstractRef`](AbstractRef.md) + +Defined in: src/core/base/Ref.ts:37 + +#### Parameters + +##### arkMethod + +[`ArkMethod`](ArkMethod.md) + +#### Returns + +[`AbstractRef`](AbstractRef.md) + +#### Inherited from + +[`AbstractRef`](AbstractRef.md).[`inferType`](AbstractRef.md#infertype) + +*** + +### setBase() + +> **setBase**(`newBase`): `void` + +Defined in: src/core/base/Ref.ts:81 + +#### Parameters + +##### newBase + +[`Local`](Local.md) + +#### Returns + +`void` + +*** + +### setIndex() + +> **setIndex**(`newIndex`): `void` + +Defined in: src/core/base/Ref.ts:95 + +#### Parameters + +##### newIndex + +[`Value`](../interfaces/Value.md) + +#### Returns + +`void` + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/base/Ref.ts:118 + +Returns a string representation of an object. + +#### Returns + +`string` diff --git a/docs/api_docs/classes/ArkAssignStmt.md b/docs/api_docs/classes/ArkAssignStmt.md new file mode 100644 index 0000000000000000000000000000000000000000..e2d9852e6f8319b1b70e026c42af67251e41589e --- /dev/null +++ b/docs/api_docs/classes/ArkAssignStmt.md @@ -0,0 +1,792 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / ArkAssignStmt + +# Class: ArkAssignStmt + +Defined in: src/core/base/Stmt.ts:302 + +## Extends + +- [`Stmt`](Stmt.md) + +## Constructors + +### new ArkAssignStmt() + +> **new ArkAssignStmt**(`leftOp`, `rightOp`): [`ArkAssignStmt`](ArkAssignStmt.md) + +Defined in: src/core/base/Stmt.ts:306 + +#### Parameters + +##### leftOp + +[`Value`](../interfaces/Value.md) + +##### rightOp + +[`Value`](../interfaces/Value.md) + +#### Returns + +[`ArkAssignStmt`](ArkAssignStmt.md) + +#### Overrides + +[`Stmt`](Stmt.md).[`constructor`](Stmt.md#constructors) + +## Properties + +### cfg + +> `protected` **cfg**: [`Cfg`](Cfg.md) + +Defined in: src/core/base/Stmt.ts:35 + +#### Inherited from + +[`Stmt`](Stmt.md).[`cfg`](Stmt.md#cfg) + +*** + +### metadata? + +> `optional` **metadata**: `ArkMetadata` + +Defined in: src/core/base/Stmt.ts:38 + +#### Inherited from + +[`Stmt`](Stmt.md).[`metadata`](Stmt.md#metadata) + +*** + +### operandOriginalPositions? + +> `protected` `optional` **operandOriginalPositions**: [`FullPosition`](FullPosition.md)[] + +Defined in: src/core/base/Stmt.ts:36 + +#### Inherited from + +[`Stmt`](Stmt.md).[`operandOriginalPositions`](Stmt.md#operandoriginalpositions) + +*** + +### originalPosition + +> `protected` **originalPosition**: [`LineColPosition`](LineColPosition.md) = `LineColPosition.DEFAULT` + +Defined in: src/core/base/Stmt.ts:34 + +#### Inherited from + +[`Stmt`](Stmt.md).[`originalPosition`](Stmt.md#originalposition) + +*** + +### originalText? + +> `protected` `optional` **originalText**: `string` + +Defined in: src/core/base/Stmt.ts:33 + +#### Inherited from + +[`Stmt`](Stmt.md).[`originalText`](Stmt.md#originaltext) + +*** + +### text? + +> `protected` `optional` **text**: `string` + +Defined in: src/core/base/Stmt.ts:32 + +#### Inherited from + +[`Stmt`](Stmt.md).[`text`](Stmt.md#text) + +## Methods + +### containsArrayRef() + +> **containsArrayRef**(): `boolean` + +Defined in: src/core/base/Stmt.ts:187 + +#### Returns + +`boolean` + +#### Inherited from + +[`Stmt`](Stmt.md).[`containsArrayRef`](Stmt.md#containsarrayref) + +*** + +### containsFieldRef() + +> **containsFieldRef**(): `boolean` + +Defined in: src/core/base/Stmt.ts:213 + +#### Returns + +`boolean` + +#### Inherited from + +[`Stmt`](Stmt.md).[`containsFieldRef`](Stmt.md#containsfieldref) + +*** + +### containsInvokeExpr() + +> **containsInvokeExpr**(): `boolean` + +Defined in: src/core/base/Stmt.ts:136 + +#### Returns + +`boolean` + +#### Inherited from + +[`Stmt`](Stmt.md).[`containsInvokeExpr`](Stmt.md#containsinvokeexpr) + +*** + +### getArrayRef() + +> **getArrayRef**(): `undefined` \| [`ArkArrayRef`](ArkArrayRef.md) + +Defined in: src/core/base/Stmt.ts:199 + +#### Returns + +`undefined` \| [`ArkArrayRef`](ArkArrayRef.md) + +#### Inherited from + +[`Stmt`](Stmt.md).[`getArrayRef`](Stmt.md#getarrayref) + +*** + +### getCfg() + +> **getCfg**(): [`Cfg`](Cfg.md) + +Defined in: src/core/base/Stmt.ts:115 + +Get the CFG (i.e., control flow graph) of an [ArkBody](ArkBody.md) in which the statement is. +A CFG contains a set of basic blocks and statements corresponding to each basic block. +Note that, "source code" and "three-address" are two types of [Stmt](Stmt.md) in ArkAnalyzer. +Source code [Stmt](Stmt.md) represents the statement of ets/ts source code, while three-address code [Stmt](Stmt.md) +represents the statement after it has been converted into three-address code. Since the source code [Stmt](Stmt.md) does not save its CFG reference, it returns **null**, while the `getCfg()` of the third address code +[Stmt](Stmt.md) will return its CFG reference. + +#### Returns + +[`Cfg`](Cfg.md) + +The CFG (i.e., control flow graph) of an [ArkBody](ArkBody.md) in which the statement is. + +#### Example + +1. get the ArkFile based on stmt. +```typescript +const arkFile = stmt.getCfg()?.getDeclaringMethod().getDeclaringArkFile(); +``` +2. get the ArkMethod based on stmt. +```typescript +let sourceMethod: ArkMethod = stmt.getCfg()?.getDeclaringMethod(); +``` + +#### Inherited from + +[`Stmt`](Stmt.md).[`getCfg`](Stmt.md#getcfg) + +*** + +### getDef() + +> **getDef**(): `null` \| [`Value`](../interfaces/Value.md) + +Defined in: src/core/base/Stmt.ts:351 + +Return the definition which is uesd in this statement. Generally, the definition is the left value of `=` in +3AC. For example, the definition in 3AC of `value = parameter0: @project-1/sample-1.ets: AnonymousClass-0` is +`value`, and the definition in `$temp0 = staticinvoke <@_ProjectName/_FileName: xxx.create()>()` is `\$temp0`. + +#### Returns + +`null` \| [`Value`](../interfaces/Value.md) + +The definition in 3AC (may be a **null**). + +#### Example + +1. get the def in stmt. +```typescript +for (const block of this.blocks) { +for (const stmt of block.getStmts()) { + const defValue = stmt.getDef(); + ... + } +} +``` + +#### Overrides + +[`Stmt`](Stmt.md).[`getDef`](Stmt.md#getdef) + +*** + +### getDefAndUses() + +> **getDefAndUses**(): [`Value`](../interfaces/Value.md)[] + +Defined in: src/core/base/Stmt.ts:86 + +#### Returns + +[`Value`](../interfaces/Value.md)[] + +#### Inherited from + +[`Stmt`](Stmt.md).[`getDefAndUses`](Stmt.md#getdefanduses) + +*** + +### getExpectedSuccessorCount() + +> **getExpectedSuccessorCount**(): `number` + +Defined in: src/core/base/Stmt.ts:132 + +Return the number of statements which this statement may go to + +#### Returns + +`number` + +#### Inherited from + +[`Stmt`](Stmt.md).[`getExpectedSuccessorCount`](Stmt.md#getexpectedsuccessorcount) + +*** + +### getExprs() + +> **getExprs**(): [`AbstractExpr`](AbstractExpr.md)[] + +Defined in: src/core/base/Stmt.ts:177 + +Returns an array of expressions in the statement. + +#### Returns + +[`AbstractExpr`](AbstractExpr.md)[] + +An array of expressions in the statement. + +#### Example + +1. Traverse expression of statement. + +```typescript +for (const expr of stmt.getExprs()) { + ... +} +``` + +#### Inherited from + +[`Stmt`](Stmt.md).[`getExprs`](Stmt.md#getexprs) + +*** + +### getFieldRef() + +> **getFieldRef**(): `undefined` \| [`AbstractFieldRef`](AbstractFieldRef.md) + +Defined in: src/core/base/Stmt.ts:226 + +#### Returns + +`undefined` \| [`AbstractFieldRef`](AbstractFieldRef.md) + +#### Inherited from + +[`Stmt`](Stmt.md).[`getFieldRef`](Stmt.md#getfieldref) + +*** + +### getInvokeExpr() + +> **getInvokeExpr**(): `undefined` \| [`AbstractInvokeExpr`](AbstractInvokeExpr.md) + +Defined in: src/core/base/Stmt.ts:156 + +Returns the method's invocation expression (including method signature and its arguments) +in the current statement. An **undefined** will be returned if there is no method used in this statement. + +#### Returns + +`undefined` \| [`AbstractInvokeExpr`](AbstractInvokeExpr.md) + +the method's invocation expression from the statement. An **undefined** will be returned if there is + no method can be found in this statement. + +#### Example + +1. get invoke expr based on stmt. +```typescript +let invoke = stmt.getInvokeExpr(); +``` + +#### Inherited from + +[`Stmt`](Stmt.md).[`getInvokeExpr`](Stmt.md#getinvokeexpr) + +*** + +### getLeftOp() + +> **getLeftOp**(): [`Value`](../interfaces/Value.md) + +Defined in: src/core/base/Stmt.ts:319 + +Returns the left operand of the assigning statement. + +#### Returns + +[`Value`](../interfaces/Value.md) + +The left operand of the assigning statement. + +#### Example + +```ts +1. If the statement is `a=b;`, the right operand is `a`; if the statement is `dd = cc + 5;`, the right operand + is `cc`. +``` + +*** + +### getMetadata() + +> **getMetadata**(`kind`): `undefined` \| `ArkMetadataType` + +Defined in: src/core/base/Stmt.ts:40 + +#### Parameters + +##### kind + +`ArkMetadataKind` + +#### Returns + +`undefined` \| `ArkMetadataType` + +#### Inherited from + +[`Stmt`](Stmt.md).[`getMetadata`](Stmt.md#getmetadata) + +*** + +### getOperandOriginalPosition() + +> **getOperandOriginalPosition**(`indexOrOperand`): `null` \| [`FullPosition`](FullPosition.md) + +Defined in: src/core/base/Stmt.ts:287 + +#### Parameters + +##### indexOrOperand + +`number` | [`Value`](../interfaces/Value.md) + +#### Returns + +`null` \| [`FullPosition`](FullPosition.md) + +#### Inherited from + +[`Stmt`](Stmt.md).[`getOperandOriginalPosition`](Stmt.md#getoperandoriginalposition) + +*** + +### getOperandOriginalPositions() + +> **getOperandOriginalPositions**(): `undefined` \| [`FullPosition`](FullPosition.md)[] + +Defined in: src/core/base/Stmt.ts:283 + +#### Returns + +`undefined` \| [`FullPosition`](FullPosition.md)[] + +#### Inherited from + +[`Stmt`](Stmt.md).[`getOperandOriginalPositions`](Stmt.md#getoperandoriginalpositions) + +*** + +### getOriginalText() + +> **getOriginalText**(): `undefined` \| `string` + +Defined in: src/core/base/Stmt.ts:275 + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[`Stmt`](Stmt.md).[`getOriginalText`](Stmt.md#getoriginaltext) + +*** + +### getOriginPositionInfo() + +> **getOriginPositionInfo**(): [`LineColPosition`](LineColPosition.md) + +Defined in: src/core/base/Stmt.ts:261 + +Returns the original position of the statement. +The position consists of two parts: line number and column number. +In the source file, the former (i.e., line number) indicates which line the statement is in, +and the latter (i.e., column number) indicates the position of the statement in the line. +The position is described as `LineColPosition(lineNo,colNum)` in ArkAnalyzer, +and its default value is LineColPosition(-1,-1). + +#### Returns + +[`LineColPosition`](LineColPosition.md) + +The original location of the statement. + +#### Example + +1. Get the stmt position info to make some condition judgements. +```typescript +for (const stmt of stmts) { + if (stmt.getOriginPositionInfo().getLineNo() === -1) { + stmt.setOriginPositionInfo(originalStmt.getOriginPositionInfo()); + this.stmtToOriginalStmt.set(stmt, originalStmt); + } +} +``` + +#### Inherited from + +[`Stmt`](Stmt.md).[`getOriginPositionInfo`](Stmt.md#getoriginpositioninfo) + +*** + +### getRightOp() + +> **getRightOp**(): [`Value`](../interfaces/Value.md) + +Defined in: src/core/base/Stmt.ts:338 + +Returns the right operand of the assigning statement. + +#### Returns + +[`Value`](../interfaces/Value.md) + +The right operand of the assigning statement. + +#### Example + +1. If the statement is `a=b;`, the right operand is `b`; if the statement is `dd = cc + 5;`, the right operand + is `cc + 5`. +2. Get the rightOp from stmt. +```typescript +const rightOp = stmt.getRightOp(); +``` + +*** + +### getUses() + +> **getUses**(): [`Value`](../interfaces/Value.md)[] + +Defined in: src/core/base/Stmt.ts:355 + +Return a list of values which are uesd in this statement + +#### Returns + +[`Value`](../interfaces/Value.md)[] + +#### Overrides + +[`Stmt`](Stmt.md).[`getUses`](Stmt.md#getuses) + +*** + +### isBranch() + +> **isBranch**(): `boolean` + +Defined in: src/core/base/Stmt.ts:127 + +Return true if the following statement may not execute after this statement. +The ArkIfStmt and ArkGotoStmt will return true. + +#### Returns + +`boolean` + +#### Inherited from + +[`Stmt`](Stmt.md).[`isBranch`](Stmt.md#isbranch) + +*** + +### replaceDef() + +> **replaceDef**(`oldDef`, `newDef`): `void` + +Defined in: src/core/base/Stmt.ts:81 + +#### Parameters + +##### oldDef + +[`Value`](../interfaces/Value.md) + +##### newDef + +[`Value`](../interfaces/Value.md) + +#### Returns + +`void` + +#### Inherited from + +[`Stmt`](Stmt.md).[`replaceDef`](Stmt.md#replacedef) + +*** + +### replaceUse() + +> **replaceUse**(`oldUse`, `newUse`): `void` + +Defined in: src/core/base/Stmt.ts:56 + +#### Parameters + +##### oldUse + +[`Value`](../interfaces/Value.md) + +##### newUse + +[`Value`](../interfaces/Value.md) + +#### Returns + +`void` + +#### Inherited from + +[`Stmt`](Stmt.md).[`replaceUse`](Stmt.md#replaceuse) + +*** + +### setCfg() + +> **setCfg**(`cfg`): `void` + +Defined in: src/core/base/Stmt.ts:119 + +#### Parameters + +##### cfg + +[`Cfg`](Cfg.md) + +#### Returns + +`void` + +#### Inherited from + +[`Stmt`](Stmt.md).[`setCfg`](Stmt.md#setcfg) + +*** + +### setLeftOp() + +> **setLeftOp**(`newLeftOp`): `void` + +Defined in: src/core/base/Stmt.ts:323 + +#### Parameters + +##### newLeftOp + +[`Value`](../interfaces/Value.md) + +#### Returns + +`void` + +*** + +### setMetadata() + +> **setMetadata**(`kind`, `value`): `void` + +Defined in: src/core/base/Stmt.ts:44 + +#### Parameters + +##### kind + +`ArkMetadataKind` + +##### value + +`ArkMetadataType` + +#### Returns + +`void` + +#### Inherited from + +[`Stmt`](Stmt.md).[`setMetadata`](Stmt.md#setmetadata) + +*** + +### setOperandOriginalPositions() + +> **setOperandOriginalPositions**(`operandOriginalPositions`): `void` + +Defined in: src/core/base/Stmt.ts:279 + +#### Parameters + +##### operandOriginalPositions + +[`FullPosition`](FullPosition.md)[] + +#### Returns + +`void` + +#### Inherited from + +[`Stmt`](Stmt.md).[`setOperandOriginalPositions`](Stmt.md#setoperandoriginalpositions) + +*** + +### setOriginalText() + +> **setOriginalText**(`originalText`): `void` + +Defined in: src/core/base/Stmt.ts:271 + +#### Parameters + +##### originalText + +`string` + +#### Returns + +`void` + +#### Inherited from + +[`Stmt`](Stmt.md).[`setOriginalText`](Stmt.md#setoriginaltext) + +*** + +### setOriginPositionInfo() + +> **setOriginPositionInfo**(`originPositionInfo`): `void` + +Defined in: src/core/base/Stmt.ts:238 + +#### Parameters + +##### originPositionInfo + +[`LineColPosition`](LineColPosition.md) + +#### Returns + +`void` + +#### Inherited from + +[`Stmt`](Stmt.md).[`setOriginPositionInfo`](Stmt.md#setoriginpositioninfo) + +*** + +### setRightOp() + +> **setRightOp**(`rightOp`): `void` + +Defined in: src/core/base/Stmt.ts:342 + +#### Parameters + +##### rightOp + +[`Value`](../interfaces/Value.md) + +#### Returns + +`void` + +*** + +### setText() + +> **setText**(`text`): `void` + +Defined in: src/core/base/Stmt.ts:267 + +#### Parameters + +##### text + +`string` + +#### Returns + +`void` + +#### Inherited from + +[`Stmt`](Stmt.md).[`setText`](Stmt.md#settext) + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/base/Stmt.ts:346 + +#### Returns + +`string` + +#### Overrides + +[`Stmt`](Stmt.md).[`toString`](Stmt.md#tostring) diff --git a/docs/api_docs/classes/ArkAwaitExpr.md b/docs/api_docs/classes/ArkAwaitExpr.md new file mode 100644 index 0000000000000000000000000000000000000000..56cd83cd89f495cbf9377d6e6e33e88531de5619 --- /dev/null +++ b/docs/api_docs/classes/ArkAwaitExpr.md @@ -0,0 +1,163 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / ArkAwaitExpr + +# Class: ArkAwaitExpr + +Defined in: src/core/base/Expr.ts:423 + +## Extends + +- [`AbstractExpr`](AbstractExpr.md) + +## Constructors + +### new ArkAwaitExpr() + +> **new ArkAwaitExpr**(`promise`): [`ArkAwaitExpr`](ArkAwaitExpr.md) + +Defined in: src/core/base/Expr.ts:426 + +#### Parameters + +##### promise + +[`Value`](../interfaces/Value.md) + +#### Returns + +[`ArkAwaitExpr`](ArkAwaitExpr.md) + +#### Overrides + +[`AbstractExpr`](AbstractExpr.md).[`constructor`](AbstractExpr.md#constructors) + +## Methods + +### getPromise() + +> **getPromise**(): [`Value`](../interfaces/Value.md) + +Defined in: src/core/base/Expr.ts:431 + +#### Returns + +[`Value`](../interfaces/Value.md) + +*** + +### getType() + +> **getType**(): [`Type`](Type.md) + +Defined in: src/core/base/Expr.ts:439 + +Return the type of this value. The interface is encapsulated in [Value](../interfaces/Value.md). +The `Type` is defined in type.ts, such as **Any**, **Unknown**, **TypeParameter**, +**UnclearReference**, **Primitive**, **Number**, **String**, etc. + +#### Returns + +[`Type`](Type.md) + +The type of this value. + +#### Example + +1. In the declaration statement, determine the left-value type and right-value type. + +```typescript +let leftValue:Value; +let rightValue:Value; +... +if (leftValue.getType() instanceof UnknownType && + !(rightValue.getType() instanceof UnknownType) && + !(rightValue.getType() instanceof UndefinedType)) { + ... +} +``` + +#### Overrides + +[`AbstractExpr`](AbstractExpr.md).[`getType`](AbstractExpr.md#gettype) + +*** + +### getUses() + +> **getUses**(): [`Value`](../interfaces/Value.md)[] + +Defined in: src/core/base/Expr.ts:454 + +Return a list of values which are contained in this [Value](../interfaces/Value.md). +Value is a core interface in ArkAnalyzer, which may represent any value or expression. + +#### Returns + +[`Value`](../interfaces/Value.md)[] + +An **array** of values used by this value. + +#### Overrides + +[`AbstractExpr`](AbstractExpr.md).[`getUses`](AbstractExpr.md#getuses) + +*** + +### inferType() + +> **inferType**(`arkMethod`): [`ArkAwaitExpr`](ArkAwaitExpr.md) + +Defined in: src/core/base/Expr.ts:449 + +#### Parameters + +##### arkMethod + +[`ArkMethod`](ArkMethod.md) + +#### Returns + +[`ArkAwaitExpr`](ArkAwaitExpr.md) + +#### Overrides + +[`AbstractExpr`](AbstractExpr.md).[`inferType`](AbstractExpr.md#infertype) + +*** + +### setPromise() + +> **setPromise**(`newPromise`): `void` + +Defined in: src/core/base/Expr.ts:435 + +#### Parameters + +##### newPromise + +[`Value`](../interfaces/Value.md) + +#### Returns + +`void` + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/base/Expr.ts:461 + +Returns a string representation of an object. + +#### Returns + +`string` + +#### Overrides + +[`AbstractExpr`](AbstractExpr.md).[`toString`](AbstractExpr.md#tostring) diff --git a/docs/api_docs/classes/ArkBody.md b/docs/api_docs/classes/ArkBody.md new file mode 100644 index 0000000000000000000000000000000000000000..b19942c934f8742c3ac80ba8b3dbc7c949c0d874 --- /dev/null +++ b/docs/api_docs/classes/ArkBody.md @@ -0,0 +1,193 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / ArkBody + +# Class: ArkBody + +Defined in: src/core/model/ArkBody.ts:23 + +## Constructors + +### new ArkBody() + +> **new ArkBody**(`locals`, `cfg`, `aliasTypeMap`?, `traps`?): [`ArkBody`](ArkBody.md) + +Defined in: src/core/model/ArkBody.ts:30 + +#### Parameters + +##### locals + +`Set`\<[`Local`](Local.md)\> + +##### cfg + +[`Cfg`](Cfg.md) + +##### aliasTypeMap? + +`Map`\<`string`, \[[`AliasType`](AliasType.md), [`ArkAliasTypeDefineStmt`](ArkAliasTypeDefineStmt.md)\]\> + +##### traps? + +`Trap`[] + +#### Returns + +[`ArkBody`](ArkBody.md) + +## Methods + +### addLocal() + +> **addLocal**(`name`, `local`): `void` + +Defined in: src/core/model/ArkBody.ts:50 + +#### Parameters + +##### name + +`string` + +##### local + +[`Local`](Local.md) + +#### Returns + +`void` + +*** + +### getAliasTypeByName() + +> **getAliasTypeByName**(`name`): `null` \| [`AliasType`](AliasType.md) + +Defined in: src/core/model/ArkBody.ts:74 + +#### Parameters + +##### name + +`string` + +#### Returns + +`null` \| [`AliasType`](AliasType.md) + +*** + +### getAliasTypeMap() + +> **getAliasTypeMap**(): `undefined` \| `Map`\<`string`, \[[`AliasType`](AliasType.md), [`ArkAliasTypeDefineStmt`](ArkAliasTypeDefineStmt.md)\]\> + +Defined in: src/core/model/ArkBody.ts:70 + +#### Returns + +`undefined` \| `Map`\<`string`, \[[`AliasType`](AliasType.md), [`ArkAliasTypeDefineStmt`](ArkAliasTypeDefineStmt.md)\]\> + +*** + +### getCfg() + +> **getCfg**(): [`Cfg`](Cfg.md) + +Defined in: src/core/model/ArkBody.ts:62 + +#### Returns + +[`Cfg`](Cfg.md) + +*** + +### getLocals() + +> **getLocals**(): `Map`\<`string`, [`Local`](Local.md)\> + +Defined in: src/core/model/ArkBody.ts:39 + +#### Returns + +`Map`\<`string`, [`Local`](Local.md)\> + +*** + +### getTraps() + +> **getTraps**(): `undefined` \| `Trap`[] + +Defined in: src/core/model/ArkBody.ts:82 + +#### Returns + +`undefined` \| `Trap`[] + +*** + +### getUsedGlobals() + +> **getUsedGlobals**(): `undefined` \| `Map`\<`string`, [`Value`](../interfaces/Value.md)\> + +Defined in: src/core/model/ArkBody.ts:54 + +#### Returns + +`undefined` \| `Map`\<`string`, [`Value`](../interfaces/Value.md)\> + +*** + +### setCfg() + +> **setCfg**(`cfg`): `void` + +Defined in: src/core/model/ArkBody.ts:66 + +#### Parameters + +##### cfg + +[`Cfg`](Cfg.md) + +#### Returns + +`void` + +*** + +### setLocals() + +> **setLocals**(`locals`): `void` + +Defined in: src/core/model/ArkBody.ts:43 + +#### Parameters + +##### locals + +`Set`\<[`Local`](Local.md)\> + +#### Returns + +`void` + +*** + +### setUsedGlobals() + +> **setUsedGlobals**(`globals`): `void` + +Defined in: src/core/model/ArkBody.ts:58 + +#### Parameters + +##### globals + +`Map`\<`string`, [`Value`](../interfaces/Value.md)\> + +#### Returns + +`void` diff --git a/docs/api_docs/classes/ArkCastExpr.md b/docs/api_docs/classes/ArkCastExpr.md new file mode 100644 index 0000000000000000000000000000000000000000..b80f877c4feff3d5b8f6ce263566f5812d1a68f1 --- /dev/null +++ b/docs/api_docs/classes/ArkCastExpr.md @@ -0,0 +1,167 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / ArkCastExpr + +# Class: ArkCastExpr + +Defined in: src/core/base/Expr.ts:800 + +## Extends + +- [`AbstractExpr`](AbstractExpr.md) + +## Constructors + +### new ArkCastExpr() + +> **new ArkCastExpr**(`op`, `type`): [`ArkCastExpr`](ArkCastExpr.md) + +Defined in: src/core/base/Expr.ts:804 + +#### Parameters + +##### op + +[`Value`](../interfaces/Value.md) + +##### type + +[`Type`](Type.md) + +#### Returns + +[`ArkCastExpr`](ArkCastExpr.md) + +#### Overrides + +[`AbstractExpr`](AbstractExpr.md).[`constructor`](AbstractExpr.md#constructors) + +## Methods + +### getOp() + +> **getOp**(): [`Value`](../interfaces/Value.md) + +Defined in: src/core/base/Expr.ts:810 + +#### Returns + +[`Value`](../interfaces/Value.md) + +*** + +### getType() + +> **getType**(): [`Type`](Type.md) + +Defined in: src/core/base/Expr.ts:825 + +Return the type of this value. The interface is encapsulated in [Value](../interfaces/Value.md). +The `Type` is defined in type.ts, such as **Any**, **Unknown**, **TypeParameter**, +**UnclearReference**, **Primitive**, **Number**, **String**, etc. + +#### Returns + +[`Type`](Type.md) + +The type of this value. + +#### Example + +1. In the declaration statement, determine the left-value type and right-value type. + +```typescript +let leftValue:Value; +let rightValue:Value; +... +if (leftValue.getType() instanceof UnknownType && + !(rightValue.getType() instanceof UnknownType) && + !(rightValue.getType() instanceof UndefinedType)) { + ... +} +``` + +#### Overrides + +[`AbstractExpr`](AbstractExpr.md).[`getType`](AbstractExpr.md#gettype) + +*** + +### getUses() + +> **getUses**(): [`Value`](../interfaces/Value.md)[] + +Defined in: src/core/base/Expr.ts:818 + +Return a list of values which are contained in this [Value](../interfaces/Value.md). +Value is a core interface in ArkAnalyzer, which may represent any value or expression. + +#### Returns + +[`Value`](../interfaces/Value.md)[] + +An **array** of values used by this value. + +#### Overrides + +[`AbstractExpr`](AbstractExpr.md).[`getUses`](AbstractExpr.md#getuses) + +*** + +### inferType() + +> **inferType**(`arkMethod`): [`AbstractExpr`](AbstractExpr.md) + +Defined in: src/core/base/Expr.ts:829 + +#### Parameters + +##### arkMethod + +[`ArkMethod`](ArkMethod.md) + +#### Returns + +[`AbstractExpr`](AbstractExpr.md) + +#### Overrides + +[`AbstractExpr`](AbstractExpr.md).[`inferType`](AbstractExpr.md#infertype) + +*** + +### setOp() + +> **setOp**(`newOp`): `void` + +Defined in: src/core/base/Expr.ts:814 + +#### Parameters + +##### newOp + +[`Value`](../interfaces/Value.md) + +#### Returns + +`void` + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/base/Expr.ts:839 + +Returns a string representation of an object. + +#### Returns + +`string` + +#### Overrides + +[`AbstractExpr`](AbstractExpr.md).[`toString`](AbstractExpr.md#tostring) diff --git a/docs/api_docs/classes/ArkCaughtExceptionRef.md b/docs/api_docs/classes/ArkCaughtExceptionRef.md new file mode 100644 index 0000000000000000000000000000000000000000..82cc8ea4cddfaa844782e2833732710335d4c484 --- /dev/null +++ b/docs/api_docs/classes/ArkCaughtExceptionRef.md @@ -0,0 +1,129 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / ArkCaughtExceptionRef + +# Class: ArkCaughtExceptionRef + +Defined in: src/core/base/Ref.ts:321 + +## Extends + +- [`AbstractRef`](AbstractRef.md) + +## Constructors + +### new ArkCaughtExceptionRef() + +> **new ArkCaughtExceptionRef**(`type`): [`ArkCaughtExceptionRef`](ArkCaughtExceptionRef.md) + +Defined in: src/core/base/Ref.ts:324 + +#### Parameters + +##### type + +[`Type`](Type.md) + +#### Returns + +[`ArkCaughtExceptionRef`](ArkCaughtExceptionRef.md) + +#### Overrides + +[`AbstractRef`](AbstractRef.md).[`constructor`](AbstractRef.md#constructors) + +## Methods + +### getType() + +> **getType**(): [`Type`](Type.md) + +Defined in: src/core/base/Ref.ts:329 + +Return the type of this value. The interface is encapsulated in [Value](../interfaces/Value.md). +The `Type` is defined in type.ts, such as **Any**, **Unknown**, **TypeParameter**, +**UnclearReference**, **Primitive**, **Number**, **String**, etc. + +#### Returns + +[`Type`](Type.md) + +The type of this value. + +#### Example + +1. In the declaration statement, determine the left-value type and right-value type. + +```typescript +let leftValue:Value; +let rightValue:Value; +... +if (leftValue.getType() instanceof UnknownType && + !(rightValue.getType() instanceof UnknownType) && + !(rightValue.getType() instanceof UndefinedType)) { + ... +} +``` + +#### Overrides + +[`AbstractRef`](AbstractRef.md).[`getType`](AbstractRef.md#gettype) + +*** + +### getUses() + +> **getUses**(): [`Value`](../interfaces/Value.md)[] + +Defined in: src/core/base/Ref.ts:333 + +Return a list of values which are contained in this [Value](../interfaces/Value.md). +Value is a core interface in ArkAnalyzer, which may represent any value or expression. + +#### Returns + +[`Value`](../interfaces/Value.md)[] + +An **array** of values used by this value. + +#### Overrides + +[`AbstractRef`](AbstractRef.md).[`getUses`](AbstractRef.md#getuses) + +*** + +### inferType() + +> **inferType**(`arkMethod`): [`AbstractRef`](AbstractRef.md) + +Defined in: src/core/base/Ref.ts:37 + +#### Parameters + +##### arkMethod + +[`ArkMethod`](ArkMethod.md) + +#### Returns + +[`AbstractRef`](AbstractRef.md) + +#### Inherited from + +[`AbstractRef`](AbstractRef.md).[`inferType`](AbstractRef.md#infertype) + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/base/Ref.ts:337 + +Returns a string representation of an object. + +#### Returns + +`string` diff --git a/docs/api_docs/classes/ArkClass.md b/docs/api_docs/classes/ArkClass.md new file mode 100644 index 0000000000000000000000000000000000000000..aaf8517db6c050b99daa37aa1a21151a8be91dd2 --- /dev/null +++ b/docs/api_docs/classes/ArkClass.md @@ -0,0 +1,1587 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / ArkClass + +# Class: ArkClass + +Defined in: src/core/model/ArkClass.ts:43 + +## Extends + +- `ArkBaseModel` + +## Implements + +- `ArkExport` + +## Constructors + +### new ArkClass() + +> **new ArkClass**(): [`ArkClass`](ArkClass.md) + +Defined in: src/core/model/ArkClass.ts:73 + +#### Returns + +[`ArkClass`](ArkClass.md) + +#### Overrides + +`ArkBaseModel.constructor` + +## Properties + +### decorators? + +> `protected` `optional` **decorators**: `Set`\<[`Decorator`](Decorator.md)\> + +Defined in: src/core/model/ArkBaseModel.ts:115 + +#### Inherited from + +`ArkBaseModel.decorators` + +*** + +### metadata? + +> `protected` `optional` **metadata**: `ArkMetadata` + +Defined in: src/core/model/ArkBaseModel.ts:116 + +#### Inherited from + +`ArkBaseModel.metadata` + +*** + +### modifiers? + +> `protected` `optional` **modifiers**: `number` + +Defined in: src/core/model/ArkBaseModel.ts:114 + +#### Inherited from + +`ArkBaseModel.modifiers` + +## Methods + +### addDecorator() + +> **addDecorator**(`decorator`): `void` + +Defined in: src/core/model/ArkBaseModel.ts:215 + +#### Parameters + +##### decorator + +[`Decorator`](Decorator.md) + +#### Returns + +`void` + +#### Inherited from + +`ArkBaseModel.addDecorator` + +*** + +### addExtendedClass() + +> **addExtendedClass**(`extendedClass`): `void` + +Defined in: src/core/model/ArkClass.ts:232 + +#### Parameters + +##### extendedClass + +[`ArkClass`](ArkClass.md) + +#### Returns + +`void` + +*** + +### addField() + +> **addField**(`field`): `void` + +Defined in: src/core/model/ArkClass.ts:288 + +#### Parameters + +##### field + +[`ArkField`](ArkField.md) + +#### Returns + +`void` + +*** + +### addFields() + +> **addFields**(`fields`): `void` + +Defined in: src/core/model/ArkClass.ts:296 + +#### Parameters + +##### fields + +[`ArkField`](ArkField.md)[] + +#### Returns + +`void` + +*** + +### addGenericType() + +> **addGenericType**(`gType`): `void` + +Defined in: src/core/model/ArkClass.ts:310 + +#### Parameters + +##### gType + +[`GenericType`](GenericType.md) + +#### Returns + +`void` + +*** + +### addHeritageClassName() + +> **addHeritageClassName**(`className`): `void` + +Defined in: src/core/model/ArkClass.ts:184 + +#### Parameters + +##### className + +`string` + +#### Returns + +`void` + +*** + +### addMethod() + +> **addMethod**(`method`): `void` + +Defined in: src/core/model/ArkClass.ts:369 + +#### Parameters + +##### method + +[`ArkMethod`](ArkMethod.md) + +#### Returns + +`void` + +*** + +### addModifier() + +> **addModifier**(`modifier`): `void` + +Defined in: src/core/model/ArkBaseModel.ts:142 + +#### Parameters + +##### modifier + +`number` + +#### Returns + +`void` + +#### Inherited from + +`ArkBaseModel.addModifier` + +*** + +### containsModifier() + +> **containsModifier**(`modifierType`): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:194 + +#### Parameters + +##### modifierType + +`ModifierType` + +#### Returns + +`boolean` + +#### Implementation of + +`ArkExport.containsModifier` + +#### Inherited from + +`ArkBaseModel.containsModifier` + +*** + +### getAllHeritageClasses() + +> **getAllHeritageClasses**(): [`ArkClass`](ArkClass.md)[] + +Defined in: src/core/model/ArkClass.ts:217 + +#### Returns + +[`ArkClass`](ArkClass.md)[] + +*** + +### getAnonymousMethodNumber() + +> **getAnonymousMethodNumber**(): `number` + +Defined in: src/core/model/ArkClass.ts:456 + +#### Returns + +`number` + +*** + +### getCategory() + +> **getCategory**(): `ClassCategory` + +Defined in: src/core/model/ArkClass.ts:121 + +#### Returns + +`ClassCategory` + +*** + +### getCode() + +> **getCode**(): `undefined` \| `string` + +Defined in: src/core/model/ArkClass.ts:89 + +Returns the codes of class as a **string.** + +#### Returns + +`undefined` \| `string` + +the codes of class. + +*** + +### getColumn() + +> **getColumn**(): `number` + +Defined in: src/core/model/ArkClass.ts:113 + +Returns the column position of this class. + +#### Returns + +`number` + +The column position of this class. + +*** + +### getDeclaringArkFile() + +> **getDeclaringArkFile**(): [`ArkFile`](ArkFile.md) + +Defined in: src/core/model/ArkClass.ts:139 + +Returns the declaring file. + +#### Returns + +[`ArkFile`](ArkFile.md) + +A file defined by ArkAnalyzer. + +#### Example + +1. Get the [ArkFile](ArkFile.md) which the ArkClass is in. + +```typescript +const arkFile = arkClass.getDeclaringArkFile(); +``` + +*** + +### getDeclaringArkNamespace() + +> **getDeclaringArkNamespace**(): `undefined` \| [`ArkNamespace`](ArkNamespace.md) + +Defined in: src/core/model/ArkClass.ts:151 + +Returns the declaring namespace of this class, which may also be an **undefined**. + +#### Returns + +`undefined` \| [`ArkNamespace`](ArkNamespace.md) + +The declaring namespace (may be **undefined**) of this class. + +*** + +### getDecorators() + +> **getDecorators**(): [`Decorator`](Decorator.md)[] + +Defined in: src/core/model/ArkBaseModel.ts:202 + +#### Returns + +[`Decorator`](Decorator.md)[] + +#### Inherited from + +`ArkBaseModel.getDecorators` + +*** + +### getDefaultArkMethod() + +> **getDefaultArkMethod**(): `null` \| [`ArkMethod`](ArkMethod.md) + +Defined in: src/core/model/ArkClass.ts:382 + +#### Returns + +`null` \| [`ArkMethod`](ArkMethod.md) + +*** + +### getExportType() + +> **getExportType**(): `ExportType` + +Defined in: src/core/model/ArkClass.ts:464 + +#### Returns + +`ExportType` + +#### Implementation of + +`ArkExport.getExportType` + +*** + +### getExtendedClasses() + +> **getExtendedClasses**(): `Map`\<`string`, [`ArkClass`](ArkClass.md)\> + +Defined in: src/core/model/ArkClass.ts:228 + +#### Returns + +`Map`\<`string`, [`ArkClass`](ArkClass.md)\> + +*** + +### getField() + +> **getField**(`fieldSignature`): `null` \| [`ArkField`](ArkField.md) + +Defined in: src/core/model/ArkClass.ts:261 + +Get the field according to its field signature. +If no field cound be found, **null**will be returned. + +#### Parameters + +##### fieldSignature + +[`FieldSignature`](FieldSignature.md) + +the field's signature. + +#### Returns + +`null` \| [`ArkField`](ArkField.md) + +A field. If there is no field in this class, the return will be a **null**. + +*** + +### getFields() + +> **getFields**(): [`ArkField`](ArkField.md)[] + +Defined in: src/core/model/ArkClass.ts:282 + +Returns an **array** of fields in the class. + +#### Returns + +[`ArkField`](ArkField.md)[] + +an **array** of fields in the class. + +*** + +### getFieldWithName() + +> **getFieldWithName**(`fieldName`): `null` \| [`ArkField`](ArkField.md) + +Defined in: src/core/model/ArkClass.ts:270 + +#### Parameters + +##### fieldName + +`string` + +#### Returns + +`null` \| [`ArkField`](ArkField.md) + +*** + +### getGenericsTypes() + +> **getGenericsTypes**(): `undefined` \| [`GenericType`](GenericType.md)[] + +Defined in: src/core/model/ArkClass.ts:306 + +#### Returns + +`undefined` \| [`GenericType`](GenericType.md)[] + +*** + +### getGlobalVariable() + +> **getGlobalVariable**(`globalMap`): [`Local`](Local.md)[] + +Defined in: src/core/model/ArkClass.ts:449 + +#### Parameters + +##### globalMap + +`Map`\<[`NamespaceSignature`](NamespaceSignature.md) \| [`FileSignature`](FileSignature.md), [`Local`](Local.md)[]\> + +#### Returns + +[`Local`](Local.md)[] + +*** + +### getImplementedInterface() + +> **getImplementedInterface**(`interfaceName`): `null` \| [`ArkClass`](ArkClass.md) + +Defined in: src/core/model/ArkClass.ts:247 + +#### Parameters + +##### interfaceName + +`string` + +#### Returns + +`null` \| [`ArkClass`](ArkClass.md) + +*** + +### getImplementedInterfaceNames() + +> **getImplementedInterfaceNames**(): `string`[] + +Defined in: src/core/model/ArkClass.ts:236 + +#### Returns + +`string`[] + +*** + +### getIndexSignatureNumber() + +> **getIndexSignatureNumber**(): `number` + +Defined in: src/core/model/ArkClass.ts:460 + +#### Returns + +`number` + +*** + +### getInstanceInitMethod() + +> **getInstanceInitMethod**(): [`ArkMethod`](ArkMethod.md) + +Defined in: src/core/model/ArkClass.ts:468 + +#### Returns + +[`ArkMethod`](ArkMethod.md) + +*** + +### getLine() + +> **getLine**(): `number` + +Defined in: src/core/model/ArkClass.ts:101 + +Returns the line position of this class. + +#### Returns + +`number` + +The line position of this class. + +*** + +### getMetadata() + +> **getMetadata**(`kind`): `undefined` \| `ArkMetadataType` + +Defined in: src/core/model/ArkBaseModel.ts:118 + +#### Parameters + +##### kind + +`ArkMetadataKind` + +#### Returns + +`undefined` \| `ArkMetadataType` + +#### Inherited from + +`ArkBaseModel.getMetadata` + +*** + +### getMethod() + +> **getMethod**(`methodSignature`): `null` \| [`ArkMethod`](ArkMethod.md) + +Defined in: src/core/model/ArkClass.ts:340 + +#### Parameters + +##### methodSignature + +[`MethodSignature`](MethodSignature.md) + +#### Returns + +`null` \| [`ArkMethod`](ArkMethod.md) + +*** + +### getMethods() + +> **getMethods**(`generated`?): [`ArkMethod`](ArkMethod.md)[] + +Defined in: src/core/model/ArkClass.ts:333 + +Returns all methods defined in the specific class in the form of an array. + +#### Parameters + +##### generated? + +`boolean` + +indicating whether this API returns the methods that are dynamically +generated at runtime. If it is not specified as true or false, the return will not include the generated method. + +#### Returns + +[`ArkMethod`](ArkMethod.md)[] + +An array of all methods in this class. + +#### Example + +1. Get methods defined in class `BookService`. + +```typescript +let classes: ArkClass[] = scene.getClasses(); +let serviceClass : ArkClass = classes[1]; +let methods: ArkMethod[] = serviceClass.getMethods(); +let methodNames: string[] = methods.map(mthd => mthd.name); +console.log(methodNames); +``` + +*** + +### getMethodWithName() + +> **getMethodWithName**(`methodName`): `null` \| [`ArkMethod`](ArkMethod.md) + +Defined in: src/core/model/ArkClass.ts:361 + +#### Parameters + +##### methodName + +`string` + +#### Returns + +`null` \| [`ArkMethod`](ArkMethod.md) + +*** + +### getModifiers() + +> **getModifiers**(): `number` + +Defined in: src/core/model/ArkBaseModel.ts:129 + +#### Returns + +`number` + +#### Implementation of + +`ArkExport.getModifiers` + +#### Inherited from + +`ArkBaseModel.getModifiers` + +*** + +### getName() + +> **getName**(): `string` + +Defined in: src/core/model/ArkClass.ts:81 + +Returns the **string**name of this class. + +#### Returns + +`string` + +The name of this class. + +#### Implementation of + +`ArkExport.getName` + +*** + +### getRealTypes() + +> **getRealTypes**(): `undefined` \| [`Type`](Type.md)[] + +Defined in: src/core/model/ArkClass.ts:302 + +#### Returns + +`undefined` \| [`Type`](Type.md)[] + +*** + +### getSignature() + +> **getSignature**(): [`ClassSignature`](ClassSignature.md) + +Defined in: src/core/model/ArkClass.ts:172 + +Returns the signature of current class (i.e., [ClassSignature](ClassSignature.md)). +The [ClassSignature](ClassSignature.md) can uniquely identify a class, according to which we can find the class from the scene. + +#### Returns + +[`ClassSignature`](ClassSignature.md) + +The class signature. + +#### Implementation of + +`ArkExport.getSignature` + +*** + +### getStateDecorators() + +> **getStateDecorators**(): [`Decorator`](Decorator.md)[] + +Defined in: src/core/model/ArkBaseModel.ts:234 + +#### Returns + +[`Decorator`](Decorator.md)[] + +#### Inherited from + +`ArkBaseModel.getStateDecorators` + +*** + +### getStaticFields() + +> **getStaticFields**(`classMap`): [`ArkField`](ArkField.md)[] + +Defined in: src/core/model/ArkClass.ts:431 + +#### Parameters + +##### classMap + +`Map`\<[`NamespaceSignature`](NamespaceSignature.md) \| [`FileSignature`](FileSignature.md), [`ArkClass`](ArkClass.md)[]\> + +#### Returns + +[`ArkField`](ArkField.md)[] + +*** + +### getStaticFieldWithName() + +> **getStaticFieldWithName**(`fieldName`): `null` \| [`ArkField`](ArkField.md) + +Defined in: src/core/model/ArkClass.ts:274 + +#### Parameters + +##### fieldName + +`string` + +#### Returns + +`null` \| [`ArkField`](ArkField.md) + +*** + +### getStaticInitMethod() + +> **getStaticInitMethod**(): [`ArkMethod`](ArkMethod.md) + +Defined in: src/core/model/ArkClass.ts:472 + +#### Returns + +[`ArkMethod`](ArkMethod.md) + +*** + +### getStaticMethodWithName() + +> **getStaticMethodWithName**(`methodName`): `null` \| [`ArkMethod`](ArkMethod.md) + +Defined in: src/core/model/ArkClass.ts:365 + +#### Parameters + +##### methodName + +`string` + +#### Returns + +`null` \| [`ArkMethod`](ArkMethod.md) + +*** + +### getSuperClass() + +> **getSuperClass**(): `null` \| [`ArkClass`](ArkClass.md) + +Defined in: src/core/model/ArkClass.ts:192 + +Returns the superclass of this class. + +#### Returns + +`null` \| [`ArkClass`](ArkClass.md) + +The superclass of this class. + +*** + +### getSuperClassName() + +> **getSuperClassName**(): `string` + +Defined in: src/core/model/ArkClass.ts:180 + +#### Returns + +`string` + +*** + +### getViewTree() + +> **getViewTree**(): `undefined` \| [`ViewTree`](../interfaces/ViewTree.md) + +Defined in: src/core/model/ArkClass.ts:406 + +Returns the view tree of the ArkClass. + +#### Returns + +`undefined` \| [`ViewTree`](../interfaces/ViewTree.md) + +The view tree of the ArkClass. + +#### Example + +1. get viewTree of ArkClass. + +```typescript +for (let arkFiles of scene.getFiles()) { +for (let arkClasss of arkFiles.getClasses()) { +if (arkClasss.hasViewTree()) { +arkClasss.getViewTree(); +} +} +} +``` + +*** + +### hasBuilderDecorator() + +> **hasBuilderDecorator**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:230 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.hasBuilderDecorator` + +*** + +### hasBuilderParamDecorator() + +> **hasBuilderParamDecorator**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:243 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.hasBuilderParamDecorator` + +*** + +### hasComponentDecorator() + +> **hasComponentDecorator**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:251 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.hasComponentDecorator` + +*** + +### hasDecorator() + +> **hasDecorator**(`kind`): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:255 + +#### Parameters + +##### kind + +`string` | `Set`\<`string`\> + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.hasDecorator` + +*** + +### hasEntryDecorator() + +> **hasEntryDecorator**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:247 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.hasEntryDecorator` + +*** + +### hasImplementedInterface() + +> **hasImplementedInterface**(`interfaceName`): `boolean` + +Defined in: src/core/model/ArkClass.ts:243 + +#### Parameters + +##### interfaceName + +`string` + +#### Returns + +`boolean` + +*** + +### hasViewTree() + +> **hasViewTree**(): `boolean` + +Defined in: src/core/model/ArkClass.ts:427 + +Check whether the view tree is defined. +If it is defined, the return value is true, otherwise it is false. + +#### Returns + +`boolean` + +True if the view tree is defined; false otherwise. + +#### Example + +1. Judge viewTree of ArkClass. + +```typescript +for (let arkFiles of scene.getFiles()) { +for (let arkClasss of arkFiles.getClasses()) { +if (arkClasss.hasViewTree()) { +arkClasss.getViewTree(); +} +} +} +``` + +*** + +### isAbstract() + +> **isAbstract**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:173 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.isAbstract` + +*** + +### isAnonymousClass() + +> **isAnonymousClass**(): `boolean` + +Defined in: src/core/model/ArkClass.ts:163 + +#### Returns + +`boolean` + +*** + +### isDeclare() + +> **isDeclare**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:190 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.isDeclare` + +*** + +### isDefault() + +> **isDefault**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:181 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.isDefault` + +*** + +### isDefaultArkClass() + +> **isDefaultArkClass**(): `boolean` + +Defined in: src/core/model/ArkClass.ts:159 + +#### Returns + +`boolean` + +*** + +### isExport() + +> **isExport**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:177 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.isExport` + +*** + +### ~~isExported()~~ + +> **isExported**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:186 + +#### Returns + +`boolean` + +#### Deprecated + +Use [isExport](ArkNamespace.md#isexport) instead. + +#### Inherited from + +`ArkBaseModel.isExported` + +*** + +### isPrivate() + +> **isPrivate**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:161 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.isPrivate` + +*** + +### isProtected() + +> **isProtected**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:157 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.isProtected` + +*** + +### isPublic() + +> **isPublic**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:165 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.isPublic` + +*** + +### isReadonly() + +> **isReadonly**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:169 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.isReadonly` + +*** + +### isStatic() + +> **isStatic**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:153 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.isStatic` + +*** + +### removeDecorator() + +> **removeDecorator**(`kind`): `void` + +Defined in: src/core/model/ArkBaseModel.ts:222 + +#### Parameters + +##### kind + +`string` + +#### Returns + +`void` + +#### Inherited from + +`ArkBaseModel.removeDecorator` + +*** + +### removeField() + +> **removeField**(`field`): `boolean` + +Defined in: src/core/model/ArkClass.ts:484 + +#### Parameters + +##### field + +[`ArkField`](ArkField.md) + +#### Returns + +`boolean` + +*** + +### removeMethod() + +> **removeMethod**(`method`): `boolean` + +Defined in: src/core/model/ArkClass.ts:491 + +#### Parameters + +##### method + +[`ArkMethod`](ArkMethod.md) + +#### Returns + +`boolean` + +*** + +### removeModifier() + +> **removeModifier**(`modifier`): `void` + +Defined in: src/core/model/ArkBaseModel.ts:146 + +#### Parameters + +##### modifier + +`ModifierType` + +#### Returns + +`void` + +#### Inherited from + +`ArkBaseModel.removeModifier` + +*** + +### setCategory() + +> **setCategory**(`category`): `void` + +Defined in: src/core/model/ArkClass.ts:125 + +#### Parameters + +##### category + +`ClassCategory` + +#### Returns + +`void` + +*** + +### setCode() + +> **setCode**(`code`): `void` + +Defined in: src/core/model/ArkClass.ts:93 + +#### Parameters + +##### code + +`string` + +#### Returns + +`void` + +*** + +### setColumn() + +> **setColumn**(`column`): `void` + +Defined in: src/core/model/ArkClass.ts:117 + +#### Parameters + +##### column + +`number` + +#### Returns + +`void` + +*** + +### setDeclaringArkFile() + +> **setDeclaringArkFile**(`declaringArkFile`): `void` + +Defined in: src/core/model/ArkClass.ts:143 + +#### Parameters + +##### declaringArkFile + +[`ArkFile`](ArkFile.md) + +#### Returns + +`void` + +*** + +### setDeclaringArkNamespace() + +> **setDeclaringArkNamespace**(`declaringArkNamespace`): `void` + +Defined in: src/core/model/ArkClass.ts:155 + +#### Parameters + +##### declaringArkNamespace + +`undefined` | [`ArkNamespace`](ArkNamespace.md) + +#### Returns + +`void` + +*** + +### setDecorators() + +> **setDecorators**(`decorators`): `void` + +Defined in: src/core/model/ArkBaseModel.ts:209 + +#### Parameters + +##### decorators + +`Set`\<[`Decorator`](Decorator.md)\> + +#### Returns + +`void` + +#### Inherited from + +`ArkBaseModel.setDecorators` + +*** + +### setDefaultArkMethod() + +> **setDefaultArkMethod**(`defaultMethod`): `void` + +Defined in: src/core/model/ArkClass.ts:377 + +#### Parameters + +##### defaultMethod + +[`ArkMethod`](ArkMethod.md) + +#### Returns + +`void` + +*** + +### setInstanceInitMethod() + +> **setInstanceInitMethod**(`arkMethod`): `void` + +Defined in: src/core/model/ArkClass.ts:476 + +#### Parameters + +##### arkMethod + +[`ArkMethod`](ArkMethod.md) + +#### Returns + +`void` + +*** + +### setLine() + +> **setLine**(`line`): `void` + +Defined in: src/core/model/ArkClass.ts:105 + +#### Parameters + +##### line + +`number` + +#### Returns + +`void` + +*** + +### setMetadata() + +> **setMetadata**(`kind`, `value`): `void` + +Defined in: src/core/model/ArkBaseModel.ts:122 + +#### Parameters + +##### kind + +`ArkMetadataKind` + +##### value + +`ArkMetadataType` + +#### Returns + +`void` + +#### Inherited from + +`ArkBaseModel.setMetadata` + +*** + +### setModifiers() + +> **setModifiers**(`modifiers`): `void` + +Defined in: src/core/model/ArkBaseModel.ts:136 + +#### Parameters + +##### modifiers + +`number` + +#### Returns + +`void` + +#### Inherited from + +`ArkBaseModel.setModifiers` + +*** + +### setSignature() + +> **setSignature**(`classSig`): `void` + +Defined in: src/core/model/ArkClass.ts:176 + +#### Parameters + +##### classSig + +[`ClassSignature`](ClassSignature.md) + +#### Returns + +`void` + +*** + +### setStaticInitMethod() + +> **setStaticInitMethod**(`arkMethod`): `void` + +Defined in: src/core/model/ArkClass.ts:480 + +#### Parameters + +##### arkMethod + +[`ArkMethod`](ArkMethod.md) + +#### Returns + +`void` + +*** + +### setViewTree() + +> **setViewTree**(`viewTree`): `void` + +Defined in: src/core/model/ArkClass.ts:386 + +#### Parameters + +##### viewTree + +[`ViewTree`](../interfaces/ViewTree.md) + +#### Returns + +`void` + +*** + +### validate() + +> **validate**(): `ArkError` + +Defined in: src/core/model/ArkClass.ts:502 + +#### Returns + +`ArkError` + +#### Overrides + +`ArkBaseModel.validate` + +*** + +### validateFields() + +> `protected` **validateFields**(`fields`): `ArkError` + +Defined in: src/core/model/ArkBaseModel.ts:267 + +#### Parameters + +##### fields + +`string`[] + +#### Returns + +`ArkError` + +#### Inherited from + +`ArkBaseModel.validateFields` diff --git a/docs/api_docs/classes/ArkConditionExpr.md b/docs/api_docs/classes/ArkConditionExpr.md new file mode 100644 index 0000000000000000000000000000000000000000..85f54f473c28c026d1c7c607090d635754af875e --- /dev/null +++ b/docs/api_docs/classes/ArkConditionExpr.md @@ -0,0 +1,350 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / ArkConditionExpr + +# Class: ArkConditionExpr + +Defined in: src/core/base/Expr.ts:699 + +## Extends + +- [`AbstractBinopExpr`](AbstractBinopExpr.md) + +## Constructors + +### new ArkConditionExpr() + +> **new ArkConditionExpr**(`op1`, `op2`, `operator`): [`ArkConditionExpr`](ArkConditionExpr.md) + +Defined in: src/core/base/Expr.ts:700 + +#### Parameters + +##### op1 + +[`Value`](../interfaces/Value.md) + +##### op2 + +[`Value`](../interfaces/Value.md) + +##### operator + +[`RelationalBinaryOperator`](../enumerations/RelationalBinaryOperator.md) + +#### Returns + +[`ArkConditionExpr`](ArkConditionExpr.md) + +#### Overrides + +[`AbstractBinopExpr`](AbstractBinopExpr.md).[`constructor`](AbstractBinopExpr.md#constructors) + +## Properties + +### op1 + +> `protected` **op1**: [`Value`](../interfaces/Value.md) + +Defined in: src/core/base/Expr.ts:543 + +#### Inherited from + +[`AbstractBinopExpr`](AbstractBinopExpr.md).[`op1`](AbstractBinopExpr.md#op1-1) + +*** + +### op2 + +> `protected` **op2**: [`Value`](../interfaces/Value.md) + +Defined in: src/core/base/Expr.ts:544 + +#### Inherited from + +[`AbstractBinopExpr`](AbstractBinopExpr.md).[`op2`](AbstractBinopExpr.md#op2-1) + +*** + +### operator + +> `protected` **operator**: [`BinaryOperator`](../type-aliases/BinaryOperator.md) + +Defined in: src/core/base/Expr.ts:545 + +#### Inherited from + +[`AbstractBinopExpr`](AbstractBinopExpr.md).[`operator`](AbstractBinopExpr.md#operator-1) + +*** + +### type + +> `protected` **type**: [`Type`](Type.md) + +Defined in: src/core/base/Expr.ts:547 + +#### Inherited from + +[`AbstractBinopExpr`](AbstractBinopExpr.md).[`type`](AbstractBinopExpr.md#type) + +## Methods + +### getOp1() + +> **getOp1**(): [`Value`](../interfaces/Value.md) + +Defined in: src/core/base/Expr.ts:561 + +Returns the first operand in the binary operation expression. +For example, the first operand in `a + b;` is `a`. + +#### Returns + +[`Value`](../interfaces/Value.md) + +The first operand in the binary operation expression. + +#### Inherited from + +[`AbstractBinopExpr`](AbstractBinopExpr.md).[`getOp1`](AbstractBinopExpr.md#getop1) + +*** + +### getOp2() + +> **getOp2**(): [`Value`](../interfaces/Value.md) + +Defined in: src/core/base/Expr.ts:574 + +Returns the second operand in the binary operation expression. +For example, the second operand in `a + b;` is `b`. + +#### Returns + +[`Value`](../interfaces/Value.md) + +The second operand in the binary operation expression. + +#### Inherited from + +[`AbstractBinopExpr`](AbstractBinopExpr.md).[`getOp2`](AbstractBinopExpr.md#getop2) + +*** + +### getOperator() + +> **getOperator**(): [`BinaryOperator`](../type-aliases/BinaryOperator.md) + +Defined in: src/core/base/Expr.ts:597 + +Get the binary operator from the statement. +The binary operator can be divided into two categories, +one is the normal binary operator and the other is relational binary operator. + +#### Returns + +[`BinaryOperator`](../type-aliases/BinaryOperator.md) + +The binary operator from the statement. + +#### Example + +```typescript +if (expr instanceof AbstractBinopExpr) { +let op1: Value = expr.getOp1(); +let op2: Value = expr.getOp2(); +let operator: string = expr.getOperator(); +... ... +} +``` + +#### Inherited from + +[`AbstractBinopExpr`](AbstractBinopExpr.md).[`getOperator`](AbstractBinopExpr.md#getoperator) + +*** + +### getType() + +> **getType**(): [`Type`](Type.md) + +Defined in: src/core/base/Expr.ts:601 + +Return the type of this value. The interface is encapsulated in [Value](../interfaces/Value.md). +The `Type` is defined in type.ts, such as **Any**, **Unknown**, **TypeParameter**, +**UnclearReference**, **Primitive**, **Number**, **String**, etc. + +#### Returns + +[`Type`](Type.md) + +The type of this value. + +#### Example + +1. In the declaration statement, determine the left-value type and right-value type. + +```typescript +let leftValue:Value; +let rightValue:Value; +... +if (leftValue.getType() instanceof UnknownType && + !(rightValue.getType() instanceof UnknownType) && + !(rightValue.getType() instanceof UndefinedType)) { + ... +} +``` + +#### Inherited from + +[`AbstractBinopExpr`](AbstractBinopExpr.md).[`getType`](AbstractBinopExpr.md#gettype) + +*** + +### getUses() + +> **getUses**(): [`Value`](../interfaces/Value.md)[] + +Defined in: src/core/base/Expr.ts:608 + +Return a list of values which are contained in this [Value](../interfaces/Value.md). +Value is a core interface in ArkAnalyzer, which may represent any value or expression. + +#### Returns + +[`Value`](../interfaces/Value.md)[] + +An **array** of values used by this value. + +#### Inherited from + +[`AbstractBinopExpr`](AbstractBinopExpr.md).[`getUses`](AbstractBinopExpr.md#getuses) + +*** + +### inferOpType() + +> `protected` **inferOpType**(`op`, `arkMethod`): `void` + +Defined in: src/core/base/Expr.ts:621 + +#### Parameters + +##### op + +[`Value`](../interfaces/Value.md) + +##### arkMethod + +[`ArkMethod`](ArkMethod.md) + +#### Returns + +`void` + +#### Inherited from + +[`AbstractBinopExpr`](AbstractBinopExpr.md).[`inferOpType`](AbstractBinopExpr.md#inferoptype) + +*** + +### inferType() + +> **inferType**(`arkMethod`): [`ArkConditionExpr`](ArkConditionExpr.md) + +Defined in: src/core/base/Expr.ts:704 + +#### Parameters + +##### arkMethod + +[`ArkMethod`](ArkMethod.md) + +#### Returns + +[`ArkConditionExpr`](ArkConditionExpr.md) + +#### Overrides + +[`AbstractBinopExpr`](AbstractBinopExpr.md).[`inferType`](AbstractBinopExpr.md#infertype) + +*** + +### setOp1() + +> **setOp1**(`newOp1`): `void` + +Defined in: src/core/base/Expr.ts:565 + +#### Parameters + +##### newOp1 + +[`Value`](../interfaces/Value.md) + +#### Returns + +`void` + +#### Inherited from + +[`AbstractBinopExpr`](AbstractBinopExpr.md).[`setOp1`](AbstractBinopExpr.md#setop1) + +*** + +### setOp2() + +> **setOp2**(`newOp2`): `void` + +Defined in: src/core/base/Expr.ts:578 + +#### Parameters + +##### newOp2 + +[`Value`](../interfaces/Value.md) + +#### Returns + +`void` + +#### Inherited from + +[`AbstractBinopExpr`](AbstractBinopExpr.md).[`setOp2`](AbstractBinopExpr.md#setop2) + +*** + +### setType() + +> `protected` **setType**(): `void` + +Defined in: src/core/base/Expr.ts:627 + +#### Returns + +`void` + +#### Inherited from + +[`AbstractBinopExpr`](AbstractBinopExpr.md).[`setType`](AbstractBinopExpr.md#settype) + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/base/Expr.ts:617 + +Returns a string representation of an object. + +#### Returns + +`string` + +#### Inherited from + +[`AbstractBinopExpr`](AbstractBinopExpr.md).[`toString`](AbstractBinopExpr.md#tostring) diff --git a/docs/api_docs/classes/ArkDeleteExpr.md b/docs/api_docs/classes/ArkDeleteExpr.md new file mode 100644 index 0000000000000000000000000000000000000000..8e7b504c40d0c7f811976250b7571ee34907e12e --- /dev/null +++ b/docs/api_docs/classes/ArkDeleteExpr.md @@ -0,0 +1,163 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / ArkDeleteExpr + +# Class: ArkDeleteExpr + +Defined in: src/core/base/Expr.ts:390 + +## Extends + +- [`AbstractExpr`](AbstractExpr.md) + +## Constructors + +### new ArkDeleteExpr() + +> **new ArkDeleteExpr**(`field`): [`ArkDeleteExpr`](ArkDeleteExpr.md) + +Defined in: src/core/base/Expr.ts:393 + +#### Parameters + +##### field + +[`AbstractFieldRef`](AbstractFieldRef.md) + +#### Returns + +[`ArkDeleteExpr`](ArkDeleteExpr.md) + +#### Overrides + +[`AbstractExpr`](AbstractExpr.md).[`constructor`](AbstractExpr.md#constructors) + +## Methods + +### getField() + +> **getField**(): [`AbstractFieldRef`](AbstractFieldRef.md) + +Defined in: src/core/base/Expr.ts:398 + +#### Returns + +[`AbstractFieldRef`](AbstractFieldRef.md) + +*** + +### getType() + +> **getType**(): [`Type`](Type.md) + +Defined in: src/core/base/Expr.ts:406 + +Return the type of this value. The interface is encapsulated in [Value](../interfaces/Value.md). +The `Type` is defined in type.ts, such as **Any**, **Unknown**, **TypeParameter**, +**UnclearReference**, **Primitive**, **Number**, **String**, etc. + +#### Returns + +[`Type`](Type.md) + +The type of this value. + +#### Example + +1. In the declaration statement, determine the left-value type and right-value type. + +```typescript +let leftValue:Value; +let rightValue:Value; +... +if (leftValue.getType() instanceof UnknownType && + !(rightValue.getType() instanceof UnknownType) && + !(rightValue.getType() instanceof UndefinedType)) { + ... +} +``` + +#### Overrides + +[`AbstractExpr`](AbstractExpr.md).[`getType`](AbstractExpr.md#gettype) + +*** + +### getUses() + +> **getUses**(): [`Value`](../interfaces/Value.md)[] + +Defined in: src/core/base/Expr.ts:410 + +Return a list of values which are contained in this [Value](../interfaces/Value.md). +Value is a core interface in ArkAnalyzer, which may represent any value or expression. + +#### Returns + +[`Value`](../interfaces/Value.md)[] + +An **array** of values used by this value. + +#### Overrides + +[`AbstractExpr`](AbstractExpr.md).[`getUses`](AbstractExpr.md#getuses) + +*** + +### inferType() + +> **inferType**(`arkMethod`): [`AbstractExpr`](AbstractExpr.md) + +Defined in: src/core/base/Expr.ts:54 + +#### Parameters + +##### arkMethod + +[`ArkMethod`](ArkMethod.md) + +#### Returns + +[`AbstractExpr`](AbstractExpr.md) + +#### Inherited from + +[`AbstractExpr`](AbstractExpr.md).[`inferType`](AbstractExpr.md#infertype) + +*** + +### setField() + +> **setField**(`newField`): `void` + +Defined in: src/core/base/Expr.ts:402 + +#### Parameters + +##### newField + +[`AbstractFieldRef`](AbstractFieldRef.md) + +#### Returns + +`void` + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/base/Expr.ts:417 + +Returns a string representation of an object. + +#### Returns + +`string` + +#### Overrides + +[`AbstractExpr`](AbstractExpr.md).[`toString`](AbstractExpr.md#tostring) diff --git a/docs/api_docs/classes/ArkField.md b/docs/api_docs/classes/ArkField.md new file mode 100644 index 0000000000000000000000000000000000000000..f6fe953d3d222eb8b484a46152a42b4f88c16413 --- /dev/null +++ b/docs/api_docs/classes/ArkField.md @@ -0,0 +1,879 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / ArkField + +# Class: ArkField + +Defined in: src/core/model/ArkField.ts:39 + +## Extends + +- `ArkBaseModel` + +## Constructors + +### new ArkField() + +> **new ArkField**(): [`ArkField`](ArkField.md) + +Defined in: src/core/model/ArkField.ts:52 + +#### Returns + +[`ArkField`](ArkField.md) + +#### Overrides + +`ArkBaseModel.constructor` + +## Properties + +### decorators? + +> `protected` `optional` **decorators**: `Set`\<[`Decorator`](Decorator.md)\> + +Defined in: src/core/model/ArkBaseModel.ts:115 + +#### Inherited from + +`ArkBaseModel.decorators` + +*** + +### metadata? + +> `protected` `optional` **metadata**: `ArkMetadata` + +Defined in: src/core/model/ArkBaseModel.ts:116 + +#### Inherited from + +`ArkBaseModel.metadata` + +*** + +### modifiers? + +> `protected` `optional` **modifiers**: `number` + +Defined in: src/core/model/ArkBaseModel.ts:114 + +#### Inherited from + +`ArkBaseModel.modifiers` + +## Methods + +### addDecorator() + +> **addDecorator**(`decorator`): `void` + +Defined in: src/core/model/ArkBaseModel.ts:215 + +#### Parameters + +##### decorator + +[`Decorator`](Decorator.md) + +#### Returns + +`void` + +#### Inherited from + +`ArkBaseModel.addDecorator` + +*** + +### addModifier() + +> **addModifier**(`modifier`): `void` + +Defined in: src/core/model/ArkBaseModel.ts:142 + +#### Parameters + +##### modifier + +`number` + +#### Returns + +`void` + +#### Inherited from + +`ArkBaseModel.addModifier` + +*** + +### containsModifier() + +> **containsModifier**(`modifierType`): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:194 + +#### Parameters + +##### modifierType + +`ModifierType` + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.containsModifier` + +*** + +### getCategory() + +> **getCategory**(): `FieldCategory` + +Defined in: src/core/model/ArkField.ts:76 + +#### Returns + +`FieldCategory` + +*** + +### getCode() + +> **getCode**(): `string` + +Defined in: src/core/model/ArkField.ts:68 + +Returns the codes of field as a **string.** + +#### Returns + +`string` + +the codes of field. + +*** + +### getDeclaringArkClass() + +> **getDeclaringArkClass**(): [`ArkClass`](ArkClass.md) + +Defined in: src/core/model/ArkField.ts:56 + +#### Returns + +[`ArkClass`](ArkClass.md) + +*** + +### getDecorators() + +> **getDecorators**(): [`Decorator`](Decorator.md)[] + +Defined in: src/core/model/ArkBaseModel.ts:202 + +#### Returns + +[`Decorator`](Decorator.md)[] + +#### Inherited from + +`ArkBaseModel.getDecorators` + +*** + +### getExclamationToken() + +> **getExclamationToken**(): `boolean` + +Defined in: src/core/model/ArkField.ts:124 + +#### Returns + +`boolean` + +*** + +### getInitializer() + +> **getInitializer**(): [`Stmt`](Stmt.md)[] + +Defined in: src/core/model/ArkField.ts:104 + +Returns an array of statements used for initialization. + +#### Returns + +[`Stmt`](Stmt.md)[] + +An array of statements used for initialization. + +*** + +### getMetadata() + +> **getMetadata**(`kind`): `undefined` \| `ArkMetadataType` + +Defined in: src/core/model/ArkBaseModel.ts:118 + +#### Parameters + +##### kind + +`ArkMetadataKind` + +#### Returns + +`undefined` \| `ArkMetadataType` + +#### Inherited from + +`ArkBaseModel.getMetadata` + +*** + +### getModifiers() + +> **getModifiers**(): `number` + +Defined in: src/core/model/ArkBaseModel.ts:129 + +#### Returns + +`number` + +#### Inherited from + +`ArkBaseModel.getModifiers` + +*** + +### getName() + +> **getName**(): `string` + +Defined in: src/core/model/ArkField.ts:84 + +#### Returns + +`string` + +*** + +### getOriginPosition() + +> **getOriginPosition**(): [`LineColPosition`](LineColPosition.md) + +Defined in: src/core/model/ArkField.ts:136 + +Returns the original position of the field at source code. + +#### Returns + +[`LineColPosition`](LineColPosition.md) + +The original position of the field at source code. + +*** + +### getQuestionToken() + +> **getQuestionToken**(): `boolean` + +Defined in: src/core/model/ArkField.ts:120 + +#### Returns + +`boolean` + +*** + +### getSignature() + +> **getSignature**(): [`FieldSignature`](FieldSignature.md) + +Defined in: src/core/model/ArkField.ts:92 + +#### Returns + +[`FieldSignature`](FieldSignature.md) + +*** + +### getStateDecorators() + +> **getStateDecorators**(): [`Decorator`](Decorator.md)[] + +Defined in: src/core/model/ArkBaseModel.ts:234 + +#### Returns + +[`Decorator`](Decorator.md)[] + +#### Inherited from + +`ArkBaseModel.getStateDecorators` + +*** + +### getType() + +> **getType**(): [`Type`](Type.md) + +Defined in: src/core/model/ArkField.ts:88 + +#### Returns + +[`Type`](Type.md) + +*** + +### hasBuilderDecorator() + +> **hasBuilderDecorator**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:230 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.hasBuilderDecorator` + +*** + +### hasBuilderParamDecorator() + +> **hasBuilderParamDecorator**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:243 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.hasBuilderParamDecorator` + +*** + +### hasComponentDecorator() + +> **hasComponentDecorator**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:251 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.hasComponentDecorator` + +*** + +### hasDecorator() + +> **hasDecorator**(`kind`): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:255 + +#### Parameters + +##### kind + +`string` | `Set`\<`string`\> + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.hasDecorator` + +*** + +### hasEntryDecorator() + +> **hasEntryDecorator**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:247 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.hasEntryDecorator` + +*** + +### isAbstract() + +> **isAbstract**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:173 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.isAbstract` + +*** + +### isDeclare() + +> **isDeclare**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:190 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.isDeclare` + +*** + +### isDefault() + +> **isDefault**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:181 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.isDefault` + +*** + +### isExport() + +> **isExport**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:177 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.isExport` + +*** + +### ~~isExported()~~ + +> **isExported**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:186 + +#### Returns + +`boolean` + +#### Deprecated + +Use [isExport](ArkNamespace.md#isexport) instead. + +#### Inherited from + +`ArkBaseModel.isExported` + +*** + +### isPrivate() + +> **isPrivate**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:161 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.isPrivate` + +*** + +### isProtected() + +> **isProtected**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:157 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.isProtected` + +*** + +### isPublic() + +> **isPublic**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:165 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.isPublic` + +*** + +### isReadonly() + +> **isReadonly**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:169 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.isReadonly` + +*** + +### isStatic() + +> **isStatic**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:153 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.isStatic` + +*** + +### removeDecorator() + +> **removeDecorator**(`kind`): `void` + +Defined in: src/core/model/ArkBaseModel.ts:222 + +#### Parameters + +##### kind + +`string` + +#### Returns + +`void` + +#### Inherited from + +`ArkBaseModel.removeDecorator` + +*** + +### removeModifier() + +> **removeModifier**(`modifier`): `void` + +Defined in: src/core/model/ArkBaseModel.ts:146 + +#### Parameters + +##### modifier + +`ModifierType` + +#### Returns + +`void` + +#### Inherited from + +`ArkBaseModel.removeModifier` + +*** + +### setCategory() + +> **setCategory**(`category`): `void` + +Defined in: src/core/model/ArkField.ts:80 + +#### Parameters + +##### category + +`FieldCategory` + +#### Returns + +`void` + +*** + +### setCode() + +> **setCode**(`code`): `void` + +Defined in: src/core/model/ArkField.ts:72 + +#### Parameters + +##### code + +`string` + +#### Returns + +`void` + +*** + +### setDeclaringArkClass() + +> **setDeclaringArkClass**(`declaringClass`): `void` + +Defined in: src/core/model/ArkField.ts:60 + +#### Parameters + +##### declaringClass + +[`ArkClass`](ArkClass.md) + +#### Returns + +`void` + +*** + +### setDecorators() + +> **setDecorators**(`decorators`): `void` + +Defined in: src/core/model/ArkBaseModel.ts:209 + +#### Parameters + +##### decorators + +`Set`\<[`Decorator`](Decorator.md)\> + +#### Returns + +`void` + +#### Inherited from + +`ArkBaseModel.setDecorators` + +*** + +### setExclamationToken() + +> **setExclamationToken**(`exclamationToken`): `void` + +Defined in: src/core/model/ArkField.ts:116 + +#### Parameters + +##### exclamationToken + +`boolean` + +#### Returns + +`void` + +*** + +### setInitializer() + +> **setInitializer**(`initializer`): `void` + +Defined in: src/core/model/ArkField.ts:108 + +#### Parameters + +##### initializer + +[`Stmt`](Stmt.md)[] + +#### Returns + +`void` + +*** + +### setMetadata() + +> **setMetadata**(`kind`, `value`): `void` + +Defined in: src/core/model/ArkBaseModel.ts:122 + +#### Parameters + +##### kind + +`ArkMetadataKind` + +##### value + +`ArkMetadataType` + +#### Returns + +`void` + +#### Inherited from + +`ArkBaseModel.setMetadata` + +*** + +### setModifiers() + +> **setModifiers**(`modifiers`): `void` + +Defined in: src/core/model/ArkBaseModel.ts:136 + +#### Parameters + +##### modifiers + +`number` + +#### Returns + +`void` + +#### Inherited from + +`ArkBaseModel.setModifiers` + +*** + +### setOriginPosition() + +> **setOriginPosition**(`position`): `void` + +Defined in: src/core/model/ArkField.ts:128 + +#### Parameters + +##### position + +[`LineColPosition`](LineColPosition.md) + +#### Returns + +`void` + +*** + +### setQuestionToken() + +> **setQuestionToken**(`questionToken`): `void` + +Defined in: src/core/model/ArkField.ts:112 + +#### Parameters + +##### questionToken + +`boolean` + +#### Returns + +`void` + +*** + +### setSignature() + +> **setSignature**(`fieldSig`): `void` + +Defined in: src/core/model/ArkField.ts:96 + +#### Parameters + +##### fieldSig + +[`FieldSignature`](FieldSignature.md) + +#### Returns + +`void` + +*** + +### validate() + +> **validate**(): `ArkError` + +Defined in: src/core/model/ArkField.ts:140 + +#### Returns + +`ArkError` + +#### Overrides + +`ArkBaseModel.validate` + +*** + +### validateFields() + +> `protected` **validateFields**(`fields`): `ArkError` + +Defined in: src/core/model/ArkBaseModel.ts:267 + +#### Parameters + +##### fields + +`string`[] + +#### Returns + +`ArkError` + +#### Inherited from + +`ArkBaseModel.validateFields` diff --git a/docs/api_docs/classes/ArkFile.md b/docs/api_docs/classes/ArkFile.md new file mode 100644 index 0000000000000000000000000000000000000000..a0d46de456f11f774780429865d98816c550116e --- /dev/null +++ b/docs/api_docs/classes/ArkFile.md @@ -0,0 +1,697 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / ArkFile + +# Class: ArkFile + +Defined in: src/core/model/ArkFile.ts:31 + +## Constructors + +### new ArkFile() + +> **new ArkFile**(): [`ArkFile`](ArkFile.md) + +Defined in: src/core/model/ArkFile.ts:54 + +#### Returns + +[`ArkFile`](ArkFile.md) + +## Methods + +### addArkClass() + +> **addArkClass**(`arkClass`): `void` + +Defined in: src/core/model/ArkFile.ts:125 + +#### Parameters + +##### arkClass + +[`ArkClass`](ArkClass.md) + +#### Returns + +`void` + +*** + +### addExportInfo() + +> **addExportInfo**(`exportInfo`, `key`?): `void` + +Defined in: src/core/model/ArkFile.ts:268 + +#### Parameters + +##### exportInfo + +[`ExportInfo`](ExportInfo.md) + +##### key? + +`string` + +#### Returns + +`void` + +*** + +### addImportInfo() + +> **addImportInfo**(`importInfo`): `void` + +Defined in: src/core/model/ArkFile.ts:185 + +#### Parameters + +##### importInfo + +[`ImportInfo`](ImportInfo.md) + +#### Returns + +`void` + +*** + +### addNamespace() + +> **addNamespace**(`namespace`): `void` + +Defined in: src/core/model/ArkFile.ts:168 + +#### Parameters + +##### namespace + +[`ArkNamespace`](ArkNamespace.md) + +#### Returns + +`void` + +*** + +### getAllNamespacesUnderThisFile() + +> **getAllNamespacesUnderThisFile**(): [`ArkNamespace`](ArkNamespace.md)[] + +Defined in: src/core/model/ArkFile.ts:308 + +#### Returns + +[`ArkNamespace`](ArkNamespace.md)[] + +*** + +### getAnonymousClassNumber() + +> **getAnonymousClassNumber**(): `number` + +Defined in: src/core/model/ArkFile.ts:317 + +#### Returns + +`number` + +*** + +### getClass() + +> **getClass**(`classSignature`): `null` \| [`ArkClass`](ArkClass.md) + +Defined in: src/core/model/ArkFile.ts:155 + +Returns the class based on its class signature. If the class could not be found, **null** will be returned. + +#### Parameters + +##### classSignature + +[`ClassSignature`](ClassSignature.md) + +the class signature. + +#### Returns + +`null` \| [`ArkClass`](ArkClass.md) + +A class. If there is no class, the return will be a **null**. + +*** + +### getClasses() + +> **getClasses**(): [`ArkClass`](ArkClass.md)[] + +Defined in: src/core/model/ArkFile.ts:164 + +#### Returns + +[`ArkClass`](ArkClass.md)[] + +*** + +### getClassWithName() + +> **getClassWithName**(`Class`): `null` \| [`ArkClass`](ArkClass.md) + +Defined in: src/core/model/ArkFile.ts:160 + +#### Parameters + +##### Class + +`string` + +#### Returns + +`null` \| [`ArkClass`](ArkClass.md) + +*** + +### getCode() + +> **getCode**(): `string` + +Defined in: src/core/model/ArkFile.ts:121 + +Returns the codes of file as a **string.** + +#### Returns + +`string` + +the codes of file. + +*** + +### getDefaultClass() + +> **getDefaultClass**(): [`ArkClass`](ArkClass.md) + +Defined in: src/core/model/ArkFile.ts:129 + +#### Returns + +[`ArkClass`](ArkClass.md) + +*** + +### getExportInfoBy() + +> **getExportInfoBy**(`name`): `undefined` \| [`ExportInfo`](ExportInfo.md) + +Defined in: src/core/model/ArkFile.ts:243 + +Find out the [ExportInfo](ExportInfo.md) of this [ArkFile](ArkFile.md) by the given export name. +It returns an [ExportInfo](ExportInfo.md) or 'undefined' if it failed to find. + +#### Parameters + +##### name + +`string` + +#### Returns + +`undefined` \| [`ExportInfo`](ExportInfo.md) + +#### Example + +```typescript +// abc.ts ArkFile +export class A { + ... +} + +export namespace B { + export namespace C { + export class D {} + } +} + +// xyz.ts call getExportInfoBy +let arkFile = scene.getFile(fileSignature); + +// a is the export class A defined in abc.ts +let a = arkFile.getExportInfoBy('A'); + +// b is the export class D within namespace C defined in abc.ts +let b = arkFile.getExportInfoBy('B.C.D'); +``` + +*** + +### getExportInfos() + +> **getExportInfos**(): [`ExportInfo`](ExportInfo.md)[] + +Defined in: src/core/model/ArkFile.ts:205 + +#### Returns + +[`ExportInfo`](ExportInfo.md)[] + +*** + +### getFilePath() + +> **getFilePath**(): `string` + +Defined in: src/core/model/ArkFile.ts:105 + +Get a file path. + +#### Returns + +`string` + +The absolute file path. + +#### Example + +1. Read source code based on file path. + +```typescript +let str = fs.readFileSync(arkFile.getFilePath(), 'utf8'); +``` + +*** + +### getFileSignature() + +> **getFileSignature**(): [`FileSignature`](FileSignature.md) + +Defined in: src/core/model/ArkFile.ts:300 + +Returns the file signature of this file. A file signature consists of project's name and file's name. + +#### Returns + +[`FileSignature`](FileSignature.md) + +The file signature of this file. + +*** + +### getImportInfoBy() + +> **getImportInfoBy**(`name`): `undefined` \| [`ImportInfo`](ImportInfo.md) + +Defined in: src/core/model/ArkFile.ts:181 + +#### Parameters + +##### name + +`string` + +#### Returns + +`undefined` \| [`ImportInfo`](ImportInfo.md) + +*** + +### getImportInfos() + +> **getImportInfos**(): [`ImportInfo`](ImportInfo.md)[] + +Defined in: src/core/model/ArkFile.ts:177 + +Returns an **array** of import information. +The import information includes: clause's name, type, modifiers, location where it is imported from, etc. + +#### Returns + +[`ImportInfo`](ImportInfo.md)[] + +An **array** of import information. + +*** + +### getModuleName() + +> **getModuleName**(): `undefined` \| `string` + +Defined in: src/core/model/ArkFile.ts:284 + +#### Returns + +`undefined` \| `string` + +*** + +### getModuleScene() + +> **getModuleScene**(): `undefined` \| `ModuleScene` + +Defined in: src/core/model/ArkFile.ts:79 + +#### Returns + +`undefined` \| `ModuleScene` + +*** + +### getName() + +> **getName**(): `string` + +Defined in: src/core/model/ArkFile.ts:61 + +Returns the **string** name of the file, which also acts as the file's relative path. + +#### Returns + +`string` + +The file's name (also means its relative path). + +*** + +### getNamespace() + +> **getNamespace**(`namespaceSignature`): `null` \| [`ArkNamespace`](ArkNamespace.md) + +Defined in: src/core/model/ArkFile.ts:137 + +#### Parameters + +##### namespaceSignature + +[`NamespaceSignature`](NamespaceSignature.md) + +#### Returns + +`null` \| [`ArkNamespace`](ArkNamespace.md) + +*** + +### getNamespaces() + +> **getNamespaces**(): [`ArkNamespace`](ArkNamespace.md)[] + +Defined in: src/core/model/ArkFile.ts:146 + +#### Returns + +[`ArkNamespace`](ArkNamespace.md)[] + +*** + +### getNamespaceWithName() + +> **getNamespaceWithName**(`namespaceName`): `null` \| [`ArkNamespace`](ArkNamespace.md) + +Defined in: src/core/model/ArkFile.ts:142 + +#### Parameters + +##### namespaceName + +`string` + +#### Returns + +`null` \| [`ArkNamespace`](ArkNamespace.md) + +*** + +### getOhPackageJson5Path() + +> **getOhPackageJson5Path**(): `string`[] + +Defined in: src/core/model/ArkFile.ts:292 + +#### Returns + +`string`[] + +*** + +### getProjectDir() + +> **getProjectDir**(): `string` + +Defined in: src/core/model/ArkFile.ts:91 + +#### Returns + +`string` + +*** + +### getProjectName() + +> **getProjectName**(): `string` + +Defined in: src/core/model/ArkFile.ts:280 + +#### Returns + +`string` + +*** + +### getScene() + +> **getScene**(): [`Scene`](Scene.md) + +Defined in: src/core/model/ArkFile.ts:75 + +Returns the scene (i.e., [Scene](Scene.md)) built for the project. The [Scene](Scene.md) is the core class of ArkAnalyzer, +through which users can access all the information of the analyzed code (project), +including file list, class list, method list, property list, etc. + +#### Returns + +[`Scene`](Scene.md) + +The scene of the file. + +*** + +### removeArkClass() + +> **removeArkClass**(`arkClass`): `boolean` + +Defined in: src/core/model/ArkFile.ts:199 + +#### Parameters + +##### arkClass + +[`ArkClass`](ArkClass.md) + +#### Returns + +`boolean` + +*** + +### removeExportInfo() + +> **removeExportInfo**(`exportInfo`, `key`?): `void` + +Defined in: src/core/model/ArkFile.ts:272 + +#### Parameters + +##### exportInfo + +[`ExportInfo`](ExportInfo.md) + +##### key? + +`string` + +#### Returns + +`void` + +*** + +### removeImportInfo() + +> **removeImportInfo**(`importInfo`): `boolean` + +Defined in: src/core/model/ArkFile.ts:189 + +#### Parameters + +##### importInfo + +[`ImportInfo`](ImportInfo.md) + +#### Returns + +`boolean` + +*** + +### removeNamespace() + +> **removeNamespace**(`namespace`): `boolean` + +Defined in: src/core/model/ArkFile.ts:193 + +#### Parameters + +##### namespace + +[`ArkNamespace`](ArkNamespace.md) + +#### Returns + +`boolean` + +*** + +### setCode() + +> **setCode**(`code`): `void` + +Defined in: src/core/model/ArkFile.ts:113 + +#### Parameters + +##### code + +`string` + +#### Returns + +`void` + +*** + +### setDefaultClass() + +> **setDefaultClass**(`defaultClass`): `void` + +Defined in: src/core/model/ArkFile.ts:133 + +#### Parameters + +##### defaultClass + +[`ArkClass`](ArkClass.md) + +#### Returns + +`void` + +*** + +### setFilePath() + +> **setFilePath**(`absoluteFilePath`): `void` + +Defined in: src/core/model/ArkFile.ts:109 + +#### Parameters + +##### absoluteFilePath + +`string` + +#### Returns + +`void` + +*** + +### setFileSignature() + +> **setFileSignature**(`fileSignature`): `void` + +Defined in: src/core/model/ArkFile.ts:304 + +#### Parameters + +##### fileSignature + +[`FileSignature`](FileSignature.md) + +#### Returns + +`void` + +*** + +### setModuleScene() + +> **setModuleScene**(`moduleScene`): `void` + +Defined in: src/core/model/ArkFile.ts:83 + +#### Parameters + +##### moduleScene + +`ModuleScene` + +#### Returns + +`void` + +*** + +### setOhPackageJson5Path() + +> **setOhPackageJson5Path**(`ohPackageJson5Path`): `void` + +Defined in: src/core/model/ArkFile.ts:288 + +#### Parameters + +##### ohPackageJson5Path + +`string`[] + +#### Returns + +`void` + +*** + +### setProjectDir() + +> **setProjectDir**(`projectDir`): `void` + +Defined in: src/core/model/ArkFile.ts:87 + +#### Parameters + +##### projectDir + +`string` + +#### Returns + +`void` + +*** + +### setScene() + +> **setScene**(`scene`): `void` + +Defined in: src/core/model/ArkFile.ts:65 + +#### Parameters + +##### scene + +[`Scene`](Scene.md) + +#### Returns + +`void` diff --git a/docs/api_docs/classes/ArkIfStmt.md b/docs/api_docs/classes/ArkIfStmt.md new file mode 100644 index 0000000000000000000000000000000000000000..0248e09467dd99ebc7f0c8b7762fd9f3e8f86d6e --- /dev/null +++ b/docs/api_docs/classes/ArkIfStmt.md @@ -0,0 +1,749 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / ArkIfStmt + +# Class: ArkIfStmt + +Defined in: src/core/base/Stmt.ts:393 + +## Extends + +- [`Stmt`](Stmt.md) + +## Constructors + +### new ArkIfStmt() + +> **new ArkIfStmt**(`conditionExpr`): [`ArkIfStmt`](ArkIfStmt.md) + +Defined in: src/core/base/Stmt.ts:396 + +#### Parameters + +##### conditionExpr + +[`ArkConditionExpr`](ArkConditionExpr.md) + +#### Returns + +[`ArkIfStmt`](ArkIfStmt.md) + +#### Overrides + +[`Stmt`](Stmt.md).[`constructor`](Stmt.md#constructors) + +## Properties + +### cfg + +> `protected` **cfg**: [`Cfg`](Cfg.md) + +Defined in: src/core/base/Stmt.ts:35 + +#### Inherited from + +[`Stmt`](Stmt.md).[`cfg`](Stmt.md#cfg) + +*** + +### metadata? + +> `optional` **metadata**: `ArkMetadata` + +Defined in: src/core/base/Stmt.ts:38 + +#### Inherited from + +[`Stmt`](Stmt.md).[`metadata`](Stmt.md#metadata) + +*** + +### operandOriginalPositions? + +> `protected` `optional` **operandOriginalPositions**: [`FullPosition`](FullPosition.md)[] + +Defined in: src/core/base/Stmt.ts:36 + +#### Inherited from + +[`Stmt`](Stmt.md).[`operandOriginalPositions`](Stmt.md#operandoriginalpositions) + +*** + +### originalPosition + +> `protected` **originalPosition**: [`LineColPosition`](LineColPosition.md) = `LineColPosition.DEFAULT` + +Defined in: src/core/base/Stmt.ts:34 + +#### Inherited from + +[`Stmt`](Stmt.md).[`originalPosition`](Stmt.md#originalposition) + +*** + +### originalText? + +> `protected` `optional` **originalText**: `string` + +Defined in: src/core/base/Stmt.ts:33 + +#### Inherited from + +[`Stmt`](Stmt.md).[`originalText`](Stmt.md#originaltext) + +*** + +### text? + +> `protected` `optional` **text**: `string` + +Defined in: src/core/base/Stmt.ts:32 + +#### Inherited from + +[`Stmt`](Stmt.md).[`text`](Stmt.md#text) + +## Methods + +### containsArrayRef() + +> **containsArrayRef**(): `boolean` + +Defined in: src/core/base/Stmt.ts:187 + +#### Returns + +`boolean` + +#### Inherited from + +[`Stmt`](Stmt.md).[`containsArrayRef`](Stmt.md#containsarrayref) + +*** + +### containsFieldRef() + +> **containsFieldRef**(): `boolean` + +Defined in: src/core/base/Stmt.ts:213 + +#### Returns + +`boolean` + +#### Inherited from + +[`Stmt`](Stmt.md).[`containsFieldRef`](Stmt.md#containsfieldref) + +*** + +### containsInvokeExpr() + +> **containsInvokeExpr**(): `boolean` + +Defined in: src/core/base/Stmt.ts:136 + +#### Returns + +`boolean` + +#### Inherited from + +[`Stmt`](Stmt.md).[`containsInvokeExpr`](Stmt.md#containsinvokeexpr) + +*** + +### getArrayRef() + +> **getArrayRef**(): `undefined` \| [`ArkArrayRef`](ArkArrayRef.md) + +Defined in: src/core/base/Stmt.ts:199 + +#### Returns + +`undefined` \| [`ArkArrayRef`](ArkArrayRef.md) + +#### Inherited from + +[`Stmt`](Stmt.md).[`getArrayRef`](Stmt.md#getarrayref) + +*** + +### getCfg() + +> **getCfg**(): [`Cfg`](Cfg.md) + +Defined in: src/core/base/Stmt.ts:115 + +Get the CFG (i.e., control flow graph) of an [ArkBody](ArkBody.md) in which the statement is. +A CFG contains a set of basic blocks and statements corresponding to each basic block. +Note that, "source code" and "three-address" are two types of [Stmt](Stmt.md) in ArkAnalyzer. +Source code [Stmt](Stmt.md) represents the statement of ets/ts source code, while three-address code [Stmt](Stmt.md) +represents the statement after it has been converted into three-address code. Since the source code [Stmt](Stmt.md) does not save its CFG reference, it returns **null**, while the `getCfg()` of the third address code +[Stmt](Stmt.md) will return its CFG reference. + +#### Returns + +[`Cfg`](Cfg.md) + +The CFG (i.e., control flow graph) of an [ArkBody](ArkBody.md) in which the statement is. + +#### Example + +1. get the ArkFile based on stmt. +```typescript +const arkFile = stmt.getCfg()?.getDeclaringMethod().getDeclaringArkFile(); +``` +2. get the ArkMethod based on stmt. +```typescript +let sourceMethod: ArkMethod = stmt.getCfg()?.getDeclaringMethod(); +``` + +#### Inherited from + +[`Stmt`](Stmt.md).[`getCfg`](Stmt.md#getcfg) + +*** + +### getConditionExpr() + +> **getConditionExpr**(): [`ArkConditionExpr`](ArkConditionExpr.md) + +Defined in: src/core/base/Stmt.ts:414 + +The condition expression consisit of two values as operands and one binary operator as operator. +The operator can indicate the relation between the two values, e.g., `<`, `<=`,`>`, `>=`, `==`, `!=`, `===`, +`!==`. + +#### Returns + +[`ArkConditionExpr`](ArkConditionExpr.md) + +a condition expression. + +#### Example + +1. When a statement is `if (a > b)`, the operands are `a` and `b`, the operator is `<`. Therefore, the condition + expression is `a > b`. +2. get a conditon expr from a condition statement. +```typescript +let expr = (this.original as ArkIfStmt).getConditionExpr(); +``` + +*** + +### getDef() + +> **getDef**(): `null` \| [`Value`](../interfaces/Value.md) + +Defined in: src/core/base/Stmt.ts:77 + +Return the definition which is uesd in this statement. Generally, the definition is the left value of `=` in +3AC. For example, the definition in 3AC of `value = parameter0: @project-1/sample-1.ets: AnonymousClass-0` is +`value`, and the definition in `$temp0 = staticinvoke <@_ProjectName/_FileName: xxx.create()>()` is `\$temp0`. + +#### Returns + +`null` \| [`Value`](../interfaces/Value.md) + +The definition in 3AC (may be a **null**). + +#### Example + +1. get the def in stmt. +```typescript +for (const block of this.blocks) { +for (const stmt of block.getStmts()) { + const defValue = stmt.getDef(); + ... + } +} +``` + +#### Inherited from + +[`Stmt`](Stmt.md).[`getDef`](Stmt.md#getdef) + +*** + +### getDefAndUses() + +> **getDefAndUses**(): [`Value`](../interfaces/Value.md)[] + +Defined in: src/core/base/Stmt.ts:86 + +#### Returns + +[`Value`](../interfaces/Value.md)[] + +#### Inherited from + +[`Stmt`](Stmt.md).[`getDefAndUses`](Stmt.md#getdefanduses) + +*** + +### getExpectedSuccessorCount() + +> **getExpectedSuccessorCount**(): `number` + +Defined in: src/core/base/Stmt.ts:426 + +Return the number of statements which this statement may go to + +#### Returns + +`number` + +#### Overrides + +[`Stmt`](Stmt.md).[`getExpectedSuccessorCount`](Stmt.md#getexpectedsuccessorcount) + +*** + +### getExprs() + +> **getExprs**(): [`AbstractExpr`](AbstractExpr.md)[] + +Defined in: src/core/base/Stmt.ts:177 + +Returns an array of expressions in the statement. + +#### Returns + +[`AbstractExpr`](AbstractExpr.md)[] + +An array of expressions in the statement. + +#### Example + +1. Traverse expression of statement. + +```typescript +for (const expr of stmt.getExprs()) { + ... +} +``` + +#### Inherited from + +[`Stmt`](Stmt.md).[`getExprs`](Stmt.md#getexprs) + +*** + +### getFieldRef() + +> **getFieldRef**(): `undefined` \| [`AbstractFieldRef`](AbstractFieldRef.md) + +Defined in: src/core/base/Stmt.ts:226 + +#### Returns + +`undefined` \| [`AbstractFieldRef`](AbstractFieldRef.md) + +#### Inherited from + +[`Stmt`](Stmt.md).[`getFieldRef`](Stmt.md#getfieldref) + +*** + +### getInvokeExpr() + +> **getInvokeExpr**(): `undefined` \| [`AbstractInvokeExpr`](AbstractInvokeExpr.md) + +Defined in: src/core/base/Stmt.ts:156 + +Returns the method's invocation expression (including method signature and its arguments) +in the current statement. An **undefined** will be returned if there is no method used in this statement. + +#### Returns + +`undefined` \| [`AbstractInvokeExpr`](AbstractInvokeExpr.md) + +the method's invocation expression from the statement. An **undefined** will be returned if there is + no method can be found in this statement. + +#### Example + +1. get invoke expr based on stmt. +```typescript +let invoke = stmt.getInvokeExpr(); +``` + +#### Inherited from + +[`Stmt`](Stmt.md).[`getInvokeExpr`](Stmt.md#getinvokeexpr) + +*** + +### getMetadata() + +> **getMetadata**(`kind`): `undefined` \| `ArkMetadataType` + +Defined in: src/core/base/Stmt.ts:40 + +#### Parameters + +##### kind + +`ArkMetadataKind` + +#### Returns + +`undefined` \| `ArkMetadataType` + +#### Inherited from + +[`Stmt`](Stmt.md).[`getMetadata`](Stmt.md#getmetadata) + +*** + +### getOperandOriginalPosition() + +> **getOperandOriginalPosition**(`indexOrOperand`): `null` \| [`FullPosition`](FullPosition.md) + +Defined in: src/core/base/Stmt.ts:287 + +#### Parameters + +##### indexOrOperand + +`number` | [`Value`](../interfaces/Value.md) + +#### Returns + +`null` \| [`FullPosition`](FullPosition.md) + +#### Inherited from + +[`Stmt`](Stmt.md).[`getOperandOriginalPosition`](Stmt.md#getoperandoriginalposition) + +*** + +### getOperandOriginalPositions() + +> **getOperandOriginalPositions**(): `undefined` \| [`FullPosition`](FullPosition.md)[] + +Defined in: src/core/base/Stmt.ts:283 + +#### Returns + +`undefined` \| [`FullPosition`](FullPosition.md)[] + +#### Inherited from + +[`Stmt`](Stmt.md).[`getOperandOriginalPositions`](Stmt.md#getoperandoriginalpositions) + +*** + +### getOriginalText() + +> **getOriginalText**(): `undefined` \| `string` + +Defined in: src/core/base/Stmt.ts:275 + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[`Stmt`](Stmt.md).[`getOriginalText`](Stmt.md#getoriginaltext) + +*** + +### getOriginPositionInfo() + +> **getOriginPositionInfo**(): [`LineColPosition`](LineColPosition.md) + +Defined in: src/core/base/Stmt.ts:261 + +Returns the original position of the statement. +The position consists of two parts: line number and column number. +In the source file, the former (i.e., line number) indicates which line the statement is in, +and the latter (i.e., column number) indicates the position of the statement in the line. +The position is described as `LineColPosition(lineNo,colNum)` in ArkAnalyzer, +and its default value is LineColPosition(-1,-1). + +#### Returns + +[`LineColPosition`](LineColPosition.md) + +The original location of the statement. + +#### Example + +1. Get the stmt position info to make some condition judgements. +```typescript +for (const stmt of stmts) { + if (stmt.getOriginPositionInfo().getLineNo() === -1) { + stmt.setOriginPositionInfo(originalStmt.getOriginPositionInfo()); + this.stmtToOriginalStmt.set(stmt, originalStmt); + } +} +``` + +#### Inherited from + +[`Stmt`](Stmt.md).[`getOriginPositionInfo`](Stmt.md#getoriginpositioninfo) + +*** + +### getUses() + +> **getUses**(): [`Value`](../interfaces/Value.md)[] + +Defined in: src/core/base/Stmt.ts:435 + +Return a list of values which are uesd in this statement + +#### Returns + +[`Value`](../interfaces/Value.md)[] + +#### Overrides + +[`Stmt`](Stmt.md).[`getUses`](Stmt.md#getuses) + +*** + +### isBranch() + +> **isBranch**(): `boolean` + +Defined in: src/core/base/Stmt.ts:422 + +Return true if the following statement may not execute after this statement. +The ArkIfStmt and ArkGotoStmt will return true. + +#### Returns + +`boolean` + +#### Overrides + +[`Stmt`](Stmt.md).[`isBranch`](Stmt.md#isbranch) + +*** + +### replaceDef() + +> **replaceDef**(`oldDef`, `newDef`): `void` + +Defined in: src/core/base/Stmt.ts:81 + +#### Parameters + +##### oldDef + +[`Value`](../interfaces/Value.md) + +##### newDef + +[`Value`](../interfaces/Value.md) + +#### Returns + +`void` + +#### Inherited from + +[`Stmt`](Stmt.md).[`replaceDef`](Stmt.md#replacedef) + +*** + +### replaceUse() + +> **replaceUse**(`oldUse`, `newUse`): `void` + +Defined in: src/core/base/Stmt.ts:56 + +#### Parameters + +##### oldUse + +[`Value`](../interfaces/Value.md) + +##### newUse + +[`Value`](../interfaces/Value.md) + +#### Returns + +`void` + +#### Inherited from + +[`Stmt`](Stmt.md).[`replaceUse`](Stmt.md#replaceuse) + +*** + +### setCfg() + +> **setCfg**(`cfg`): `void` + +Defined in: src/core/base/Stmt.ts:119 + +#### Parameters + +##### cfg + +[`Cfg`](Cfg.md) + +#### Returns + +`void` + +#### Inherited from + +[`Stmt`](Stmt.md).[`setCfg`](Stmt.md#setcfg) + +*** + +### setConditionExpr() + +> **setConditionExpr**(`newConditionExpr`): `void` + +Defined in: src/core/base/Stmt.ts:418 + +#### Parameters + +##### newConditionExpr + +[`ArkConditionExpr`](ArkConditionExpr.md) + +#### Returns + +`void` + +*** + +### setMetadata() + +> **setMetadata**(`kind`, `value`): `void` + +Defined in: src/core/base/Stmt.ts:44 + +#### Parameters + +##### kind + +`ArkMetadataKind` + +##### value + +`ArkMetadataType` + +#### Returns + +`void` + +#### Inherited from + +[`Stmt`](Stmt.md).[`setMetadata`](Stmt.md#setmetadata) + +*** + +### setOperandOriginalPositions() + +> **setOperandOriginalPositions**(`operandOriginalPositions`): `void` + +Defined in: src/core/base/Stmt.ts:279 + +#### Parameters + +##### operandOriginalPositions + +[`FullPosition`](FullPosition.md)[] + +#### Returns + +`void` + +#### Inherited from + +[`Stmt`](Stmt.md).[`setOperandOriginalPositions`](Stmt.md#setoperandoriginalpositions) + +*** + +### setOriginalText() + +> **setOriginalText**(`originalText`): `void` + +Defined in: src/core/base/Stmt.ts:271 + +#### Parameters + +##### originalText + +`string` + +#### Returns + +`void` + +#### Inherited from + +[`Stmt`](Stmt.md).[`setOriginalText`](Stmt.md#setoriginaltext) + +*** + +### setOriginPositionInfo() + +> **setOriginPositionInfo**(`originPositionInfo`): `void` + +Defined in: src/core/base/Stmt.ts:238 + +#### Parameters + +##### originPositionInfo + +[`LineColPosition`](LineColPosition.md) + +#### Returns + +`void` + +#### Inherited from + +[`Stmt`](Stmt.md).[`setOriginPositionInfo`](Stmt.md#setoriginpositioninfo) + +*** + +### setText() + +> **setText**(`text`): `void` + +Defined in: src/core/base/Stmt.ts:267 + +#### Parameters + +##### text + +`string` + +#### Returns + +`void` + +#### Inherited from + +[`Stmt`](Stmt.md).[`setText`](Stmt.md#settext) + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/base/Stmt.ts:430 + +#### Returns + +`string` + +#### Overrides + +[`Stmt`](Stmt.md).[`toString`](Stmt.md#tostring) diff --git a/docs/api_docs/classes/ArkInstanceFieldRef.md b/docs/api_docs/classes/ArkInstanceFieldRef.md new file mode 100644 index 0000000000000000000000000000000000000000..96c48c96240545eec553b50dc517c8c777dc2a4b --- /dev/null +++ b/docs/api_docs/classes/ArkInstanceFieldRef.md @@ -0,0 +1,263 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / ArkInstanceFieldRef + +# Class: ArkInstanceFieldRef + +Defined in: src/core/base/Ref.ts:170 + +## Extends + +- [`AbstractFieldRef`](AbstractFieldRef.md) + +## Constructors + +### new ArkInstanceFieldRef() + +> **new ArkInstanceFieldRef**(`base`, `fieldSignature`): [`ArkInstanceFieldRef`](ArkInstanceFieldRef.md) + +Defined in: src/core/base/Ref.ts:173 + +#### Parameters + +##### base + +[`Local`](Local.md) + +##### fieldSignature + +[`FieldSignature`](FieldSignature.md) + +#### Returns + +[`ArkInstanceFieldRef`](ArkInstanceFieldRef.md) + +#### Overrides + +[`AbstractFieldRef`](AbstractFieldRef.md).[`constructor`](AbstractFieldRef.md#constructors) + +## Methods + +### getBase() + +> **getBase**(): [`Local`](Local.md) + +Defined in: src/core/base/Ref.ts:198 + +Returns the local of field, showing which object this field belongs to. +A [Local](Local.md) consists of : +- Name: the **string** name of local value, e.g., "$temp0". +- Type: the type of value. + +#### Returns + +[`Local`](Local.md) + +The object that the field belongs to. + +#### Example + +1. Get a base. + +```typescript +if (expr instanceof ArkInstanceFieldRef) { +... +let base = expr.getBase(); +if (base.getName() == 'this') { +... +} +... +} +``` + +*** + +### getFieldName() + +> **getFieldName**(): `string` + +Defined in: src/core/base/Ref.ts:135 + +Returns the the field name as a **string**. + +#### Returns + +`string` + +The the field name. + +#### Inherited from + +[`AbstractFieldRef`](AbstractFieldRef.md).[`getFieldName`](AbstractFieldRef.md#getfieldname) + +*** + +### getFieldSignature() + +> **getFieldSignature**(): [`FieldSignature`](FieldSignature.md) + +Defined in: src/core/base/Ref.ts:157 + +Returns a field signature, which consists of a class signature, +a **string** field name, and a **boolean** label indicating whether it is static or not. + +#### Returns + +[`FieldSignature`](FieldSignature.md) + +The field signature. + +#### Example + +1. Compare two Fields + +```typescript +const fieldSignature = new FieldSignature(); +fieldSignature.setFieldName(...); +const fieldRef = new ArkInstanceFieldRef(baseValue as Local, fieldSignature); +... +if (fieldRef.getFieldSignature().getFieldName() === +targetField.getFieldSignature().getFieldName()) { +... +} +``` + +#### Inherited from + +[`AbstractFieldRef`](AbstractFieldRef.md).[`getFieldSignature`](AbstractFieldRef.md#getfieldsignature) + +*** + +### getType() + +> **getType**(): [`Type`](Type.md) + +Defined in: src/core/base/Ref.ts:165 + +Return the type of this value. The interface is encapsulated in [Value](../interfaces/Value.md). +The `Type` is defined in type.ts, such as **Any**, **Unknown**, **TypeParameter**, +**UnclearReference**, **Primitive**, **Number**, **String**, etc. + +#### Returns + +[`Type`](Type.md) + +The type of this value. + +#### Example + +1. In the declaration statement, determine the left-value type and right-value type. + +```typescript +let leftValue:Value; +let rightValue:Value; +... +if (leftValue.getType() instanceof UnknownType && + !(rightValue.getType() instanceof UnknownType) && + !(rightValue.getType() instanceof UndefinedType)) { + ... +} +``` + +#### Inherited from + +[`AbstractFieldRef`](AbstractFieldRef.md).[`getType`](AbstractFieldRef.md#gettype) + +*** + +### getUses() + +> **getUses**(): [`Value`](../interfaces/Value.md)[] + +Defined in: src/core/base/Ref.ts:206 + +Return a list of values which are contained in this [Value](../interfaces/Value.md). +Value is a core interface in ArkAnalyzer, which may represent any value or expression. + +#### Returns + +[`Value`](../interfaces/Value.md)[] + +An **array** of values used by this value. + +#### Overrides + +[`AbstractFieldRef`](AbstractFieldRef.md).[`getUses`](AbstractFieldRef.md#getuses) + +*** + +### inferType() + +> **inferType**(`arkMethod`): [`AbstractRef`](AbstractRef.md) + +Defined in: src/core/base/Ref.ts:217 + +#### Parameters + +##### arkMethod + +[`ArkMethod`](ArkMethod.md) + +#### Returns + +[`AbstractRef`](AbstractRef.md) + +#### Overrides + +[`AbstractFieldRef`](AbstractFieldRef.md).[`inferType`](AbstractFieldRef.md#infertype) + +*** + +### setBase() + +> **setBase**(`newBase`): `void` + +Defined in: src/core/base/Ref.ts:202 + +#### Parameters + +##### newBase + +[`Local`](Local.md) + +#### Returns + +`void` + +*** + +### setFieldSignature() + +> **setFieldSignature**(`newFieldSignature`): `void` + +Defined in: src/core/base/Ref.ts:161 + +#### Parameters + +##### newFieldSignature + +[`FieldSignature`](FieldSignature.md) + +#### Returns + +`void` + +#### Inherited from + +[`AbstractFieldRef`](AbstractFieldRef.md).[`setFieldSignature`](AbstractFieldRef.md#setfieldsignature) + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/base/Ref.ts:213 + +Returns a string representation of an object. + +#### Returns + +`string` diff --git a/docs/api_docs/classes/ArkInstanceInvokeExpr.md b/docs/api_docs/classes/ArkInstanceInvokeExpr.md new file mode 100644 index 0000000000000000000000000000000000000000..86fc46ee53b79af9602cbf03c475b4f9d917bc5d --- /dev/null +++ b/docs/api_docs/classes/ArkInstanceInvokeExpr.md @@ -0,0 +1,362 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / ArkInstanceInvokeExpr + +# Class: ArkInstanceInvokeExpr + +Defined in: src/core/base/Expr.ts:160 + +## Extends + +- [`AbstractInvokeExpr`](AbstractInvokeExpr.md) + +## Constructors + +### new ArkInstanceInvokeExpr() + +> **new ArkInstanceInvokeExpr**(`base`, `methodSignature`, `args`, `realGenericTypes`?): [`ArkInstanceInvokeExpr`](ArkInstanceInvokeExpr.md) + +Defined in: src/core/base/Expr.ts:163 + +#### Parameters + +##### base + +[`Local`](Local.md) + +##### methodSignature + +[`MethodSignature`](MethodSignature.md) + +##### args + +[`Value`](../interfaces/Value.md)[] + +##### realGenericTypes? + +[`Type`](Type.md)[] + +#### Returns + +[`ArkInstanceInvokeExpr`](ArkInstanceInvokeExpr.md) + +#### Overrides + +[`AbstractInvokeExpr`](AbstractInvokeExpr.md).[`constructor`](AbstractInvokeExpr.md#constructors) + +## Methods + +### getArg() + +> **getArg**(`index`): [`Value`](../interfaces/Value.md) + +Defined in: src/core/base/Expr.ts:98 + +Returns an argument used in the expression according to its index. + +#### Parameters + +##### index + +`number` + +the index of the argument. + +#### Returns + +[`Value`](../interfaces/Value.md) + +An argument used in the expression. + +#### Inherited from + +[`AbstractInvokeExpr`](AbstractInvokeExpr.md).[`getArg`](AbstractInvokeExpr.md#getarg) + +*** + +### getArgs() + +> **getArgs**(): [`Value`](../interfaces/Value.md)[] + +Defined in: src/core/base/Expr.ts:124 + +Returns an **array** of arguments used in the expression. + +#### Returns + +[`Value`](../interfaces/Value.md)[] + +An **array** of arguments used in the expression. + +#### Example + +1. get args number. + +```typescript +const argsNum = expr.getArgs().length; +if (argsNum < 5) { +... ... +} +``` + +2. iterate arg based on expression + +```typescript +for (const arg of this.getArgs()) { +strs.push(arg.toString()); +strs.push(', '); +} +``` + +#### Inherited from + +[`AbstractInvokeExpr`](AbstractInvokeExpr.md).[`getArgs`](AbstractInvokeExpr.md#getargs) + +*** + +### getBase() + +> **getBase**(): [`Local`](Local.md) + +Defined in: src/core/base/Expr.ts:172 + +Returns the local of the instance of invoke expression. + +#### Returns + +[`Local`](Local.md) + +The local of the invoke expression's instance.. + +*** + +### getMethodSignature() + +> **getMethodSignature**(): [`MethodSignature`](MethodSignature.md) + +Defined in: src/core/base/Expr.ts:85 + +Get method Signature. The method signature is consist of ClassSignature and MethodSubSignature. +It is the unique flag of a method. It is usually used to compose a expression string in ArkIRTransformer. + +#### Returns + +[`MethodSignature`](MethodSignature.md) + +The class method signature, such as ArkStaticInvokeExpr. + +#### Example + +1. 3AC information composed of getMethodSignature (). + +```typescript +let strs: string[] = []; +strs.push('staticinvoke <'); +strs.push(this.getMethodSignature().toString()); +strs.push('>('); +``` + +#### Inherited from + +[`AbstractInvokeExpr`](AbstractInvokeExpr.md).[`getMethodSignature`](AbstractInvokeExpr.md#getmethodsignature) + +*** + +### getRealGenericTypes() + +> **getRealGenericTypes**(): `undefined` \| [`Type`](Type.md)[] + +Defined in: src/core/base/Expr.ts:140 + +#### Returns + +`undefined` \| [`Type`](Type.md)[] + +#### Inherited from + +[`AbstractInvokeExpr`](AbstractInvokeExpr.md).[`getRealGenericTypes`](AbstractInvokeExpr.md#getrealgenerictypes) + +*** + +### getType() + +> **getType**(): [`Type`](Type.md) + +Defined in: src/core/base/Expr.ts:132 + +Return the type of this value. The interface is encapsulated in [Value](../interfaces/Value.md). +The `Type` is defined in type.ts, such as **Any**, **Unknown**, **TypeParameter**, +**UnclearReference**, **Primitive**, **Number**, **String**, etc. + +#### Returns + +[`Type`](Type.md) + +The type of this value. + +#### Example + +1. In the declaration statement, determine the left-value type and right-value type. + +```typescript +let leftValue:Value; +let rightValue:Value; +... +if (leftValue.getType() instanceof UnknownType && + !(rightValue.getType() instanceof UnknownType) && + !(rightValue.getType() instanceof UndefinedType)) { + ... +} +``` + +#### Inherited from + +[`AbstractInvokeExpr`](AbstractInvokeExpr.md).[`getType`](AbstractInvokeExpr.md#gettype) + +*** + +### getUses() + +> **getUses**(): [`Value`](../interfaces/Value.md)[] + +Defined in: src/core/base/Expr.ts:186 + +Returns an **array** of values used in this invoke expression, +including all arguments and values each arguments used. +For [ArkInstanceInvokeExpr](ArkInstanceInvokeExpr.md), the return also contains the caller base and uses of base. + +#### Returns + +[`Value`](../interfaces/Value.md)[] + +An **array** of arguments used in the invoke expression. + +#### Overrides + +[`AbstractInvokeExpr`](AbstractInvokeExpr.md).[`getUses`](AbstractInvokeExpr.md#getuses) + +*** + +### inferType() + +> **inferType**(`arkMethod`): [`AbstractInvokeExpr`](AbstractInvokeExpr.md) + +Defined in: src/core/base/Expr.ts:215 + +#### Parameters + +##### arkMethod + +[`ArkMethod`](ArkMethod.md) + +#### Returns + +[`AbstractInvokeExpr`](AbstractInvokeExpr.md) + +#### Overrides + +[`AbstractInvokeExpr`](AbstractInvokeExpr.md).[`inferType`](AbstractInvokeExpr.md#infertype) + +*** + +### setArgs() + +> **setArgs**(`newArgs`): `void` + +Defined in: src/core/base/Expr.ts:128 + +#### Parameters + +##### newArgs + +[`Value`](../interfaces/Value.md)[] + +#### Returns + +`void` + +#### Inherited from + +[`AbstractInvokeExpr`](AbstractInvokeExpr.md).[`setArgs`](AbstractInvokeExpr.md#setargs) + +*** + +### setBase() + +> **setBase**(`newBase`): `void` + +Defined in: src/core/base/Expr.ts:176 + +#### Parameters + +##### newBase + +[`Local`](Local.md) + +#### Returns + +`void` + +*** + +### setMethodSignature() + +> **setMethodSignature**(`newMethodSignature`): `void` + +Defined in: src/core/base/Expr.ts:89 + +#### Parameters + +##### newMethodSignature + +[`MethodSignature`](MethodSignature.md) + +#### Returns + +`void` + +#### Inherited from + +[`AbstractInvokeExpr`](AbstractInvokeExpr.md).[`setMethodSignature`](AbstractInvokeExpr.md#setmethodsignature) + +*** + +### setRealGenericTypes() + +> **setRealGenericTypes**(`realTypes`): `void` + +Defined in: src/core/base/Expr.ts:144 + +#### Parameters + +##### realTypes + +`undefined` | [`Type`](Type.md)[] + +#### Returns + +`void` + +#### Inherited from + +[`AbstractInvokeExpr`](AbstractInvokeExpr.md).[`setRealGenericTypes`](AbstractInvokeExpr.md#setrealgenerictypes) + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/base/Expr.ts:197 + +Returns a string representation of an object. + +#### Returns + +`string` + +#### Overrides + +[`AbstractInvokeExpr`](AbstractInvokeExpr.md).[`toString`](AbstractInvokeExpr.md#tostring) diff --git a/docs/api_docs/classes/ArkInstanceOfExpr.md b/docs/api_docs/classes/ArkInstanceOfExpr.md new file mode 100644 index 0000000000000000000000000000000000000000..bbb902ef680994ab8e8271b710fbe4e92c8e0b30 --- /dev/null +++ b/docs/api_docs/classes/ArkInstanceOfExpr.md @@ -0,0 +1,179 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / ArkInstanceOfExpr + +# Class: ArkInstanceOfExpr + +Defined in: src/core/base/Expr.ts:761 + +## Extends + +- [`AbstractExpr`](AbstractExpr.md) + +## Constructors + +### new ArkInstanceOfExpr() + +> **new ArkInstanceOfExpr**(`op`, `checkType`): [`ArkInstanceOfExpr`](ArkInstanceOfExpr.md) + +Defined in: src/core/base/Expr.ts:765 + +#### Parameters + +##### op + +[`Value`](../interfaces/Value.md) + +##### checkType + +[`Type`](Type.md) + +#### Returns + +[`ArkInstanceOfExpr`](ArkInstanceOfExpr.md) + +#### Overrides + +[`AbstractExpr`](AbstractExpr.md).[`constructor`](AbstractExpr.md#constructors) + +## Methods + +### getCheckType() + +> **getCheckType**(): [`Type`](Type.md) + +Defined in: src/core/base/Expr.ts:779 + +#### Returns + +[`Type`](Type.md) + +*** + +### getOp() + +> **getOp**(): [`Value`](../interfaces/Value.md) + +Defined in: src/core/base/Expr.ts:771 + +#### Returns + +[`Value`](../interfaces/Value.md) + +*** + +### getType() + +> **getType**(): [`Type`](Type.md) + +Defined in: src/core/base/Expr.ts:783 + +Return the type of this value. The interface is encapsulated in [Value](../interfaces/Value.md). +The `Type` is defined in type.ts, such as **Any**, **Unknown**, **TypeParameter**, +**UnclearReference**, **Primitive**, **Number**, **String**, etc. + +#### Returns + +[`Type`](Type.md) + +The type of this value. + +#### Example + +1. In the declaration statement, determine the left-value type and right-value type. + +```typescript +let leftValue:Value; +let rightValue:Value; +... +if (leftValue.getType() instanceof UnknownType && + !(rightValue.getType() instanceof UnknownType) && + !(rightValue.getType() instanceof UndefinedType)) { + ... +} +``` + +#### Overrides + +[`AbstractExpr`](AbstractExpr.md).[`getType`](AbstractExpr.md#gettype) + +*** + +### getUses() + +> **getUses**(): [`Value`](../interfaces/Value.md)[] + +Defined in: src/core/base/Expr.ts:787 + +Return a list of values which are contained in this [Value](../interfaces/Value.md). +Value is a core interface in ArkAnalyzer, which may represent any value or expression. + +#### Returns + +[`Value`](../interfaces/Value.md)[] + +An **array** of values used by this value. + +#### Overrides + +[`AbstractExpr`](AbstractExpr.md).[`getUses`](AbstractExpr.md#getuses) + +*** + +### inferType() + +> **inferType**(`arkMethod`): [`AbstractExpr`](AbstractExpr.md) + +Defined in: src/core/base/Expr.ts:54 + +#### Parameters + +##### arkMethod + +[`ArkMethod`](ArkMethod.md) + +#### Returns + +[`AbstractExpr`](AbstractExpr.md) + +#### Inherited from + +[`AbstractExpr`](AbstractExpr.md).[`inferType`](AbstractExpr.md#infertype) + +*** + +### setOp() + +> **setOp**(`newOp`): `void` + +Defined in: src/core/base/Expr.ts:775 + +#### Parameters + +##### newOp + +[`Value`](../interfaces/Value.md) + +#### Returns + +`void` + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/base/Expr.ts:794 + +Returns a string representation of an object. + +#### Returns + +`string` + +#### Overrides + +[`AbstractExpr`](AbstractExpr.md).[`toString`](AbstractExpr.md#tostring) diff --git a/docs/api_docs/classes/ArkInvokeStmt.md b/docs/api_docs/classes/ArkInvokeStmt.md new file mode 100644 index 0000000000000000000000000000000000000000..6e8b187c236a1e1b0b7f1164a44e001d3b123cc6 --- /dev/null +++ b/docs/api_docs/classes/ArkInvokeStmt.md @@ -0,0 +1,722 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / ArkInvokeStmt + +# Class: ArkInvokeStmt + +Defined in: src/core/base/Stmt.ts:364 + +## Extends + +- [`Stmt`](Stmt.md) + +## Constructors + +### new ArkInvokeStmt() + +> **new ArkInvokeStmt**(`invokeExpr`): [`ArkInvokeStmt`](ArkInvokeStmt.md) + +Defined in: src/core/base/Stmt.ts:367 + +#### Parameters + +##### invokeExpr + +[`AbstractInvokeExpr`](AbstractInvokeExpr.md) + +#### Returns + +[`ArkInvokeStmt`](ArkInvokeStmt.md) + +#### Overrides + +[`Stmt`](Stmt.md).[`constructor`](Stmt.md#constructors) + +## Properties + +### cfg + +> `protected` **cfg**: [`Cfg`](Cfg.md) + +Defined in: src/core/base/Stmt.ts:35 + +#### Inherited from + +[`Stmt`](Stmt.md).[`cfg`](Stmt.md#cfg) + +*** + +### metadata? + +> `optional` **metadata**: `ArkMetadata` + +Defined in: src/core/base/Stmt.ts:38 + +#### Inherited from + +[`Stmt`](Stmt.md).[`metadata`](Stmt.md#metadata) + +*** + +### operandOriginalPositions? + +> `protected` `optional` **operandOriginalPositions**: [`FullPosition`](FullPosition.md)[] + +Defined in: src/core/base/Stmt.ts:36 + +#### Inherited from + +[`Stmt`](Stmt.md).[`operandOriginalPositions`](Stmt.md#operandoriginalpositions) + +*** + +### originalPosition + +> `protected` **originalPosition**: [`LineColPosition`](LineColPosition.md) = `LineColPosition.DEFAULT` + +Defined in: src/core/base/Stmt.ts:34 + +#### Inherited from + +[`Stmt`](Stmt.md).[`originalPosition`](Stmt.md#originalposition) + +*** + +### originalText? + +> `protected` `optional` **originalText**: `string` + +Defined in: src/core/base/Stmt.ts:33 + +#### Inherited from + +[`Stmt`](Stmt.md).[`originalText`](Stmt.md#originaltext) + +*** + +### text? + +> `protected` `optional` **text**: `string` + +Defined in: src/core/base/Stmt.ts:32 + +#### Inherited from + +[`Stmt`](Stmt.md).[`text`](Stmt.md#text) + +## Methods + +### containsArrayRef() + +> **containsArrayRef**(): `boolean` + +Defined in: src/core/base/Stmt.ts:187 + +#### Returns + +`boolean` + +#### Inherited from + +[`Stmt`](Stmt.md).[`containsArrayRef`](Stmt.md#containsarrayref) + +*** + +### containsFieldRef() + +> **containsFieldRef**(): `boolean` + +Defined in: src/core/base/Stmt.ts:213 + +#### Returns + +`boolean` + +#### Inherited from + +[`Stmt`](Stmt.md).[`containsFieldRef`](Stmt.md#containsfieldref) + +*** + +### containsInvokeExpr() + +> **containsInvokeExpr**(): `boolean` + +Defined in: src/core/base/Stmt.ts:136 + +#### Returns + +`boolean` + +#### Inherited from + +[`Stmt`](Stmt.md).[`containsInvokeExpr`](Stmt.md#containsinvokeexpr) + +*** + +### getArrayRef() + +> **getArrayRef**(): `undefined` \| [`ArkArrayRef`](ArkArrayRef.md) + +Defined in: src/core/base/Stmt.ts:199 + +#### Returns + +`undefined` \| [`ArkArrayRef`](ArkArrayRef.md) + +#### Inherited from + +[`Stmt`](Stmt.md).[`getArrayRef`](Stmt.md#getarrayref) + +*** + +### getCfg() + +> **getCfg**(): [`Cfg`](Cfg.md) + +Defined in: src/core/base/Stmt.ts:115 + +Get the CFG (i.e., control flow graph) of an [ArkBody](ArkBody.md) in which the statement is. +A CFG contains a set of basic blocks and statements corresponding to each basic block. +Note that, "source code" and "three-address" are two types of [Stmt](Stmt.md) in ArkAnalyzer. +Source code [Stmt](Stmt.md) represents the statement of ets/ts source code, while three-address code [Stmt](Stmt.md) +represents the statement after it has been converted into three-address code. Since the source code [Stmt](Stmt.md) does not save its CFG reference, it returns **null**, while the `getCfg()` of the third address code +[Stmt](Stmt.md) will return its CFG reference. + +#### Returns + +[`Cfg`](Cfg.md) + +The CFG (i.e., control flow graph) of an [ArkBody](ArkBody.md) in which the statement is. + +#### Example + +1. get the ArkFile based on stmt. +```typescript +const arkFile = stmt.getCfg()?.getDeclaringMethod().getDeclaringArkFile(); +``` +2. get the ArkMethod based on stmt. +```typescript +let sourceMethod: ArkMethod = stmt.getCfg()?.getDeclaringMethod(); +``` + +#### Inherited from + +[`Stmt`](Stmt.md).[`getCfg`](Stmt.md#getcfg) + +*** + +### getDef() + +> **getDef**(): `null` \| [`Value`](../interfaces/Value.md) + +Defined in: src/core/base/Stmt.ts:77 + +Return the definition which is uesd in this statement. Generally, the definition is the left value of `=` in +3AC. For example, the definition in 3AC of `value = parameter0: @project-1/sample-1.ets: AnonymousClass-0` is +`value`, and the definition in `$temp0 = staticinvoke <@_ProjectName/_FileName: xxx.create()>()` is `\$temp0`. + +#### Returns + +`null` \| [`Value`](../interfaces/Value.md) + +The definition in 3AC (may be a **null**). + +#### Example + +1. get the def in stmt. +```typescript +for (const block of this.blocks) { +for (const stmt of block.getStmts()) { + const defValue = stmt.getDef(); + ... + } +} +``` + +#### Inherited from + +[`Stmt`](Stmt.md).[`getDef`](Stmt.md#getdef) + +*** + +### getDefAndUses() + +> **getDefAndUses**(): [`Value`](../interfaces/Value.md)[] + +Defined in: src/core/base/Stmt.ts:86 + +#### Returns + +[`Value`](../interfaces/Value.md)[] + +#### Inherited from + +[`Stmt`](Stmt.md).[`getDefAndUses`](Stmt.md#getdefanduses) + +*** + +### getExpectedSuccessorCount() + +> **getExpectedSuccessorCount**(): `number` + +Defined in: src/core/base/Stmt.ts:132 + +Return the number of statements which this statement may go to + +#### Returns + +`number` + +#### Inherited from + +[`Stmt`](Stmt.md).[`getExpectedSuccessorCount`](Stmt.md#getexpectedsuccessorcount) + +*** + +### getExprs() + +> **getExprs**(): [`AbstractExpr`](AbstractExpr.md)[] + +Defined in: src/core/base/Stmt.ts:177 + +Returns an array of expressions in the statement. + +#### Returns + +[`AbstractExpr`](AbstractExpr.md)[] + +An array of expressions in the statement. + +#### Example + +1. Traverse expression of statement. + +```typescript +for (const expr of stmt.getExprs()) { + ... +} +``` + +#### Inherited from + +[`Stmt`](Stmt.md).[`getExprs`](Stmt.md#getexprs) + +*** + +### getFieldRef() + +> **getFieldRef**(): `undefined` \| [`AbstractFieldRef`](AbstractFieldRef.md) + +Defined in: src/core/base/Stmt.ts:226 + +#### Returns + +`undefined` \| [`AbstractFieldRef`](AbstractFieldRef.md) + +#### Inherited from + +[`Stmt`](Stmt.md).[`getFieldRef`](Stmt.md#getfieldref) + +*** + +### getInvokeExpr() + +> **getInvokeExpr**(): [`AbstractInvokeExpr`](AbstractInvokeExpr.md) + +Defined in: src/core/base/Stmt.ts:376 + +Returns the method's invocation expression (including method signature and its arguments) +in the current statement. An **undefined** will be returned if there is no method used in this statement. + +#### Returns + +[`AbstractInvokeExpr`](AbstractInvokeExpr.md) + +the method's invocation expression from the statement. An **undefined** will be returned if there is + no method can be found in this statement. + +#### Example + +1. get invoke expr based on stmt. +```typescript +let invoke = stmt.getInvokeExpr(); +``` + +#### Overrides + +[`Stmt`](Stmt.md).[`getInvokeExpr`](Stmt.md#getinvokeexpr) + +*** + +### getMetadata() + +> **getMetadata**(`kind`): `undefined` \| `ArkMetadataType` + +Defined in: src/core/base/Stmt.ts:40 + +#### Parameters + +##### kind + +`ArkMetadataKind` + +#### Returns + +`undefined` \| `ArkMetadataType` + +#### Inherited from + +[`Stmt`](Stmt.md).[`getMetadata`](Stmt.md#getmetadata) + +*** + +### getOperandOriginalPosition() + +> **getOperandOriginalPosition**(`indexOrOperand`): `null` \| [`FullPosition`](FullPosition.md) + +Defined in: src/core/base/Stmt.ts:287 + +#### Parameters + +##### indexOrOperand + +`number` | [`Value`](../interfaces/Value.md) + +#### Returns + +`null` \| [`FullPosition`](FullPosition.md) + +#### Inherited from + +[`Stmt`](Stmt.md).[`getOperandOriginalPosition`](Stmt.md#getoperandoriginalposition) + +*** + +### getOperandOriginalPositions() + +> **getOperandOriginalPositions**(): `undefined` \| [`FullPosition`](FullPosition.md)[] + +Defined in: src/core/base/Stmt.ts:283 + +#### Returns + +`undefined` \| [`FullPosition`](FullPosition.md)[] + +#### Inherited from + +[`Stmt`](Stmt.md).[`getOperandOriginalPositions`](Stmt.md#getoperandoriginalpositions) + +*** + +### getOriginalText() + +> **getOriginalText**(): `undefined` \| `string` + +Defined in: src/core/base/Stmt.ts:275 + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[`Stmt`](Stmt.md).[`getOriginalText`](Stmt.md#getoriginaltext) + +*** + +### getOriginPositionInfo() + +> **getOriginPositionInfo**(): [`LineColPosition`](LineColPosition.md) + +Defined in: src/core/base/Stmt.ts:261 + +Returns the original position of the statement. +The position consists of two parts: line number and column number. +In the source file, the former (i.e., line number) indicates which line the statement is in, +and the latter (i.e., column number) indicates the position of the statement in the line. +The position is described as `LineColPosition(lineNo,colNum)` in ArkAnalyzer, +and its default value is LineColPosition(-1,-1). + +#### Returns + +[`LineColPosition`](LineColPosition.md) + +The original location of the statement. + +#### Example + +1. Get the stmt position info to make some condition judgements. +```typescript +for (const stmt of stmts) { + if (stmt.getOriginPositionInfo().getLineNo() === -1) { + stmt.setOriginPositionInfo(originalStmt.getOriginPositionInfo()); + this.stmtToOriginalStmt.set(stmt, originalStmt); + } +} +``` + +#### Inherited from + +[`Stmt`](Stmt.md).[`getOriginPositionInfo`](Stmt.md#getoriginpositioninfo) + +*** + +### getUses() + +> **getUses**(): [`Value`](../interfaces/Value.md)[] + +Defined in: src/core/base/Stmt.ts:385 + +Return a list of values which are uesd in this statement + +#### Returns + +[`Value`](../interfaces/Value.md)[] + +#### Overrides + +[`Stmt`](Stmt.md).[`getUses`](Stmt.md#getuses) + +*** + +### isBranch() + +> **isBranch**(): `boolean` + +Defined in: src/core/base/Stmt.ts:127 + +Return true if the following statement may not execute after this statement. +The ArkIfStmt and ArkGotoStmt will return true. + +#### Returns + +`boolean` + +#### Inherited from + +[`Stmt`](Stmt.md).[`isBranch`](Stmt.md#isbranch) + +*** + +### replaceDef() + +> **replaceDef**(`oldDef`, `newDef`): `void` + +Defined in: src/core/base/Stmt.ts:81 + +#### Parameters + +##### oldDef + +[`Value`](../interfaces/Value.md) + +##### newDef + +[`Value`](../interfaces/Value.md) + +#### Returns + +`void` + +#### Inherited from + +[`Stmt`](Stmt.md).[`replaceDef`](Stmt.md#replacedef) + +*** + +### replaceInvokeExpr() + +> **replaceInvokeExpr**(`newExpr`): `void` + +Defined in: src/core/base/Stmt.ts:372 + +#### Parameters + +##### newExpr + +[`AbstractInvokeExpr`](AbstractInvokeExpr.md) + +#### Returns + +`void` + +*** + +### replaceUse() + +> **replaceUse**(`oldUse`, `newUse`): `void` + +Defined in: src/core/base/Stmt.ts:56 + +#### Parameters + +##### oldUse + +[`Value`](../interfaces/Value.md) + +##### newUse + +[`Value`](../interfaces/Value.md) + +#### Returns + +`void` + +#### Inherited from + +[`Stmt`](Stmt.md).[`replaceUse`](Stmt.md#replaceuse) + +*** + +### setCfg() + +> **setCfg**(`cfg`): `void` + +Defined in: src/core/base/Stmt.ts:119 + +#### Parameters + +##### cfg + +[`Cfg`](Cfg.md) + +#### Returns + +`void` + +#### Inherited from + +[`Stmt`](Stmt.md).[`setCfg`](Stmt.md#setcfg) + +*** + +### setMetadata() + +> **setMetadata**(`kind`, `value`): `void` + +Defined in: src/core/base/Stmt.ts:44 + +#### Parameters + +##### kind + +`ArkMetadataKind` + +##### value + +`ArkMetadataType` + +#### Returns + +`void` + +#### Inherited from + +[`Stmt`](Stmt.md).[`setMetadata`](Stmt.md#setmetadata) + +*** + +### setOperandOriginalPositions() + +> **setOperandOriginalPositions**(`operandOriginalPositions`): `void` + +Defined in: src/core/base/Stmt.ts:279 + +#### Parameters + +##### operandOriginalPositions + +[`FullPosition`](FullPosition.md)[] + +#### Returns + +`void` + +#### Inherited from + +[`Stmt`](Stmt.md).[`setOperandOriginalPositions`](Stmt.md#setoperandoriginalpositions) + +*** + +### setOriginalText() + +> **setOriginalText**(`originalText`): `void` + +Defined in: src/core/base/Stmt.ts:271 + +#### Parameters + +##### originalText + +`string` + +#### Returns + +`void` + +#### Inherited from + +[`Stmt`](Stmt.md).[`setOriginalText`](Stmt.md#setoriginaltext) + +*** + +### setOriginPositionInfo() + +> **setOriginPositionInfo**(`originPositionInfo`): `void` + +Defined in: src/core/base/Stmt.ts:238 + +#### Parameters + +##### originPositionInfo + +[`LineColPosition`](LineColPosition.md) + +#### Returns + +`void` + +#### Inherited from + +[`Stmt`](Stmt.md).[`setOriginPositionInfo`](Stmt.md#setoriginpositioninfo) + +*** + +### setText() + +> **setText**(`text`): `void` + +Defined in: src/core/base/Stmt.ts:267 + +#### Parameters + +##### text + +`string` + +#### Returns + +`void` + +#### Inherited from + +[`Stmt`](Stmt.md).[`setText`](Stmt.md#settext) + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/base/Stmt.ts:380 + +#### Returns + +`string` + +#### Overrides + +[`Stmt`](Stmt.md).[`toString`](Stmt.md#tostring) diff --git a/docs/api_docs/classes/ArkMethod.md b/docs/api_docs/classes/ArkMethod.md new file mode 100644 index 0000000000000000000000000000000000000000..6a26b175ded1bca80e60b9263afaad4a5ce6079d --- /dev/null +++ b/docs/api_docs/classes/ArkMethod.md @@ -0,0 +1,1607 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / ArkMethod + +# Class: ArkMethod + +Defined in: src/core/model/ArkMethod.ts:42 + +## Extends + +- `ArkBaseModel` + +## Implements + +- `ArkExport` + +## Constructors + +### new ArkMethod() + +> **new ArkMethod**(): [`ArkMethod`](ArkMethod.md) + +Defined in: src/core/model/ArkMethod.ts:64 + +#### Returns + +[`ArkMethod`](ArkMethod.md) + +#### Overrides + +`ArkBaseModel.constructor` + +## Properties + +### decorators? + +> `protected` `optional` **decorators**: `Set`\<[`Decorator`](Decorator.md)\> + +Defined in: src/core/model/ArkBaseModel.ts:115 + +#### Inherited from + +`ArkBaseModel.decorators` + +*** + +### metadata? + +> `protected` `optional` **metadata**: `ArkMetadata` + +Defined in: src/core/model/ArkBaseModel.ts:116 + +#### Inherited from + +`ArkBaseModel.metadata` + +*** + +### modifiers? + +> `protected` `optional` **modifiers**: `number` + +Defined in: src/core/model/ArkBaseModel.ts:114 + +#### Inherited from + +`ArkBaseModel.modifiers` + +## Methods + +### addDecorator() + +> **addDecorator**(`decorator`): `void` + +Defined in: src/core/model/ArkBaseModel.ts:215 + +#### Parameters + +##### decorator + +[`Decorator`](Decorator.md) + +#### Returns + +`void` + +#### Inherited from + +`ArkBaseModel.addDecorator` + +*** + +### addModifier() + +> **addModifier**(`modifier`): `void` + +Defined in: src/core/model/ArkBaseModel.ts:142 + +#### Parameters + +##### modifier + +`number` + +#### Returns + +`void` + +#### Inherited from + +`ArkBaseModel.addModifier` + +*** + +### buildBody() + +> **buildBody**(): `void` + +Defined in: src/core/model/ArkMethod.ts:529 + +#### Returns + +`void` + +*** + +### containsModifier() + +> **containsModifier**(`modifierType`): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:194 + +#### Parameters + +##### modifierType + +`ModifierType` + +#### Returns + +`boolean` + +#### Implementation of + +`ArkExport.containsModifier` + +#### Inherited from + +`ArkBaseModel.containsModifier` + +*** + +### freeBodyBuilder() + +> **freeBodyBuilder**(): `void` + +Defined in: src/core/model/ArkMethod.ts:525 + +#### Returns + +`void` + +*** + +### getAsteriskToken() + +> **getAsteriskToken**(): `boolean` + +Defined in: src/core/model/ArkMethod.ts:550 + +#### Returns + +`boolean` + +*** + +### getBody() + +> **getBody**(): `undefined` \| [`ArkBody`](ArkBody.md) + +Defined in: src/core/model/ArkMethod.ts:387 + +Get [ArkBody](ArkBody.md) of a Method. +A [ArkBody](ArkBody.md) contains the CFG and actual instructions or operations to be executed for a method. +It is analogous to the body of a function or method in high-level programming languages, +which contains the statements and expressions that define what the function does. + +#### Returns + +`undefined` \| [`ArkBody`](ArkBody.md) + +The [ArkBody](ArkBody.md) of a method. + +#### Example + +1. Get cfg or stmt through ArkBody. + +```typescript +let cfg = this.scene.getMethod()?.getBody().getCfg(); +const body = arkMethod.getBody() +``` + +2. Get local variable through ArkBody. + +```typescript +arkClass.getDefaultArkMethod()?.getBody().getLocals.forEach(local=>{...}) +let locals = arkFile().getDefaultClass().getDefaultArkMethod()?.getBody()?.getLocals(); +``` + +*** + +### getBodyBuilder() + +> **getBodyBuilder**(): `undefined` \| `BodyBuilder` + +Defined in: src/core/model/ArkMethod.ts:362 + +#### Returns + +`undefined` \| `BodyBuilder` + +*** + +### getCfg() + +> **getCfg**(): `undefined` \| [`Cfg`](Cfg.md) + +Defined in: src/core/model/ArkMethod.ts:430 + +Get the CFG (i.e., control flow graph) of a method. +The CFG is a graphical representation of all possible control flow paths within a method's body. +A CFG consists of blocks, statements and goto control jumps. + +#### Returns + +`undefined` \| [`Cfg`](Cfg.md) + +The CFG (i.e., control flow graph) of a method. + +#### Example + +1. get stmt through ArkBody cfg. + +```typescript +body = arkMethod.getBody(); +const cfg = body.getCfg(); +for (const threeAddressStmt of cfg.getStmts()) { +... ... +} +``` + +2. get blocks through ArkBody cfg. + +```typescript +const body = arkMethod.getBody(); +const blocks = [...body.getCfg().getBlocks()]; +for (let i=0; i **getCode**(): `undefined` \| `string` + +Defined in: src/core/model/ArkMethod.ts:80 + +Returns the codes of method as a **string.** + +#### Returns + +`undefined` \| `string` + +the codes of method. + +*** + +### getColumn() + +> **getColumn**(): `null` \| `number` + +Defined in: src/core/model/ArkMethod.ts:183 + +Get column of the method's implementation or null if the method has no implementation. + +#### Returns + +`null` \| `number` + +null or the number of the column. + +*** + +### getDeclareColumns() + +> **getDeclareColumns**(): `null` \| `number`[] + +Defined in: src/core/model/ArkMethod.ts:107 + +Get all columns of the method's declarations or null if the method has no seperated declaration. + +#### Returns + +`null` \| `number`[] + +null or the columns of the method's declarations with number type. + +*** + +### getDeclareLineCols() + +> **getDeclareLineCols**(): `null` \| `number`[] + +Defined in: src/core/model/ArkMethod.ts:151 + +Get encoded lines and columns of the method's declarations or null if the method has no seperated declaration. + +#### Returns + +`null` \| `number`[] + +null or the encoded lines and columns of the method's declarations with LineCol type. + +*** + +### getDeclareLines() + +> **getDeclareLines**(): `null` \| `number`[] + +Defined in: src/core/model/ArkMethod.ts:92 + +Get all lines of the method's declarations or null if the method has no seperated declaration. + +#### Returns + +`null` \| `number`[] + +null or the lines of the method's declarations with number type. + +*** + +### getDeclareSignatureIndex() + +> **getDeclareSignatureIndex**(`targetSignature`): `number` + +Defined in: src/core/model/ArkMethod.ts:267 + +Get the index of the matched method declare signature among all declare signatures. +The index will be -1 if there is no matched signature found. + +#### Parameters + +##### targetSignature + +[`MethodSignature`](MethodSignature.md) + +the target declare signature want to search. + +#### Returns + +`number` + +-1 or the index of the matched signature. + +*** + +### getDeclareSignatures() + +> **getDeclareSignatures**(): `null` \| [`MethodSignature`](MethodSignature.md)[] + +Defined in: src/core/model/ArkMethod.ts:257 + +Get all declare signatures. +The results could be null if there is no seperated declaration of the method. + +#### Returns + +`null` \| [`MethodSignature`](MethodSignature.md)[] + +null or the method declare signatures. + +*** + +### getDeclaringArkClass() + +> **getDeclaringArkClass**(): [`ArkClass`](ArkClass.md) + +Defined in: src/core/model/ArkMethod.ts:224 + +Returns the declaring class of the method. + +#### Returns + +[`ArkClass`](ArkClass.md) + +The declaring class of the method. + +*** + +### getDeclaringArkFile() + +> **getDeclaringArkFile**(): [`ArkFile`](ArkFile.md) + +Defined in: src/core/model/ArkMethod.ts:232 + +#### Returns + +[`ArkFile`](ArkFile.md) + +*** + +### getDecorators() + +> **getDecorators**(): [`Decorator`](Decorator.md)[] + +Defined in: src/core/model/ArkBaseModel.ts:202 + +#### Returns + +[`Decorator`](Decorator.md)[] + +#### Inherited from + +`ArkBaseModel.getDecorators` + +*** + +### getExportType() + +> **getExportType**(): `ExportType` + +Defined in: src/core/model/ArkMethod.ts:68 + +#### Returns + +`ExportType` + +#### Implementation of + +`ArkExport.getExportType` + +*** + +### getFunctionLocal() + +> **getFunctionLocal**(`name`): `null` \| [`Local`](Local.md) + +Defined in: src/core/model/ArkMethod.ts:657 + +#### Parameters + +##### name + +`string` + +#### Returns + +`null` \| [`Local`](Local.md) + +*** + +### getGenericTypes() + +> **getGenericTypes**(): `undefined` \| [`GenericType`](GenericType.md)[] + +Defined in: src/core/model/ArkMethod.ts:350 + +#### Returns + +`undefined` \| [`GenericType`](GenericType.md)[] + +*** + +### getImplementationSignature() + +> **getImplementationSignature**(): `null` \| [`MethodSignature`](MethodSignature.md) + +Defined in: src/core/model/ArkMethod.ts:285 + +Get the method signature of the implementation. +The signature could be null if the method is only a declaration which body is undefined. + +#### Returns + +`null` \| [`MethodSignature`](MethodSignature.md) + +null or the method implementation signature. + +*** + +### getLine() + +> **getLine**(): `null` \| `number` + +Defined in: src/core/model/ArkMethod.ts:159 + +Get line of the method's implementation or null if the method has no implementation. + +#### Returns + +`null` \| `number` + +null or the number of the line. + +*** + +### getLineCol() + +> **getLineCol**(): `null` \| `number` + +Defined in: src/core/model/ArkMethod.ts:207 + +Get encoded line and column of the method's implementation or null if the method has no implementation. + +#### Returns + +`null` \| `number` + +null or the encoded line and column of the method's implementation with LineCol type. + +*** + +### getMetadata() + +> **getMetadata**(`kind`): `undefined` \| `ArkMetadataType` + +Defined in: src/core/model/ArkBaseModel.ts:118 + +#### Parameters + +##### kind + +`ArkMetadataKind` + +#### Returns + +`undefined` \| `ArkMetadataType` + +#### Inherited from + +`ArkBaseModel.getMetadata` + +*** + +### getModifiers() + +> **getModifiers**(): `number` + +Defined in: src/core/model/ArkBaseModel.ts:129 + +#### Returns + +`number` + +#### Implementation of + +`ArkExport.getModifiers` + +#### Inherited from + +`ArkBaseModel.getModifiers` + +*** + +### getName() + +> **getName**(): `string` + +Defined in: src/core/model/ArkMethod.ts:72 + +#### Returns + +`string` + +#### Implementation of + +`ArkExport.getName` + +*** + +### getOriginalCfg() + +> **getOriginalCfg**(): `undefined` \| [`Cfg`](Cfg.md) + +Defined in: src/core/model/ArkMethod.ts:434 + +#### Returns + +`undefined` \| [`Cfg`](Cfg.md) + +*** + +### getOuterMethod() + +> **getOuterMethod**(): `undefined` \| [`ArkMethod`](ArkMethod.md) + +Defined in: src/core/model/ArkMethod.ts:649 + +#### Returns + +`undefined` \| [`ArkMethod`](ArkMethod.md) + +*** + +### getParameterInstances() + +> **getParameterInstances**(): [`Value`](../interfaces/Value.md)[] + +Defined in: src/core/model/ArkMethod.ts:453 + +#### Returns + +[`Value`](../interfaces/Value.md)[] + +*** + +### getParameterRefs() + +> **getParameterRefs**(): `null` \| [`ArkParameterRef`](ArkParameterRef.md)[] + +Defined in: src/core/model/ArkMethod.ts:438 + +#### Returns + +`null` \| [`ArkParameterRef`](ArkParameterRef.md)[] + +*** + +### getParameters() + +> **getParameters**(): `MethodParameter`[] + +Defined in: src/core/model/ArkMethod.ts:244 + +#### Returns + +`MethodParameter`[] + +*** + +### getReturnStmt() + +> **getReturnStmt**(): [`Stmt`](Stmt.md)[] + +Defined in: src/core/model/ArkMethod.ts:502 + +#### Returns + +[`Stmt`](Stmt.md)[] + +*** + +### getReturnType() + +> **getReturnType**(): [`Type`](Type.md) + +Defined in: src/core/model/ArkMethod.ts:248 + +#### Returns + +[`Type`](Type.md) + +*** + +### getReturnValues() + +> **getReturnValues**(): [`Value`](../interfaces/Value.md)[] + +Defined in: src/core/model/ArkMethod.ts:491 + +#### Returns + +[`Value`](../interfaces/Value.md)[] + +*** + +### getSignature() + +> **getSignature**(): [`MethodSignature`](MethodSignature.md) + +Defined in: src/core/model/ArkMethod.ts:304 + +Get the method signature of the implementation or the first declaration if there is no implementation. +For a method, the implementation and declaration signatures must not be undefined at the same time. +A [MethodSignature](MethodSignature.md) includes: +- Class Signature: indicates which class this method belong to. +- Method SubSignature: indicates the detail info of this method such as method name, parameters, returnType, etc. + +#### Returns + +[`MethodSignature`](MethodSignature.md) + +The method signature. + +#### Example + +1. Get the signature of method mtd. + +```typescript +let signature = mtd.getSignature(); +// ... ... +``` + +#### Implementation of + +`ArkExport.getSignature` + +*** + +### getStateDecorators() + +> **getStateDecorators**(): [`Decorator`](Decorator.md)[] + +Defined in: src/core/model/ArkBaseModel.ts:234 + +#### Returns + +[`Decorator`](Decorator.md)[] + +#### Inherited from + +`ArkBaseModel.getStateDecorators` + +*** + +### getSubSignature() + +> **getSubSignature**(): [`MethodSubSignature`](MethodSubSignature.md) + +Defined in: src/core/model/ArkMethod.ts:346 + +#### Returns + +[`MethodSubSignature`](MethodSubSignature.md) + +*** + +### getThisInstance() + +> **getThisInstance**(): `null` \| [`Value`](../interfaces/Value.md) + +Defined in: src/core/model/ArkMethod.ts:474 + +#### Returns + +`null` \| [`Value`](../interfaces/Value.md) + +*** + +### getViewTree() + +> **getViewTree**(): `undefined` \| [`ViewTree`](../interfaces/ViewTree.md) + +Defined in: src/core/model/ArkMethod.ts:510 + +#### Returns + +`undefined` \| [`ViewTree`](../interfaces/ViewTree.md) + +*** + +### hasBuilderDecorator() + +> **hasBuilderDecorator**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:230 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.hasBuilderDecorator` + +*** + +### hasBuilderParamDecorator() + +> **hasBuilderParamDecorator**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:243 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.hasBuilderParamDecorator` + +*** + +### hasComponentDecorator() + +> **hasComponentDecorator**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:251 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.hasComponentDecorator` + +*** + +### hasDecorator() + +> **hasDecorator**(`kind`): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:255 + +#### Parameters + +##### kind + +`string` | `Set`\<`string`\> + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.hasDecorator` + +*** + +### hasEntryDecorator() + +> **hasEntryDecorator**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:247 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.hasEntryDecorator` + +*** + +### hasViewTree() + +> **hasViewTree**(): `boolean` + +Defined in: src/core/model/ArkMethod.ts:514 + +#### Returns + +`boolean` + +*** + +### isAbstract() + +> **isAbstract**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:173 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.isAbstract` + +*** + +### isAnonymousMethod() + +> **isAnonymousMethod**(): `boolean` + +Defined in: src/core/model/ArkMethod.ts:240 + +#### Returns + +`boolean` + +*** + +### isDeclare() + +> **isDeclare**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:190 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.isDeclare` + +*** + +### isDefault() + +> **isDefault**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:181 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.isDefault` + +*** + +### isDefaultArkMethod() + +> **isDefaultArkMethod**(): `boolean` + +Defined in: src/core/model/ArkMethod.ts:236 + +#### Returns + +`boolean` + +*** + +### isExport() + +> **isExport**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:177 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.isExport` + +*** + +### ~~isExported()~~ + +> **isExported**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:186 + +#### Returns + +`boolean` + +#### Deprecated + +Use [isExport](ArkNamespace.md#isexport) instead. + +#### Inherited from + +`ArkBaseModel.isExported` + +*** + +### isGenerated() + +> **isGenerated**(): `boolean` + +Defined in: src/core/model/ArkMethod.ts:542 + +#### Returns + +`boolean` + +*** + +### isGenericsMethod() + +> **isGenericsMethod**(): `boolean` + +Defined in: src/core/model/ArkMethod.ts:354 + +#### Returns + +`boolean` + +*** + +### isPrivate() + +> **isPrivate**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:161 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.isPrivate` + +*** + +### isProtected() + +> **isProtected**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:157 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.isProtected` + +*** + +### isPublic() + +> **isPublic**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:165 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.isPublic` + +*** + +### isReadonly() + +> **isReadonly**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:169 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.isReadonly` + +*** + +### isStatic() + +> **isStatic**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:153 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.isStatic` + +*** + +### matchMethodSignature() + +> **matchMethodSignature**(`args`): [`MethodSignature`](MethodSignature.md) + +Defined in: src/core/model/ArkMethod.ts:591 + +#### Parameters + +##### args + +[`Value`](../interfaces/Value.md)[] + +#### Returns + +[`MethodSignature`](MethodSignature.md) + +*** + +### removeDecorator() + +> **removeDecorator**(`kind`): `void` + +Defined in: src/core/model/ArkBaseModel.ts:222 + +#### Parameters + +##### kind + +`string` + +#### Returns + +`void` + +#### Inherited from + +`ArkBaseModel.removeDecorator` + +*** + +### removeModifier() + +> **removeModifier**(`modifier`): `void` + +Defined in: src/core/model/ArkBaseModel.ts:146 + +#### Parameters + +##### modifier + +`ModifierType` + +#### Returns + +`void` + +#### Inherited from + +`ArkBaseModel.removeModifier` + +*** + +### setAsteriskToken() + +> **setAsteriskToken**(`asteriskToken`): `void` + +Defined in: src/core/model/ArkMethod.ts:554 + +#### Parameters + +##### asteriskToken + +`boolean` + +#### Returns + +`void` + +*** + +### setBody() + +> **setBody**(`body`): `void` + +Defined in: src/core/model/ArkMethod.ts:391 + +#### Parameters + +##### body + +[`ArkBody`](ArkBody.md) + +#### Returns + +`void` + +*** + +### setBodyBuilder() + +> **setBodyBuilder**(`bodyBuilder`): `void` + +Defined in: src/core/model/ArkMethod.ts:518 + +#### Parameters + +##### bodyBuilder + +`BodyBuilder` + +#### Returns + +`void` + +*** + +### setCode() + +> **setCode**(`code`): `void` + +Defined in: src/core/model/ArkMethod.ts:84 + +#### Parameters + +##### code + +`string` + +#### Returns + +`void` + +*** + +### setColumn() + +> **setColumn**(`column`): `void` + +Defined in: src/core/model/ArkMethod.ts:196 + +Set column of the implementation with column number input. +The column number will be encoded together with the original line number. + +#### Parameters + +##### column + +`number` + +the column number of the method implementation. + +#### Returns + +`void` + +*** + +### setDeclareLineCols() + +> **setDeclareLineCols**(`lineCols`): `void` + +Defined in: src/core/model/ArkMethod.ts:143 + +Set lineCols of the declarations directly with LineCol type input. + +#### Parameters + +##### lineCols + +`number`[] + +the encoded lines and columns with LineCol type. + +#### Returns + +`void` + +*** + +### setDeclareLinesAndCols() + +> **setDeclareLinesAndCols**(`lines`, `columns`): `void` + +Defined in: src/core/model/ArkMethod.ts:125 + +Set lines and columns of the declarations with number type inputs and then encoded them to LineCol type. +The length of lines and columns should be the same otherwise they cannot be encoded together. + +#### Parameters + +##### lines + +`number`[] + +the number of lines. + +##### columns + +`number`[] + +the number of columns. + +#### Returns + +`void` + +*** + +### setDeclareSignatures() + +> **setDeclareSignatures**(`signatures`): `void` + +Defined in: src/core/model/ArkMethod.ts:314 + +Set signatures of all declarations. +It will reset the declaration signatures if they are already defined before. + +#### Parameters + +##### signatures + +one signature or a list of signatures. + +[`MethodSignature`](MethodSignature.md) | [`MethodSignature`](MethodSignature.md)[] + +#### Returns + +`void` + +*** + +### setDeclareSignatureWithIndex() + +> **setDeclareSignatureWithIndex**(`signature`, `index`): `void` + +Defined in: src/core/model/ArkMethod.ts:329 + +Reset signature of one declaration with the specified index. +Will do nothing if the index doesn't exist. + +#### Parameters + +##### signature + +[`MethodSignature`](MethodSignature.md) + +new signature want to set. + +##### index + +`number` + +index of signature want to set. + +#### Returns + +`void` + +*** + +### setDeclaringArkClass() + +> **setDeclaringArkClass**(`declaringArkClass`): `void` + +Defined in: src/core/model/ArkMethod.ts:228 + +#### Parameters + +##### declaringArkClass + +[`ArkClass`](ArkClass.md) + +#### Returns + +`void` + +*** + +### setDecorators() + +> **setDecorators**(`decorators`): `void` + +Defined in: src/core/model/ArkBaseModel.ts:209 + +#### Parameters + +##### decorators + +`Set`\<[`Decorator`](Decorator.md)\> + +#### Returns + +`void` + +#### Inherited from + +`ArkBaseModel.setDecorators` + +*** + +### setGenericTypes() + +> **setGenericTypes**(`genericTypes`): `void` + +Defined in: src/core/model/ArkMethod.ts:358 + +#### Parameters + +##### genericTypes + +[`GenericType`](GenericType.md)[] + +#### Returns + +`void` + +*** + +### setImplementationSignature() + +> **setImplementationSignature**(`signature`): `void` + +Defined in: src/core/model/ArkMethod.ts:342 + +Set signature of implementation. +It will reset the implementation signature if it is already defined before. + +#### Parameters + +##### signature + +[`MethodSignature`](MethodSignature.md) + +signature of implementation. + +#### Returns + +`void` + +*** + +### setIsGeneratedFlag() + +> **setIsGeneratedFlag**(`isGeneratedFlag`): `void` + +Defined in: src/core/model/ArkMethod.ts:546 + +#### Parameters + +##### isGeneratedFlag + +`boolean` + +#### Returns + +`void` + +*** + +### setLine() + +> **setLine**(`line`): `void` + +Defined in: src/core/model/ArkMethod.ts:172 + +Set line of the implementation with line number input. +The line number will be encoded together with the original column number. + +#### Parameters + +##### line + +`number` + +the line number of the method implementation. + +#### Returns + +`void` + +*** + +### setLineCol() + +> **setLineCol**(`lineCol`): `void` + +Defined in: src/core/model/ArkMethod.ts:216 + +Set lineCol of the implementation directly with LineCol type input. + +#### Parameters + +##### lineCol + +`number` + +the encoded line and column with LineCol type. + +#### Returns + +`void` + +*** + +### setMetadata() + +> **setMetadata**(`kind`, `value`): `void` + +Defined in: src/core/model/ArkBaseModel.ts:122 + +#### Parameters + +##### kind + +`ArkMetadataKind` + +##### value + +`ArkMetadataType` + +#### Returns + +`void` + +#### Inherited from + +`ArkBaseModel.setMetadata` + +*** + +### setModifiers() + +> **setModifiers**(`modifiers`): `void` + +Defined in: src/core/model/ArkBaseModel.ts:136 + +#### Parameters + +##### modifiers + +`number` + +#### Returns + +`void` + +#### Inherited from + +`ArkBaseModel.setModifiers` + +*** + +### setOuterMethod() + +> **setOuterMethod**(`method`): `void` + +Defined in: src/core/model/ArkMethod.ts:653 + +#### Parameters + +##### method + +[`ArkMethod`](ArkMethod.md) + +#### Returns + +`void` + +*** + +### setViewTree() + +> **setViewTree**(`viewTree`): `void` + +Defined in: src/core/model/ArkMethod.ts:506 + +#### Parameters + +##### viewTree + +[`ViewTree`](../interfaces/ViewTree.md) + +#### Returns + +`void` + +*** + +### validate() + +> **validate**(): `ArkError` + +Defined in: src/core/model/ArkMethod.ts:558 + +#### Returns + +`ArkError` + +#### Overrides + +`ArkBaseModel.validate` + +*** + +### validateFields() + +> `protected` **validateFields**(`fields`): `ArkError` + +Defined in: src/core/model/ArkBaseModel.ts:267 + +#### Parameters + +##### fields + +`string`[] + +#### Returns + +`ArkError` + +#### Inherited from + +`ArkBaseModel.validateFields` diff --git a/docs/api_docs/classes/ArkNamespace.md b/docs/api_docs/classes/ArkNamespace.md new file mode 100644 index 0000000000000000000000000000000000000000..c1f2d4a15d12288e5bb74cfe2d51458886d5e3b9 --- /dev/null +++ b/docs/api_docs/classes/ArkNamespace.md @@ -0,0 +1,1167 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / ArkNamespace + +# Class: ArkNamespace + +Defined in: src/core/model/ArkNamespace.ts:29 + +## Extends + +- `ArkBaseModel` + +## Implements + +- `ArkExport` + +## Constructors + +### new ArkNamespace() + +> **new ArkNamespace**(): [`ArkNamespace`](ArkNamespace.md) + +Defined in: src/core/model/ArkNamespace.ts:50 + +#### Returns + +[`ArkNamespace`](ArkNamespace.md) + +#### Overrides + +`ArkBaseModel.constructor` + +## Properties + +### decorators? + +> `protected` `optional` **decorators**: `Set`\<[`Decorator`](Decorator.md)\> + +Defined in: src/core/model/ArkBaseModel.ts:115 + +#### Inherited from + +`ArkBaseModel.decorators` + +*** + +### metadata? + +> `protected` `optional` **metadata**: `ArkMetadata` + +Defined in: src/core/model/ArkBaseModel.ts:116 + +#### Inherited from + +`ArkBaseModel.metadata` + +*** + +### modifiers? + +> `protected` `optional` **modifiers**: `number` + +Defined in: src/core/model/ArkBaseModel.ts:114 + +#### Inherited from + +`ArkBaseModel.modifiers` + +## Methods + +### addArkClass() + +> **addArkClass**(`arkClass`): `void` + +Defined in: src/core/model/ArkNamespace.ts:148 + +#### Parameters + +##### arkClass + +[`ArkClass`](ArkClass.md) + +#### Returns + +`void` + +*** + +### addDecorator() + +> **addDecorator**(`decorator`): `void` + +Defined in: src/core/model/ArkBaseModel.ts:215 + +#### Parameters + +##### decorator + +[`Decorator`](Decorator.md) + +#### Returns + +`void` + +#### Inherited from + +`ArkBaseModel.addDecorator` + +*** + +### addExportInfo() + +> **addExportInfo**(`exportInfo`): `void` + +Defined in: src/core/model/ArkNamespace.ts:166 + +#### Parameters + +##### exportInfo + +[`ExportInfo`](ExportInfo.md) + +#### Returns + +`void` + +*** + +### addModifier() + +> **addModifier**(`modifier`): `void` + +Defined in: src/core/model/ArkBaseModel.ts:142 + +#### Parameters + +##### modifier + +`number` + +#### Returns + +`void` + +#### Inherited from + +`ArkBaseModel.addModifier` + +*** + +### addNamespace() + +> **addNamespace**(`namespace`): `void` + +Defined in: src/core/model/ArkNamespace.ts:54 + +#### Parameters + +##### namespace + +[`ArkNamespace`](ArkNamespace.md) + +#### Returns + +`void` + +*** + +### containsModifier() + +> **containsModifier**(`modifierType`): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:194 + +#### Parameters + +##### modifierType + +`ModifierType` + +#### Returns + +`boolean` + +#### Implementation of + +`ArkExport.containsModifier` + +#### Inherited from + +`ArkBaseModel.containsModifier` + +*** + +### getAllClassesUnderThisNamespace() + +> **getAllClassesUnderThisNamespace**(): [`ArkClass`](ArkClass.md)[] + +Defined in: src/core/model/ArkNamespace.ts:189 + +#### Returns + +[`ArkClass`](ArkClass.md)[] + +*** + +### getAllMethodsUnderThisNamespace() + +> **getAllMethodsUnderThisNamespace**(): [`ArkMethod`](ArkMethod.md)[] + +Defined in: src/core/model/ArkNamespace.ts:178 + +#### Returns + +[`ArkMethod`](ArkMethod.md)[] + +*** + +### getAllNamespacesUnderThisNamespace() + +> **getAllNamespacesUnderThisNamespace**(): [`ArkNamespace`](ArkNamespace.md)[] + +Defined in: src/core/model/ArkNamespace.ts:198 + +#### Returns + +[`ArkNamespace`](ArkNamespace.md)[] + +*** + +### getAnonymousClassNumber() + +> **getAnonymousClassNumber**(): `number` + +Defined in: src/core/model/ArkNamespace.ts:207 + +#### Returns + +`number` + +*** + +### getClass() + +> **getClass**(`classSignature`): `null` \| [`ArkClass`](ArkClass.md) + +Defined in: src/core/model/ArkNamespace.ts:135 + +#### Parameters + +##### classSignature + +[`ClassSignature`](ClassSignature.md) + +#### Returns + +`null` \| [`ArkClass`](ArkClass.md) + +*** + +### getClasses() + +> **getClasses**(): [`ArkClass`](ArkClass.md)[] + +Defined in: src/core/model/ArkNamespace.ts:144 + +#### Returns + +[`ArkClass`](ArkClass.md)[] + +*** + +### getClassWithName() + +> **getClassWithName**(`Class`): `null` \| [`ArkClass`](ArkClass.md) + +Defined in: src/core/model/ArkNamespace.ts:140 + +#### Parameters + +##### Class + +`string` + +#### Returns + +`null` \| [`ArkClass`](ArkClass.md) + +*** + +### getCode() + +> **getCode**(): `string` + +Defined in: src/core/model/ArkNamespace.ts:87 + +#### Returns + +`string` + +*** + +### getColumn() + +> **getColumn**(): `number` + +Defined in: src/core/model/ArkNamespace.ts:103 + +#### Returns + +`number` + +*** + +### getDeclaringArkFile() + +> **getDeclaringArkFile**(): [`ArkFile`](ArkFile.md) + +Defined in: src/core/model/ArkNamespace.ts:119 + +#### Returns + +[`ArkFile`](ArkFile.md) + +*** + +### getDeclaringArkNamespace() + +> **getDeclaringArkNamespace**(): `null` \| [`ArkNamespace`](ArkNamespace.md) + +Defined in: src/core/model/ArkNamespace.ts:127 + +#### Returns + +`null` \| [`ArkNamespace`](ArkNamespace.md) + +*** + +### getDeclaringInstance() + +> **getDeclaringInstance**(): [`ArkFile`](ArkFile.md) \| [`ArkNamespace`](ArkNamespace.md) + +Defined in: src/core/model/ArkNamespace.ts:111 + +#### Returns + +[`ArkFile`](ArkFile.md) \| [`ArkNamespace`](ArkNamespace.md) + +*** + +### getDecorators() + +> **getDecorators**(): [`Decorator`](Decorator.md)[] + +Defined in: src/core/model/ArkBaseModel.ts:202 + +#### Returns + +[`Decorator`](Decorator.md)[] + +#### Inherited from + +`ArkBaseModel.getDecorators` + +*** + +### getDefaultClass() + +> **getDefaultClass**(): [`ArkClass`](ArkClass.md) + +Defined in: src/core/model/ArkNamespace.ts:170 + +#### Returns + +[`ArkClass`](ArkClass.md) + +*** + +### getExportInfoBy() + +> **getExportInfoBy**(`name`): `undefined` \| [`ExportInfo`](ExportInfo.md) + +Defined in: src/core/model/ArkNamespace.ts:162 + +#### Parameters + +##### name + +`string` + +#### Returns + +`undefined` \| [`ExportInfo`](ExportInfo.md) + +*** + +### getExportInfos() + +> **getExportInfos**(): [`ExportInfo`](ExportInfo.md)[] + +Defined in: src/core/model/ArkNamespace.ts:152 + +#### Returns + +[`ExportInfo`](ExportInfo.md)[] + +*** + +### getExportType() + +> **getExportType**(): `ExportType` + +Defined in: src/core/model/ArkNamespace.ts:211 + +#### Returns + +`ExportType` + +#### Implementation of + +`ArkExport.getExportType` + +*** + +### getLine() + +> **getLine**(): `number` + +Defined in: src/core/model/ArkNamespace.ts:95 + +#### Returns + +`number` + +*** + +### getMetadata() + +> **getMetadata**(`kind`): `undefined` \| `ArkMetadataType` + +Defined in: src/core/model/ArkBaseModel.ts:118 + +#### Parameters + +##### kind + +`ArkMetadataKind` + +#### Returns + +`undefined` \| `ArkMetadataType` + +#### Inherited from + +`ArkBaseModel.getMetadata` + +*** + +### getModifiers() + +> **getModifiers**(): `number` + +Defined in: src/core/model/ArkBaseModel.ts:129 + +#### Returns + +`number` + +#### Implementation of + +`ArkExport.getModifiers` + +#### Inherited from + +`ArkBaseModel.getModifiers` + +*** + +### getName() + +> **getName**(): `string` + +Defined in: src/core/model/ArkNamespace.ts:83 + +#### Returns + +`string` + +#### Implementation of + +`ArkExport.getName` + +*** + +### getNamespace() + +> **getNamespace**(`namespaceSignature`): `null` \| [`ArkNamespace`](ArkNamespace.md) + +Defined in: src/core/model/ArkNamespace.ts:58 + +#### Parameters + +##### namespaceSignature + +[`NamespaceSignature`](NamespaceSignature.md) + +#### Returns + +`null` \| [`ArkNamespace`](ArkNamespace.md) + +*** + +### getNamespaces() + +> **getNamespaces**(): [`ArkNamespace`](ArkNamespace.md)[] + +Defined in: src/core/model/ArkNamespace.ts:67 + +#### Returns + +[`ArkNamespace`](ArkNamespace.md)[] + +*** + +### getNamespaceSignature() + +> **getNamespaceSignature**(): [`NamespaceSignature`](NamespaceSignature.md) + +Defined in: src/core/model/ArkNamespace.ts:79 + +#### Returns + +[`NamespaceSignature`](NamespaceSignature.md) + +*** + +### getNamespaceWithName() + +> **getNamespaceWithName**(`namespaceName`): `null` \| [`ArkNamespace`](ArkNamespace.md) + +Defined in: src/core/model/ArkNamespace.ts:63 + +#### Parameters + +##### namespaceName + +`string` + +#### Returns + +`null` \| [`ArkNamespace`](ArkNamespace.md) + +*** + +### getSignature() + +> **getSignature**(): [`NamespaceSignature`](NamespaceSignature.md) + +Defined in: src/core/model/ArkNamespace.ts:75 + +#### Returns + +[`NamespaceSignature`](NamespaceSignature.md) + +#### Implementation of + +`ArkExport.getSignature` + +*** + +### getStateDecorators() + +> **getStateDecorators**(): [`Decorator`](Decorator.md)[] + +Defined in: src/core/model/ArkBaseModel.ts:234 + +#### Returns + +[`Decorator`](Decorator.md)[] + +#### Inherited from + +`ArkBaseModel.getStateDecorators` + +*** + +### hasBuilderDecorator() + +> **hasBuilderDecorator**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:230 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.hasBuilderDecorator` + +*** + +### hasBuilderParamDecorator() + +> **hasBuilderParamDecorator**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:243 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.hasBuilderParamDecorator` + +*** + +### hasComponentDecorator() + +> **hasComponentDecorator**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:251 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.hasComponentDecorator` + +*** + +### hasDecorator() + +> **hasDecorator**(`kind`): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:255 + +#### Parameters + +##### kind + +`string` | `Set`\<`string`\> + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.hasDecorator` + +*** + +### hasEntryDecorator() + +> **hasEntryDecorator**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:247 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.hasEntryDecorator` + +*** + +### isAbstract() + +> **isAbstract**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:173 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.isAbstract` + +*** + +### isDeclare() + +> **isDeclare**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:190 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.isDeclare` + +*** + +### isDefault() + +> **isDefault**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:181 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.isDefault` + +*** + +### isExport() + +> **isExport**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:177 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.isExport` + +*** + +### ~~isExported()~~ + +> **isExported**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:186 + +#### Returns + +`boolean` + +#### Deprecated + +Use [isExport](ArkNamespace.md#isexport) instead. + +#### Inherited from + +`ArkBaseModel.isExported` + +*** + +### isPrivate() + +> **isPrivate**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:161 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.isPrivate` + +*** + +### isProtected() + +> **isProtected**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:157 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.isProtected` + +*** + +### isPublic() + +> **isPublic**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:165 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.isPublic` + +*** + +### isReadonly() + +> **isReadonly**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:169 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.isReadonly` + +*** + +### isStatic() + +> **isStatic**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:153 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.isStatic` + +*** + +### removeArkClass() + +> **removeArkClass**(`arkClass`): `boolean` + +Defined in: src/core/model/ArkNamespace.ts:215 + +#### Parameters + +##### arkClass + +[`ArkClass`](ArkClass.md) + +#### Returns + +`boolean` + +*** + +### removeDecorator() + +> **removeDecorator**(`kind`): `void` + +Defined in: src/core/model/ArkBaseModel.ts:222 + +#### Parameters + +##### kind + +`string` + +#### Returns + +`void` + +#### Inherited from + +`ArkBaseModel.removeDecorator` + +*** + +### removeModifier() + +> **removeModifier**(`modifier`): `void` + +Defined in: src/core/model/ArkBaseModel.ts:146 + +#### Parameters + +##### modifier + +`ModifierType` + +#### Returns + +`void` + +#### Inherited from + +`ArkBaseModel.removeModifier` + +*** + +### removeNamespace() + +> **removeNamespace**(`namespace`): `boolean` + +Defined in: src/core/model/ArkNamespace.ts:221 + +#### Parameters + +##### namespace + +[`ArkNamespace`](ArkNamespace.md) + +#### Returns + +`boolean` + +*** + +### setCode() + +> **setCode**(`code`): `void` + +Defined in: src/core/model/ArkNamespace.ts:91 + +#### Parameters + +##### code + +`string` + +#### Returns + +`void` + +*** + +### setColumn() + +> **setColumn**(`column`): `void` + +Defined in: src/core/model/ArkNamespace.ts:107 + +#### Parameters + +##### column + +`number` + +#### Returns + +`void` + +*** + +### setDeclaringArkFile() + +> **setDeclaringArkFile**(`declaringArkFile`): `void` + +Defined in: src/core/model/ArkNamespace.ts:123 + +#### Parameters + +##### declaringArkFile + +[`ArkFile`](ArkFile.md) + +#### Returns + +`void` + +*** + +### setDeclaringArkNamespace() + +> **setDeclaringArkNamespace**(`declaringArkNamespace`): `void` + +Defined in: src/core/model/ArkNamespace.ts:131 + +#### Parameters + +##### declaringArkNamespace + +[`ArkNamespace`](ArkNamespace.md) + +#### Returns + +`void` + +*** + +### setDeclaringInstance() + +> **setDeclaringInstance**(`declaringInstance`): `void` + +Defined in: src/core/model/ArkNamespace.ts:115 + +#### Parameters + +##### declaringInstance + +[`ArkFile`](ArkFile.md) | [`ArkNamespace`](ArkNamespace.md) + +#### Returns + +`void` + +*** + +### setDecorators() + +> **setDecorators**(`decorators`): `void` + +Defined in: src/core/model/ArkBaseModel.ts:209 + +#### Parameters + +##### decorators + +`Set`\<[`Decorator`](Decorator.md)\> + +#### Returns + +`void` + +#### Inherited from + +`ArkBaseModel.setDecorators` + +*** + +### setDefaultClass() + +> **setDefaultClass**(`defaultClass`): `void` + +Defined in: src/core/model/ArkNamespace.ts:174 + +#### Parameters + +##### defaultClass + +[`ArkClass`](ArkClass.md) + +#### Returns + +`void` + +*** + +### setLine() + +> **setLine**(`line`): `void` + +Defined in: src/core/model/ArkNamespace.ts:99 + +#### Parameters + +##### line + +`number` + +#### Returns + +`void` + +*** + +### setMetadata() + +> **setMetadata**(`kind`, `value`): `void` + +Defined in: src/core/model/ArkBaseModel.ts:122 + +#### Parameters + +##### kind + +`ArkMetadataKind` + +##### value + +`ArkMetadataType` + +#### Returns + +`void` + +#### Inherited from + +`ArkBaseModel.setMetadata` + +*** + +### setModifiers() + +> **setModifiers**(`modifiers`): `void` + +Defined in: src/core/model/ArkBaseModel.ts:136 + +#### Parameters + +##### modifiers + +`number` + +#### Returns + +`void` + +#### Inherited from + +`ArkBaseModel.setModifiers` + +*** + +### setSignature() + +> **setSignature**(`namespaceSignature`): `void` + +Defined in: src/core/model/ArkNamespace.ts:71 + +#### Parameters + +##### namespaceSignature + +[`NamespaceSignature`](NamespaceSignature.md) + +#### Returns + +`void` + +*** + +### validate() + +> **validate**(): `ArkError` + +Defined in: src/core/model/ArkNamespace.ts:227 + +#### Returns + +`ArkError` + +#### Overrides + +`ArkBaseModel.validate` + +*** + +### validateFields() + +> `protected` **validateFields**(`fields`): `ArkError` + +Defined in: src/core/model/ArkBaseModel.ts:267 + +#### Parameters + +##### fields + +`string`[] + +#### Returns + +`ArkError` + +#### Inherited from + +`ArkBaseModel.validateFields` diff --git a/docs/api_docs/classes/ArkNewArrayExpr.md b/docs/api_docs/classes/ArkNewArrayExpr.md new file mode 100644 index 0000000000000000000000000000000000000000..0028890ff1a1dd51a16aed13ec004396d13a1ed0 --- /dev/null +++ b/docs/api_docs/classes/ArkNewArrayExpr.md @@ -0,0 +1,213 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / ArkNewArrayExpr + +# Class: ArkNewArrayExpr + +Defined in: src/core/base/Expr.ts:334 + +## Extends + +- [`AbstractExpr`](AbstractExpr.md) + +## Constructors + +### new ArkNewArrayExpr() + +> **new ArkNewArrayExpr**(`baseType`, `size`, `fromLiteral`): [`ArkNewArrayExpr`](ArkNewArrayExpr.md) + +Defined in: src/core/base/Expr.ts:340 + +#### Parameters + +##### baseType + +[`Type`](Type.md) + +##### size + +[`Value`](../interfaces/Value.md) + +##### fromLiteral + +`boolean` = `false` + +#### Returns + +[`ArkNewArrayExpr`](ArkNewArrayExpr.md) + +#### Overrides + +[`AbstractExpr`](AbstractExpr.md).[`constructor`](AbstractExpr.md#constructors) + +## Methods + +### getBaseType() + +> **getBaseType**(): [`Type`](Type.md) + +Defined in: src/core/base/Expr.ts:359 + +#### Returns + +[`Type`](Type.md) + +*** + +### getSize() + +> **getSize**(): [`Value`](../interfaces/Value.md) + +Defined in: src/core/base/Expr.ts:347 + +#### Returns + +[`Value`](../interfaces/Value.md) + +*** + +### getType() + +> **getType**(): [`ArrayType`](ArrayType.md) + +Defined in: src/core/base/Expr.ts:355 + +Return the type of this value. The interface is encapsulated in [Value](../interfaces/Value.md). +The `Type` is defined in type.ts, such as **Any**, **Unknown**, **TypeParameter**, +**UnclearReference**, **Primitive**, **Number**, **String**, etc. + +#### Returns + +[`ArrayType`](ArrayType.md) + +The type of this value. + +#### Example + +1. In the declaration statement, determine the left-value type and right-value type. + +```typescript +let leftValue:Value; +let rightValue:Value; +... +if (leftValue.getType() instanceof UnknownType && + !(rightValue.getType() instanceof UnknownType) && + !(rightValue.getType() instanceof UndefinedType)) { + ... +} +``` + +#### Overrides + +[`AbstractExpr`](AbstractExpr.md).[`getType`](AbstractExpr.md#gettype) + +*** + +### getUses() + +> **getUses**(): [`Value`](../interfaces/Value.md)[] + +Defined in: src/core/base/Expr.ts:379 + +Return a list of values which are contained in this [Value](../interfaces/Value.md). +Value is a core interface in ArkAnalyzer, which may represent any value or expression. + +#### Returns + +[`Value`](../interfaces/Value.md)[] + +An **array** of values used by this value. + +#### Overrides + +[`AbstractExpr`](AbstractExpr.md).[`getUses`](AbstractExpr.md#getuses) + +*** + +### inferType() + +> **inferType**(`arkMethod`): [`ArkNewArrayExpr`](ArkNewArrayExpr.md) + +Defined in: src/core/base/Expr.ts:371 + +#### Parameters + +##### arkMethod + +[`ArkMethod`](ArkMethod.md) + +#### Returns + +[`ArkNewArrayExpr`](ArkNewArrayExpr.md) + +#### Overrides + +[`AbstractExpr`](AbstractExpr.md).[`inferType`](AbstractExpr.md#infertype) + +*** + +### isFromLiteral() + +> **isFromLiteral**(): `boolean` + +Defined in: src/core/base/Expr.ts:367 + +#### Returns + +`boolean` + +*** + +### setBaseType() + +> **setBaseType**(`newType`): `void` + +Defined in: src/core/base/Expr.ts:363 + +#### Parameters + +##### newType + +[`Type`](Type.md) + +#### Returns + +`void` + +*** + +### setSize() + +> **setSize**(`newSize`): `void` + +Defined in: src/core/base/Expr.ts:351 + +#### Parameters + +##### newSize + +[`Value`](../interfaces/Value.md) + +#### Returns + +`void` + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/base/Expr.ts:385 + +Returns a string representation of an object. + +#### Returns + +`string` + +#### Overrides + +[`AbstractExpr`](AbstractExpr.md).[`toString`](AbstractExpr.md#tostring) diff --git a/docs/api_docs/classes/ArkNewExpr.md b/docs/api_docs/classes/ArkNewExpr.md new file mode 100644 index 0000000000000000000000000000000000000000..821a97efa83eadf87e8094dd986d803c2d716ddf --- /dev/null +++ b/docs/api_docs/classes/ArkNewExpr.md @@ -0,0 +1,145 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / ArkNewExpr + +# Class: ArkNewExpr + +Defined in: src/core/base/Expr.ts:296 + +## Extends + +- [`AbstractExpr`](AbstractExpr.md) + +## Constructors + +### new ArkNewExpr() + +> **new ArkNewExpr**(`classType`): [`ArkNewExpr`](ArkNewExpr.md) + +Defined in: src/core/base/Expr.ts:299 + +#### Parameters + +##### classType + +[`ClassType`](ClassType.md) + +#### Returns + +[`ArkNewExpr`](ArkNewExpr.md) + +#### Overrides + +[`AbstractExpr`](AbstractExpr.md).[`constructor`](AbstractExpr.md#constructors) + +## Methods + +### getClassType() + +> **getClassType**(): [`ClassType`](ClassType.md) + +Defined in: src/core/base/Expr.ts:304 + +#### Returns + +[`ClassType`](ClassType.md) + +*** + +### getType() + +> **getType**(): [`Type`](Type.md) + +Defined in: src/core/base/Expr.ts:312 + +Return the type of this value. The interface is encapsulated in [Value](../interfaces/Value.md). +The `Type` is defined in type.ts, such as **Any**, **Unknown**, **TypeParameter**, +**UnclearReference**, **Primitive**, **Number**, **String**, etc. + +#### Returns + +[`Type`](Type.md) + +The type of this value. + +#### Example + +1. In the declaration statement, determine the left-value type and right-value type. + +```typescript +let leftValue:Value; +let rightValue:Value; +... +if (leftValue.getType() instanceof UnknownType && + !(rightValue.getType() instanceof UnknownType) && + !(rightValue.getType() instanceof UndefinedType)) { + ... +} +``` + +#### Overrides + +[`AbstractExpr`](AbstractExpr.md).[`getType`](AbstractExpr.md#gettype) + +*** + +### getUses() + +> **getUses**(): [`Value`](../interfaces/Value.md)[] + +Defined in: src/core/base/Expr.ts:308 + +Return a list of values which are contained in this [Value](../interfaces/Value.md). +Value is a core interface in ArkAnalyzer, which may represent any value or expression. + +#### Returns + +[`Value`](../interfaces/Value.md)[] + +An **array** of values used by this value. + +#### Overrides + +[`AbstractExpr`](AbstractExpr.md).[`getUses`](AbstractExpr.md#getuses) + +*** + +### inferType() + +> **inferType**(`arkMethod`): [`ArkNewExpr`](ArkNewExpr.md) + +Defined in: src/core/base/Expr.ts:320 + +#### Parameters + +##### arkMethod + +[`ArkMethod`](ArkMethod.md) + +#### Returns + +[`ArkNewExpr`](ArkNewExpr.md) + +#### Overrides + +[`AbstractExpr`](AbstractExpr.md).[`inferType`](AbstractExpr.md#infertype) + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/base/Expr.ts:316 + +Returns a string representation of an object. + +#### Returns + +`string` + +#### Overrides + +[`AbstractExpr`](AbstractExpr.md).[`toString`](AbstractExpr.md#tostring) diff --git a/docs/api_docs/classes/ArkNormalBinopExpr.md b/docs/api_docs/classes/ArkNormalBinopExpr.md new file mode 100644 index 0000000000000000000000000000000000000000..b968bbc8a50498951323f676ea94510c08ec866a --- /dev/null +++ b/docs/api_docs/classes/ArkNormalBinopExpr.md @@ -0,0 +1,350 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / ArkNormalBinopExpr + +# Class: ArkNormalBinopExpr + +Defined in: src/core/base/Expr.ts:723 + +## Extends + +- [`AbstractBinopExpr`](AbstractBinopExpr.md) + +## Constructors + +### new ArkNormalBinopExpr() + +> **new ArkNormalBinopExpr**(`op1`, `op2`, `operator`): [`ArkNormalBinopExpr`](ArkNormalBinopExpr.md) + +Defined in: src/core/base/Expr.ts:724 + +#### Parameters + +##### op1 + +[`Value`](../interfaces/Value.md) + +##### op2 + +[`Value`](../interfaces/Value.md) + +##### operator + +[`NormalBinaryOperator`](../enumerations/NormalBinaryOperator.md) + +#### Returns + +[`ArkNormalBinopExpr`](ArkNormalBinopExpr.md) + +#### Overrides + +[`AbstractBinopExpr`](AbstractBinopExpr.md).[`constructor`](AbstractBinopExpr.md#constructors) + +## Properties + +### op1 + +> `protected` **op1**: [`Value`](../interfaces/Value.md) + +Defined in: src/core/base/Expr.ts:543 + +#### Inherited from + +[`AbstractBinopExpr`](AbstractBinopExpr.md).[`op1`](AbstractBinopExpr.md#op1-1) + +*** + +### op2 + +> `protected` **op2**: [`Value`](../interfaces/Value.md) + +Defined in: src/core/base/Expr.ts:544 + +#### Inherited from + +[`AbstractBinopExpr`](AbstractBinopExpr.md).[`op2`](AbstractBinopExpr.md#op2-1) + +*** + +### operator + +> `protected` **operator**: [`BinaryOperator`](../type-aliases/BinaryOperator.md) + +Defined in: src/core/base/Expr.ts:545 + +#### Inherited from + +[`AbstractBinopExpr`](AbstractBinopExpr.md).[`operator`](AbstractBinopExpr.md#operator-1) + +*** + +### type + +> `protected` **type**: [`Type`](Type.md) + +Defined in: src/core/base/Expr.ts:547 + +#### Inherited from + +[`AbstractBinopExpr`](AbstractBinopExpr.md).[`type`](AbstractBinopExpr.md#type) + +## Methods + +### getOp1() + +> **getOp1**(): [`Value`](../interfaces/Value.md) + +Defined in: src/core/base/Expr.ts:561 + +Returns the first operand in the binary operation expression. +For example, the first operand in `a + b;` is `a`. + +#### Returns + +[`Value`](../interfaces/Value.md) + +The first operand in the binary operation expression. + +#### Inherited from + +[`AbstractBinopExpr`](AbstractBinopExpr.md).[`getOp1`](AbstractBinopExpr.md#getop1) + +*** + +### getOp2() + +> **getOp2**(): [`Value`](../interfaces/Value.md) + +Defined in: src/core/base/Expr.ts:574 + +Returns the second operand in the binary operation expression. +For example, the second operand in `a + b;` is `b`. + +#### Returns + +[`Value`](../interfaces/Value.md) + +The second operand in the binary operation expression. + +#### Inherited from + +[`AbstractBinopExpr`](AbstractBinopExpr.md).[`getOp2`](AbstractBinopExpr.md#getop2) + +*** + +### getOperator() + +> **getOperator**(): [`BinaryOperator`](../type-aliases/BinaryOperator.md) + +Defined in: src/core/base/Expr.ts:597 + +Get the binary operator from the statement. +The binary operator can be divided into two categories, +one is the normal binary operator and the other is relational binary operator. + +#### Returns + +[`BinaryOperator`](../type-aliases/BinaryOperator.md) + +The binary operator from the statement. + +#### Example + +```typescript +if (expr instanceof AbstractBinopExpr) { +let op1: Value = expr.getOp1(); +let op2: Value = expr.getOp2(); +let operator: string = expr.getOperator(); +... ... +} +``` + +#### Inherited from + +[`AbstractBinopExpr`](AbstractBinopExpr.md).[`getOperator`](AbstractBinopExpr.md#getoperator) + +*** + +### getType() + +> **getType**(): [`Type`](Type.md) + +Defined in: src/core/base/Expr.ts:601 + +Return the type of this value. The interface is encapsulated in [Value](../interfaces/Value.md). +The `Type` is defined in type.ts, such as **Any**, **Unknown**, **TypeParameter**, +**UnclearReference**, **Primitive**, **Number**, **String**, etc. + +#### Returns + +[`Type`](Type.md) + +The type of this value. + +#### Example + +1. In the declaration statement, determine the left-value type and right-value type. + +```typescript +let leftValue:Value; +let rightValue:Value; +... +if (leftValue.getType() instanceof UnknownType && + !(rightValue.getType() instanceof UnknownType) && + !(rightValue.getType() instanceof UndefinedType)) { + ... +} +``` + +#### Inherited from + +[`AbstractBinopExpr`](AbstractBinopExpr.md).[`getType`](AbstractBinopExpr.md#gettype) + +*** + +### getUses() + +> **getUses**(): [`Value`](../interfaces/Value.md)[] + +Defined in: src/core/base/Expr.ts:608 + +Return a list of values which are contained in this [Value](../interfaces/Value.md). +Value is a core interface in ArkAnalyzer, which may represent any value or expression. + +#### Returns + +[`Value`](../interfaces/Value.md)[] + +An **array** of values used by this value. + +#### Inherited from + +[`AbstractBinopExpr`](AbstractBinopExpr.md).[`getUses`](AbstractBinopExpr.md#getuses) + +*** + +### inferOpType() + +> `protected` **inferOpType**(`op`, `arkMethod`): `void` + +Defined in: src/core/base/Expr.ts:621 + +#### Parameters + +##### op + +[`Value`](../interfaces/Value.md) + +##### arkMethod + +[`ArkMethod`](ArkMethod.md) + +#### Returns + +`void` + +#### Inherited from + +[`AbstractBinopExpr`](AbstractBinopExpr.md).[`inferOpType`](AbstractBinopExpr.md#inferoptype) + +*** + +### inferType() + +> **inferType**(`arkMethod`): [`AbstractBinopExpr`](AbstractBinopExpr.md) + +Defined in: src/core/base/Expr.ts:691 + +#### Parameters + +##### arkMethod + +[`ArkMethod`](ArkMethod.md) + +#### Returns + +[`AbstractBinopExpr`](AbstractBinopExpr.md) + +#### Inherited from + +[`AbstractBinopExpr`](AbstractBinopExpr.md).[`inferType`](AbstractBinopExpr.md#infertype) + +*** + +### setOp1() + +> **setOp1**(`newOp1`): `void` + +Defined in: src/core/base/Expr.ts:565 + +#### Parameters + +##### newOp1 + +[`Value`](../interfaces/Value.md) + +#### Returns + +`void` + +#### Inherited from + +[`AbstractBinopExpr`](AbstractBinopExpr.md).[`setOp1`](AbstractBinopExpr.md#setop1) + +*** + +### setOp2() + +> **setOp2**(`newOp2`): `void` + +Defined in: src/core/base/Expr.ts:578 + +#### Parameters + +##### newOp2 + +[`Value`](../interfaces/Value.md) + +#### Returns + +`void` + +#### Inherited from + +[`AbstractBinopExpr`](AbstractBinopExpr.md).[`setOp2`](AbstractBinopExpr.md#setop2) + +*** + +### setType() + +> `protected` **setType**(): `void` + +Defined in: src/core/base/Expr.ts:627 + +#### Returns + +`void` + +#### Inherited from + +[`AbstractBinopExpr`](AbstractBinopExpr.md).[`setType`](AbstractBinopExpr.md#settype) + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/base/Expr.ts:617 + +Returns a string representation of an object. + +#### Returns + +`string` + +#### Inherited from + +[`AbstractBinopExpr`](AbstractBinopExpr.md).[`toString`](AbstractBinopExpr.md#tostring) diff --git a/docs/api_docs/classes/ArkParameterRef.md b/docs/api_docs/classes/ArkParameterRef.md new file mode 100644 index 0000000000000000000000000000000000000000..3d55799234394fedc08eeb736f0a34a736ff0a18 --- /dev/null +++ b/docs/api_docs/classes/ArkParameterRef.md @@ -0,0 +1,181 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / ArkParameterRef + +# Class: ArkParameterRef + +Defined in: src/core/base/Ref.ts:237 + +## Extends + +- [`AbstractRef`](AbstractRef.md) + +## Constructors + +### new ArkParameterRef() + +> **new ArkParameterRef**(`index`, `paramType`): [`ArkParameterRef`](ArkParameterRef.md) + +Defined in: src/core/base/Ref.ts:241 + +#### Parameters + +##### index + +`number` + +##### paramType + +[`Type`](Type.md) + +#### Returns + +[`ArkParameterRef`](ArkParameterRef.md) + +#### Overrides + +[`AbstractRef`](AbstractRef.md).[`constructor`](AbstractRef.md#constructors) + +## Methods + +### getIndex() + +> **getIndex**(): `number` + +Defined in: src/core/base/Ref.ts:247 + +#### Returns + +`number` + +*** + +### getType() + +> **getType**(): [`Type`](Type.md) + +Defined in: src/core/base/Ref.ts:255 + +Return the type of this value. The interface is encapsulated in [Value](../interfaces/Value.md). +The `Type` is defined in type.ts, such as **Any**, **Unknown**, **TypeParameter**, +**UnclearReference**, **Primitive**, **Number**, **String**, etc. + +#### Returns + +[`Type`](Type.md) + +The type of this value. + +#### Example + +1. In the declaration statement, determine the left-value type and right-value type. + +```typescript +let leftValue:Value; +let rightValue:Value; +... +if (leftValue.getType() instanceof UnknownType && + !(rightValue.getType() instanceof UnknownType) && + !(rightValue.getType() instanceof UndefinedType)) { + ... +} +``` + +#### Overrides + +[`AbstractRef`](AbstractRef.md).[`getType`](AbstractRef.md#gettype) + +*** + +### getUses() + +> **getUses**(): [`Value`](../interfaces/Value.md)[] + +Defined in: src/core/base/Ref.ts:278 + +Return a list of values which are contained in this [Value](../interfaces/Value.md). +Value is a core interface in ArkAnalyzer, which may represent any value or expression. + +#### Returns + +[`Value`](../interfaces/Value.md)[] + +An **array** of values used by this value. + +#### Overrides + +[`AbstractRef`](AbstractRef.md).[`getUses`](AbstractRef.md#getuses) + +*** + +### inferType() + +> **inferType**(`arkMethod`): [`AbstractRef`](AbstractRef.md) + +Defined in: src/core/base/Ref.ts:263 + +#### Parameters + +##### arkMethod + +[`ArkMethod`](ArkMethod.md) + +#### Returns + +[`AbstractRef`](AbstractRef.md) + +#### Overrides + +[`AbstractRef`](AbstractRef.md).[`inferType`](AbstractRef.md#infertype) + +*** + +### setIndex() + +> **setIndex**(`index`): `void` + +Defined in: src/core/base/Ref.ts:251 + +#### Parameters + +##### index + +`number` + +#### Returns + +`void` + +*** + +### setType() + +> **setType**(`newType`): `void` + +Defined in: src/core/base/Ref.ts:259 + +#### Parameters + +##### newType + +[`Type`](Type.md) + +#### Returns + +`void` + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/base/Ref.ts:282 + +Returns a string representation of an object. + +#### Returns + +`string` diff --git a/docs/api_docs/classes/ArkPhiExpr.md b/docs/api_docs/classes/ArkPhiExpr.md new file mode 100644 index 0000000000000000000000000000000000000000..c06692ace0d7a181716ebcd811f9e3d3e47fd51b --- /dev/null +++ b/docs/api_docs/classes/ArkPhiExpr.md @@ -0,0 +1,187 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / ArkPhiExpr + +# Class: ArkPhiExpr + +Defined in: src/core/base/Expr.ts:844 + +## Extends + +- [`AbstractExpr`](AbstractExpr.md) + +## Constructors + +### new ArkPhiExpr() + +> **new ArkPhiExpr**(): [`ArkPhiExpr`](ArkPhiExpr.md) + +Defined in: src/core/base/Expr.ts:848 + +#### Returns + +[`ArkPhiExpr`](ArkPhiExpr.md) + +#### Overrides + +[`AbstractExpr`](AbstractExpr.md).[`constructor`](AbstractExpr.md#constructors) + +## Methods + +### getArgs() + +> **getArgs**(): [`Local`](Local.md)[] + +Defined in: src/core/base/Expr.ts:860 + +#### Returns + +[`Local`](Local.md)[] + +*** + +### getArgToBlock() + +> **getArgToBlock**(): `Map`\<[`Local`](Local.md), [`BasicBlock`](BasicBlock.md)\> + +Defined in: src/core/base/Expr.ts:868 + +#### Returns + +`Map`\<[`Local`](Local.md), [`BasicBlock`](BasicBlock.md)\> + +*** + +### getType() + +> **getType**(): [`Type`](Type.md) + +Defined in: src/core/base/Expr.ts:876 + +Return the type of this value. The interface is encapsulated in [Value](../interfaces/Value.md). +The `Type` is defined in type.ts, such as **Any**, **Unknown**, **TypeParameter**, +**UnclearReference**, **Primitive**, **Number**, **String**, etc. + +#### Returns + +[`Type`](Type.md) + +The type of this value. + +#### Example + +1. In the declaration statement, determine the left-value type and right-value type. + +```typescript +let leftValue:Value; +let rightValue:Value; +... +if (leftValue.getType() instanceof UnknownType && + !(rightValue.getType() instanceof UnknownType) && + !(rightValue.getType() instanceof UndefinedType)) { + ... +} +``` + +#### Overrides + +[`AbstractExpr`](AbstractExpr.md).[`getType`](AbstractExpr.md#gettype) + +*** + +### getUses() + +> **getUses**(): [`Value`](../interfaces/Value.md)[] + +Defined in: src/core/base/Expr.ts:854 + +Return a list of values which are contained in this [Value](../interfaces/Value.md). +Value is a core interface in ArkAnalyzer, which may represent any value or expression. + +#### Returns + +[`Value`](../interfaces/Value.md)[] + +An **array** of values used by this value. + +#### Overrides + +[`AbstractExpr`](AbstractExpr.md).[`getUses`](AbstractExpr.md#getuses) + +*** + +### inferType() + +> **inferType**(`arkMethod`): [`AbstractExpr`](AbstractExpr.md) + +Defined in: src/core/base/Expr.ts:54 + +#### Parameters + +##### arkMethod + +[`ArkMethod`](ArkMethod.md) + +#### Returns + +[`AbstractExpr`](AbstractExpr.md) + +#### Inherited from + +[`AbstractExpr`](AbstractExpr.md).[`inferType`](AbstractExpr.md#infertype) + +*** + +### setArgs() + +> **setArgs**(`args`): `void` + +Defined in: src/core/base/Expr.ts:864 + +#### Parameters + +##### args + +[`Local`](Local.md)[] + +#### Returns + +`void` + +*** + +### setArgToBlock() + +> **setArgToBlock**(`argToBlock`): `void` + +Defined in: src/core/base/Expr.ts:872 + +#### Parameters + +##### argToBlock + +`Map`\<[`Local`](Local.md), [`BasicBlock`](BasicBlock.md)\> + +#### Returns + +`void` + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/base/Expr.ts:880 + +Returns a string representation of an object. + +#### Returns + +`string` + +#### Overrides + +[`AbstractExpr`](AbstractExpr.md).[`toString`](AbstractExpr.md#tostring) diff --git a/docs/api_docs/classes/ArkPtrInvokeExpr.md b/docs/api_docs/classes/ArkPtrInvokeExpr.md new file mode 100644 index 0000000000000000000000000000000000000000..2a6b2c783b618a9d776f802899e2e395496863bf --- /dev/null +++ b/docs/api_docs/classes/ArkPtrInvokeExpr.md @@ -0,0 +1,357 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / ArkPtrInvokeExpr + +# Class: ArkPtrInvokeExpr + +Defined in: src/core/base/Expr.ts:248 + +## Extends + +- [`AbstractInvokeExpr`](AbstractInvokeExpr.md) + +## Constructors + +### new ArkPtrInvokeExpr() + +> **new ArkPtrInvokeExpr**(`methodSignature`, `ptr`, `args`, `realGenericTypes`?): [`ArkPtrInvokeExpr`](ArkPtrInvokeExpr.md) + +Defined in: src/core/base/Expr.ts:251 + +#### Parameters + +##### methodSignature + +[`MethodSignature`](MethodSignature.md) + +##### ptr + +[`Local`](Local.md) + +##### args + +[`Value`](../interfaces/Value.md)[] + +##### realGenericTypes? + +[`Type`](Type.md)[] + +#### Returns + +[`ArkPtrInvokeExpr`](ArkPtrInvokeExpr.md) + +#### Overrides + +[`AbstractInvokeExpr`](AbstractInvokeExpr.md).[`constructor`](AbstractInvokeExpr.md#constructors) + +## Methods + +### getArg() + +> **getArg**(`index`): [`Value`](../interfaces/Value.md) + +Defined in: src/core/base/Expr.ts:98 + +Returns an argument used in the expression according to its index. + +#### Parameters + +##### index + +`number` + +the index of the argument. + +#### Returns + +[`Value`](../interfaces/Value.md) + +An argument used in the expression. + +#### Inherited from + +[`AbstractInvokeExpr`](AbstractInvokeExpr.md).[`getArg`](AbstractInvokeExpr.md#getarg) + +*** + +### getArgs() + +> **getArgs**(): [`Value`](../interfaces/Value.md)[] + +Defined in: src/core/base/Expr.ts:124 + +Returns an **array** of arguments used in the expression. + +#### Returns + +[`Value`](../interfaces/Value.md)[] + +An **array** of arguments used in the expression. + +#### Example + +1. get args number. + +```typescript +const argsNum = expr.getArgs().length; +if (argsNum < 5) { +... ... +} +``` + +2. iterate arg based on expression + +```typescript +for (const arg of this.getArgs()) { +strs.push(arg.toString()); +strs.push(', '); +} +``` + +#### Inherited from + +[`AbstractInvokeExpr`](AbstractInvokeExpr.md).[`getArgs`](AbstractInvokeExpr.md#getargs) + +*** + +### getFuncPtrLocal() + +> **getFuncPtrLocal**(): [`Local`](Local.md) + +Defined in: src/core/base/Expr.ts:260 + +#### Returns + +[`Local`](Local.md) + +*** + +### getMethodSignature() + +> **getMethodSignature**(): [`MethodSignature`](MethodSignature.md) + +Defined in: src/core/base/Expr.ts:85 + +Get method Signature. The method signature is consist of ClassSignature and MethodSubSignature. +It is the unique flag of a method. It is usually used to compose a expression string in ArkIRTransformer. + +#### Returns + +[`MethodSignature`](MethodSignature.md) + +The class method signature, such as ArkStaticInvokeExpr. + +#### Example + +1. 3AC information composed of getMethodSignature (). + +```typescript +let strs: string[] = []; +strs.push('staticinvoke <'); +strs.push(this.getMethodSignature().toString()); +strs.push('>('); +``` + +#### Inherited from + +[`AbstractInvokeExpr`](AbstractInvokeExpr.md).[`getMethodSignature`](AbstractInvokeExpr.md#getmethodsignature) + +*** + +### getRealGenericTypes() + +> **getRealGenericTypes**(): `undefined` \| [`Type`](Type.md)[] + +Defined in: src/core/base/Expr.ts:140 + +#### Returns + +`undefined` \| [`Type`](Type.md)[] + +#### Inherited from + +[`AbstractInvokeExpr`](AbstractInvokeExpr.md).[`getRealGenericTypes`](AbstractInvokeExpr.md#getrealgenerictypes) + +*** + +### getType() + +> **getType**(): [`Type`](Type.md) + +Defined in: src/core/base/Expr.ts:132 + +Return the type of this value. The interface is encapsulated in [Value](../interfaces/Value.md). +The `Type` is defined in type.ts, such as **Any**, **Unknown**, **TypeParameter**, +**UnclearReference**, **Primitive**, **Number**, **String**, etc. + +#### Returns + +[`Type`](Type.md) + +The type of this value. + +#### Example + +1. In the declaration statement, determine the left-value type and right-value type. + +```typescript +let leftValue:Value; +let rightValue:Value; +... +if (leftValue.getType() instanceof UnknownType && + !(rightValue.getType() instanceof UnknownType) && + !(rightValue.getType() instanceof UndefinedType)) { + ... +} +``` + +#### Inherited from + +[`AbstractInvokeExpr`](AbstractInvokeExpr.md).[`getType`](AbstractInvokeExpr.md#gettype) + +*** + +### getUses() + +> **getUses**(): [`Value`](../interfaces/Value.md)[] + +Defined in: src/core/base/Expr.ts:285 + +Return a list of values which are contained in this [Value](../interfaces/Value.md). +Value is a core interface in ArkAnalyzer, which may represent any value or expression. + +#### Returns + +[`Value`](../interfaces/Value.md)[] + +An **array** of values used by this value. + +#### Overrides + +[`AbstractInvokeExpr`](AbstractInvokeExpr.md).[`getUses`](AbstractInvokeExpr.md#getuses) + +*** + +### inferType() + +> **inferType**(`arkMethod`): [`ArkPtrInvokeExpr`](ArkPtrInvokeExpr.md) + +Defined in: src/core/base/Expr.ts:280 + +#### Parameters + +##### arkMethod + +[`ArkMethod`](ArkMethod.md) + +#### Returns + +[`ArkPtrInvokeExpr`](ArkPtrInvokeExpr.md) + +#### Overrides + +[`AbstractInvokeExpr`](AbstractInvokeExpr.md).[`inferType`](AbstractInvokeExpr.md#infertype) + +*** + +### setArgs() + +> **setArgs**(`newArgs`): `void` + +Defined in: src/core/base/Expr.ts:128 + +#### Parameters + +##### newArgs + +[`Value`](../interfaces/Value.md)[] + +#### Returns + +`void` + +#### Inherited from + +[`AbstractInvokeExpr`](AbstractInvokeExpr.md).[`setArgs`](AbstractInvokeExpr.md#setargs) + +*** + +### setFunPtrLocal() + +> **setFunPtrLocal**(`ptr`): `void` + +Defined in: src/core/base/Expr.ts:256 + +#### Parameters + +##### ptr + +[`Local`](Local.md) + +#### Returns + +`void` + +*** + +### setMethodSignature() + +> **setMethodSignature**(`newMethodSignature`): `void` + +Defined in: src/core/base/Expr.ts:89 + +#### Parameters + +##### newMethodSignature + +[`MethodSignature`](MethodSignature.md) + +#### Returns + +`void` + +#### Inherited from + +[`AbstractInvokeExpr`](AbstractInvokeExpr.md).[`setMethodSignature`](AbstractInvokeExpr.md#setmethodsignature) + +*** + +### setRealGenericTypes() + +> **setRealGenericTypes**(`realTypes`): `void` + +Defined in: src/core/base/Expr.ts:144 + +#### Parameters + +##### realTypes + +`undefined` | [`Type`](Type.md)[] + +#### Returns + +`void` + +#### Inherited from + +[`AbstractInvokeExpr`](AbstractInvokeExpr.md).[`setRealGenericTypes`](AbstractInvokeExpr.md#setrealgenerictypes) + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/base/Expr.ts:264 + +Returns a string representation of an object. + +#### Returns + +`string` + +#### Overrides + +[`AbstractInvokeExpr`](AbstractInvokeExpr.md).[`toString`](AbstractInvokeExpr.md#tostring) diff --git a/docs/api_docs/classes/ArkReturnStmt.md b/docs/api_docs/classes/ArkReturnStmt.md new file mode 100644 index 0000000000000000000000000000000000000000..ad5a2d8427e32916be75201d0b2597c3551070a4 --- /dev/null +++ b/docs/api_docs/classes/ArkReturnStmt.md @@ -0,0 +1,734 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / ArkReturnStmt + +# Class: ArkReturnStmt + +Defined in: src/core/base/Stmt.ts:443 + +## Extends + +- [`Stmt`](Stmt.md) + +## Constructors + +### new ArkReturnStmt() + +> **new ArkReturnStmt**(`op`): [`ArkReturnStmt`](ArkReturnStmt.md) + +Defined in: src/core/base/Stmt.ts:446 + +#### Parameters + +##### op + +[`Value`](../interfaces/Value.md) + +#### Returns + +[`ArkReturnStmt`](ArkReturnStmt.md) + +#### Overrides + +[`Stmt`](Stmt.md).[`constructor`](Stmt.md#constructors) + +## Properties + +### cfg + +> `protected` **cfg**: [`Cfg`](Cfg.md) + +Defined in: src/core/base/Stmt.ts:35 + +#### Inherited from + +[`Stmt`](Stmt.md).[`cfg`](Stmt.md#cfg) + +*** + +### metadata? + +> `optional` **metadata**: `ArkMetadata` + +Defined in: src/core/base/Stmt.ts:38 + +#### Inherited from + +[`Stmt`](Stmt.md).[`metadata`](Stmt.md#metadata) + +*** + +### operandOriginalPositions? + +> `protected` `optional` **operandOriginalPositions**: [`FullPosition`](FullPosition.md)[] + +Defined in: src/core/base/Stmt.ts:36 + +#### Inherited from + +[`Stmt`](Stmt.md).[`operandOriginalPositions`](Stmt.md#operandoriginalpositions) + +*** + +### originalPosition + +> `protected` **originalPosition**: [`LineColPosition`](LineColPosition.md) = `LineColPosition.DEFAULT` + +Defined in: src/core/base/Stmt.ts:34 + +#### Inherited from + +[`Stmt`](Stmt.md).[`originalPosition`](Stmt.md#originalposition) + +*** + +### originalText? + +> `protected` `optional` **originalText**: `string` + +Defined in: src/core/base/Stmt.ts:33 + +#### Inherited from + +[`Stmt`](Stmt.md).[`originalText`](Stmt.md#originaltext) + +*** + +### text? + +> `protected` `optional` **text**: `string` + +Defined in: src/core/base/Stmt.ts:32 + +#### Inherited from + +[`Stmt`](Stmt.md).[`text`](Stmt.md#text) + +## Methods + +### containsArrayRef() + +> **containsArrayRef**(): `boolean` + +Defined in: src/core/base/Stmt.ts:187 + +#### Returns + +`boolean` + +#### Inherited from + +[`Stmt`](Stmt.md).[`containsArrayRef`](Stmt.md#containsarrayref) + +*** + +### containsFieldRef() + +> **containsFieldRef**(): `boolean` + +Defined in: src/core/base/Stmt.ts:213 + +#### Returns + +`boolean` + +#### Inherited from + +[`Stmt`](Stmt.md).[`containsFieldRef`](Stmt.md#containsfieldref) + +*** + +### containsInvokeExpr() + +> **containsInvokeExpr**(): `boolean` + +Defined in: src/core/base/Stmt.ts:136 + +#### Returns + +`boolean` + +#### Inherited from + +[`Stmt`](Stmt.md).[`containsInvokeExpr`](Stmt.md#containsinvokeexpr) + +*** + +### getArrayRef() + +> **getArrayRef**(): `undefined` \| [`ArkArrayRef`](ArkArrayRef.md) + +Defined in: src/core/base/Stmt.ts:199 + +#### Returns + +`undefined` \| [`ArkArrayRef`](ArkArrayRef.md) + +#### Inherited from + +[`Stmt`](Stmt.md).[`getArrayRef`](Stmt.md#getarrayref) + +*** + +### getCfg() + +> **getCfg**(): [`Cfg`](Cfg.md) + +Defined in: src/core/base/Stmt.ts:115 + +Get the CFG (i.e., control flow graph) of an [ArkBody](ArkBody.md) in which the statement is. +A CFG contains a set of basic blocks and statements corresponding to each basic block. +Note that, "source code" and "three-address" are two types of [Stmt](Stmt.md) in ArkAnalyzer. +Source code [Stmt](Stmt.md) represents the statement of ets/ts source code, while three-address code [Stmt](Stmt.md) +represents the statement after it has been converted into three-address code. Since the source code [Stmt](Stmt.md) does not save its CFG reference, it returns **null**, while the `getCfg()` of the third address code +[Stmt](Stmt.md) will return its CFG reference. + +#### Returns + +[`Cfg`](Cfg.md) + +The CFG (i.e., control flow graph) of an [ArkBody](ArkBody.md) in which the statement is. + +#### Example + +1. get the ArkFile based on stmt. +```typescript +const arkFile = stmt.getCfg()?.getDeclaringMethod().getDeclaringArkFile(); +``` +2. get the ArkMethod based on stmt. +```typescript +let sourceMethod: ArkMethod = stmt.getCfg()?.getDeclaringMethod(); +``` + +#### Inherited from + +[`Stmt`](Stmt.md).[`getCfg`](Stmt.md#getcfg) + +*** + +### getDef() + +> **getDef**(): `null` \| [`Value`](../interfaces/Value.md) + +Defined in: src/core/base/Stmt.ts:77 + +Return the definition which is uesd in this statement. Generally, the definition is the left value of `=` in +3AC. For example, the definition in 3AC of `value = parameter0: @project-1/sample-1.ets: AnonymousClass-0` is +`value`, and the definition in `$temp0 = staticinvoke <@_ProjectName/_FileName: xxx.create()>()` is `\$temp0`. + +#### Returns + +`null` \| [`Value`](../interfaces/Value.md) + +The definition in 3AC (may be a **null**). + +#### Example + +1. get the def in stmt. +```typescript +for (const block of this.blocks) { +for (const stmt of block.getStmts()) { + const defValue = stmt.getDef(); + ... + } +} +``` + +#### Inherited from + +[`Stmt`](Stmt.md).[`getDef`](Stmt.md#getdef) + +*** + +### getDefAndUses() + +> **getDefAndUses**(): [`Value`](../interfaces/Value.md)[] + +Defined in: src/core/base/Stmt.ts:86 + +#### Returns + +[`Value`](../interfaces/Value.md)[] + +#### Inherited from + +[`Stmt`](Stmt.md).[`getDefAndUses`](Stmt.md#getdefanduses) + +*** + +### getExpectedSuccessorCount() + +> **getExpectedSuccessorCount**(): `number` + +Defined in: src/core/base/Stmt.ts:451 + +Return the number of statements which this statement may go to + +#### Returns + +`number` + +#### Overrides + +[`Stmt`](Stmt.md).[`getExpectedSuccessorCount`](Stmt.md#getexpectedsuccessorcount) + +*** + +### getExprs() + +> **getExprs**(): [`AbstractExpr`](AbstractExpr.md)[] + +Defined in: src/core/base/Stmt.ts:177 + +Returns an array of expressions in the statement. + +#### Returns + +[`AbstractExpr`](AbstractExpr.md)[] + +An array of expressions in the statement. + +#### Example + +1. Traverse expression of statement. + +```typescript +for (const expr of stmt.getExprs()) { + ... +} +``` + +#### Inherited from + +[`Stmt`](Stmt.md).[`getExprs`](Stmt.md#getexprs) + +*** + +### getFieldRef() + +> **getFieldRef**(): `undefined` \| [`AbstractFieldRef`](AbstractFieldRef.md) + +Defined in: src/core/base/Stmt.ts:226 + +#### Returns + +`undefined` \| [`AbstractFieldRef`](AbstractFieldRef.md) + +#### Inherited from + +[`Stmt`](Stmt.md).[`getFieldRef`](Stmt.md#getfieldref) + +*** + +### getInvokeExpr() + +> **getInvokeExpr**(): `undefined` \| [`AbstractInvokeExpr`](AbstractInvokeExpr.md) + +Defined in: src/core/base/Stmt.ts:156 + +Returns the method's invocation expression (including method signature and its arguments) +in the current statement. An **undefined** will be returned if there is no method used in this statement. + +#### Returns + +`undefined` \| [`AbstractInvokeExpr`](AbstractInvokeExpr.md) + +the method's invocation expression from the statement. An **undefined** will be returned if there is + no method can be found in this statement. + +#### Example + +1. get invoke expr based on stmt. +```typescript +let invoke = stmt.getInvokeExpr(); +``` + +#### Inherited from + +[`Stmt`](Stmt.md).[`getInvokeExpr`](Stmt.md#getinvokeexpr) + +*** + +### getMetadata() + +> **getMetadata**(`kind`): `undefined` \| `ArkMetadataType` + +Defined in: src/core/base/Stmt.ts:40 + +#### Parameters + +##### kind + +`ArkMetadataKind` + +#### Returns + +`undefined` \| `ArkMetadataType` + +#### Inherited from + +[`Stmt`](Stmt.md).[`getMetadata`](Stmt.md#getmetadata) + +*** + +### getOp() + +> **getOp**(): [`Value`](../interfaces/Value.md) + +Defined in: src/core/base/Stmt.ts:455 + +#### Returns + +[`Value`](../interfaces/Value.md) + +*** + +### getOperandOriginalPosition() + +> **getOperandOriginalPosition**(`indexOrOperand`): `null` \| [`FullPosition`](FullPosition.md) + +Defined in: src/core/base/Stmt.ts:287 + +#### Parameters + +##### indexOrOperand + +`number` | [`Value`](../interfaces/Value.md) + +#### Returns + +`null` \| [`FullPosition`](FullPosition.md) + +#### Inherited from + +[`Stmt`](Stmt.md).[`getOperandOriginalPosition`](Stmt.md#getoperandoriginalposition) + +*** + +### getOperandOriginalPositions() + +> **getOperandOriginalPositions**(): `undefined` \| [`FullPosition`](FullPosition.md)[] + +Defined in: src/core/base/Stmt.ts:283 + +#### Returns + +`undefined` \| [`FullPosition`](FullPosition.md)[] + +#### Inherited from + +[`Stmt`](Stmt.md).[`getOperandOriginalPositions`](Stmt.md#getoperandoriginalpositions) + +*** + +### getOriginalText() + +> **getOriginalText**(): `undefined` \| `string` + +Defined in: src/core/base/Stmt.ts:275 + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[`Stmt`](Stmt.md).[`getOriginalText`](Stmt.md#getoriginaltext) + +*** + +### getOriginPositionInfo() + +> **getOriginPositionInfo**(): [`LineColPosition`](LineColPosition.md) + +Defined in: src/core/base/Stmt.ts:261 + +Returns the original position of the statement. +The position consists of two parts: line number and column number. +In the source file, the former (i.e., line number) indicates which line the statement is in, +and the latter (i.e., column number) indicates the position of the statement in the line. +The position is described as `LineColPosition(lineNo,colNum)` in ArkAnalyzer, +and its default value is LineColPosition(-1,-1). + +#### Returns + +[`LineColPosition`](LineColPosition.md) + +The original location of the statement. + +#### Example + +1. Get the stmt position info to make some condition judgements. +```typescript +for (const stmt of stmts) { + if (stmt.getOriginPositionInfo().getLineNo() === -1) { + stmt.setOriginPositionInfo(originalStmt.getOriginPositionInfo()); + this.stmtToOriginalStmt.set(stmt, originalStmt); + } +} +``` + +#### Inherited from + +[`Stmt`](Stmt.md).[`getOriginPositionInfo`](Stmt.md#getoriginpositioninfo) + +*** + +### getUses() + +> **getUses**(): [`Value`](../interfaces/Value.md)[] + +Defined in: src/core/base/Stmt.ts:468 + +Return a list of values which are uesd in this statement + +#### Returns + +[`Value`](../interfaces/Value.md)[] + +#### Overrides + +[`Stmt`](Stmt.md).[`getUses`](Stmt.md#getuses) + +*** + +### isBranch() + +> **isBranch**(): `boolean` + +Defined in: src/core/base/Stmt.ts:127 + +Return true if the following statement may not execute after this statement. +The ArkIfStmt and ArkGotoStmt will return true. + +#### Returns + +`boolean` + +#### Inherited from + +[`Stmt`](Stmt.md).[`isBranch`](Stmt.md#isbranch) + +*** + +### replaceDef() + +> **replaceDef**(`oldDef`, `newDef`): `void` + +Defined in: src/core/base/Stmt.ts:81 + +#### Parameters + +##### oldDef + +[`Value`](../interfaces/Value.md) + +##### newDef + +[`Value`](../interfaces/Value.md) + +#### Returns + +`void` + +#### Inherited from + +[`Stmt`](Stmt.md).[`replaceDef`](Stmt.md#replacedef) + +*** + +### replaceUse() + +> **replaceUse**(`oldUse`, `newUse`): `void` + +Defined in: src/core/base/Stmt.ts:56 + +#### Parameters + +##### oldUse + +[`Value`](../interfaces/Value.md) + +##### newUse + +[`Value`](../interfaces/Value.md) + +#### Returns + +`void` + +#### Inherited from + +[`Stmt`](Stmt.md).[`replaceUse`](Stmt.md#replaceuse) + +*** + +### setCfg() + +> **setCfg**(`cfg`): `void` + +Defined in: src/core/base/Stmt.ts:119 + +#### Parameters + +##### cfg + +[`Cfg`](Cfg.md) + +#### Returns + +`void` + +#### Inherited from + +[`Stmt`](Stmt.md).[`setCfg`](Stmt.md#setcfg) + +*** + +### setMetadata() + +> **setMetadata**(`kind`, `value`): `void` + +Defined in: src/core/base/Stmt.ts:44 + +#### Parameters + +##### kind + +`ArkMetadataKind` + +##### value + +`ArkMetadataType` + +#### Returns + +`void` + +#### Inherited from + +[`Stmt`](Stmt.md).[`setMetadata`](Stmt.md#setmetadata) + +*** + +### setOperandOriginalPositions() + +> **setOperandOriginalPositions**(`operandOriginalPositions`): `void` + +Defined in: src/core/base/Stmt.ts:279 + +#### Parameters + +##### operandOriginalPositions + +[`FullPosition`](FullPosition.md)[] + +#### Returns + +`void` + +#### Inherited from + +[`Stmt`](Stmt.md).[`setOperandOriginalPositions`](Stmt.md#setoperandoriginalpositions) + +*** + +### setOriginalText() + +> **setOriginalText**(`originalText`): `void` + +Defined in: src/core/base/Stmt.ts:271 + +#### Parameters + +##### originalText + +`string` + +#### Returns + +`void` + +#### Inherited from + +[`Stmt`](Stmt.md).[`setOriginalText`](Stmt.md#setoriginaltext) + +*** + +### setOriginPositionInfo() + +> **setOriginPositionInfo**(`originPositionInfo`): `void` + +Defined in: src/core/base/Stmt.ts:238 + +#### Parameters + +##### originPositionInfo + +[`LineColPosition`](LineColPosition.md) + +#### Returns + +`void` + +#### Inherited from + +[`Stmt`](Stmt.md).[`setOriginPositionInfo`](Stmt.md#setoriginpositioninfo) + +*** + +### setReturnValue() + +> **setReturnValue**(`returnValue`): `void` + +Defined in: src/core/base/Stmt.ts:459 + +#### Parameters + +##### returnValue + +[`Value`](../interfaces/Value.md) + +#### Returns + +`void` + +*** + +### setText() + +> **setText**(`text`): `void` + +Defined in: src/core/base/Stmt.ts:267 + +#### Parameters + +##### text + +`string` + +#### Returns + +`void` + +#### Inherited from + +[`Stmt`](Stmt.md).[`setText`](Stmt.md#settext) + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/base/Stmt.ts:463 + +#### Returns + +`string` + +#### Overrides + +[`Stmt`](Stmt.md).[`toString`](Stmt.md#tostring) diff --git a/docs/api_docs/classes/ArkReturnVoidStmt.md b/docs/api_docs/classes/ArkReturnVoidStmt.md new file mode 100644 index 0000000000000000000000000000000000000000..1cccc418940dbe1e4faff34e223c31aad9e250f0 --- /dev/null +++ b/docs/api_docs/classes/ArkReturnVoidStmt.md @@ -0,0 +1,698 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / ArkReturnVoidStmt + +# Class: ArkReturnVoidStmt + +Defined in: src/core/base/Stmt.ts:476 + +## Extends + +- [`Stmt`](Stmt.md) + +## Constructors + +### new ArkReturnVoidStmt() + +> **new ArkReturnVoidStmt**(): [`ArkReturnVoidStmt`](ArkReturnVoidStmt.md) + +Defined in: src/core/base/Stmt.ts:477 + +#### Returns + +[`ArkReturnVoidStmt`](ArkReturnVoidStmt.md) + +#### Overrides + +[`Stmt`](Stmt.md).[`constructor`](Stmt.md#constructors) + +## Properties + +### cfg + +> `protected` **cfg**: [`Cfg`](Cfg.md) + +Defined in: src/core/base/Stmt.ts:35 + +#### Inherited from + +[`Stmt`](Stmt.md).[`cfg`](Stmt.md#cfg) + +*** + +### metadata? + +> `optional` **metadata**: `ArkMetadata` + +Defined in: src/core/base/Stmt.ts:38 + +#### Inherited from + +[`Stmt`](Stmt.md).[`metadata`](Stmt.md#metadata) + +*** + +### operandOriginalPositions? + +> `protected` `optional` **operandOriginalPositions**: [`FullPosition`](FullPosition.md)[] + +Defined in: src/core/base/Stmt.ts:36 + +#### Inherited from + +[`Stmt`](Stmt.md).[`operandOriginalPositions`](Stmt.md#operandoriginalpositions) + +*** + +### originalPosition + +> `protected` **originalPosition**: [`LineColPosition`](LineColPosition.md) = `LineColPosition.DEFAULT` + +Defined in: src/core/base/Stmt.ts:34 + +#### Inherited from + +[`Stmt`](Stmt.md).[`originalPosition`](Stmt.md#originalposition) + +*** + +### originalText? + +> `protected` `optional` **originalText**: `string` + +Defined in: src/core/base/Stmt.ts:33 + +#### Inherited from + +[`Stmt`](Stmt.md).[`originalText`](Stmt.md#originaltext) + +*** + +### text? + +> `protected` `optional` **text**: `string` + +Defined in: src/core/base/Stmt.ts:32 + +#### Inherited from + +[`Stmt`](Stmt.md).[`text`](Stmt.md#text) + +## Methods + +### containsArrayRef() + +> **containsArrayRef**(): `boolean` + +Defined in: src/core/base/Stmt.ts:187 + +#### Returns + +`boolean` + +#### Inherited from + +[`Stmt`](Stmt.md).[`containsArrayRef`](Stmt.md#containsarrayref) + +*** + +### containsFieldRef() + +> **containsFieldRef**(): `boolean` + +Defined in: src/core/base/Stmt.ts:213 + +#### Returns + +`boolean` + +#### Inherited from + +[`Stmt`](Stmt.md).[`containsFieldRef`](Stmt.md#containsfieldref) + +*** + +### containsInvokeExpr() + +> **containsInvokeExpr**(): `boolean` + +Defined in: src/core/base/Stmt.ts:136 + +#### Returns + +`boolean` + +#### Inherited from + +[`Stmt`](Stmt.md).[`containsInvokeExpr`](Stmt.md#containsinvokeexpr) + +*** + +### getArrayRef() + +> **getArrayRef**(): `undefined` \| [`ArkArrayRef`](ArkArrayRef.md) + +Defined in: src/core/base/Stmt.ts:199 + +#### Returns + +`undefined` \| [`ArkArrayRef`](ArkArrayRef.md) + +#### Inherited from + +[`Stmt`](Stmt.md).[`getArrayRef`](Stmt.md#getarrayref) + +*** + +### getCfg() + +> **getCfg**(): [`Cfg`](Cfg.md) + +Defined in: src/core/base/Stmt.ts:115 + +Get the CFG (i.e., control flow graph) of an [ArkBody](ArkBody.md) in which the statement is. +A CFG contains a set of basic blocks and statements corresponding to each basic block. +Note that, "source code" and "three-address" are two types of [Stmt](Stmt.md) in ArkAnalyzer. +Source code [Stmt](Stmt.md) represents the statement of ets/ts source code, while three-address code [Stmt](Stmt.md) +represents the statement after it has been converted into three-address code. Since the source code [Stmt](Stmt.md) does not save its CFG reference, it returns **null**, while the `getCfg()` of the third address code +[Stmt](Stmt.md) will return its CFG reference. + +#### Returns + +[`Cfg`](Cfg.md) + +The CFG (i.e., control flow graph) of an [ArkBody](ArkBody.md) in which the statement is. + +#### Example + +1. get the ArkFile based on stmt. +```typescript +const arkFile = stmt.getCfg()?.getDeclaringMethod().getDeclaringArkFile(); +``` +2. get the ArkMethod based on stmt. +```typescript +let sourceMethod: ArkMethod = stmt.getCfg()?.getDeclaringMethod(); +``` + +#### Inherited from + +[`Stmt`](Stmt.md).[`getCfg`](Stmt.md#getcfg) + +*** + +### getDef() + +> **getDef**(): `null` \| [`Value`](../interfaces/Value.md) + +Defined in: src/core/base/Stmt.ts:77 + +Return the definition which is uesd in this statement. Generally, the definition is the left value of `=` in +3AC. For example, the definition in 3AC of `value = parameter0: @project-1/sample-1.ets: AnonymousClass-0` is +`value`, and the definition in `$temp0 = staticinvoke <@_ProjectName/_FileName: xxx.create()>()` is `\$temp0`. + +#### Returns + +`null` \| [`Value`](../interfaces/Value.md) + +The definition in 3AC (may be a **null**). + +#### Example + +1. get the def in stmt. +```typescript +for (const block of this.blocks) { +for (const stmt of block.getStmts()) { + const defValue = stmt.getDef(); + ... + } +} +``` + +#### Inherited from + +[`Stmt`](Stmt.md).[`getDef`](Stmt.md#getdef) + +*** + +### getDefAndUses() + +> **getDefAndUses**(): [`Value`](../interfaces/Value.md)[] + +Defined in: src/core/base/Stmt.ts:86 + +#### Returns + +[`Value`](../interfaces/Value.md)[] + +#### Inherited from + +[`Stmt`](Stmt.md).[`getDefAndUses`](Stmt.md#getdefanduses) + +*** + +### getExpectedSuccessorCount() + +> **getExpectedSuccessorCount**(): `number` + +Defined in: src/core/base/Stmt.ts:481 + +Return the number of statements which this statement may go to + +#### Returns + +`number` + +#### Overrides + +[`Stmt`](Stmt.md).[`getExpectedSuccessorCount`](Stmt.md#getexpectedsuccessorcount) + +*** + +### getExprs() + +> **getExprs**(): [`AbstractExpr`](AbstractExpr.md)[] + +Defined in: src/core/base/Stmt.ts:177 + +Returns an array of expressions in the statement. + +#### Returns + +[`AbstractExpr`](AbstractExpr.md)[] + +An array of expressions in the statement. + +#### Example + +1. Traverse expression of statement. + +```typescript +for (const expr of stmt.getExprs()) { + ... +} +``` + +#### Inherited from + +[`Stmt`](Stmt.md).[`getExprs`](Stmt.md#getexprs) + +*** + +### getFieldRef() + +> **getFieldRef**(): `undefined` \| [`AbstractFieldRef`](AbstractFieldRef.md) + +Defined in: src/core/base/Stmt.ts:226 + +#### Returns + +`undefined` \| [`AbstractFieldRef`](AbstractFieldRef.md) + +#### Inherited from + +[`Stmt`](Stmt.md).[`getFieldRef`](Stmt.md#getfieldref) + +*** + +### getInvokeExpr() + +> **getInvokeExpr**(): `undefined` \| [`AbstractInvokeExpr`](AbstractInvokeExpr.md) + +Defined in: src/core/base/Stmt.ts:156 + +Returns the method's invocation expression (including method signature and its arguments) +in the current statement. An **undefined** will be returned if there is no method used in this statement. + +#### Returns + +`undefined` \| [`AbstractInvokeExpr`](AbstractInvokeExpr.md) + +the method's invocation expression from the statement. An **undefined** will be returned if there is + no method can be found in this statement. + +#### Example + +1. get invoke expr based on stmt. +```typescript +let invoke = stmt.getInvokeExpr(); +``` + +#### Inherited from + +[`Stmt`](Stmt.md).[`getInvokeExpr`](Stmt.md#getinvokeexpr) + +*** + +### getMetadata() + +> **getMetadata**(`kind`): `undefined` \| `ArkMetadataType` + +Defined in: src/core/base/Stmt.ts:40 + +#### Parameters + +##### kind + +`ArkMetadataKind` + +#### Returns + +`undefined` \| `ArkMetadataType` + +#### Inherited from + +[`Stmt`](Stmt.md).[`getMetadata`](Stmt.md#getmetadata) + +*** + +### getOperandOriginalPosition() + +> **getOperandOriginalPosition**(`indexOrOperand`): `null` \| [`FullPosition`](FullPosition.md) + +Defined in: src/core/base/Stmt.ts:287 + +#### Parameters + +##### indexOrOperand + +`number` | [`Value`](../interfaces/Value.md) + +#### Returns + +`null` \| [`FullPosition`](FullPosition.md) + +#### Inherited from + +[`Stmt`](Stmt.md).[`getOperandOriginalPosition`](Stmt.md#getoperandoriginalposition) + +*** + +### getOperandOriginalPositions() + +> **getOperandOriginalPositions**(): `undefined` \| [`FullPosition`](FullPosition.md)[] + +Defined in: src/core/base/Stmt.ts:283 + +#### Returns + +`undefined` \| [`FullPosition`](FullPosition.md)[] + +#### Inherited from + +[`Stmt`](Stmt.md).[`getOperandOriginalPositions`](Stmt.md#getoperandoriginalpositions) + +*** + +### getOriginalText() + +> **getOriginalText**(): `undefined` \| `string` + +Defined in: src/core/base/Stmt.ts:275 + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[`Stmt`](Stmt.md).[`getOriginalText`](Stmt.md#getoriginaltext) + +*** + +### getOriginPositionInfo() + +> **getOriginPositionInfo**(): [`LineColPosition`](LineColPosition.md) + +Defined in: src/core/base/Stmt.ts:261 + +Returns the original position of the statement. +The position consists of two parts: line number and column number. +In the source file, the former (i.e., line number) indicates which line the statement is in, +and the latter (i.e., column number) indicates the position of the statement in the line. +The position is described as `LineColPosition(lineNo,colNum)` in ArkAnalyzer, +and its default value is LineColPosition(-1,-1). + +#### Returns + +[`LineColPosition`](LineColPosition.md) + +The original location of the statement. + +#### Example + +1. Get the stmt position info to make some condition judgements. +```typescript +for (const stmt of stmts) { + if (stmt.getOriginPositionInfo().getLineNo() === -1) { + stmt.setOriginPositionInfo(originalStmt.getOriginPositionInfo()); + this.stmtToOriginalStmt.set(stmt, originalStmt); + } +} +``` + +#### Inherited from + +[`Stmt`](Stmt.md).[`getOriginPositionInfo`](Stmt.md#getoriginpositioninfo) + +*** + +### getUses() + +> **getUses**(): [`Value`](../interfaces/Value.md)[] + +Defined in: src/core/base/Stmt.ts:52 + +Return a list of values which are uesd in this statement + +#### Returns + +[`Value`](../interfaces/Value.md)[] + +#### Inherited from + +[`Stmt`](Stmt.md).[`getUses`](Stmt.md#getuses) + +*** + +### isBranch() + +> **isBranch**(): `boolean` + +Defined in: src/core/base/Stmt.ts:127 + +Return true if the following statement may not execute after this statement. +The ArkIfStmt and ArkGotoStmt will return true. + +#### Returns + +`boolean` + +#### Inherited from + +[`Stmt`](Stmt.md).[`isBranch`](Stmt.md#isbranch) + +*** + +### replaceDef() + +> **replaceDef**(`oldDef`, `newDef`): `void` + +Defined in: src/core/base/Stmt.ts:81 + +#### Parameters + +##### oldDef + +[`Value`](../interfaces/Value.md) + +##### newDef + +[`Value`](../interfaces/Value.md) + +#### Returns + +`void` + +#### Inherited from + +[`Stmt`](Stmt.md).[`replaceDef`](Stmt.md#replacedef) + +*** + +### replaceUse() + +> **replaceUse**(`oldUse`, `newUse`): `void` + +Defined in: src/core/base/Stmt.ts:56 + +#### Parameters + +##### oldUse + +[`Value`](../interfaces/Value.md) + +##### newUse + +[`Value`](../interfaces/Value.md) + +#### Returns + +`void` + +#### Inherited from + +[`Stmt`](Stmt.md).[`replaceUse`](Stmt.md#replaceuse) + +*** + +### setCfg() + +> **setCfg**(`cfg`): `void` + +Defined in: src/core/base/Stmt.ts:119 + +#### Parameters + +##### cfg + +[`Cfg`](Cfg.md) + +#### Returns + +`void` + +#### Inherited from + +[`Stmt`](Stmt.md).[`setCfg`](Stmt.md#setcfg) + +*** + +### setMetadata() + +> **setMetadata**(`kind`, `value`): `void` + +Defined in: src/core/base/Stmt.ts:44 + +#### Parameters + +##### kind + +`ArkMetadataKind` + +##### value + +`ArkMetadataType` + +#### Returns + +`void` + +#### Inherited from + +[`Stmt`](Stmt.md).[`setMetadata`](Stmt.md#setmetadata) + +*** + +### setOperandOriginalPositions() + +> **setOperandOriginalPositions**(`operandOriginalPositions`): `void` + +Defined in: src/core/base/Stmt.ts:279 + +#### Parameters + +##### operandOriginalPositions + +[`FullPosition`](FullPosition.md)[] + +#### Returns + +`void` + +#### Inherited from + +[`Stmt`](Stmt.md).[`setOperandOriginalPositions`](Stmt.md#setoperandoriginalpositions) + +*** + +### setOriginalText() + +> **setOriginalText**(`originalText`): `void` + +Defined in: src/core/base/Stmt.ts:271 + +#### Parameters + +##### originalText + +`string` + +#### Returns + +`void` + +#### Inherited from + +[`Stmt`](Stmt.md).[`setOriginalText`](Stmt.md#setoriginaltext) + +*** + +### setOriginPositionInfo() + +> **setOriginPositionInfo**(`originPositionInfo`): `void` + +Defined in: src/core/base/Stmt.ts:238 + +#### Parameters + +##### originPositionInfo + +[`LineColPosition`](LineColPosition.md) + +#### Returns + +`void` + +#### Inherited from + +[`Stmt`](Stmt.md).[`setOriginPositionInfo`](Stmt.md#setoriginpositioninfo) + +*** + +### setText() + +> **setText**(`text`): `void` + +Defined in: src/core/base/Stmt.ts:267 + +#### Parameters + +##### text + +`string` + +#### Returns + +`void` + +#### Inherited from + +[`Stmt`](Stmt.md).[`setText`](Stmt.md#settext) + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/base/Stmt.ts:485 + +#### Returns + +`string` + +#### Overrides + +[`Stmt`](Stmt.md).[`toString`](Stmt.md#tostring) diff --git a/docs/api_docs/classes/ArkSignatureBuilder.md b/docs/api_docs/classes/ArkSignatureBuilder.md new file mode 100644 index 0000000000000000000000000000000000000000..e5c30855d0786e290bdb230b8ec62895e7fa241b --- /dev/null +++ b/docs/api_docs/classes/ArkSignatureBuilder.md @@ -0,0 +1,129 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / ArkSignatureBuilder + +# Class: ArkSignatureBuilder + +Defined in: src/core/model/builder/ArkSignatureBuilder.ts:19 + +## Constructors + +### new ArkSignatureBuilder() + +> **new ArkSignatureBuilder**(): [`ArkSignatureBuilder`](ArkSignatureBuilder.md) + +#### Returns + +[`ArkSignatureBuilder`](ArkSignatureBuilder.md) + +## Methods + +### buildClassSignatureFromClassName() + +> `static` **buildClassSignatureFromClassName**(`className`): [`ClassSignature`](ClassSignature.md) + +Defined in: src/core/model/builder/ArkSignatureBuilder.ts:37 + +#### Parameters + +##### className + +`string` + +#### Returns + +[`ClassSignature`](ClassSignature.md) + +*** + +### buildFieldSignatureFromFieldName() + +> `static` **buildFieldSignatureFromFieldName**(`fieldName`, `staticFlag`): [`FieldSignature`](FieldSignature.md) + +Defined in: src/core/model/builder/ArkSignatureBuilder.ts:41 + +#### Parameters + +##### fieldName + +`string` + +##### staticFlag + +`boolean` = `false` + +#### Returns + +[`FieldSignature`](FieldSignature.md) + +*** + +### buildMethodSignatureFromClassNameAndMethodName() + +> `static` **buildMethodSignatureFromClassNameAndMethodName**(`className`, `methodName`, `staticFlag`): [`MethodSignature`](MethodSignature.md) + +Defined in: src/core/model/builder/ArkSignatureBuilder.ts:20 + +#### Parameters + +##### className + +`string` + +##### methodName + +`string` + +##### staticFlag + +`boolean` = `false` + +#### Returns + +[`MethodSignature`](MethodSignature.md) + +*** + +### buildMethodSignatureFromMethodName() + +> `static` **buildMethodSignatureFromMethodName**(`methodName`, `staticFlag`): [`MethodSignature`](MethodSignature.md) + +Defined in: src/core/model/builder/ArkSignatureBuilder.ts:27 + +#### Parameters + +##### methodName + +`string` + +##### staticFlag + +`boolean` = `false` + +#### Returns + +[`MethodSignature`](MethodSignature.md) + +*** + +### buildMethodSubSignatureFromMethodName() + +> `static` **buildMethodSubSignatureFromMethodName**(`methodName`, `staticFlag`): [`MethodSubSignature`](MethodSubSignature.md) + +Defined in: src/core/model/builder/ArkSignatureBuilder.ts:32 + +#### Parameters + +##### methodName + +`string` + +##### staticFlag + +`boolean` = `false` + +#### Returns + +[`MethodSubSignature`](MethodSubSignature.md) diff --git a/docs/api_docs/classes/ArkStaticFieldRef.md b/docs/api_docs/classes/ArkStaticFieldRef.md new file mode 100644 index 0000000000000000000000000000000000000000..19f62b1bd1feab2a708ffe09ae390c6716f0ffa5 --- /dev/null +++ b/docs/api_docs/classes/ArkStaticFieldRef.md @@ -0,0 +1,207 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / ArkStaticFieldRef + +# Class: ArkStaticFieldRef + +Defined in: src/core/base/Ref.ts:223 + +## Extends + +- [`AbstractFieldRef`](AbstractFieldRef.md) + +## Constructors + +### new ArkStaticFieldRef() + +> **new ArkStaticFieldRef**(`fieldSignature`): [`ArkStaticFieldRef`](ArkStaticFieldRef.md) + +Defined in: src/core/base/Ref.ts:224 + +#### Parameters + +##### fieldSignature + +[`FieldSignature`](FieldSignature.md) + +#### Returns + +[`ArkStaticFieldRef`](ArkStaticFieldRef.md) + +#### Overrides + +[`AbstractFieldRef`](AbstractFieldRef.md).[`constructor`](AbstractFieldRef.md#constructors) + +## Methods + +### getFieldName() + +> **getFieldName**(): `string` + +Defined in: src/core/base/Ref.ts:135 + +Returns the the field name as a **string**. + +#### Returns + +`string` + +The the field name. + +#### Inherited from + +[`AbstractFieldRef`](AbstractFieldRef.md).[`getFieldName`](AbstractFieldRef.md#getfieldname) + +*** + +### getFieldSignature() + +> **getFieldSignature**(): [`FieldSignature`](FieldSignature.md) + +Defined in: src/core/base/Ref.ts:157 + +Returns a field signature, which consists of a class signature, +a **string** field name, and a **boolean** label indicating whether it is static or not. + +#### Returns + +[`FieldSignature`](FieldSignature.md) + +The field signature. + +#### Example + +1. Compare two Fields + +```typescript +const fieldSignature = new FieldSignature(); +fieldSignature.setFieldName(...); +const fieldRef = new ArkInstanceFieldRef(baseValue as Local, fieldSignature); +... +if (fieldRef.getFieldSignature().getFieldName() === +targetField.getFieldSignature().getFieldName()) { +... +} +``` + +#### Inherited from + +[`AbstractFieldRef`](AbstractFieldRef.md).[`getFieldSignature`](AbstractFieldRef.md#getfieldsignature) + +*** + +### getType() + +> **getType**(): [`Type`](Type.md) + +Defined in: src/core/base/Ref.ts:165 + +Return the type of this value. The interface is encapsulated in [Value](../interfaces/Value.md). +The `Type` is defined in type.ts, such as **Any**, **Unknown**, **TypeParameter**, +**UnclearReference**, **Primitive**, **Number**, **String**, etc. + +#### Returns + +[`Type`](Type.md) + +The type of this value. + +#### Example + +1. In the declaration statement, determine the left-value type and right-value type. + +```typescript +let leftValue:Value; +let rightValue:Value; +... +if (leftValue.getType() instanceof UnknownType && + !(rightValue.getType() instanceof UnknownType) && + !(rightValue.getType() instanceof UndefinedType)) { + ... +} +``` + +#### Inherited from + +[`AbstractFieldRef`](AbstractFieldRef.md).[`getType`](AbstractFieldRef.md#gettype) + +*** + +### getUses() + +> **getUses**(): [`Value`](../interfaces/Value.md)[] + +Defined in: src/core/base/Ref.ts:228 + +Return a list of values which are contained in this [Value](../interfaces/Value.md). +Value is a core interface in ArkAnalyzer, which may represent any value or expression. + +#### Returns + +[`Value`](../interfaces/Value.md)[] + +An **array** of values used by this value. + +#### Overrides + +[`AbstractFieldRef`](AbstractFieldRef.md).[`getUses`](AbstractFieldRef.md#getuses) + +*** + +### inferType() + +> **inferType**(`arkMethod`): [`AbstractRef`](AbstractRef.md) + +Defined in: src/core/base/Ref.ts:37 + +#### Parameters + +##### arkMethod + +[`ArkMethod`](ArkMethod.md) + +#### Returns + +[`AbstractRef`](AbstractRef.md) + +#### Inherited from + +[`AbstractFieldRef`](AbstractFieldRef.md).[`inferType`](AbstractFieldRef.md#infertype) + +*** + +### setFieldSignature() + +> **setFieldSignature**(`newFieldSignature`): `void` + +Defined in: src/core/base/Ref.ts:161 + +#### Parameters + +##### newFieldSignature + +[`FieldSignature`](FieldSignature.md) + +#### Returns + +`void` + +#### Inherited from + +[`AbstractFieldRef`](AbstractFieldRef.md).[`setFieldSignature`](AbstractFieldRef.md#setfieldsignature) + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/base/Ref.ts:232 + +Returns a string representation of an object. + +#### Returns + +`string` diff --git a/docs/api_docs/classes/ArkStaticInvokeExpr.md b/docs/api_docs/classes/ArkStaticInvokeExpr.md new file mode 100644 index 0000000000000000000000000000000000000000..f2faf1c9d8942690182d27fc1d0e8a7e354446e3 --- /dev/null +++ b/docs/api_docs/classes/ArkStaticInvokeExpr.md @@ -0,0 +1,323 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / ArkStaticInvokeExpr + +# Class: ArkStaticInvokeExpr + +Defined in: src/core/base/Expr.ts:221 + +## Extends + +- [`AbstractInvokeExpr`](AbstractInvokeExpr.md) + +## Constructors + +### new ArkStaticInvokeExpr() + +> **new ArkStaticInvokeExpr**(`methodSignature`, `args`, `realGenericTypes`?): [`ArkStaticInvokeExpr`](ArkStaticInvokeExpr.md) + +Defined in: src/core/base/Expr.ts:222 + +#### Parameters + +##### methodSignature + +[`MethodSignature`](MethodSignature.md) + +##### args + +[`Value`](../interfaces/Value.md)[] + +##### realGenericTypes? + +[`Type`](Type.md)[] + +#### Returns + +[`ArkStaticInvokeExpr`](ArkStaticInvokeExpr.md) + +#### Overrides + +[`AbstractInvokeExpr`](AbstractInvokeExpr.md).[`constructor`](AbstractInvokeExpr.md#constructors) + +## Methods + +### getArg() + +> **getArg**(`index`): [`Value`](../interfaces/Value.md) + +Defined in: src/core/base/Expr.ts:98 + +Returns an argument used in the expression according to its index. + +#### Parameters + +##### index + +`number` + +the index of the argument. + +#### Returns + +[`Value`](../interfaces/Value.md) + +An argument used in the expression. + +#### Inherited from + +[`AbstractInvokeExpr`](AbstractInvokeExpr.md).[`getArg`](AbstractInvokeExpr.md#getarg) + +*** + +### getArgs() + +> **getArgs**(): [`Value`](../interfaces/Value.md)[] + +Defined in: src/core/base/Expr.ts:124 + +Returns an **array** of arguments used in the expression. + +#### Returns + +[`Value`](../interfaces/Value.md)[] + +An **array** of arguments used in the expression. + +#### Example + +1. get args number. + +```typescript +const argsNum = expr.getArgs().length; +if (argsNum < 5) { +... ... +} +``` + +2. iterate arg based on expression + +```typescript +for (const arg of this.getArgs()) { +strs.push(arg.toString()); +strs.push(', '); +} +``` + +#### Inherited from + +[`AbstractInvokeExpr`](AbstractInvokeExpr.md).[`getArgs`](AbstractInvokeExpr.md#getargs) + +*** + +### getMethodSignature() + +> **getMethodSignature**(): [`MethodSignature`](MethodSignature.md) + +Defined in: src/core/base/Expr.ts:85 + +Get method Signature. The method signature is consist of ClassSignature and MethodSubSignature. +It is the unique flag of a method. It is usually used to compose a expression string in ArkIRTransformer. + +#### Returns + +[`MethodSignature`](MethodSignature.md) + +The class method signature, such as ArkStaticInvokeExpr. + +#### Example + +1. 3AC information composed of getMethodSignature (). + +```typescript +let strs: string[] = []; +strs.push('staticinvoke <'); +strs.push(this.getMethodSignature().toString()); +strs.push('>('); +``` + +#### Inherited from + +[`AbstractInvokeExpr`](AbstractInvokeExpr.md).[`getMethodSignature`](AbstractInvokeExpr.md#getmethodsignature) + +*** + +### getRealGenericTypes() + +> **getRealGenericTypes**(): `undefined` \| [`Type`](Type.md)[] + +Defined in: src/core/base/Expr.ts:140 + +#### Returns + +`undefined` \| [`Type`](Type.md)[] + +#### Inherited from + +[`AbstractInvokeExpr`](AbstractInvokeExpr.md).[`getRealGenericTypes`](AbstractInvokeExpr.md#getrealgenerictypes) + +*** + +### getType() + +> **getType**(): [`Type`](Type.md) + +Defined in: src/core/base/Expr.ts:132 + +Return the type of this value. The interface is encapsulated in [Value](../interfaces/Value.md). +The `Type` is defined in type.ts, such as **Any**, **Unknown**, **TypeParameter**, +**UnclearReference**, **Primitive**, **Number**, **String**, etc. + +#### Returns + +[`Type`](Type.md) + +The type of this value. + +#### Example + +1. In the declaration statement, determine the left-value type and right-value type. + +```typescript +let leftValue:Value; +let rightValue:Value; +... +if (leftValue.getType() instanceof UnknownType && + !(rightValue.getType() instanceof UnknownType) && + !(rightValue.getType() instanceof UndefinedType)) { + ... +} +``` + +#### Inherited from + +[`AbstractInvokeExpr`](AbstractInvokeExpr.md).[`getType`](AbstractInvokeExpr.md#gettype) + +*** + +### getUses() + +> **getUses**(): [`Value`](../interfaces/Value.md)[] + +Defined in: src/core/base/Expr.ts:150 + +Return a list of values which are contained in this [Value](../interfaces/Value.md). +Value is a core interface in ArkAnalyzer, which may represent any value or expression. + +#### Returns + +[`Value`](../interfaces/Value.md)[] + +An **array** of values used by this value. + +#### Inherited from + +[`AbstractInvokeExpr`](AbstractInvokeExpr.md).[`getUses`](AbstractInvokeExpr.md#getuses) + +*** + +### inferType() + +> **inferType**(`arkMethod`): [`AbstractInvokeExpr`](AbstractInvokeExpr.md) + +Defined in: src/core/base/Expr.ts:242 + +#### Parameters + +##### arkMethod + +[`ArkMethod`](ArkMethod.md) + +#### Returns + +[`AbstractInvokeExpr`](AbstractInvokeExpr.md) + +#### Overrides + +[`AbstractInvokeExpr`](AbstractInvokeExpr.md).[`inferType`](AbstractInvokeExpr.md#infertype) + +*** + +### setArgs() + +> **setArgs**(`newArgs`): `void` + +Defined in: src/core/base/Expr.ts:128 + +#### Parameters + +##### newArgs + +[`Value`](../interfaces/Value.md)[] + +#### Returns + +`void` + +#### Inherited from + +[`AbstractInvokeExpr`](AbstractInvokeExpr.md).[`setArgs`](AbstractInvokeExpr.md#setargs) + +*** + +### setMethodSignature() + +> **setMethodSignature**(`newMethodSignature`): `void` + +Defined in: src/core/base/Expr.ts:89 + +#### Parameters + +##### newMethodSignature + +[`MethodSignature`](MethodSignature.md) + +#### Returns + +`void` + +#### Inherited from + +[`AbstractInvokeExpr`](AbstractInvokeExpr.md).[`setMethodSignature`](AbstractInvokeExpr.md#setmethodsignature) + +*** + +### setRealGenericTypes() + +> **setRealGenericTypes**(`realTypes`): `void` + +Defined in: src/core/base/Expr.ts:144 + +#### Parameters + +##### realTypes + +`undefined` | [`Type`](Type.md)[] + +#### Returns + +`void` + +#### Inherited from + +[`AbstractInvokeExpr`](AbstractInvokeExpr.md).[`setRealGenericTypes`](AbstractInvokeExpr.md#setrealgenerictypes) + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/base/Expr.ts:226 + +Returns a string representation of an object. + +#### Returns + +`string` + +#### Overrides + +[`AbstractInvokeExpr`](AbstractInvokeExpr.md).[`toString`](AbstractInvokeExpr.md#tostring) diff --git a/docs/api_docs/classes/ArkThisRef.md b/docs/api_docs/classes/ArkThisRef.md new file mode 100644 index 0000000000000000000000000000000000000000..b2544bf1addcdb91f9cd54af48f8803e83035931 --- /dev/null +++ b/docs/api_docs/classes/ArkThisRef.md @@ -0,0 +1,129 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / ArkThisRef + +# Class: ArkThisRef + +Defined in: src/core/base/Ref.ts:288 + +## Extends + +- [`AbstractRef`](AbstractRef.md) + +## Constructors + +### new ArkThisRef() + +> **new ArkThisRef**(`type`): [`ArkThisRef`](ArkThisRef.md) + +Defined in: src/core/base/Ref.ts:291 + +#### Parameters + +##### type + +[`ClassType`](ClassType.md) + +#### Returns + +[`ArkThisRef`](ArkThisRef.md) + +#### Overrides + +[`AbstractRef`](AbstractRef.md).[`constructor`](AbstractRef.md#constructors) + +## Methods + +### getType() + +> **getType**(): [`ClassType`](ClassType.md) + +Defined in: src/core/base/Ref.ts:308 + +Return the type of this value. The interface is encapsulated in [Value](../interfaces/Value.md). +The `Type` is defined in type.ts, such as **Any**, **Unknown**, **TypeParameter**, +**UnclearReference**, **Primitive**, **Number**, **String**, etc. + +#### Returns + +[`ClassType`](ClassType.md) + +The type of this value. + +#### Example + +1. In the declaration statement, determine the left-value type and right-value type. + +```typescript +let leftValue:Value; +let rightValue:Value; +... +if (leftValue.getType() instanceof UnknownType && + !(rightValue.getType() instanceof UnknownType) && + !(rightValue.getType() instanceof UndefinedType)) { + ... +} +``` + +#### Overrides + +[`AbstractRef`](AbstractRef.md).[`getType`](AbstractRef.md#gettype) + +*** + +### getUses() + +> **getUses**(): [`Value`](../interfaces/Value.md)[] + +Defined in: src/core/base/Ref.ts:312 + +Return a list of values which are contained in this [Value](../interfaces/Value.md). +Value is a core interface in ArkAnalyzer, which may represent any value or expression. + +#### Returns + +[`Value`](../interfaces/Value.md)[] + +An **array** of values used by this value. + +#### Overrides + +[`AbstractRef`](AbstractRef.md).[`getUses`](AbstractRef.md#getuses) + +*** + +### inferType() + +> **inferType**(`arkMethod`): [`AbstractRef`](AbstractRef.md) + +Defined in: src/core/base/Ref.ts:296 + +#### Parameters + +##### arkMethod + +[`ArkMethod`](ArkMethod.md) + +#### Returns + +[`AbstractRef`](AbstractRef.md) + +#### Overrides + +[`AbstractRef`](AbstractRef.md).[`inferType`](AbstractRef.md#infertype) + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/base/Ref.ts:316 + +Returns a string representation of an object. + +#### Returns + +`string` diff --git a/docs/api_docs/classes/ArkThrowStmt.md b/docs/api_docs/classes/ArkThrowStmt.md new file mode 100644 index 0000000000000000000000000000000000000000..4d4bc2d93f1b0388c93d66606e2eb4eb8b912d8b --- /dev/null +++ b/docs/api_docs/classes/ArkThrowStmt.md @@ -0,0 +1,734 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / ArkThrowStmt + +# Class: ArkThrowStmt + +Defined in: src/core/base/Stmt.ts:491 + +## Extends + +- [`Stmt`](Stmt.md) + +## Constructors + +### new ArkThrowStmt() + +> **new ArkThrowStmt**(`op`): [`ArkThrowStmt`](ArkThrowStmt.md) + +Defined in: src/core/base/Stmt.ts:494 + +#### Parameters + +##### op + +[`Value`](../interfaces/Value.md) + +#### Returns + +[`ArkThrowStmt`](ArkThrowStmt.md) + +#### Overrides + +[`Stmt`](Stmt.md).[`constructor`](Stmt.md#constructors) + +## Properties + +### cfg + +> `protected` **cfg**: [`Cfg`](Cfg.md) + +Defined in: src/core/base/Stmt.ts:35 + +#### Inherited from + +[`Stmt`](Stmt.md).[`cfg`](Stmt.md#cfg) + +*** + +### metadata? + +> `optional` **metadata**: `ArkMetadata` + +Defined in: src/core/base/Stmt.ts:38 + +#### Inherited from + +[`Stmt`](Stmt.md).[`metadata`](Stmt.md#metadata) + +*** + +### operandOriginalPositions? + +> `protected` `optional` **operandOriginalPositions**: [`FullPosition`](FullPosition.md)[] + +Defined in: src/core/base/Stmt.ts:36 + +#### Inherited from + +[`Stmt`](Stmt.md).[`operandOriginalPositions`](Stmt.md#operandoriginalpositions) + +*** + +### originalPosition + +> `protected` **originalPosition**: [`LineColPosition`](LineColPosition.md) = `LineColPosition.DEFAULT` + +Defined in: src/core/base/Stmt.ts:34 + +#### Inherited from + +[`Stmt`](Stmt.md).[`originalPosition`](Stmt.md#originalposition) + +*** + +### originalText? + +> `protected` `optional` **originalText**: `string` + +Defined in: src/core/base/Stmt.ts:33 + +#### Inherited from + +[`Stmt`](Stmt.md).[`originalText`](Stmt.md#originaltext) + +*** + +### text? + +> `protected` `optional` **text**: `string` + +Defined in: src/core/base/Stmt.ts:32 + +#### Inherited from + +[`Stmt`](Stmt.md).[`text`](Stmt.md#text) + +## Methods + +### containsArrayRef() + +> **containsArrayRef**(): `boolean` + +Defined in: src/core/base/Stmt.ts:187 + +#### Returns + +`boolean` + +#### Inherited from + +[`Stmt`](Stmt.md).[`containsArrayRef`](Stmt.md#containsarrayref) + +*** + +### containsFieldRef() + +> **containsFieldRef**(): `boolean` + +Defined in: src/core/base/Stmt.ts:213 + +#### Returns + +`boolean` + +#### Inherited from + +[`Stmt`](Stmt.md).[`containsFieldRef`](Stmt.md#containsfieldref) + +*** + +### containsInvokeExpr() + +> **containsInvokeExpr**(): `boolean` + +Defined in: src/core/base/Stmt.ts:136 + +#### Returns + +`boolean` + +#### Inherited from + +[`Stmt`](Stmt.md).[`containsInvokeExpr`](Stmt.md#containsinvokeexpr) + +*** + +### getArrayRef() + +> **getArrayRef**(): `undefined` \| [`ArkArrayRef`](ArkArrayRef.md) + +Defined in: src/core/base/Stmt.ts:199 + +#### Returns + +`undefined` \| [`ArkArrayRef`](ArkArrayRef.md) + +#### Inherited from + +[`Stmt`](Stmt.md).[`getArrayRef`](Stmt.md#getarrayref) + +*** + +### getCfg() + +> **getCfg**(): [`Cfg`](Cfg.md) + +Defined in: src/core/base/Stmt.ts:115 + +Get the CFG (i.e., control flow graph) of an [ArkBody](ArkBody.md) in which the statement is. +A CFG contains a set of basic blocks and statements corresponding to each basic block. +Note that, "source code" and "three-address" are two types of [Stmt](Stmt.md) in ArkAnalyzer. +Source code [Stmt](Stmt.md) represents the statement of ets/ts source code, while three-address code [Stmt](Stmt.md) +represents the statement after it has been converted into three-address code. Since the source code [Stmt](Stmt.md) does not save its CFG reference, it returns **null**, while the `getCfg()` of the third address code +[Stmt](Stmt.md) will return its CFG reference. + +#### Returns + +[`Cfg`](Cfg.md) + +The CFG (i.e., control flow graph) of an [ArkBody](ArkBody.md) in which the statement is. + +#### Example + +1. get the ArkFile based on stmt. +```typescript +const arkFile = stmt.getCfg()?.getDeclaringMethod().getDeclaringArkFile(); +``` +2. get the ArkMethod based on stmt. +```typescript +let sourceMethod: ArkMethod = stmt.getCfg()?.getDeclaringMethod(); +``` + +#### Inherited from + +[`Stmt`](Stmt.md).[`getCfg`](Stmt.md#getcfg) + +*** + +### getDef() + +> **getDef**(): `null` \| [`Value`](../interfaces/Value.md) + +Defined in: src/core/base/Stmt.ts:77 + +Return the definition which is uesd in this statement. Generally, the definition is the left value of `=` in +3AC. For example, the definition in 3AC of `value = parameter0: @project-1/sample-1.ets: AnonymousClass-0` is +`value`, and the definition in `$temp0 = staticinvoke <@_ProjectName/_FileName: xxx.create()>()` is `\$temp0`. + +#### Returns + +`null` \| [`Value`](../interfaces/Value.md) + +The definition in 3AC (may be a **null**). + +#### Example + +1. get the def in stmt. +```typescript +for (const block of this.blocks) { +for (const stmt of block.getStmts()) { + const defValue = stmt.getDef(); + ... + } +} +``` + +#### Inherited from + +[`Stmt`](Stmt.md).[`getDef`](Stmt.md#getdef) + +*** + +### getDefAndUses() + +> **getDefAndUses**(): [`Value`](../interfaces/Value.md)[] + +Defined in: src/core/base/Stmt.ts:86 + +#### Returns + +[`Value`](../interfaces/Value.md)[] + +#### Inherited from + +[`Stmt`](Stmt.md).[`getDefAndUses`](Stmt.md#getdefanduses) + +*** + +### getExpectedSuccessorCount() + +> **getExpectedSuccessorCount**(): `number` + +Defined in: src/core/base/Stmt.ts:132 + +Return the number of statements which this statement may go to + +#### Returns + +`number` + +#### Inherited from + +[`Stmt`](Stmt.md).[`getExpectedSuccessorCount`](Stmt.md#getexpectedsuccessorcount) + +*** + +### getExprs() + +> **getExprs**(): [`AbstractExpr`](AbstractExpr.md)[] + +Defined in: src/core/base/Stmt.ts:177 + +Returns an array of expressions in the statement. + +#### Returns + +[`AbstractExpr`](AbstractExpr.md)[] + +An array of expressions in the statement. + +#### Example + +1. Traverse expression of statement. + +```typescript +for (const expr of stmt.getExprs()) { + ... +} +``` + +#### Inherited from + +[`Stmt`](Stmt.md).[`getExprs`](Stmt.md#getexprs) + +*** + +### getFieldRef() + +> **getFieldRef**(): `undefined` \| [`AbstractFieldRef`](AbstractFieldRef.md) + +Defined in: src/core/base/Stmt.ts:226 + +#### Returns + +`undefined` \| [`AbstractFieldRef`](AbstractFieldRef.md) + +#### Inherited from + +[`Stmt`](Stmt.md).[`getFieldRef`](Stmt.md#getfieldref) + +*** + +### getInvokeExpr() + +> **getInvokeExpr**(): `undefined` \| [`AbstractInvokeExpr`](AbstractInvokeExpr.md) + +Defined in: src/core/base/Stmt.ts:156 + +Returns the method's invocation expression (including method signature and its arguments) +in the current statement. An **undefined** will be returned if there is no method used in this statement. + +#### Returns + +`undefined` \| [`AbstractInvokeExpr`](AbstractInvokeExpr.md) + +the method's invocation expression from the statement. An **undefined** will be returned if there is + no method can be found in this statement. + +#### Example + +1. get invoke expr based on stmt. +```typescript +let invoke = stmt.getInvokeExpr(); +``` + +#### Inherited from + +[`Stmt`](Stmt.md).[`getInvokeExpr`](Stmt.md#getinvokeexpr) + +*** + +### getMetadata() + +> **getMetadata**(`kind`): `undefined` \| `ArkMetadataType` + +Defined in: src/core/base/Stmt.ts:40 + +#### Parameters + +##### kind + +`ArkMetadataKind` + +#### Returns + +`undefined` \| `ArkMetadataType` + +#### Inherited from + +[`Stmt`](Stmt.md).[`getMetadata`](Stmt.md#getmetadata) + +*** + +### getOp() + +> **getOp**(): [`Value`](../interfaces/Value.md) + +Defined in: src/core/base/Stmt.ts:499 + +#### Returns + +[`Value`](../interfaces/Value.md) + +*** + +### getOperandOriginalPosition() + +> **getOperandOriginalPosition**(`indexOrOperand`): `null` \| [`FullPosition`](FullPosition.md) + +Defined in: src/core/base/Stmt.ts:287 + +#### Parameters + +##### indexOrOperand + +`number` | [`Value`](../interfaces/Value.md) + +#### Returns + +`null` \| [`FullPosition`](FullPosition.md) + +#### Inherited from + +[`Stmt`](Stmt.md).[`getOperandOriginalPosition`](Stmt.md#getoperandoriginalposition) + +*** + +### getOperandOriginalPositions() + +> **getOperandOriginalPositions**(): `undefined` \| [`FullPosition`](FullPosition.md)[] + +Defined in: src/core/base/Stmt.ts:283 + +#### Returns + +`undefined` \| [`FullPosition`](FullPosition.md)[] + +#### Inherited from + +[`Stmt`](Stmt.md).[`getOperandOriginalPositions`](Stmt.md#getoperandoriginalpositions) + +*** + +### getOriginalText() + +> **getOriginalText**(): `undefined` \| `string` + +Defined in: src/core/base/Stmt.ts:275 + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[`Stmt`](Stmt.md).[`getOriginalText`](Stmt.md#getoriginaltext) + +*** + +### getOriginPositionInfo() + +> **getOriginPositionInfo**(): [`LineColPosition`](LineColPosition.md) + +Defined in: src/core/base/Stmt.ts:261 + +Returns the original position of the statement. +The position consists of two parts: line number and column number. +In the source file, the former (i.e., line number) indicates which line the statement is in, +and the latter (i.e., column number) indicates the position of the statement in the line. +The position is described as `LineColPosition(lineNo,colNum)` in ArkAnalyzer, +and its default value is LineColPosition(-1,-1). + +#### Returns + +[`LineColPosition`](LineColPosition.md) + +The original location of the statement. + +#### Example + +1. Get the stmt position info to make some condition judgements. +```typescript +for (const stmt of stmts) { + if (stmt.getOriginPositionInfo().getLineNo() === -1) { + stmt.setOriginPositionInfo(originalStmt.getOriginPositionInfo()); + this.stmtToOriginalStmt.set(stmt, originalStmt); + } +} +``` + +#### Inherited from + +[`Stmt`](Stmt.md).[`getOriginPositionInfo`](Stmt.md#getoriginpositioninfo) + +*** + +### getUses() + +> **getUses**(): [`Value`](../interfaces/Value.md)[] + +Defined in: src/core/base/Stmt.ts:512 + +Return a list of values which are uesd in this statement + +#### Returns + +[`Value`](../interfaces/Value.md)[] + +#### Overrides + +[`Stmt`](Stmt.md).[`getUses`](Stmt.md#getuses) + +*** + +### isBranch() + +> **isBranch**(): `boolean` + +Defined in: src/core/base/Stmt.ts:127 + +Return true if the following statement may not execute after this statement. +The ArkIfStmt and ArkGotoStmt will return true. + +#### Returns + +`boolean` + +#### Inherited from + +[`Stmt`](Stmt.md).[`isBranch`](Stmt.md#isbranch) + +*** + +### replaceDef() + +> **replaceDef**(`oldDef`, `newDef`): `void` + +Defined in: src/core/base/Stmt.ts:81 + +#### Parameters + +##### oldDef + +[`Value`](../interfaces/Value.md) + +##### newDef + +[`Value`](../interfaces/Value.md) + +#### Returns + +`void` + +#### Inherited from + +[`Stmt`](Stmt.md).[`replaceDef`](Stmt.md#replacedef) + +*** + +### replaceUse() + +> **replaceUse**(`oldUse`, `newUse`): `void` + +Defined in: src/core/base/Stmt.ts:56 + +#### Parameters + +##### oldUse + +[`Value`](../interfaces/Value.md) + +##### newUse + +[`Value`](../interfaces/Value.md) + +#### Returns + +`void` + +#### Inherited from + +[`Stmt`](Stmt.md).[`replaceUse`](Stmt.md#replaceuse) + +*** + +### setCfg() + +> **setCfg**(`cfg`): `void` + +Defined in: src/core/base/Stmt.ts:119 + +#### Parameters + +##### cfg + +[`Cfg`](Cfg.md) + +#### Returns + +`void` + +#### Inherited from + +[`Stmt`](Stmt.md).[`setCfg`](Stmt.md#setcfg) + +*** + +### setMetadata() + +> **setMetadata**(`kind`, `value`): `void` + +Defined in: src/core/base/Stmt.ts:44 + +#### Parameters + +##### kind + +`ArkMetadataKind` + +##### value + +`ArkMetadataType` + +#### Returns + +`void` + +#### Inherited from + +[`Stmt`](Stmt.md).[`setMetadata`](Stmt.md#setmetadata) + +*** + +### setOp() + +> **setOp**(`newOp`): `void` + +Defined in: src/core/base/Stmt.ts:503 + +#### Parameters + +##### newOp + +[`Value`](../interfaces/Value.md) + +#### Returns + +`void` + +*** + +### setOperandOriginalPositions() + +> **setOperandOriginalPositions**(`operandOriginalPositions`): `void` + +Defined in: src/core/base/Stmt.ts:279 + +#### Parameters + +##### operandOriginalPositions + +[`FullPosition`](FullPosition.md)[] + +#### Returns + +`void` + +#### Inherited from + +[`Stmt`](Stmt.md).[`setOperandOriginalPositions`](Stmt.md#setoperandoriginalpositions) + +*** + +### setOriginalText() + +> **setOriginalText**(`originalText`): `void` + +Defined in: src/core/base/Stmt.ts:271 + +#### Parameters + +##### originalText + +`string` + +#### Returns + +`void` + +#### Inherited from + +[`Stmt`](Stmt.md).[`setOriginalText`](Stmt.md#setoriginaltext) + +*** + +### setOriginPositionInfo() + +> **setOriginPositionInfo**(`originPositionInfo`): `void` + +Defined in: src/core/base/Stmt.ts:238 + +#### Parameters + +##### originPositionInfo + +[`LineColPosition`](LineColPosition.md) + +#### Returns + +`void` + +#### Inherited from + +[`Stmt`](Stmt.md).[`setOriginPositionInfo`](Stmt.md#setoriginpositioninfo) + +*** + +### setText() + +> **setText**(`text`): `void` + +Defined in: src/core/base/Stmt.ts:267 + +#### Parameters + +##### text + +`string` + +#### Returns + +`void` + +#### Inherited from + +[`Stmt`](Stmt.md).[`setText`](Stmt.md#settext) + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/base/Stmt.ts:507 + +#### Returns + +`string` + +#### Overrides + +[`Stmt`](Stmt.md).[`toString`](Stmt.md#tostring) diff --git a/docs/api_docs/classes/ArkTypeOfExpr.md b/docs/api_docs/classes/ArkTypeOfExpr.md new file mode 100644 index 0000000000000000000000000000000000000000..376534f3517c4206ec2a64f8c2f0add4abeb8787 --- /dev/null +++ b/docs/api_docs/classes/ArkTypeOfExpr.md @@ -0,0 +1,163 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / ArkTypeOfExpr + +# Class: ArkTypeOfExpr + +Defined in: src/core/base/Expr.ts:729 + +## Extends + +- [`AbstractExpr`](AbstractExpr.md) + +## Constructors + +### new ArkTypeOfExpr() + +> **new ArkTypeOfExpr**(`op`): [`ArkTypeOfExpr`](ArkTypeOfExpr.md) + +Defined in: src/core/base/Expr.ts:732 + +#### Parameters + +##### op + +[`Value`](../interfaces/Value.md) + +#### Returns + +[`ArkTypeOfExpr`](ArkTypeOfExpr.md) + +#### Overrides + +[`AbstractExpr`](AbstractExpr.md).[`constructor`](AbstractExpr.md#constructors) + +## Methods + +### getOp() + +> **getOp**(): [`Value`](../interfaces/Value.md) + +Defined in: src/core/base/Expr.ts:737 + +#### Returns + +[`Value`](../interfaces/Value.md) + +*** + +### getType() + +> **getType**(): [`Type`](Type.md) + +Defined in: src/core/base/Expr.ts:752 + +Return the type of this value. The interface is encapsulated in [Value](../interfaces/Value.md). +The `Type` is defined in type.ts, such as **Any**, **Unknown**, **TypeParameter**, +**UnclearReference**, **Primitive**, **Number**, **String**, etc. + +#### Returns + +[`Type`](Type.md) + +The type of this value. + +#### Example + +1. In the declaration statement, determine the left-value type and right-value type. + +```typescript +let leftValue:Value; +let rightValue:Value; +... +if (leftValue.getType() instanceof UnknownType && + !(rightValue.getType() instanceof UnknownType) && + !(rightValue.getType() instanceof UndefinedType)) { + ... +} +``` + +#### Overrides + +[`AbstractExpr`](AbstractExpr.md).[`getType`](AbstractExpr.md#gettype) + +*** + +### getUses() + +> **getUses**(): [`Value`](../interfaces/Value.md)[] + +Defined in: src/core/base/Expr.ts:745 + +Return a list of values which are contained in this [Value](../interfaces/Value.md). +Value is a core interface in ArkAnalyzer, which may represent any value or expression. + +#### Returns + +[`Value`](../interfaces/Value.md)[] + +An **array** of values used by this value. + +#### Overrides + +[`AbstractExpr`](AbstractExpr.md).[`getUses`](AbstractExpr.md#getuses) + +*** + +### inferType() + +> **inferType**(`arkMethod`): [`AbstractExpr`](AbstractExpr.md) + +Defined in: src/core/base/Expr.ts:54 + +#### Parameters + +##### arkMethod + +[`ArkMethod`](ArkMethod.md) + +#### Returns + +[`AbstractExpr`](AbstractExpr.md) + +#### Inherited from + +[`AbstractExpr`](AbstractExpr.md).[`inferType`](AbstractExpr.md#infertype) + +*** + +### setOp() + +> **setOp**(`newOp`): `void` + +Defined in: src/core/base/Expr.ts:741 + +#### Parameters + +##### newOp + +[`Value`](../interfaces/Value.md) + +#### Returns + +`void` + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/base/Expr.ts:756 + +Returns a string representation of an object. + +#### Returns + +`string` + +#### Overrides + +[`AbstractExpr`](AbstractExpr.md).[`toString`](AbstractExpr.md#tostring) diff --git a/docs/api_docs/classes/ArkUnopExpr.md b/docs/api_docs/classes/ArkUnopExpr.md new file mode 100644 index 0000000000000000000000000000000000000000..1c8b1f3dab8aa7788e34b3d8916c3625e19f641b --- /dev/null +++ b/docs/api_docs/classes/ArkUnopExpr.md @@ -0,0 +1,183 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / ArkUnopExpr + +# Class: ArkUnopExpr + +Defined in: src/core/base/Expr.ts:902 + +## Extends + +- [`AbstractExpr`](AbstractExpr.md) + +## Constructors + +### new ArkUnopExpr() + +> **new ArkUnopExpr**(`op`, `operator`): [`ArkUnopExpr`](ArkUnopExpr.md) + +Defined in: src/core/base/Expr.ts:906 + +#### Parameters + +##### op + +[`Value`](../interfaces/Value.md) + +##### operator + +[`UnaryOperator`](../enumerations/UnaryOperator.md) + +#### Returns + +[`ArkUnopExpr`](ArkUnopExpr.md) + +#### Overrides + +[`AbstractExpr`](AbstractExpr.md).[`constructor`](AbstractExpr.md#constructors) + +## Methods + +### getOp() + +> **getOp**(): [`Value`](../interfaces/Value.md) + +Defined in: src/core/base/Expr.ts:919 + +#### Returns + +[`Value`](../interfaces/Value.md) + +*** + +### getOperator() + +> **getOperator**(): [`UnaryOperator`](../enumerations/UnaryOperator.md) + +Defined in: src/core/base/Expr.ts:935 + +Get the unary operator from the statement, such as `-`,`~`,`!`. + +#### Returns + +[`UnaryOperator`](../enumerations/UnaryOperator.md) + +the unary operator of a statement. + +*** + +### getType() + +> **getType**(): [`Type`](Type.md) + +Defined in: src/core/base/Expr.ts:927 + +Return the type of this value. The interface is encapsulated in [Value](../interfaces/Value.md). +The `Type` is defined in type.ts, such as **Any**, **Unknown**, **TypeParameter**, +**UnclearReference**, **Primitive**, **Number**, **String**, etc. + +#### Returns + +[`Type`](Type.md) + +The type of this value. + +#### Example + +1. In the declaration statement, determine the left-value type and right-value type. + +```typescript +let leftValue:Value; +let rightValue:Value; +... +if (leftValue.getType() instanceof UnknownType && + !(rightValue.getType() instanceof UnknownType) && + !(rightValue.getType() instanceof UndefinedType)) { + ... +} +``` + +#### Overrides + +[`AbstractExpr`](AbstractExpr.md).[`getType`](AbstractExpr.md#gettype) + +*** + +### getUses() + +> **getUses**(): [`Value`](../interfaces/Value.md)[] + +Defined in: src/core/base/Expr.ts:912 + +Return a list of values which are contained in this [Value](../interfaces/Value.md). +Value is a core interface in ArkAnalyzer, which may represent any value or expression. + +#### Returns + +[`Value`](../interfaces/Value.md)[] + +An **array** of values used by this value. + +#### Overrides + +[`AbstractExpr`](AbstractExpr.md).[`getUses`](AbstractExpr.md#getuses) + +*** + +### inferType() + +> **inferType**(`arkMethod`): [`AbstractExpr`](AbstractExpr.md) + +Defined in: src/core/base/Expr.ts:54 + +#### Parameters + +##### arkMethod + +[`ArkMethod`](ArkMethod.md) + +#### Returns + +[`AbstractExpr`](AbstractExpr.md) + +#### Inherited from + +[`AbstractExpr`](AbstractExpr.md).[`inferType`](AbstractExpr.md#infertype) + +*** + +### setOp() + +> **setOp**(`newOp`): `void` + +Defined in: src/core/base/Expr.ts:923 + +#### Parameters + +##### newOp + +[`Value`](../interfaces/Value.md) + +#### Returns + +`void` + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/base/Expr.ts:939 + +Returns a string representation of an object. + +#### Returns + +`string` + +#### Overrides + +[`AbstractExpr`](AbstractExpr.md).[`toString`](AbstractExpr.md#tostring) diff --git a/docs/api_docs/classes/ArkYieldExpr.md b/docs/api_docs/classes/ArkYieldExpr.md new file mode 100644 index 0000000000000000000000000000000000000000..65d46bfc80fdf78d35d480188ecf1d6cdccc18aa --- /dev/null +++ b/docs/api_docs/classes/ArkYieldExpr.md @@ -0,0 +1,163 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / ArkYieldExpr + +# Class: ArkYieldExpr + +Defined in: src/core/base/Expr.ts:467 + +## Extends + +- [`AbstractExpr`](AbstractExpr.md) + +## Constructors + +### new ArkYieldExpr() + +> **new ArkYieldExpr**(`yieldValue`): [`ArkYieldExpr`](ArkYieldExpr.md) + +Defined in: src/core/base/Expr.ts:470 + +#### Parameters + +##### yieldValue + +[`Value`](../interfaces/Value.md) + +#### Returns + +[`ArkYieldExpr`](ArkYieldExpr.md) + +#### Overrides + +[`AbstractExpr`](AbstractExpr.md).[`constructor`](AbstractExpr.md#constructors) + +## Methods + +### getType() + +> **getType**(): [`Type`](Type.md) + +Defined in: src/core/base/Expr.ts:483 + +Return the type of this value. The interface is encapsulated in [Value](../interfaces/Value.md). +The `Type` is defined in type.ts, such as **Any**, **Unknown**, **TypeParameter**, +**UnclearReference**, **Primitive**, **Number**, **String**, etc. + +#### Returns + +[`Type`](Type.md) + +The type of this value. + +#### Example + +1. In the declaration statement, determine the left-value type and right-value type. + +```typescript +let leftValue:Value; +let rightValue:Value; +... +if (leftValue.getType() instanceof UnknownType && + !(rightValue.getType() instanceof UnknownType) && + !(rightValue.getType() instanceof UndefinedType)) { + ... +} +``` + +#### Overrides + +[`AbstractExpr`](AbstractExpr.md).[`getType`](AbstractExpr.md#gettype) + +*** + +### getUses() + +> **getUses**(): [`Value`](../interfaces/Value.md)[] + +Defined in: src/core/base/Expr.ts:487 + +Return a list of values which are contained in this [Value](../interfaces/Value.md). +Value is a core interface in ArkAnalyzer, which may represent any value or expression. + +#### Returns + +[`Value`](../interfaces/Value.md)[] + +An **array** of values used by this value. + +#### Overrides + +[`AbstractExpr`](AbstractExpr.md).[`getUses`](AbstractExpr.md#getuses) + +*** + +### getYieldValue() + +> **getYieldValue**(): [`Value`](../interfaces/Value.md) + +Defined in: src/core/base/Expr.ts:475 + +#### Returns + +[`Value`](../interfaces/Value.md) + +*** + +### inferType() + +> **inferType**(`arkMethod`): [`AbstractExpr`](AbstractExpr.md) + +Defined in: src/core/base/Expr.ts:54 + +#### Parameters + +##### arkMethod + +[`ArkMethod`](ArkMethod.md) + +#### Returns + +[`AbstractExpr`](AbstractExpr.md) + +#### Inherited from + +[`AbstractExpr`](AbstractExpr.md).[`inferType`](AbstractExpr.md#infertype) + +*** + +### setYieldValue() + +> **setYieldValue**(`newYieldValue`): `void` + +Defined in: src/core/base/Expr.ts:479 + +#### Parameters + +##### newYieldValue + +[`Value`](../interfaces/Value.md) + +#### Returns + +`void` + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/base/Expr.ts:494 + +Returns a string representation of an object. + +#### Returns + +`string` + +#### Overrides + +[`AbstractExpr`](AbstractExpr.md).[`toString`](AbstractExpr.md#tostring) diff --git a/docs/api_docs/classes/ArrayType.md b/docs/api_docs/classes/ArrayType.md new file mode 100644 index 0000000000000000000000000000000000000000..9875350bfa4847fabbe5b9f61a2ae86628620906 --- /dev/null +++ b/docs/api_docs/classes/ArrayType.md @@ -0,0 +1,117 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / ArrayType + +# Class: ArrayType + +Defined in: src/core/base/Type.ts:393 + +## Extends + +- [`Type`](Type.md) + +## Constructors + +### new ArrayType() + +> **new ArrayType**(`baseType`, `dimension`): [`ArrayType`](ArrayType.md) + +Defined in: src/core/base/Type.ts:397 + +#### Parameters + +##### baseType + +[`Type`](Type.md) + +##### dimension + +`number` + +#### Returns + +[`ArrayType`](ArrayType.md) + +#### Overrides + +[`Type`](Type.md).[`constructor`](Type.md#constructors) + +## Methods + +### getBaseType() + +> **getBaseType**(): [`Type`](Type.md) + +Defined in: src/core/base/Type.ts:407 + +Returns the base type of this array, such as `Any`, `Unknown`, `TypeParameter`, etc. + +#### Returns + +[`Type`](Type.md) + +The base type of array. + +*** + +### getDimension() + +> **getDimension**(): `number` + +Defined in: src/core/base/Type.ts:415 + +#### Returns + +`number` + +*** + +### getTypeString() + +> **getTypeString**(): `string` + +Defined in: src/core/base/Type.ts:419 + +#### Returns + +`string` + +#### Overrides + +[`Type`](Type.md).[`getTypeString`](Type.md#gettypestring) + +*** + +### setBaseType() + +> **setBaseType**(`newType`): `void` + +Defined in: src/core/base/Type.ts:411 + +#### Parameters + +##### newType + +[`Type`](Type.md) + +#### Returns + +`void` + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/base/Type.ts:36 + +#### Returns + +`string` + +#### Inherited from + +[`Type`](Type.md).[`toString`](Type.md#tostring) diff --git a/docs/api_docs/classes/AstTreeUtils.md b/docs/api_docs/classes/AstTreeUtils.md new file mode 100644 index 0000000000000000000000000000000000000000..87e0a9c3fe5a0c68f4c9c2148940fdf1515ae1e3 --- /dev/null +++ b/docs/api_docs/classes/AstTreeUtils.md @@ -0,0 +1,41 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / AstTreeUtils + +# Class: AstTreeUtils + +Defined in: src/utils/AstTreeUtils.ts:19 + +## Constructors + +### new AstTreeUtils() + +> **new AstTreeUtils**(): [`AstTreeUtils`](AstTreeUtils.md) + +#### Returns + +[`AstTreeUtils`](AstTreeUtils.md) + +## Methods + +### getASTNode() + +> `static` **getASTNode**(`fileName`, `code`): [`SourceFile`](../namespaces/ts/interfaces/SourceFile.md) + +Defined in: src/utils/AstTreeUtils.ts:20 + +#### Parameters + +##### fileName + +`string` + +##### code + +`string` + +#### Returns + +[`SourceFile`](../namespaces/ts/interfaces/SourceFile.md) diff --git a/docs/api_docs/classes/BaseEdge.md b/docs/api_docs/classes/BaseEdge.md new file mode 100644 index 0000000000000000000000000000000000000000..85e116a950b19e53670e268a9d9ede3fa9062d94 --- /dev/null +++ b/docs/api_docs/classes/BaseEdge.md @@ -0,0 +1,158 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / BaseEdge + +# Class: `abstract` BaseEdge + +Defined in: src/core/graph/BaseExplicitGraph.ts:24 + +## Extended by + +- [`CallGraphEdge`](CallGraphEdge.md) +- [`PagEdge`](PagEdge.md) + +## Constructors + +### new BaseEdge() + +> **new BaseEdge**(`s`, `d`, `k`): [`BaseEdge`](BaseEdge.md) + +Defined in: src/core/graph/BaseExplicitGraph.ts:29 + +#### Parameters + +##### s + +[`BaseNode`](BaseNode.md) + +##### d + +[`BaseNode`](BaseNode.md) + +##### k + +`number` + +#### Returns + +[`BaseEdge`](BaseEdge.md) + +## Properties + +### kind + +> `protected` **kind**: `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:27 + +## Methods + +### getDotAttr() + +> **getDotAttr**(): `string` + +Defined in: src/core/graph/BaseExplicitGraph.ts:66 + +#### Returns + +`string` + +*** + +### getDstID() + +> **getDstID**(): `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:39 + +#### Returns + +`number` + +*** + +### getDstNode() + +> **getDstNode**(): [`BaseNode`](BaseNode.md) + +Defined in: src/core/graph/BaseExplicitGraph.ts:47 + +#### Returns + +[`BaseNode`](BaseNode.md) + +*** + +### getEndPoints() + +> **getEndPoints**(): `object` + +Defined in: src/core/graph/BaseExplicitGraph.ts:59 + +#### Returns + +`object` + +##### dst + +> **dst**: `number` + +##### src + +> **src**: `number` + +*** + +### getKind() + +> **getKind**(): `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:51 + +#### Returns + +`number` + +*** + +### getSrcID() + +> **getSrcID**(): `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:35 + +#### Returns + +`number` + +*** + +### getSrcNode() + +> **getSrcNode**(): [`BaseNode`](BaseNode.md) + +Defined in: src/core/graph/BaseExplicitGraph.ts:43 + +#### Returns + +[`BaseNode`](BaseNode.md) + +*** + +### setKind() + +> **setKind**(`kind`): `void` + +Defined in: src/core/graph/BaseExplicitGraph.ts:55 + +#### Parameters + +##### kind + +`number` + +#### Returns + +`void` diff --git a/docs/api_docs/classes/BaseExplicitGraph.md b/docs/api_docs/classes/BaseExplicitGraph.md new file mode 100644 index 0000000000000000000000000000000000000000..a831ad14f9360260d4c60bb9769ad20d81f1e63c --- /dev/null +++ b/docs/api_docs/classes/BaseExplicitGraph.md @@ -0,0 +1,234 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / BaseExplicitGraph + +# Class: `abstract` BaseExplicitGraph + +Defined in: src/core/graph/BaseExplicitGraph.ts:141 + +## Extended by + +- [`CallGraph`](CallGraph.md) +- [`Pag`](Pag.md) + +## Implements + +- [`GraphTraits`](../interfaces/GraphTraits.md) + +## Constructors + +### new BaseExplicitGraph() + +> **new BaseExplicitGraph**(): [`BaseExplicitGraph`](BaseExplicitGraph.md) + +Defined in: src/core/graph/BaseExplicitGraph.ts:147 + +#### Returns + +[`BaseExplicitGraph`](BaseExplicitGraph.md) + +## Properties + +### edgeMarkSet + +> `protected` **edgeMarkSet**: `Set`\<`string`\> + +Defined in: src/core/graph/BaseExplicitGraph.ts:145 + +*** + +### edgeNum + +> `protected` **edgeNum**: `number` = `0` + +Defined in: src/core/graph/BaseExplicitGraph.ts:142 + +*** + +### idToNodeMap + +> `protected` **idToNodeMap**: `Map`\<`number`, [`BaseNode`](BaseNode.md)\> + +Defined in: src/core/graph/BaseExplicitGraph.ts:144 + +*** + +### nodeNum + +> `protected` **nodeNum**: `number` = `0` + +Defined in: src/core/graph/BaseExplicitGraph.ts:143 + +## Methods + +### addNode() + +> **addNode**(`n`): `void` + +Defined in: src/core/graph/BaseExplicitGraph.ts:160 + +#### Parameters + +##### n + +[`BaseNode`](BaseNode.md) + +#### Returns + +`void` + +*** + +### getGraphName() + +> `abstract` **getGraphName**(): `string` + +Defined in: src/core/graph/BaseExplicitGraph.ts:209 + +#### Returns + +`string` + +#### Implementation of + +[`GraphTraits`](../interfaces/GraphTraits.md).[`getGraphName`](../interfaces/GraphTraits.md#getgraphname) + +*** + +### getNode() + +> **getNode**(`id`): `undefined` \| [`BaseNode`](BaseNode.md) + +Defined in: src/core/graph/BaseExplicitGraph.ts:165 + +#### Parameters + +##### id + +`number` + +#### Returns + +`undefined` \| [`BaseNode`](BaseNode.md) + +#### Implementation of + +[`GraphTraits`](../interfaces/GraphTraits.md).[`getNode`](../interfaces/GraphTraits.md#getnode) + +*** + +### getNodeNum() + +> **getNodeNum**(): `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:152 + +#### Returns + +`number` + +*** + +### getNodesIter() + +> **getNodesIter**(): `IterableIterator`\<[`BaseNode`](BaseNode.md)\> + +Defined in: src/core/graph/BaseExplicitGraph.ts:205 + +#### Returns + +`IterableIterator`\<[`BaseNode`](BaseNode.md)\> + +*** + +### hasEdge() + +> **hasEdge**(`src`, `dst`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:185 + +#### Parameters + +##### src + +[`BaseNode`](BaseNode.md) + +##### dst + +[`BaseNode`](BaseNode.md) + +#### Returns + +`boolean` + +*** + +### hasNode() + +> **hasNode**(`id`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:173 + +#### Parameters + +##### id + +`number` + +#### Returns + +`boolean` + +*** + +### ifEdgeExisting() + +> **ifEdgeExisting**(`edge`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:195 + +#### Parameters + +##### edge + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`boolean` + +*** + +### nodesItor() + +> **nodesItor**(): `IterableIterator`\<[`BaseNode`](BaseNode.md)\> + +Defined in: src/core/graph/BaseExplicitGraph.ts:156 + +#### Returns + +`IterableIterator`\<[`BaseNode`](BaseNode.md)\> + +#### Implementation of + +[`GraphTraits`](../interfaces/GraphTraits.md).[`nodesItor`](../interfaces/GraphTraits.md#nodesitor) + +*** + +### removeNode() + +> **removeNode**(`id`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:177 + +#### Parameters + +##### id + +`number` + +#### Returns + +`boolean` diff --git a/docs/api_docs/classes/BaseNode.md b/docs/api_docs/classes/BaseNode.md new file mode 100644 index 0000000000000000000000000000000000000000..39081c3c2668e4d2ed892bf880f54cb2dbc894cc --- /dev/null +++ b/docs/api_docs/classes/BaseNode.md @@ -0,0 +1,266 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / BaseNode + +# Class: `abstract` BaseNode + +Defined in: src/core/graph/BaseExplicitGraph.ts:71 + +## Extended by + +- [`CallGraphNode`](CallGraphNode.md) +- [`PagNode`](PagNode.md) + +## Constructors + +### new BaseNode() + +> **new BaseNode**(`id`, `k`): [`BaseNode`](BaseNode.md) + +Defined in: src/core/graph/BaseExplicitGraph.ts:77 + +#### Parameters + +##### id + +`number` + +##### k + +`number` + +#### Returns + +[`BaseNode`](BaseNode.md) + +## Properties + +### kind + +> `protected` **kind**: `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:73 + +## Methods + +### addIncomingEdge() + +> **addIncomingEdge**(`e`): `void` + +Defined in: src/core/graph/BaseExplicitGraph.ts:110 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`void` + +*** + +### addOutgoingEdge() + +> **addOutgoingEdge**(`e`): `void` + +Defined in: src/core/graph/BaseExplicitGraph.ts:114 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`void` + +*** + +### getDotAttr() + +> **getDotAttr**(): `string` + +Defined in: src/core/graph/BaseExplicitGraph.ts:134 + +#### Returns + +`string` + +*** + +### getDotLabel() + +> `abstract` **getDotLabel**(): `string` + +Defined in: src/core/graph/BaseExplicitGraph.ts:138 + +#### Returns + +`string` + +*** + +### getID() + +> **getID**(): `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:82 + +#### Returns + +`number` + +*** + +### getIncomingEdge() + +> **getIncomingEdge**(): `Set`\<[`BaseEdge`](BaseEdge.md)\> + +Defined in: src/core/graph/BaseExplicitGraph.ts:126 + +#### Returns + +`Set`\<[`BaseEdge`](BaseEdge.md)\> + +*** + +### getKind() + +> **getKind**(): `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:86 + +#### Returns + +`number` + +*** + +### getOutgoingEdges() + +> **getOutgoingEdges**(): `Set`\<[`BaseEdge`](BaseEdge.md)\> + +Defined in: src/core/graph/BaseExplicitGraph.ts:130 + +#### Returns + +`Set`\<[`BaseEdge`](BaseEdge.md)\> + +*** + +### hasIncomingEdge() + +> **hasIncomingEdge**(`e`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:102 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`boolean` + +*** + +### hasIncomingEdges() + +> **hasIncomingEdges**(): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:94 + +#### Returns + +`boolean` + +*** + +### hasOutgoingEdge() + +> **hasOutgoingEdge**(`e`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:106 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`boolean` + +*** + +### hasOutgoingEdges() + +> **hasOutgoingEdges**(): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:98 + +#### Returns + +`boolean` + +*** + +### removeIncomingEdge() + +> **removeIncomingEdge**(`e`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:118 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`boolean` + +*** + +### removeOutgoingEdge() + +> **removeOutgoingEdge**(`e`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:122 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`boolean` + +*** + +### setKind() + +> **setKind**(`kind`): `void` + +Defined in: src/core/graph/BaseExplicitGraph.ts:90 + +#### Parameters + +##### kind + +`number` + +#### Returns + +`void` diff --git a/docs/api_docs/classes/BasicBlock.md b/docs/api_docs/classes/BasicBlock.md new file mode 100644 index 0000000000000000000000000000000000000000..3f17590debe0ffd251174013b427e574d05d7a93 --- /dev/null +++ b/docs/api_docs/classes/BasicBlock.md @@ -0,0 +1,485 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / BasicBlock + +# Class: BasicBlock + +Defined in: src/core/graph/BasicBlock.ts:31 + +## Constructors + +### new BasicBlock() + +> **new BasicBlock**(): [`BasicBlock`](BasicBlock.md) + +Defined in: src/core/graph/BasicBlock.ts:38 + +#### Returns + +[`BasicBlock`](BasicBlock.md) + +## Methods + +### addExceptionalSuccessorBlock() + +> **addExceptionalSuccessorBlock**(`block`): `void` + +Defined in: src/core/graph/BasicBlock.ts:280 + +#### Parameters + +##### block + +[`BasicBlock`](BasicBlock.md) + +#### Returns + +`void` + +*** + +### addHead() + +> **addHead**(`stmt`): `void` + +Defined in: src/core/graph/BasicBlock.ts:64 + +Adds the given stmt at the beginning of the basic block. + +#### Parameters + +##### stmt + +[`Stmt`](Stmt.md) | [`Stmt`](Stmt.md)[] + +#### Returns + +`void` + +*** + +### addPredecessorBlock() + +> **addPredecessorBlock**(`block`): `void` + +Defined in: src/core/graph/BasicBlock.ts:184 + +#### Parameters + +##### block + +[`BasicBlock`](BasicBlock.md) + +#### Returns + +`void` + +*** + +### addStmt() + +> **addStmt**(`stmt`): `void` + +Defined in: src/core/graph/BasicBlock.ts:56 + +#### Parameters + +##### stmt + +[`Stmt`](Stmt.md) + +#### Returns + +`void` + +*** + +### addStmtToFirst() + +> **addStmtToFirst**(`stmt`): `void` + +Defined in: src/core/graph/BasicBlock.ts:205 + +#### Parameters + +##### stmt + +[`Stmt`](Stmt.md) + +#### Returns + +`void` + +*** + +### addSuccessorBlock() + +> **addSuccessorBlock**(`block`): `void` + +Defined in: src/core/graph/BasicBlock.ts:210 + +#### Parameters + +##### block + +[`BasicBlock`](BasicBlock.md) + +#### Returns + +`void` + +*** + +### addTail() + +> **addTail**(`stmt`): `void` + +Defined in: src/core/graph/BasicBlock.ts:76 + +Adds the given stmt at the end of the basic block. + +#### Parameters + +##### stmt + +[`Stmt`](Stmt.md) | [`Stmt`](Stmt.md)[] + +#### Returns + +`void` + +*** + +### getExceptionalSuccessorBlocks() + +> **getExceptionalSuccessorBlocks**(): `undefined` \| [`BasicBlock`](BasicBlock.md)[] + +Defined in: src/core/graph/BasicBlock.ts:276 + +#### Returns + +`undefined` \| [`BasicBlock`](BasicBlock.md)[] + +*** + +### getHead() + +> **getHead**(): `null` \| [`Stmt`](Stmt.md) + +Defined in: src/core/graph/BasicBlock.ts:139 + +#### Returns + +`null` \| [`Stmt`](Stmt.md) + +*** + +### getId() + +> **getId**(): `number` + +Defined in: src/core/graph/BasicBlock.ts:40 + +#### Returns + +`number` + +*** + +### getPredecessors() + +> **getPredecessors**(): [`BasicBlock`](BasicBlock.md)[] + +Defined in: src/core/graph/BasicBlock.ts:180 + +Returns predecessors of the current basic block, whose types are also basic blocks. + +#### Returns + +[`BasicBlock`](BasicBlock.md)[] + +An array of basic blocks. + +*** + +### getStmts() + +> **getStmts**(): [`Stmt`](Stmt.md)[] + +Defined in: src/core/graph/BasicBlock.ts:52 + +Returns an array of the statements in a basic block. + +#### Returns + +[`Stmt`](Stmt.md)[] + +An array of statements in a basic block. + +*** + +### getSuccessors() + +> **getSuccessors**(): [`BasicBlock`](BasicBlock.md)[] + +Defined in: src/core/graph/BasicBlock.ts:172 + +Returns successors of the current basic block, whose types are also basic blocks (i.e.[BasicBlock](BasicBlock.md)). + +#### Returns + +[`BasicBlock`](BasicBlock.md)[] + +Successors of the current basic block. + +#### Example + +1. get block successors. + +```typescript +const body = arkMethod.getBody(); +const blocks = [...body.getCfg().getBlocks()] +for (let i = 0; i < blocks.length; i++) { +const block = blocks[i] + ... + for (const next of block.getSuccessors()) { + ... + } +} +``` + +*** + +### getTail() + +> **getTail**(): `null` \| [`Stmt`](Stmt.md) + +Defined in: src/core/graph/BasicBlock.ts:146 + +#### Returns + +`null` \| [`Stmt`](Stmt.md) + +*** + +### insertAfter() + +> **insertAfter**(`toInsert`, `point`): `number` + +Defined in: src/core/graph/BasicBlock.ts:90 + +Inserts toInsert in the basic block after point. + +#### Parameters + +##### toInsert + +[`Stmt`](Stmt.md) | [`Stmt`](Stmt.md)[] + +##### point + +[`Stmt`](Stmt.md) + +#### Returns + +`number` + +The number of successfully inserted statements + +*** + +### insertBefore() + +> **insertBefore**(`toInsert`, `point`): `number` + +Defined in: src/core/graph/BasicBlock.ts:104 + +Inserts toInsert in the basic block befor point. + +#### Parameters + +##### toInsert + +[`Stmt`](Stmt.md) | [`Stmt`](Stmt.md)[] + +##### point + +[`Stmt`](Stmt.md) + +#### Returns + +`number` + +The number of successfully inserted statements + +*** + +### remove() + +> **remove**(`stmt`): `void` + +Defined in: src/core/graph/BasicBlock.ts:117 + +Removes the given stmt from this basic block. + +#### Parameters + +##### stmt + +[`Stmt`](Stmt.md) + +#### Returns + +`void` + +*** + +### removeHead() + +> **removeHead**(): `void` + +Defined in: src/core/graph/BasicBlock.ts:128 + +Removes the first stmt from this basic block. + +#### Returns + +`void` + +*** + +### removePredecessorBlock() + +> **removePredecessorBlock**(`block`): `boolean` + +Defined in: src/core/graph/BasicBlock.ts:214 + +#### Parameters + +##### block + +[`BasicBlock`](BasicBlock.md) + +#### Returns + +`boolean` + +*** + +### removeSuccessorBlock() + +> **removeSuccessorBlock**(`block`): `boolean` + +Defined in: src/core/graph/BasicBlock.ts:223 + +#### Parameters + +##### block + +[`BasicBlock`](BasicBlock.md) + +#### Returns + +`boolean` + +*** + +### removeTail() + +> **removeTail**(): `void` + +Defined in: src/core/graph/BasicBlock.ts:135 + +Removes the last stmt from this basic block. + +#### Returns + +`void` + +*** + +### setId() + +> **setId**(`id`): `void` + +Defined in: src/core/graph/BasicBlock.ts:44 + +#### Parameters + +##### id + +`number` + +#### Returns + +`void` + +*** + +### setPredecessorBlock() + +> **setPredecessorBlock**(`idx`, `block`): `boolean` + +Defined in: src/core/graph/BasicBlock.ts:188 + +#### Parameters + +##### idx + +`number` + +##### block + +[`BasicBlock`](BasicBlock.md) + +#### Returns + +`boolean` + +*** + +### setSuccessorBlock() + +> **setSuccessorBlock**(`idx`, `block`): `boolean` + +Defined in: src/core/graph/BasicBlock.ts:196 + +#### Parameters + +##### idx + +`number` + +##### block + +[`BasicBlock`](BasicBlock.md) + +#### Returns + +`boolean` + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/graph/BasicBlock.ts:232 + +#### Returns + +`string` + +*** + +### validate() + +> **validate**(): `ArkError` + +Defined in: src/core/graph/BasicBlock.ts:240 + +#### Returns + +`ArkError` diff --git a/docs/api_docs/classes/BooleanType.md b/docs/api_docs/classes/BooleanType.md new file mode 100644 index 0000000000000000000000000000000000000000..69b3d7b1f61a80cb69f2033984577ea74c15d682 --- /dev/null +++ b/docs/api_docs/classes/BooleanType.md @@ -0,0 +1,75 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / BooleanType + +# Class: BooleanType + +Defined in: src/core/base/Type.ts:135 + +primitive type + +## Extends + +- [`PrimitiveType`](PrimitiveType.md) + +## Methods + +### getName() + +> **getName**(): `string` + +Defined in: src/core/base/Type.ts:126 + +#### Returns + +`string` + +#### Inherited from + +[`PrimitiveType`](PrimitiveType.md).[`getName`](PrimitiveType.md#getname) + +*** + +### getTypeString() + +> **getTypeString**(): `string` + +Defined in: src/core/base/Type.ts:130 + +#### Returns + +`string` + +#### Inherited from + +[`PrimitiveType`](PrimitiveType.md).[`getTypeString`](PrimitiveType.md#gettypestring) + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/base/Type.ts:36 + +#### Returns + +`string` + +#### Inherited from + +[`PrimitiveType`](PrimitiveType.md).[`toString`](PrimitiveType.md#tostring) + +*** + +### getInstance() + +> `static` **getInstance**(): [`BooleanType`](BooleanType.md) + +Defined in: src/core/base/Type.ts:142 + +#### Returns + +[`BooleanType`](BooleanType.md) diff --git a/docs/api_docs/classes/CGStat.md b/docs/api_docs/classes/CGStat.md new file mode 100644 index 0000000000000000000000000000000000000000..1ca8fb37d677a76d542563e8969226513d6504b3 --- /dev/null +++ b/docs/api_docs/classes/CGStat.md @@ -0,0 +1,117 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / CGStat + +# Class: CGStat + +Defined in: src/callgraph/common/Statistics.ts:187 + +## Extends + +- `StatTraits` + +## Constructors + +### new CGStat() + +> **new CGStat**(): [`CGStat`](CGStat.md) + +#### Returns + +[`CGStat`](CGStat.md) + +#### Inherited from + +`StatTraits.constructor` + +## Properties + +### numConstructor + +> **numConstructor**: `number` = `0` + +Defined in: src/callgraph/common/Statistics.ts:193 + +*** + +### numIntrinsic + +> **numIntrinsic**: `number` = `0` + +Defined in: src/callgraph/common/Statistics.ts:192 + +*** + +### numReal + +> **numReal**: `number` = `0` + +Defined in: src/callgraph/common/Statistics.ts:190 + +*** + +### numTotalNode + +> **numTotalNode**: `number` = `0` + +Defined in: src/callgraph/common/Statistics.ts:189 + +*** + +### numVirtual + +> **numVirtual**: `number` = `0` + +Defined in: src/callgraph/common/Statistics.ts:191 + +## Methods + +### addNodeStat() + +> **addNodeStat**(`kind`): `void` + +Defined in: src/callgraph/common/Statistics.ts:195 + +#### Parameters + +##### kind + +[`CallGraphNodeKind`](../enumerations/CallGraphNodeKind.md) + +#### Returns + +`void` + +*** + +### getStat() + +> **getStat**(): `string` + +Defined in: src/callgraph/common/Statistics.ts:214 + +#### Returns + +`string` + +#### Overrides + +`StatTraits.getStat` + +*** + +### printStat() + +> **printStat**(): `void` + +Defined in: src/callgraph/common/Statistics.ts:29 + +#### Returns + +`void` + +#### Inherited from + +`StatTraits.printStat` diff --git a/docs/api_docs/classes/CSCallSite.md b/docs/api_docs/classes/CSCallSite.md new file mode 100644 index 0000000000000000000000000000000000000000..89d8a1034994aee67d4ed6f9d723cb106fcf6a25 --- /dev/null +++ b/docs/api_docs/classes/CSCallSite.md @@ -0,0 +1,95 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / CSCallSite + +# Class: CSCallSite + +Defined in: src/callgraph/model/CallGraph.ts:65 + +## Extends + +- [`CallSite`](CallSite.md) + +## Constructors + +### new CSCallSite() + +> **new CSCallSite**(`id`, `cs`): [`CSCallSite`](CSCallSite.md) + +Defined in: src/callgraph/model/CallGraph.ts:68 + +#### Parameters + +##### id + +`number` + +##### cs + +[`CallSite`](CallSite.md) + +#### Returns + +[`CSCallSite`](CSCallSite.md) + +#### Overrides + +[`CallSite`](CallSite.md).[`constructor`](CallSite.md#constructors) + +## Properties + +### args + +> **args**: `undefined` \| [`Value`](../interfaces/Value.md)[] + +Defined in: src/callgraph/model/CallGraph.ts:39 + +#### Inherited from + +[`CallSite`](CallSite.md).[`args`](CallSite.md#args) + +*** + +### calleeFuncID + +> **calleeFuncID**: `number` + +Defined in: src/callgraph/model/CallGraph.ts:40 + +#### Inherited from + +[`CallSite`](CallSite.md).[`calleeFuncID`](CallSite.md#calleefuncid) + +*** + +### callerFuncID + +> **callerFuncID**: `number` + +Defined in: src/callgraph/model/CallGraph.ts:41 + +#### Inherited from + +[`CallSite`](CallSite.md).[`callerFuncID`](CallSite.md#callerfuncid) + +*** + +### callStmt + +> **callStmt**: [`Stmt`](Stmt.md) + +Defined in: src/callgraph/model/CallGraph.ts:38 + +#### Inherited from + +[`CallSite`](CallSite.md).[`callStmt`](CallSite.md#callstmt) + +*** + +### cid + +> **cid**: `number` + +Defined in: src/callgraph/model/CallGraph.ts:66 diff --git a/docs/api_docs/classes/CSFuncID.md b/docs/api_docs/classes/CSFuncID.md new file mode 100644 index 0000000000000000000000000000000000000000..d1109b59986ce5cdc9decc69d3dc83640134f770 --- /dev/null +++ b/docs/api_docs/classes/CSFuncID.md @@ -0,0 +1,47 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / CSFuncID + +# Class: CSFuncID + +Defined in: src/callgraph/pointerAnalysis/PagBuilder.ts:40 + +## Constructors + +### new CSFuncID() + +> **new CSFuncID**(`cid`, `fid`): [`CSFuncID`](CSFuncID.md) + +Defined in: src/callgraph/pointerAnalysis/PagBuilder.ts:43 + +#### Parameters + +##### cid + +`number` + +##### fid + +`number` + +#### Returns + +[`CSFuncID`](CSFuncID.md) + +## Properties + +### cid + +> **cid**: `number` + +Defined in: src/callgraph/pointerAnalysis/PagBuilder.ts:41 + +*** + +### funcID + +> **funcID**: `number` + +Defined in: src/callgraph/pointerAnalysis/PagBuilder.ts:42 diff --git a/docs/api_docs/classes/CallGraph.md b/docs/api_docs/classes/CallGraph.md new file mode 100644 index 0000000000000000000000000000000000000000..d8052120b9aca924ae202d93f4932abbee8fab92 --- /dev/null +++ b/docs/api_docs/classes/CallGraph.md @@ -0,0 +1,715 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / CallGraph + +# Class: CallGraph + +Defined in: src/callgraph/model/CallGraph.ts:160 + +## Extends + +- [`BaseExplicitGraph`](BaseExplicitGraph.md) + +## Constructors + +### new CallGraph() + +> **new CallGraph**(`s`): [`CallGraph`](CallGraph.md) + +Defined in: src/callgraph/model/CallGraph.ts:175 + +#### Parameters + +##### s + +[`Scene`](Scene.md) + +#### Returns + +[`CallGraph`](CallGraph.md) + +#### Overrides + +[`BaseExplicitGraph`](BaseExplicitGraph.md).[`constructor`](BaseExplicitGraph.md#constructors) + +## Properties + +### edgeMarkSet + +> `protected` **edgeMarkSet**: `Set`\<`string`\> + +Defined in: src/core/graph/BaseExplicitGraph.ts:145 + +#### Inherited from + +[`BaseExplicitGraph`](BaseExplicitGraph.md).[`edgeMarkSet`](BaseExplicitGraph.md#edgemarkset) + +*** + +### edgeNum + +> `protected` **edgeNum**: `number` = `0` + +Defined in: src/core/graph/BaseExplicitGraph.ts:142 + +#### Inherited from + +[`BaseExplicitGraph`](BaseExplicitGraph.md).[`edgeNum`](BaseExplicitGraph.md#edgenum) + +*** + +### idToNodeMap + +> `protected` **idToNodeMap**: `Map`\<`number`, [`BaseNode`](BaseNode.md)\> + +Defined in: src/core/graph/BaseExplicitGraph.ts:144 + +#### Inherited from + +[`BaseExplicitGraph`](BaseExplicitGraph.md).[`idToNodeMap`](BaseExplicitGraph.md#idtonodemap) + +*** + +### nodeNum + +> `protected` **nodeNum**: `number` = `0` + +Defined in: src/core/graph/BaseExplicitGraph.ts:143 + +#### Inherited from + +[`BaseExplicitGraph`](BaseExplicitGraph.md).[`nodeNum`](BaseExplicitGraph.md#nodenum) + +## Methods + +### addCallGraphNode() + +> **addCallGraphNode**(`method`, `kind`): [`CallGraphNode`](CallGraphNode.md) + +Defined in: src/callgraph/model/CallGraph.ts:190 + +#### Parameters + +##### method + +[`MethodSignature`](MethodSignature.md) + +##### kind + +[`CallGraphNodeKind`](../enumerations/CallGraphNodeKind.md) = `CallGraphNodeKind.real` + +#### Returns + +[`CallGraphNode`](CallGraphNode.md) + +*** + +### addDirectOrSpecialCallEdge() + +> **addDirectOrSpecialCallEdge**(`caller`, `callee`, `callStmt`, `isDirectCall`): `void` + +Defined in: src/callgraph/model/CallGraph.ts:234 + +#### Parameters + +##### caller + +[`MethodSignature`](MethodSignature.md) + +##### callee + +[`MethodSignature`](MethodSignature.md) + +##### callStmt + +[`Stmt`](Stmt.md) + +##### isDirectCall + +`boolean` = `true` + +#### Returns + +`void` + +*** + +### addDynamicCallEdge() + +> **addDynamicCallEdge**(`callerID`, `calleeID`, `callStmt`): `void` + +Defined in: src/callgraph/model/CallGraph.ts:292 + +#### Parameters + +##### callerID + +`number` + +##### calleeID + +`number` + +##### callStmt + +[`Stmt`](Stmt.md) + +#### Returns + +`void` + +*** + +### addDynamicCallInfo() + +> **addDynamicCallInfo**(`callStmt`, `caller`, `protentialCallee`?): `void` + +Defined in: src/callgraph/model/CallGraph.ts:280 + +#### Parameters + +##### callStmt + +[`Stmt`](Stmt.md) + +##### caller + +[`MethodSignature`](MethodSignature.md) + +##### protentialCallee? + +[`MethodSignature`](MethodSignature.md) + +#### Returns + +`void` + +*** + +### addNode() + +> **addNode**(`n`): `void` + +Defined in: src/core/graph/BaseExplicitGraph.ts:160 + +#### Parameters + +##### n + +[`BaseNode`](BaseNode.md) + +#### Returns + +`void` + +#### Inherited from + +[`BaseExplicitGraph`](BaseExplicitGraph.md).[`addNode`](BaseExplicitGraph.md#addnode) + +*** + +### addStmtToCallSiteMap() + +> **addStmtToCallSiteMap**(`stmt`, `cs`): `boolean` + +Defined in: src/callgraph/model/CallGraph.ts:310 + +#### Parameters + +##### stmt + +[`Stmt`](Stmt.md) + +##### cs + +[`CallSite`](CallSite.md) + +#### Returns + +`boolean` + +*** + +### detectReachable() + +> **detectReachable**(`fromID`, `dstID`): `boolean` + +Defined in: src/callgraph/model/CallGraph.ts:375 + +#### Parameters + +##### fromID + +`number` + +##### dstID + +`number` + +#### Returns + +`boolean` + +*** + +### dump() + +> **dump**(`name`, `entry`?): `void` + +Defined in: src/callgraph/model/CallGraph.ts:367 + +#### Parameters + +##### name + +`string` + +##### entry? + +`number` + +#### Returns + +`void` + +*** + +### getArkMethodByFuncID() + +> **getArkMethodByFuncID**(`id`): `null` \| [`ArkMethod`](ArkMethod.md) + +Defined in: src/callgraph/model/CallGraph.ts:349 + +#### Parameters + +##### id + +`number` + +#### Returns + +`null` \| [`ArkMethod`](ArkMethod.md) + +*** + +### getCallEdgeByPair() + +> **getCallEdgeByPair**(`srcID`, `dstID`): `undefined` \| [`CallGraphEdge`](CallGraphEdge.md) + +Defined in: src/callgraph/model/CallGraph.ts:185 + +#### Parameters + +##### srcID + +`number` + +##### dstID + +`number` + +#### Returns + +`undefined` \| [`CallGraphEdge`](CallGraphEdge.md) + +*** + +### getCallGraphNodeByMethod() + +> **getCallGraphNodeByMethod**(`method`): [`CallGraphNode`](CallGraphNode.md) + +Defined in: src/callgraph/model/CallGraph.ts:218 + +#### Parameters + +##### method + +[`MethodSignature`](MethodSignature.md) + +#### Returns + +[`CallGraphNode`](CallGraphNode.md) + +*** + +### getCallSiteByStmt() + +> **getCallSiteByStmt**(`stmt`): `undefined` \| [`CallSite`](CallSite.md) + +Defined in: src/callgraph/model/CallGraph.ts:318 + +#### Parameters + +##### stmt + +[`Stmt`](Stmt.md) + +#### Returns + +`undefined` \| [`CallSite`](CallSite.md) + +*** + +### getDummyMainFuncID() + +> **getDummyMainFuncID**(): `undefined` \| `number` + +Defined in: src/callgraph/model/CallGraph.ts:413 + +#### Returns + +`undefined` \| `number` + +*** + +### getDynCallsiteByStmt() + +> **getDynCallsiteByStmt**(`stmt`): `undefined` \| [`DynCallSite`](DynCallSite.md) + +Defined in: src/callgraph/model/CallGraph.ts:306 + +#### Parameters + +##### stmt + +[`Stmt`](Stmt.md) + +#### Returns + +`undefined` \| [`DynCallSite`](DynCallSite.md) + +*** + +### getDynEdges() + +> **getDynEdges**(): `Map`\<[`MethodSignature`](MethodSignature.md), `Set`\<[`MethodSignature`](MethodSignature.md)\>\> + +Defined in: src/callgraph/model/CallGraph.ts:322 + +#### Returns + +`Map`\<[`MethodSignature`](MethodSignature.md), `Set`\<[`MethodSignature`](MethodSignature.md)\>\> + +*** + +### getEntries() + +> **getEntries**(): `number`[] + +Defined in: src/callgraph/model/CallGraph.ts:359 + +#### Returns + +`number`[] + +*** + +### getGraphName() + +> **getGraphName**(): `string` + +Defined in: src/callgraph/model/CallGraph.ts:429 + +#### Returns + +`string` + +#### Overrides + +[`BaseExplicitGraph`](BaseExplicitGraph.md).[`getGraphName`](BaseExplicitGraph.md#getgraphname) + +*** + +### getMethodByFuncID() + +> **getMethodByFuncID**(`id`): `null` \| [`MethodSignature`](MethodSignature.md) + +Defined in: src/callgraph/model/CallGraph.ts:340 + +#### Parameters + +##### id + +`number` + +#### Returns + +`null` \| [`MethodSignature`](MethodSignature.md) + +*** + +### getNode() + +> **getNode**(`id`): `undefined` \| [`BaseNode`](BaseNode.md) + +Defined in: src/core/graph/BaseExplicitGraph.ts:165 + +#### Parameters + +##### id + +`number` + +#### Returns + +`undefined` \| [`BaseNode`](BaseNode.md) + +#### Inherited from + +[`BaseExplicitGraph`](BaseExplicitGraph.md).[`getNode`](BaseExplicitGraph.md#getnode) + +*** + +### getNodeNum() + +> **getNodeNum**(): `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:152 + +#### Returns + +`number` + +#### Inherited from + +[`BaseExplicitGraph`](BaseExplicitGraph.md).[`getNodeNum`](BaseExplicitGraph.md#getnodenum) + +*** + +### getNodesIter() + +> **getNodesIter**(): `IterableIterator`\<[`BaseNode`](BaseNode.md)\> + +Defined in: src/core/graph/BaseExplicitGraph.ts:205 + +#### Returns + +`IterableIterator`\<[`BaseNode`](BaseNode.md)\> + +#### Inherited from + +[`BaseExplicitGraph`](BaseExplicitGraph.md).[`getNodesIter`](BaseExplicitGraph.md#getnodesiter) + +*** + +### getStat() + +> **getStat**(): `string` + +Defined in: src/callgraph/model/CallGraph.ts:405 + +#### Returns + +`string` + +*** + +### hasEdge() + +> **hasEdge**(`src`, `dst`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:185 + +#### Parameters + +##### src + +[`BaseNode`](BaseNode.md) + +##### dst + +[`BaseNode`](BaseNode.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`BaseExplicitGraph`](BaseExplicitGraph.md).[`hasEdge`](BaseExplicitGraph.md#hasedge) + +*** + +### hasNode() + +> **hasNode**(`id`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:173 + +#### Parameters + +##### id + +`number` + +#### Returns + +`boolean` + +#### Inherited from + +[`BaseExplicitGraph`](BaseExplicitGraph.md).[`hasNode`](BaseExplicitGraph.md#hasnode) + +*** + +### ifEdgeExisting() + +> **ifEdgeExisting**(`edge`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:195 + +#### Parameters + +##### edge + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`BaseExplicitGraph`](BaseExplicitGraph.md).[`ifEdgeExisting`](BaseExplicitGraph.md#ifedgeexisting) + +*** + +### isUnknownMethod() + +> **isUnknownMethod**(`funcID`): `boolean` + +Defined in: src/callgraph/model/CallGraph.ts:417 + +#### Parameters + +##### funcID + +`number` + +#### Returns + +`boolean` + +*** + +### nodesItor() + +> **nodesItor**(): `IterableIterator`\<[`BaseNode`](BaseNode.md)\> + +Defined in: src/core/graph/BaseExplicitGraph.ts:156 + +#### Returns + +`IterableIterator`\<[`BaseNode`](BaseNode.md)\> + +#### Inherited from + +[`BaseExplicitGraph`](BaseExplicitGraph.md).[`nodesItor`](BaseExplicitGraph.md#nodesitor) + +*** + +### printStat() + +> **printStat**(): `void` + +Defined in: src/callgraph/model/CallGraph.ts:401 + +#### Returns + +`void` + +*** + +### removeCallGraphEdge() + +> **removeCallGraphEdge**(`nodeID`): `void` + +Defined in: src/callgraph/model/CallGraph.ts:268 + +#### Parameters + +##### nodeID + +`number` + +#### Returns + +`void` + +*** + +### removeCallGraphNode() + +> **removeCallGraphNode**(`nodeID`): `void` + +Defined in: src/callgraph/model/CallGraph.ts:209 + +#### Parameters + +##### nodeID + +`number` + +#### Returns + +`void` + +*** + +### removeNode() + +> **removeNode**(`id`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:177 + +#### Parameters + +##### id + +`number` + +#### Returns + +`boolean` + +#### Inherited from + +[`BaseExplicitGraph`](BaseExplicitGraph.md).[`removeNode`](BaseExplicitGraph.md#removenode) + +*** + +### setDummyMainFuncID() + +> **setDummyMainFuncID**(`dummyMainMethodID`): `void` + +Defined in: src/callgraph/model/CallGraph.ts:409 + +#### Parameters + +##### dummyMainMethodID + +`number` + +#### Returns + +`void` + +*** + +### setEntries() + +> **setEntries**(`n`): `void` + +Defined in: src/callgraph/model/CallGraph.ts:363 + +#### Parameters + +##### n + +`number`[] + +#### Returns + +`void` diff --git a/docs/api_docs/classes/CallGraphBuilder.md b/docs/api_docs/classes/CallGraphBuilder.md new file mode 100644 index 0000000000000000000000000000000000000000..28c4e812b70c06c016b04c199364d5f84be6afe0 --- /dev/null +++ b/docs/api_docs/classes/CallGraphBuilder.md @@ -0,0 +1,117 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / CallGraphBuilder + +# Class: CallGraphBuilder + +Defined in: src/callgraph/model/builder/CallGraphBuilder.ts:24 + +## Constructors + +### new CallGraphBuilder() + +> **new CallGraphBuilder**(`c`, `s`): [`CallGraphBuilder`](CallGraphBuilder.md) + +Defined in: src/callgraph/model/builder/CallGraphBuilder.ts:28 + +#### Parameters + +##### c + +[`CallGraph`](CallGraph.md) + +##### s + +[`Scene`](Scene.md) + +#### Returns + +[`CallGraphBuilder`](CallGraphBuilder.md) + +## Methods + +### buildClassHierarchyCallGraph() + +> **buildClassHierarchyCallGraph**(`entries`, `displayGeneratedMethod`): `void` + +Defined in: src/callgraph/model/builder/CallGraphBuilder.ts:83 + +#### Parameters + +##### entries + +[`MethodSignature`](MethodSignature.md)[] + +##### displayGeneratedMethod + +`boolean` = `false` + +#### Returns + +`void` + +*** + +### buildDirectCallGraph() + +> **buildDirectCallGraph**(`methods`): `void` + +Defined in: src/callgraph/model/builder/CallGraphBuilder.ts:42 + +#### Parameters + +##### methods + +[`ArkMethod`](ArkMethod.md)[] + +#### Returns + +`void` + +*** + +### buildDirectCallGraphForScene() + +> **buildDirectCallGraphForScene**(): `void` + +Defined in: src/callgraph/model/builder/CallGraphBuilder.ts:34 + +#### Returns + +`void` + +*** + +### buildRapidTypeCallGraph() + +> **buildRapidTypeCallGraph**(`entries`, `displayGeneratedMethod`): `void` + +Defined in: src/callgraph/model/builder/CallGraphBuilder.ts:94 + +#### Parameters + +##### entries + +[`MethodSignature`](MethodSignature.md)[] + +##### displayGeneratedMethod + +`boolean` = `false` + +#### Returns + +`void` + +*** + +### setEntries() + +> **setEntries**(): `void` + +Defined in: src/callgraph/model/builder/CallGraphBuilder.ts:114 + +#### Returns + +`void` diff --git a/docs/api_docs/classes/CallGraphEdge.md b/docs/api_docs/classes/CallGraphEdge.md new file mode 100644 index 0000000000000000000000000000000000000000..2bfce9ab99b96d015e7a5b52a1a88dcf0a0fccaa --- /dev/null +++ b/docs/api_docs/classes/CallGraphEdge.md @@ -0,0 +1,247 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / CallGraphEdge + +# Class: CallGraphEdge + +Defined in: src/callgraph/model/CallGraph.ts:74 + +## Extends + +- [`BaseEdge`](BaseEdge.md) + +## Constructors + +### new CallGraphEdge() + +> **new CallGraphEdge**(`src`, `dst`): [`CallGraphEdge`](CallGraphEdge.md) + +Defined in: src/callgraph/model/CallGraph.ts:80 + +#### Parameters + +##### src + +[`CallGraphNode`](CallGraphNode.md) + +##### dst + +[`CallGraphNode`](CallGraphNode.md) + +#### Returns + +[`CallGraphEdge`](CallGraphEdge.md) + +#### Overrides + +[`BaseEdge`](BaseEdge.md).[`constructor`](BaseEdge.md#constructors) + +## Properties + +### kind + +> `protected` **kind**: `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:27 + +#### Inherited from + +[`BaseEdge`](BaseEdge.md).[`kind`](BaseEdge.md#kind) + +## Methods + +### addDirectCallSite() + +> **addDirectCallSite**(`stmt`): `void` + +Defined in: src/callgraph/model/CallGraph.ts:84 + +#### Parameters + +##### stmt + +[`Stmt`](Stmt.md) + +#### Returns + +`void` + +*** + +### addInDirectCallSite() + +> **addInDirectCallSite**(`stmt`): `void` + +Defined in: src/callgraph/model/CallGraph.ts:92 + +#### Parameters + +##### stmt + +[`Stmt`](Stmt.md) + +#### Returns + +`void` + +*** + +### addSpecialCallSite() + +> **addSpecialCallSite**(`stmt`): `void` + +Defined in: src/callgraph/model/CallGraph.ts:88 + +#### Parameters + +##### stmt + +[`Stmt`](Stmt.md) + +#### Returns + +`void` + +*** + +### getDotAttr() + +> **getDotAttr**(): `string` + +Defined in: src/callgraph/model/CallGraph.ts:96 + +#### Returns + +`string` + +#### Overrides + +[`BaseEdge`](BaseEdge.md).[`getDotAttr`](BaseEdge.md#getdotattr) + +*** + +### getDstID() + +> **getDstID**(): `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:39 + +#### Returns + +`number` + +#### Inherited from + +[`BaseEdge`](BaseEdge.md).[`getDstID`](BaseEdge.md#getdstid) + +*** + +### getDstNode() + +> **getDstNode**(): [`BaseNode`](BaseNode.md) + +Defined in: src/core/graph/BaseExplicitGraph.ts:47 + +#### Returns + +[`BaseNode`](BaseNode.md) + +#### Inherited from + +[`BaseEdge`](BaseEdge.md).[`getDstNode`](BaseEdge.md#getdstnode) + +*** + +### getEndPoints() + +> **getEndPoints**(): `object` + +Defined in: src/core/graph/BaseExplicitGraph.ts:59 + +#### Returns + +`object` + +##### dst + +> **dst**: `number` + +##### src + +> **src**: `number` + +#### Inherited from + +[`BaseEdge`](BaseEdge.md).[`getEndPoints`](BaseEdge.md#getendpoints) + +*** + +### getKind() + +> **getKind**(): `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:51 + +#### Returns + +`number` + +#### Inherited from + +[`BaseEdge`](BaseEdge.md).[`getKind`](BaseEdge.md#getkind) + +*** + +### getSrcID() + +> **getSrcID**(): `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:35 + +#### Returns + +`number` + +#### Inherited from + +[`BaseEdge`](BaseEdge.md).[`getSrcID`](BaseEdge.md#getsrcid) + +*** + +### getSrcNode() + +> **getSrcNode**(): [`BaseNode`](BaseNode.md) + +Defined in: src/core/graph/BaseExplicitGraph.ts:43 + +#### Returns + +[`BaseNode`](BaseNode.md) + +#### Inherited from + +[`BaseEdge`](BaseEdge.md).[`getSrcNode`](BaseEdge.md#getsrcnode) + +*** + +### setKind() + +> **setKind**(`kind`): `void` + +Defined in: src/core/graph/BaseExplicitGraph.ts:55 + +#### Parameters + +##### kind + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`BaseEdge`](BaseEdge.md).[`setKind`](BaseEdge.md#setkind) diff --git a/docs/api_docs/classes/CallGraphNode.md b/docs/api_docs/classes/CallGraphNode.md new file mode 100644 index 0000000000000000000000000000000000000000..c607af84467fcc15c67d6c2ccce5f9aa5030f85e --- /dev/null +++ b/docs/api_docs/classes/CallGraphNode.md @@ -0,0 +1,409 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / CallGraphNode + +# Class: CallGraphNode + +Defined in: src/callgraph/model/CallGraph.ts:116 + +## Extends + +- [`BaseNode`](BaseNode.md) + +## Constructors + +### new CallGraphNode() + +> **new CallGraphNode**(`id`, `m`, `k`): [`CallGraphNode`](CallGraphNode.md) + +Defined in: src/callgraph/model/CallGraph.ts:121 + +#### Parameters + +##### id + +`number` + +##### m + +[`MethodSignature`](MethodSignature.md) + +##### k + +[`CallGraphNodeKind`](../enumerations/CallGraphNodeKind.md) = `CallGraphNodeKind.real` + +#### Returns + +[`CallGraphNode`](CallGraphNode.md) + +#### Overrides + +[`BaseNode`](BaseNode.md).[`constructor`](BaseNode.md#constructors) + +## Properties + +### kind + +> `protected` **kind**: `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:73 + +#### Inherited from + +[`BaseNode`](BaseNode.md).[`kind`](BaseNode.md#kind) + +## Accessors + +### isBlankMethod + +#### Get Signature + +> **get** **isBlankMethod**(): `boolean` + +Defined in: src/callgraph/model/CallGraph.ts:138 + +##### Returns + +`boolean` + +#### Set Signature + +> **set** **isBlankMethod**(`is`): `void` + +Defined in: src/callgraph/model/CallGraph.ts:142 + +##### Parameters + +###### is + +`boolean` + +##### Returns + +`void` + +## Methods + +### addIncomingEdge() + +> **addIncomingEdge**(`e`): `void` + +Defined in: src/core/graph/BaseExplicitGraph.ts:110 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`BaseNode`](BaseNode.md).[`addIncomingEdge`](BaseNode.md#addincomingedge) + +*** + +### addOutgoingEdge() + +> **addOutgoingEdge**(`e`): `void` + +Defined in: src/core/graph/BaseExplicitGraph.ts:114 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`BaseNode`](BaseNode.md).[`addOutgoingEdge`](BaseNode.md#addoutgoingedge) + +*** + +### getDotAttr() + +> **getDotAttr**(): `string` + +Defined in: src/callgraph/model/CallGraph.ts:146 + +#### Returns + +`string` + +#### Overrides + +[`BaseNode`](BaseNode.md).[`getDotAttr`](BaseNode.md#getdotattr) + +*** + +### getDotLabel() + +> **getDotLabel**(): `string` + +Defined in: src/callgraph/model/CallGraph.ts:153 + +#### Returns + +`string` + +#### Overrides + +[`BaseNode`](BaseNode.md).[`getDotLabel`](BaseNode.md#getdotlabel) + +*** + +### getID() + +> **getID**(): `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:82 + +#### Returns + +`number` + +#### Inherited from + +[`BaseNode`](BaseNode.md).[`getID`](BaseNode.md#getid) + +*** + +### getIncomingEdge() + +> **getIncomingEdge**(): `Set`\<[`BaseEdge`](BaseEdge.md)\> + +Defined in: src/core/graph/BaseExplicitGraph.ts:126 + +#### Returns + +`Set`\<[`BaseEdge`](BaseEdge.md)\> + +#### Inherited from + +[`BaseNode`](BaseNode.md).[`getIncomingEdge`](BaseNode.md#getincomingedge) + +*** + +### getKind() + +> **getKind**(): `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:86 + +#### Returns + +`number` + +#### Inherited from + +[`BaseNode`](BaseNode.md).[`getKind`](BaseNode.md#getkind) + +*** + +### getMethod() + +> **getMethod**(): [`MethodSignature`](MethodSignature.md) + +Defined in: src/callgraph/model/CallGraph.ts:126 + +#### Returns + +[`MethodSignature`](MethodSignature.md) + +*** + +### getOutgoingEdges() + +> **getOutgoingEdges**(): `Set`\<[`BaseEdge`](BaseEdge.md)\> + +Defined in: src/core/graph/BaseExplicitGraph.ts:130 + +#### Returns + +`Set`\<[`BaseEdge`](BaseEdge.md)\> + +#### Inherited from + +[`BaseNode`](BaseNode.md).[`getOutgoingEdges`](BaseNode.md#getoutgoingedges) + +*** + +### hasIncomingEdge() + +> **hasIncomingEdge**(`e`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:102 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`BaseNode`](BaseNode.md).[`hasIncomingEdge`](BaseNode.md#hasincomingedge) + +*** + +### hasIncomingEdges() + +> **hasIncomingEdges**(): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:94 + +#### Returns + +`boolean` + +#### Inherited from + +[`BaseNode`](BaseNode.md).[`hasIncomingEdges`](BaseNode.md#hasincomingedges) + +*** + +### hasOutgoingEdge() + +> **hasOutgoingEdge**(`e`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:106 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`BaseNode`](BaseNode.md).[`hasOutgoingEdge`](BaseNode.md#hasoutgoingedge) + +*** + +### hasOutgoingEdges() + +> **hasOutgoingEdges**(): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:98 + +#### Returns + +`boolean` + +#### Inherited from + +[`BaseNode`](BaseNode.md).[`hasOutgoingEdges`](BaseNode.md#hasoutgoingedges) + +*** + +### isSdkMethod() + +> **isSdkMethod**(): `boolean` + +Defined in: src/callgraph/model/CallGraph.ts:134 + +#### Returns + +`boolean` + +*** + +### removeIncomingEdge() + +> **removeIncomingEdge**(`e`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:118 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`BaseNode`](BaseNode.md).[`removeIncomingEdge`](BaseNode.md#removeincomingedge) + +*** + +### removeOutgoingEdge() + +> **removeOutgoingEdge**(`e`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:122 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`BaseNode`](BaseNode.md).[`removeOutgoingEdge`](BaseNode.md#removeoutgoingedge) + +*** + +### setKind() + +> **setKind**(`kind`): `void` + +Defined in: src/core/graph/BaseExplicitGraph.ts:90 + +#### Parameters + +##### kind + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`BaseNode`](BaseNode.md).[`setKind`](BaseNode.md#setkind) + +*** + +### setSdkMethod() + +> **setSdkMethod**(`v`): `void` + +Defined in: src/callgraph/model/CallGraph.ts:130 + +#### Parameters + +##### v + +`boolean` + +#### Returns + +`void` diff --git a/docs/api_docs/classes/CallSite.md b/docs/api_docs/classes/CallSite.md new file mode 100644 index 0000000000000000000000000000000000000000..d668f95f8db9a1c511054b9aa16e6f858559a2e9 --- /dev/null +++ b/docs/api_docs/classes/CallSite.md @@ -0,0 +1,75 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / CallSite + +# Class: CallSite + +Defined in: src/callgraph/model/CallGraph.ts:37 + +## Extended by + +- [`CSCallSite`](CSCallSite.md) + +## Constructors + +### new CallSite() + +> **new CallSite**(`s`, `a`, `ce`, `cr`): [`CallSite`](CallSite.md) + +Defined in: src/callgraph/model/CallGraph.ts:43 + +#### Parameters + +##### s + +[`Stmt`](Stmt.md) + +##### a + +`undefined` | [`Value`](../interfaces/Value.md)[] + +##### ce + +`number` + +##### cr + +`number` + +#### Returns + +[`CallSite`](CallSite.md) + +## Properties + +### args + +> **args**: `undefined` \| [`Value`](../interfaces/Value.md)[] + +Defined in: src/callgraph/model/CallGraph.ts:39 + +*** + +### calleeFuncID + +> **calleeFuncID**: `number` + +Defined in: src/callgraph/model/CallGraph.ts:40 + +*** + +### callerFuncID + +> **callerFuncID**: `number` + +Defined in: src/callgraph/model/CallGraph.ts:41 + +*** + +### callStmt + +> **callStmt**: [`Stmt`](Stmt.md) + +Defined in: src/callgraph/model/CallGraph.ts:38 diff --git a/docs/api_docs/classes/Cfg.md b/docs/api_docs/classes/Cfg.md new file mode 100644 index 0000000000000000000000000000000000000000..74ee5263d5b5503e9b8a339d7fa054ada93d8ea6 --- /dev/null +++ b/docs/api_docs/classes/Cfg.md @@ -0,0 +1,309 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / Cfg + +# Class: Cfg + +Defined in: src/core/graph/Cfg.ts:30 + +## Constructors + +### new Cfg() + +> **new Cfg**(): [`Cfg`](Cfg.md) + +Defined in: src/core/graph/Cfg.ts:38 + +#### Returns + +[`Cfg`](Cfg.md) + +## Methods + +### addBlock() + +> **addBlock**(`block`): `void` + +Defined in: src/core/graph/Cfg.ts:114 + +#### Parameters + +##### block + +[`BasicBlock`](BasicBlock.md) + +#### Returns + +`void` + +*** + +### buildDefUseChain() + +> **buildDefUseChain**(): `void` + +Defined in: src/core/graph/Cfg.ts:182 + +#### Returns + +`void` + +*** + +### buildDefUseStmt() + +> **buildDefUseStmt**(`locals`): `void` + +Defined in: src/core/graph/Cfg.ts:155 + +#### Parameters + +##### locals + +`Set`\<[`Local`](Local.md)\> + +#### Returns + +`void` + +*** + +### getBlocks() + +> **getBlocks**(): `Set`\<[`BasicBlock`](BasicBlock.md)\> + +Defined in: src/core/graph/Cfg.ts:122 + +#### Returns + +`Set`\<[`BasicBlock`](BasicBlock.md)\> + +*** + +### getDeclaringMethod() + +> **getDeclaringMethod**(): [`ArkMethod`](ArkMethod.md) + +Defined in: src/core/graph/Cfg.ts:138 + +#### Returns + +[`ArkMethod`](ArkMethod.md) + +*** + +### getDefUseChains() + +> **getDefUseChains**(): [`DefUseChain`](DefUseChain.md)[] + +Defined in: src/core/graph/Cfg.ts:146 + +#### Returns + +[`DefUseChain`](DefUseChain.md)[] + +*** + +### getStartingBlock() + +> **getStartingBlock**(): `undefined` \| [`BasicBlock`](BasicBlock.md) + +Defined in: src/core/graph/Cfg.ts:126 + +#### Returns + +`undefined` \| [`BasicBlock`](BasicBlock.md) + +*** + +### getStartingStmt() + +> **getStartingStmt**(): [`Stmt`](Stmt.md) + +Defined in: src/core/graph/Cfg.ts:130 + +#### Returns + +[`Stmt`](Stmt.md) + +*** + +### getStmts() + +> **getStmts**(): [`Stmt`](Stmt.md)[] + +Defined in: src/core/graph/Cfg.ts:40 + +#### Returns + +[`Stmt`](Stmt.md)[] + +*** + +### getUnreachableBlocks() + +> **getUnreachableBlocks**(): `Set`\<[`BasicBlock`](BasicBlock.md)\> + +Defined in: src/core/graph/Cfg.ts:236 + +#### Returns + +`Set`\<[`BasicBlock`](BasicBlock.md)\> + +*** + +### insertAfter() + +> **insertAfter**(`toInsert`, `point`): `number` + +Defined in: src/core/graph/Cfg.ts:54 + +Inserts toInsert in the basic block in CFG after point. + +#### Parameters + +##### toInsert + +[`Stmt`](Stmt.md) | [`Stmt`](Stmt.md)[] + +##### point + +[`Stmt`](Stmt.md) + +#### Returns + +`number` + +The number of successfully inserted statements + +*** + +### insertBefore() + +> **insertBefore**(`toInsert`, `point`): `number` + +Defined in: src/core/graph/Cfg.ts:70 + +Inserts toInsert in the basic block in CFG befor point. + +#### Parameters + +##### toInsert + +[`Stmt`](Stmt.md) | [`Stmt`](Stmt.md)[] + +##### point + +[`Stmt`](Stmt.md) + +#### Returns + +`number` + +The number of successfully inserted statements + +*** + +### remove() + +> **remove**(`stmt`): `void` + +Defined in: src/core/graph/Cfg.ts:85 + +Removes the given stmt from the basic block in CFG. + +#### Parameters + +##### stmt + +[`Stmt`](Stmt.md) + +#### Returns + +`void` + +*** + +### setDeclaringMethod() + +> **setDeclaringMethod**(`method`): `void` + +Defined in: src/core/graph/Cfg.ts:142 + +#### Parameters + +##### method + +[`ArkMethod`](ArkMethod.md) + +#### Returns + +`void` + +*** + +### setStartingStmt() + +> **setStartingStmt**(`newStartingStmt`): `void` + +Defined in: src/core/graph/Cfg.ts:134 + +#### Parameters + +##### newStartingStmt + +[`Stmt`](Stmt.md) + +#### Returns + +`void` + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/graph/Cfg.ts:151 + +#### Returns + +`string` + +*** + +### updateStmt2BlockMap() + +> **updateStmt2BlockMap**(`block`, `changed`?): `void` + +Defined in: src/core/graph/Cfg.ts:99 + +Update stmtToBlock Map + +#### Parameters + +##### block + +[`BasicBlock`](BasicBlock.md) + +##### changed? + +[`Stmt`](Stmt.md) | [`Stmt`](Stmt.md)[] + +#### Returns + +`void` + +*** + +### validate() + +> **validate**(): `ArkError` + +Defined in: src/core/graph/Cfg.ts:251 + +#### Returns + +`ArkError` diff --git a/docs/api_docs/classes/ClassHierarchyAnalysis.md b/docs/api_docs/classes/ClassHierarchyAnalysis.md new file mode 100644 index 0000000000000000000000000000000000000000..b5111c17fbc596a1e085f40015e90b26b601ce4a --- /dev/null +++ b/docs/api_docs/classes/ClassHierarchyAnalysis.md @@ -0,0 +1,333 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / ClassHierarchyAnalysis + +# Class: ClassHierarchyAnalysis + +Defined in: src/callgraph/algorithm/ClassHierarchyAnalysis.ts:24 + +## Extends + +- [`AbstractAnalysis`](AbstractAnalysis.md) + +## Constructors + +### new ClassHierarchyAnalysis() + +> **new ClassHierarchyAnalysis**(`scene`, `cg`): [`ClassHierarchyAnalysis`](ClassHierarchyAnalysis.md) + +Defined in: src/callgraph/algorithm/ClassHierarchyAnalysis.ts:26 + +#### Parameters + +##### scene + +[`Scene`](Scene.md) + +##### cg + +[`CallGraph`](CallGraph.md) + +#### Returns + +[`ClassHierarchyAnalysis`](ClassHierarchyAnalysis.md) + +#### Overrides + +[`AbstractAnalysis`](AbstractAnalysis.md).[`constructor`](AbstractAnalysis.md#constructors) + +## Properties + +### cg + +> `protected` **cg**: [`CallGraph`](CallGraph.md) + +Defined in: src/callgraph/algorithm/AbstractAnalysis.ts:32 + +#### Inherited from + +[`AbstractAnalysis`](AbstractAnalysis.md).[`cg`](AbstractAnalysis.md#cg) + +*** + +### cgBuilder + +> `protected` **cgBuilder**: [`CallGraphBuilder`](CallGraphBuilder.md) + +Defined in: src/callgraph/algorithm/AbstractAnalysis.ts:33 + +#### Inherited from + +[`AbstractAnalysis`](AbstractAnalysis.md).[`cgBuilder`](AbstractAnalysis.md#cgbuilder) + +*** + +### processedMethod + +> `protected` **processedMethod**: `Set`\<`number`\> + +Defined in: src/callgraph/algorithm/AbstractAnalysis.ts:35 + +#### Inherited from + +[`AbstractAnalysis`](AbstractAnalysis.md).[`processedMethod`](AbstractAnalysis.md#processedmethod) + +*** + +### scene + +> `protected` **scene**: [`Scene`](Scene.md) + +Defined in: src/callgraph/algorithm/AbstractAnalysis.ts:31 + +#### Inherited from + +[`AbstractAnalysis`](AbstractAnalysis.md).[`scene`](AbstractAnalysis.md#scene) + +*** + +### workList + +> `protected` **workList**: `number`[] = `[]` + +Defined in: src/callgraph/algorithm/AbstractAnalysis.ts:34 + +#### Inherited from + +[`AbstractAnalysis`](AbstractAnalysis.md).[`workList`](AbstractAnalysis.md#worklist) + +## Methods + +### addCallGraphEdge() + +> `protected` **addCallGraphEdge**(`caller`, `callee`, `cs`, `displayGeneratedMethod`): `void` + +Defined in: src/callgraph/algorithm/AbstractAnalysis.ts:147 + +#### Parameters + +##### caller + +`number` + +##### callee + +`null` | [`ArkMethod`](ArkMethod.md) + +##### cs + +[`CallSite`](CallSite.md) + +##### displayGeneratedMethod + +`boolean` + +#### Returns + +`void` + +#### Inherited from + +[`AbstractAnalysis`](AbstractAnalysis.md).[`addCallGraphEdge`](AbstractAnalysis.md#addcallgraphedge) + +*** + +### getCallGraph() + +> **getCallGraph**(): [`CallGraph`](CallGraph.md) + +Defined in: src/callgraph/algorithm/AbstractAnalysis.ts:45 + +#### Returns + +[`CallGraph`](CallGraph.md) + +#### Inherited from + +[`AbstractAnalysis`](AbstractAnalysis.md).[`getCallGraph`](AbstractAnalysis.md#getcallgraph) + +*** + +### getClassHierarchy() + +> **getClassHierarchy**(`arkClass`): [`ArkClass`](ArkClass.md)[] + +Defined in: src/callgraph/algorithm/AbstractAnalysis.ts:59 + +#### Parameters + +##### arkClass + +[`ArkClass`](ArkClass.md) + +#### Returns + +[`ArkClass`](ArkClass.md)[] + +#### Inherited from + +[`AbstractAnalysis`](AbstractAnalysis.md).[`getClassHierarchy`](AbstractAnalysis.md#getclasshierarchy) + +*** + +### getParamAnonymousMethod() + +> `protected` **getParamAnonymousMethod**(`invokeExpr`): [`MethodSignature`](MethodSignature.md)[] + +Defined in: src/callgraph/algorithm/AbstractAnalysis.ts:134 + +#### Parameters + +##### invokeExpr + +[`AbstractInvokeExpr`](AbstractInvokeExpr.md) + +#### Returns + +[`MethodSignature`](MethodSignature.md)[] + +#### Inherited from + +[`AbstractAnalysis`](AbstractAnalysis.md).[`getParamAnonymousMethod`](AbstractAnalysis.md#getparamanonymousmethod) + +*** + +### getScene() + +> **getScene**(): [`Scene`](Scene.md) + +Defined in: src/callgraph/algorithm/AbstractAnalysis.ts:41 + +#### Returns + +[`Scene`](Scene.md) + +#### Inherited from + +[`AbstractAnalysis`](AbstractAnalysis.md).[`getScene`](AbstractAnalysis.md#getscene) + +*** + +### init() + +> `protected` **init**(): `void` + +Defined in: src/callgraph/algorithm/AbstractAnalysis.ts:105 + +#### Returns + +`void` + +#### Inherited from + +[`AbstractAnalysis`](AbstractAnalysis.md).[`init`](AbstractAnalysis.md#init) + +*** + +### preProcessMethod() + +> `protected` **preProcessMethod**(): [`CallSite`](CallSite.md)[] + +Defined in: src/callgraph/algorithm/ClassHierarchyAnalysis.ts:87 + +#### Returns + +[`CallSite`](CallSite.md)[] + +#### Overrides + +[`AbstractAnalysis`](AbstractAnalysis.md).[`preProcessMethod`](AbstractAnalysis.md#preprocessmethod) + +*** + +### processMethod() + +> `protected` **processMethod**(`methodID`): [`CallSite`](CallSite.md)[] + +Defined in: src/callgraph/algorithm/AbstractAnalysis.ts:112 + +#### Parameters + +##### methodID + +`number` + +#### Returns + +[`CallSite`](CallSite.md)[] + +#### Inherited from + +[`AbstractAnalysis`](AbstractAnalysis.md).[`processMethod`](AbstractAnalysis.md#processmethod) + +*** + +### resolveCall() + +> **resolveCall**(`callerMethod`, `invokeStmt`): [`CallSite`](CallSite.md)[] + +Defined in: src/callgraph/algorithm/ClassHierarchyAnalysis.ts:31 + +#### Parameters + +##### callerMethod + +`number` + +##### invokeStmt + +[`Stmt`](Stmt.md) + +#### Returns + +[`CallSite`](CallSite.md)[] + +#### Overrides + +[`AbstractAnalysis`](AbstractAnalysis.md).[`resolveCall`](AbstractAnalysis.md#resolvecall) + +*** + +### resolveInvokeExpr() + +> **resolveInvokeExpr**(`invokeExpr`): `undefined` \| [`ArkMethod`](ArkMethod.md) + +Defined in: src/callgraph/algorithm/AbstractAnalysis.ts:52 + +#### Parameters + +##### invokeExpr + +[`AbstractInvokeExpr`](AbstractInvokeExpr.md) + +#### Returns + +`undefined` \| [`ArkMethod`](ArkMethod.md) + +#### Inherited from + +[`AbstractAnalysis`](AbstractAnalysis.md).[`resolveInvokeExpr`](AbstractAnalysis.md#resolveinvokeexpr) + +*** + +### start() + +> **start**(`displayGeneratedMethod`): `void` + +Defined in: src/callgraph/algorithm/AbstractAnalysis.ts:75 + +#### Parameters + +##### displayGeneratedMethod + +`boolean` + +#### Returns + +`void` + +#### Inherited from + +[`AbstractAnalysis`](AbstractAnalysis.md).[`start`](AbstractAnalysis.md#start) diff --git a/docs/api_docs/classes/ClassSignature.md b/docs/api_docs/classes/ClassSignature.md new file mode 100644 index 0000000000000000000000000000000000000000..c7a4adeef49b2e86a3e84cb7c39efe9d235c8a99 --- /dev/null +++ b/docs/api_docs/classes/ClassSignature.md @@ -0,0 +1,149 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / ClassSignature + +# Class: ClassSignature + +Defined in: src/core/model/ArkSignature.ts:112 + +## Extended by + +- [`AliasClassSignature`](AliasClassSignature.md) + +## Constructors + +### new ClassSignature() + +> **new ClassSignature**(`className`, `declaringFileSignature`, `declaringNamespaceSignature`): [`ClassSignature`](ClassSignature.md) + +Defined in: src/core/model/ArkSignature.ts:120 + +#### Parameters + +##### className + +`string` + +##### declaringFileSignature + +[`FileSignature`](FileSignature.md) + +##### declaringNamespaceSignature + +`null` | [`NamespaceSignature`](NamespaceSignature.md) + +#### Returns + +[`ClassSignature`](ClassSignature.md) + +## Properties + +### DEFAULT + +> `readonly` `static` **DEFAULT**: [`ClassSignature`](ClassSignature.md) + +Defined in: src/core/model/ArkSignature.ts:117 + +## Methods + +### getClassName() + +> **getClassName**(): `string` + +Defined in: src/core/model/ArkSignature.ts:147 + +Get the **string** name of class from the the class signature. The default value is `""`. + +#### Returns + +`string` + +The name of this class. + +*** + +### getDeclaringFileSignature() + +> **getDeclaringFileSignature**(): [`FileSignature`](FileSignature.md) + +Defined in: src/core/model/ArkSignature.ts:131 + +Returns the declaring file signature. + +#### Returns + +[`FileSignature`](FileSignature.md) + +The declaring file signature. + +*** + +### getDeclaringNamespaceSignature() + +> **getDeclaringNamespaceSignature**(): `null` \| [`NamespaceSignature`](NamespaceSignature.md) + +Defined in: src/core/model/ArkSignature.ts:139 + +Get the declaring namespace's signature. + +#### Returns + +`null` \| [`NamespaceSignature`](NamespaceSignature.md) + +the declaring namespace's signature. + +*** + +### getType() + +> **getType**(): [`ClassType`](ClassType.md) + +Defined in: src/core/model/ArkSignature.ts:155 + +#### Returns + +[`ClassType`](ClassType.md) + +*** + +### setClassName() + +> **setClassName**(`className`): `void` + +Defined in: src/core/model/ArkSignature.ts:151 + +#### Parameters + +##### className + +`string` + +#### Returns + +`void` + +*** + +### toMapKey() + +> **toMapKey**(): `string` + +Defined in: src/core/model/ArkSignature.ts:167 + +#### Returns + +`string` + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/model/ArkSignature.ts:159 + +#### Returns + +`string` diff --git a/docs/api_docs/classes/ClassType.md b/docs/api_docs/classes/ClassType.md new file mode 100644 index 0000000000000000000000000000000000000000..8609985df97654bca0951e09545099272e147f1f --- /dev/null +++ b/docs/api_docs/classes/ClassType.md @@ -0,0 +1,133 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / ClassType + +# Class: ClassType + +Defined in: src/core/base/Type.ts:357 + +type of an object + +## Extends + +- [`Type`](Type.md) + +## Constructors + +### new ClassType() + +> **new ClassType**(`classSignature`, `realGenericTypes`?): [`ClassType`](ClassType.md) + +Defined in: src/core/base/Type.ts:361 + +#### Parameters + +##### classSignature + +[`ClassSignature`](ClassSignature.md) + +##### realGenericTypes? + +[`Type`](Type.md)[] + +#### Returns + +[`ClassType`](ClassType.md) + +#### Overrides + +[`Type`](Type.md).[`constructor`](Type.md#constructors) + +## Methods + +### getClassSignature() + +> **getClassSignature**(): [`ClassSignature`](ClassSignature.md) + +Defined in: src/core/base/Type.ts:367 + +#### Returns + +[`ClassSignature`](ClassSignature.md) + +*** + +### getRealGenericTypes() + +> **getRealGenericTypes**(): `undefined` \| [`Type`](Type.md)[] + +Defined in: src/core/base/Type.ts:375 + +#### Returns + +`undefined` \| [`Type`](Type.md)[] + +*** + +### getTypeString() + +> **getTypeString**(): `string` + +Defined in: src/core/base/Type.ts:383 + +#### Returns + +`string` + +#### Overrides + +[`Type`](Type.md).[`getTypeString`](Type.md#gettypestring) + +*** + +### setClassSignature() + +> **setClassSignature**(`newClassSignature`): `void` + +Defined in: src/core/base/Type.ts:371 + +#### Parameters + +##### newClassSignature + +[`ClassSignature`](ClassSignature.md) + +#### Returns + +`void` + +*** + +### setRealGenericTypes() + +> **setRealGenericTypes**(`types`): `void` + +Defined in: src/core/base/Type.ts:379 + +#### Parameters + +##### types + +`undefined` | [`Type`](Type.md)[] + +#### Returns + +`void` + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/base/Type.ts:36 + +#### Returns + +`string` + +#### Inherited from + +[`Type`](Type.md).[`toString`](Type.md#tostring) diff --git a/docs/api_docs/classes/ClosureFieldRef.md b/docs/api_docs/classes/ClosureFieldRef.md new file mode 100644 index 0000000000000000000000000000000000000000..3d12bbc89407d73e9093a17b772523d2ecc31eab --- /dev/null +++ b/docs/api_docs/classes/ClosureFieldRef.md @@ -0,0 +1,161 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / ClosureFieldRef + +# Class: ClosureFieldRef + +Defined in: src/core/base/Ref.ts:391 + +## Extends + +- [`AbstractRef`](AbstractRef.md) + +## Constructors + +### new ClosureFieldRef() + +> **new ClosureFieldRef**(`base`, `fieldName`, `type`): [`ClosureFieldRef`](ClosureFieldRef.md) + +Defined in: src/core/base/Ref.ts:396 + +#### Parameters + +##### base + +[`Local`](Local.md) + +##### fieldName + +`string` + +##### type + +[`Type`](Type.md) + +#### Returns + +[`ClosureFieldRef`](ClosureFieldRef.md) + +#### Overrides + +[`AbstractRef`](AbstractRef.md).[`constructor`](AbstractRef.md#constructors) + +## Methods + +### getBase() + +> **getBase**(): [`Local`](Local.md) + +Defined in: src/core/base/Ref.ts:407 + +#### Returns + +[`Local`](Local.md) + +*** + +### getFieldName() + +> **getFieldName**(): `string` + +Defined in: src/core/base/Ref.ts:415 + +#### Returns + +`string` + +*** + +### getType() + +> **getType**(): [`Type`](Type.md) + +Defined in: src/core/base/Ref.ts:411 + +Return the type of this value. The interface is encapsulated in [Value](../interfaces/Value.md). +The `Type` is defined in type.ts, such as **Any**, **Unknown**, **TypeParameter**, +**UnclearReference**, **Primitive**, **Number**, **String**, etc. + +#### Returns + +[`Type`](Type.md) + +The type of this value. + +#### Example + +1. In the declaration statement, determine the left-value type and right-value type. + +```typescript +let leftValue:Value; +let rightValue:Value; +... +if (leftValue.getType() instanceof UnknownType && + !(rightValue.getType() instanceof UnknownType) && + !(rightValue.getType() instanceof UndefinedType)) { + ... +} +``` + +#### Overrides + +[`AbstractRef`](AbstractRef.md).[`getType`](AbstractRef.md#gettype) + +*** + +### getUses() + +> **getUses**(): [`Value`](../interfaces/Value.md)[] + +Defined in: src/core/base/Ref.ts:403 + +Return a list of values which are contained in this [Value](../interfaces/Value.md). +Value is a core interface in ArkAnalyzer, which may represent any value or expression. + +#### Returns + +[`Value`](../interfaces/Value.md)[] + +An **array** of values used by this value. + +#### Overrides + +[`AbstractRef`](AbstractRef.md).[`getUses`](AbstractRef.md#getuses) + +*** + +### inferType() + +> **inferType**(`arkMethod`): [`AbstractRef`](AbstractRef.md) + +Defined in: src/core/base/Ref.ts:37 + +#### Parameters + +##### arkMethod + +[`ArkMethod`](ArkMethod.md) + +#### Returns + +[`AbstractRef`](AbstractRef.md) + +#### Inherited from + +[`AbstractRef`](AbstractRef.md).[`inferType`](AbstractRef.md#infertype) + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/base/Ref.ts:419 + +Returns a string representation of an object. + +#### Returns + +`string` diff --git a/docs/api_docs/classes/ClosureType.md b/docs/api_docs/classes/ClosureType.md new file mode 100644 index 0000000000000000000000000000000000000000..6f1bc5def7f97a392802e0782a4a3409d3ee4db9 --- /dev/null +++ b/docs/api_docs/classes/ClosureType.md @@ -0,0 +1,121 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / ClosureType + +# Class: ClosureType + +Defined in: src/core/base/Type.ts:336 + +types for closures which is a special FunctionType with a lexical env + +## Extends + +- [`FunctionType`](FunctionType.md) + +## Constructors + +### new ClosureType() + +> **new ClosureType**(`lexicalEnv`, `methodSignature`, `realGenericTypes`?): [`ClosureType`](ClosureType.md) + +Defined in: src/core/base/Type.ts:339 + +#### Parameters + +##### lexicalEnv + +[`LexicalEnvType`](LexicalEnvType.md) + +##### methodSignature + +[`MethodSignature`](MethodSignature.md) + +##### realGenericTypes? + +[`Type`](Type.md)[] + +#### Returns + +[`ClosureType`](ClosureType.md) + +#### Overrides + +[`FunctionType`](FunctionType.md).[`constructor`](FunctionType.md#constructors) + +## Methods + +### getLexicalEnv() + +> **getLexicalEnv**(): [`LexicalEnvType`](LexicalEnvType.md) + +Defined in: src/core/base/Type.ts:344 + +#### Returns + +[`LexicalEnvType`](LexicalEnvType.md) + +*** + +### getMethodSignature() + +> **getMethodSignature**(): [`MethodSignature`](MethodSignature.md) + +Defined in: src/core/base/Type.ts:319 + +#### Returns + +[`MethodSignature`](MethodSignature.md) + +#### Inherited from + +[`FunctionType`](FunctionType.md).[`getMethodSignature`](FunctionType.md#getmethodsignature) + +*** + +### getRealGenericTypes() + +> **getRealGenericTypes**(): `undefined` \| [`Type`](Type.md)[] + +Defined in: src/core/base/Type.ts:323 + +#### Returns + +`undefined` \| [`Type`](Type.md)[] + +#### Inherited from + +[`FunctionType`](FunctionType.md).[`getRealGenericTypes`](FunctionType.md#getrealgenerictypes) + +*** + +### getTypeString() + +> **getTypeString**(): `string` + +Defined in: src/core/base/Type.ts:348 + +#### Returns + +`string` + +#### Overrides + +[`FunctionType`](FunctionType.md).[`getTypeString`](FunctionType.md#gettypestring) + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/base/Type.ts:36 + +#### Returns + +`string` + +#### Inherited from + +[`FunctionType`](FunctionType.md).[`toString`](FunctionType.md#tostring) diff --git a/docs/api_docs/classes/Constant.md b/docs/api_docs/classes/Constant.md new file mode 100644 index 0000000000000000000000000000000000000000..f7fefc0e26640a1196eb8ec382d9a4c8b523639c --- /dev/null +++ b/docs/api_docs/classes/Constant.md @@ -0,0 +1,108 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / Constant + +# Class: Constant + +Defined in: src/core/base/Constant.ts:23 + +## Implements + +- [`Value`](../interfaces/Value.md) + +## Constructors + +### new Constant() + +> **new Constant**(`value`, `type`): [`Constant`](Constant.md) + +Defined in: src/core/base/Constant.ts:27 + +#### Parameters + +##### value + +`string` + +##### type + +[`Type`](Type.md) + +#### Returns + +[`Constant`](Constant.md) + +## Methods + +### getType() + +> **getType**(): [`Type`](Type.md) + +Defined in: src/core/base/Constant.ts:48 + +Returns the type of this constant. + +#### Returns + +[`Type`](Type.md) + +The type of this constant. + +#### Implementation of + +[`Value`](../interfaces/Value.md).[`getType`](../interfaces/Value.md#gettype) + +*** + +### getUses() + +> **getUses**(): [`Value`](../interfaces/Value.md)[] + +Defined in: src/core/base/Constant.ts:40 + +Return a list of values which are contained in this [Value](../interfaces/Value.md). +Value is a core interface in ArkAnalyzer, which may represent any value or expression. + +#### Returns + +[`Value`](../interfaces/Value.md)[] + +An **array** of values used by this value. + +#### Implementation of + +[`Value`](../interfaces/Value.md).[`getUses`](../interfaces/Value.md#getuses) + +*** + +### getValue() + +> **getValue**(): `string` + +Defined in: src/core/base/Constant.ts:36 + +Returns the constant's value as a **string**. + +#### Returns + +`string` + +The constant's value. + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/base/Constant.ts:56 + +Get a string of constant value in Constant. + +#### Returns + +`string` + +The string of constant value. diff --git a/docs/api_docs/classes/CopyPagEdge.md b/docs/api_docs/classes/CopyPagEdge.md new file mode 100644 index 0000000000000000000000000000000000000000..2eb863b23ab0afda6bbc724ea36457e8ddef1462 --- /dev/null +++ b/docs/api_docs/classes/CopyPagEdge.md @@ -0,0 +1,197 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / CopyPagEdge + +# Class: CopyPagEdge + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:94 + +## Extends + +- [`PagEdge`](PagEdge.md) + +## Constructors + +### new CopyPagEdge() + +> **new CopyPagEdge**(`n`, `d`, `s`): [`CopyPagEdge`](CopyPagEdge.md) + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:95 + +#### Parameters + +##### n + +[`PagNode`](PagNode.md) + +##### d + +[`PagNode`](PagNode.md) + +##### s + +[`Stmt`](Stmt.md) + +#### Returns + +[`CopyPagEdge`](CopyPagEdge.md) + +#### Overrides + +[`PagEdge`](PagEdge.md).[`constructor`](PagEdge.md#constructors) + +## Properties + +### kind + +> `protected` **kind**: `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:27 + +#### Inherited from + +[`PagEdge`](PagEdge.md).[`kind`](PagEdge.md#kind) + +## Methods + +### getDotAttr() + +> **getDotAttr**(): `string` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:65 + +#### Returns + +`string` + +#### Inherited from + +[`PagEdge`](PagEdge.md).[`getDotAttr`](PagEdge.md#getdotattr) + +*** + +### getDstID() + +> **getDstID**(): `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:39 + +#### Returns + +`number` + +#### Inherited from + +[`PagEdge`](PagEdge.md).[`getDstID`](PagEdge.md#getdstid) + +*** + +### getDstNode() + +> **getDstNode**(): [`BaseNode`](BaseNode.md) + +Defined in: src/core/graph/BaseExplicitGraph.ts:47 + +#### Returns + +[`BaseNode`](BaseNode.md) + +#### Inherited from + +[`PagEdge`](PagEdge.md).[`getDstNode`](PagEdge.md#getdstnode) + +*** + +### getEndPoints() + +> **getEndPoints**(): `object` + +Defined in: src/core/graph/BaseExplicitGraph.ts:59 + +#### Returns + +`object` + +##### dst + +> **dst**: `number` + +##### src + +> **src**: `number` + +#### Inherited from + +[`PagEdge`](PagEdge.md).[`getEndPoints`](PagEdge.md#getendpoints) + +*** + +### getKind() + +> **getKind**(): `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:51 + +#### Returns + +`number` + +#### Inherited from + +[`PagEdge`](PagEdge.md).[`getKind`](PagEdge.md#getkind) + +*** + +### getSrcID() + +> **getSrcID**(): `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:35 + +#### Returns + +`number` + +#### Inherited from + +[`PagEdge`](PagEdge.md).[`getSrcID`](PagEdge.md#getsrcid) + +*** + +### getSrcNode() + +> **getSrcNode**(): [`BaseNode`](BaseNode.md) + +Defined in: src/core/graph/BaseExplicitGraph.ts:43 + +#### Returns + +[`BaseNode`](BaseNode.md) + +#### Inherited from + +[`PagEdge`](PagEdge.md).[`getSrcNode`](PagEdge.md#getsrcnode) + +*** + +### setKind() + +> **setKind**(`kind`): `void` + +Defined in: src/core/graph/BaseExplicitGraph.ts:55 + +#### Parameters + +##### kind + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`PagEdge`](PagEdge.md).[`setKind`](PagEdge.md#setkind) diff --git a/docs/api_docs/classes/DataflowProblem.md b/docs/api_docs/classes/DataflowProblem.md new file mode 100644 index 0000000000000000000000000000000000000000..d43bb21217151b34df63e2007a59d506ca943ecf --- /dev/null +++ b/docs/api_docs/classes/DataflowProblem.md @@ -0,0 +1,181 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / DataflowProblem + +# Class: `abstract` DataflowProblem\ + +Defined in: src/core/dataflow/DataflowProblem.ts:19 + +## Extended by + +- [`UndefinedVariableChecker`](UndefinedVariableChecker.md) + +## Type Parameters + +• **D** + +## Constructors + +### new DataflowProblem() + +> **new DataflowProblem**\<`D`\>(): [`DataflowProblem`](DataflowProblem.md)\<`D`\> + +#### Returns + +[`DataflowProblem`](DataflowProblem.md)\<`D`\> + +## Methods + +### createZeroValue() + +> `abstract` **createZeroValue**(): `D` + +Defined in: src/core/dataflow/DataflowProblem.ts:44 + +#### Returns + +`D` + +*** + +### factEqual() + +> `abstract` **factEqual**(`d1`, `d2`): `boolean` + +Defined in: src/core/dataflow/DataflowProblem.ts:50 + +#### Parameters + +##### d1 + +`D` + +##### d2 + +`D` + +#### Returns + +`boolean` + +*** + +### getCallFlowFunction() + +> `abstract` **getCallFlowFunction**(`srcStmt`, `method`): [`FlowFunction`](../interfaces/FlowFunction.md)\<`D`\> + +Defined in: src/core/dataflow/DataflowProblem.ts:38 + +#### Parameters + +##### srcStmt + +[`Stmt`](Stmt.md) + +##### method + +[`ArkMethod`](ArkMethod.md) + +#### Returns + +[`FlowFunction`](../interfaces/FlowFunction.md)\<`D`\> + +*** + +### getCallToReturnFlowFunction() + +> `abstract` **getCallToReturnFlowFunction**(`srcStmt`, `tgtStmt`): [`FlowFunction`](../interfaces/FlowFunction.md)\<`D`\> + +Defined in: src/core/dataflow/DataflowProblem.ts:42 + +#### Parameters + +##### srcStmt + +[`Stmt`](Stmt.md) + +##### tgtStmt + +[`Stmt`](Stmt.md) + +#### Returns + +[`FlowFunction`](../interfaces/FlowFunction.md)\<`D`\> + +*** + +### getEntryMethod() + +> `abstract` **getEntryMethod**(): [`ArkMethod`](ArkMethod.md) + +Defined in: src/core/dataflow/DataflowProblem.ts:48 + +#### Returns + +[`ArkMethod`](ArkMethod.md) + +*** + +### getEntryPoint() + +> `abstract` **getEntryPoint**(): [`Stmt`](Stmt.md) + +Defined in: src/core/dataflow/DataflowProblem.ts:46 + +#### Returns + +[`Stmt`](Stmt.md) + +*** + +### getExitToReturnFlowFunction() + +> `abstract` **getExitToReturnFlowFunction**(`srcStmt`, `tgtStmt`, `callStmt`): [`FlowFunction`](../interfaces/FlowFunction.md)\<`D`\> + +Defined in: src/core/dataflow/DataflowProblem.ts:40 + +#### Parameters + +##### srcStmt + +[`Stmt`](Stmt.md) + +##### tgtStmt + +[`Stmt`](Stmt.md) + +##### callStmt + +[`Stmt`](Stmt.md) + +#### Returns + +[`FlowFunction`](../interfaces/FlowFunction.md)\<`D`\> + +*** + +### getNormalFlowFunction() + +> `abstract` **getNormalFlowFunction**(`srcStmt`, `tgtStmt`): [`FlowFunction`](../interfaces/FlowFunction.md)\<`D`\> + +Defined in: src/core/dataflow/DataflowProblem.ts:36 + +Transfer the outFact of srcStmt to the inFact of tgtStmt + +Return true if keeping progagation (i.e., tgtStmt will be added to the WorkList for further analysis) + +#### Parameters + +##### srcStmt + +[`Stmt`](Stmt.md) + +##### tgtStmt + +[`Stmt`](Stmt.md) + +#### Returns + +[`FlowFunction`](../interfaces/FlowFunction.md)\<`D`\> diff --git a/docs/api_docs/classes/DataflowResult.md b/docs/api_docs/classes/DataflowResult.md new file mode 100644 index 0000000000000000000000000000000000000000..42f9ed0b822b6332fb53a24081bb194eb301b0e8 --- /dev/null +++ b/docs/api_docs/classes/DataflowResult.md @@ -0,0 +1,43 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / DataflowResult + +# Class: DataflowResult + +Defined in: src/core/dataflow/DataflowResult.ts:19 + +## Constructors + +### new DataflowResult() + +> **new DataflowResult**(): [`DataflowResult`](DataflowResult.md) + +#### Returns + +[`DataflowResult`](DataflowResult.md) + +## Properties + +### globalFacts + +> **globalFacts**: `Set`\<[`Fact`](Fact.md)\> + +Defined in: src/core/dataflow/DataflowResult.ts:24 + +*** + +### stmt2InFacts + +> **stmt2InFacts**: `Map`\<[`Stmt`](Stmt.md), [`Fact`](Fact.md)\> + +Defined in: src/core/dataflow/DataflowResult.ts:20 + +*** + +### stmt2OutFacts + +> **stmt2OutFacts**: `Map`\<[`Stmt`](Stmt.md), [`Fact`](Fact.md)\> + +Defined in: src/core/dataflow/DataflowResult.ts:21 diff --git a/docs/api_docs/classes/DataflowSolver.md b/docs/api_docs/classes/DataflowSolver.md new file mode 100644 index 0000000000000000000000000000000000000000..70b9e203d80b58a03595f7e606a1ae79b12cbd66 --- /dev/null +++ b/docs/api_docs/classes/DataflowSolver.md @@ -0,0 +1,467 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / DataflowSolver + +# Class: `abstract` DataflowSolver\ + +Defined in: src/core/dataflow/DataflowSolver.ts:39 + +## Extended by + +- [`UndefinedVariableSolver`](UndefinedVariableSolver.md) + +## Type Parameters + +• **D** + +## Constructors + +### new DataflowSolver() + +> **new DataflowSolver**\<`D`\>(`problem`, `scene`): [`DataflowSolver`](DataflowSolver.md)\<`D`\> + +Defined in: src/core/dataflow/DataflowSolver.ts:53 + +#### Parameters + +##### problem + +[`DataflowProblem`](DataflowProblem.md)\<`D`\> + +##### scene + +[`Scene`](Scene.md) + +#### Returns + +[`DataflowSolver`](DataflowSolver.md)\<`D`\> + +## Properties + +### CHA + +> `protected` **CHA**: [`ClassHierarchyAnalysis`](ClassHierarchyAnalysis.md) + +Defined in: src/core/dataflow/DataflowSolver.ts:49 + +*** + +### endSummary + +> `protected` **endSummary**: `Map`\<[`PathEdgePoint`](PathEdgePoint.md)\<`D`\>, `Set`\<[`PathEdgePoint`](PathEdgePoint.md)\<`D`\>\>\> + +Defined in: src/core/dataflow/DataflowSolver.ts:46 + +*** + +### inComing + +> `protected` **inComing**: `Map`\<[`PathEdgePoint`](PathEdgePoint.md)\<`D`\>, `Set`\<[`PathEdgePoint`](PathEdgePoint.md)\<`D`\>\>\> + +Defined in: src/core/dataflow/DataflowSolver.ts:45 + +*** + +### laterEdges + +> `protected` **laterEdges**: `Set`\<[`PathEdge`](PathEdge.md)\<`D`\>\> + +Defined in: src/core/dataflow/DataflowSolver.ts:51 + +*** + +### pathEdgeSet + +> `protected` **pathEdgeSet**: `Set`\<[`PathEdge`](PathEdge.md)\<`D`\>\> + +Defined in: src/core/dataflow/DataflowSolver.ts:43 + +*** + +### problem + +> `protected` **problem**: [`DataflowProblem`](DataflowProblem.md)\<`D`\> + +Defined in: src/core/dataflow/DataflowSolver.ts:41 + +*** + +### scene + +> `protected` **scene**: [`Scene`](Scene.md) + +Defined in: src/core/dataflow/DataflowSolver.ts:48 + +*** + +### stmtNexts + +> `protected` **stmtNexts**: `Map`\<[`Stmt`](Stmt.md), `Set`\<[`Stmt`](Stmt.md)\>\> + +Defined in: src/core/dataflow/DataflowSolver.ts:50 + +*** + +### summaryEdge + +> `protected` **summaryEdge**: `Set`\<`CallToReturnCacheEdge`\<`D`\>\> + +Defined in: src/core/dataflow/DataflowSolver.ts:47 + +*** + +### workList + +> `protected` **workList**: [`PathEdge`](PathEdge.md)\<`D`\>[] + +Defined in: src/core/dataflow/DataflowSolver.ts:42 + +*** + +### zeroFact + +> `protected` **zeroFact**: `D` + +Defined in: src/core/dataflow/DataflowSolver.ts:44 + +## Methods + +### buildStmtMapInBlock() + +> `protected` **buildStmtMapInBlock**(`block`): `void` + +Defined in: src/core/dataflow/DataflowSolver.ts:113 + +#### Parameters + +##### block + +[`BasicBlock`](BasicBlock.md) + +#### Returns + +`void` + +*** + +### buildStmtMapInClass() + +> `protected` **buildStmtMapInClass**(): `void` + +Defined in: src/core/dataflow/DataflowSolver.ts:98 + +#### Returns + +`void` + +*** + +### callNodeFactPropagate() + +> `protected` **callNodeFactPropagate**(`edge`, `firstStmt`, `fact`, `returnSite`): `void` + +Defined in: src/core/dataflow/DataflowSolver.ts:277 + +#### Parameters + +##### edge + +[`PathEdge`](PathEdge.md)\<`D`\> + +##### firstStmt + +[`Stmt`](Stmt.md) + +##### fact + +`D` + +##### returnSite + +[`Stmt`](Stmt.md) + +#### Returns + +`void` + +*** + +### computeResult() + +> `protected` **computeResult**(`stmt`, `d`): `boolean` + +Defined in: src/core/dataflow/DataflowSolver.ts:71 + +#### Parameters + +##### stmt + +[`Stmt`](Stmt.md) + +##### d + +`D` + +#### Returns + +`boolean` + +*** + +### doSolve() + +> `protected` **doSolve**(): `void` + +Defined in: src/core/dataflow/DataflowSolver.ts:309 + +#### Returns + +`void` + +*** + +### getAllCalleeMethods() + +> `protected` **getAllCalleeMethods**(`callNode`): `Set`\<[`ArkMethod`](ArkMethod.md)\> + +Defined in: src/core/dataflow/DataflowSolver.ts:137 + +#### Parameters + +##### callNode + +[`ArkInvokeStmt`](ArkInvokeStmt.md) + +#### Returns + +`Set`\<[`ArkMethod`](ArkMethod.md)\> + +*** + +### getChildren() + +> `protected` **getChildren**(`stmt`): [`Stmt`](Stmt.md)[] + +Defined in: src/core/dataflow/DataflowSolver.ts:80 + +#### Parameters + +##### stmt + +[`Stmt`](Stmt.md) + +#### Returns + +[`Stmt`](Stmt.md)[] + +*** + +### getPathEdgeSet() + +> **getPathEdgeSet**(): `Set`\<[`PathEdge`](PathEdge.md)\<`D`\>\> + +Defined in: src/core/dataflow/DataflowSolver.ts:344 + +#### Returns + +`Set`\<[`PathEdge`](PathEdge.md)\<`D`\>\> + +*** + +### getReturnSiteOfCall() + +> `protected` **getReturnSiteOfCall**(`call`): [`Stmt`](Stmt.md) + +Defined in: src/core/dataflow/DataflowSolver.ts:150 + +#### Parameters + +##### call + +[`Stmt`](Stmt.md) + +#### Returns + +[`Stmt`](Stmt.md) + +*** + +### getStartOfCallerMethod() + +> `protected` **getStartOfCallerMethod**(`call`): [`Stmt`](Stmt.md) + +Defined in: src/core/dataflow/DataflowSolver.ts:154 + +#### Parameters + +##### call + +[`Stmt`](Stmt.md) + +#### Returns + +[`Stmt`](Stmt.md) + +*** + +### init() + +> `protected` **init**(): `void` + +Defined in: src/core/dataflow/DataflowSolver.ts:84 + +#### Returns + +`void` + +*** + +### isCallStatement() + +> `protected` **isCallStatement**(`stmt`): `boolean` + +Defined in: src/core/dataflow/DataflowSolver.ts:326 + +#### Parameters + +##### stmt + +[`Stmt`](Stmt.md) + +#### Returns + +`boolean` + +*** + +### isExitStatement() + +> `protected` **isExitStatement**(`stmt`): `boolean` + +Defined in: src/core/dataflow/DataflowSolver.ts:340 + +#### Parameters + +##### stmt + +[`Stmt`](Stmt.md) + +#### Returns + +`boolean` + +*** + +### pathEdgeSetHasEdge() + +> `protected` **pathEdgeSetHasEdge**(`edge`): `boolean` + +Defined in: src/core/dataflow/DataflowSolver.ts:160 + +#### Parameters + +##### edge + +[`PathEdge`](PathEdge.md)\<`D`\> + +#### Returns + +`boolean` + +*** + +### processCallNode() + +> `protected` **processCallNode**(`edge`): `void` + +Defined in: src/core/dataflow/DataflowSolver.ts:243 + +#### Parameters + +##### edge + +[`PathEdge`](PathEdge.md)\<`D`\> + +#### Returns + +`void` + +*** + +### processExitNode() + +> `protected` **processExitNode**(`edge`): `void` + +Defined in: src/core/dataflow/DataflowSolver.ts:185 + +#### Parameters + +##### edge + +[`PathEdge`](PathEdge.md)\<`D`\> + +#### Returns + +`void` + +*** + +### processNormalNode() + +> `protected` **processNormalNode**(`edge`): `void` + +Defined in: src/core/dataflow/DataflowSolver.ts:227 + +#### Parameters + +##### edge + +[`PathEdge`](PathEdge.md)\<`D`\> + +#### Returns + +`void` + +*** + +### propagate() + +> `protected` **propagate**(`edge`): `void` + +Defined in: src/core/dataflow/DataflowSolver.ts:171 + +#### Parameters + +##### edge + +[`PathEdge`](PathEdge.md)\<`D`\> + +#### Returns + +`void` + +*** + +### setCfg4AllStmt() + +> `protected` **setCfg4AllStmt**(): `void` + +Defined in: src/core/dataflow/DataflowSolver.ts:129 + +#### Returns + +`void` + +*** + +### solve() + +> **solve**(): `void` + +Defined in: src/core/dataflow/DataflowSolver.ts:66 + +#### Returns + +`void` diff --git a/docs/api_docs/classes/Decorator.md b/docs/api_docs/classes/Decorator.md new file mode 100644 index 0000000000000000000000000000000000000000..d540290b8d159b94927b11d777c54fd0784e0bdd --- /dev/null +++ b/docs/api_docs/classes/Decorator.md @@ -0,0 +1,123 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / Decorator + +# Class: Decorator + +Defined in: src/core/base/Decorator.ts:19 + +## Constructors + +### new Decorator() + +> **new Decorator**(`name`): [`Decorator`](Decorator.md) + +Defined in: src/core/base/Decorator.ts:23 + +#### Parameters + +##### name + +`string` + +#### Returns + +[`Decorator`](Decorator.md) + +## Properties + +### content + +> **content**: `string` = `''` + +Defined in: src/core/base/Decorator.ts:21 + +*** + +### kind + +> **kind**: `string` + +Defined in: src/core/base/Decorator.ts:20 + +*** + +### param + +> **param**: `string` = `''` + +Defined in: src/core/base/Decorator.ts:22 + +## Methods + +### getContent() + +> **getContent**(): `string` + +Defined in: src/core/base/Decorator.ts:32 + +#### Returns + +`string` + +*** + +### getKind() + +> **getKind**(): `string` + +Defined in: src/core/base/Decorator.ts:26 + +#### Returns + +`string` + +*** + +### getParam() + +> **getParam**(): `string` + +Defined in: src/core/base/Decorator.ts:38 + +#### Returns + +`string` + +*** + +### setContent() + +> **setContent**(`content`): `void` + +Defined in: src/core/base/Decorator.ts:29 + +#### Parameters + +##### content + +`string` + +#### Returns + +`void` + +*** + +### setParam() + +> **setParam**(`param`): `void` + +Defined in: src/core/base/Decorator.ts:35 + +#### Parameters + +##### param + +`string` + +#### Returns + +`void` diff --git a/docs/api_docs/classes/DefUseChain.md b/docs/api_docs/classes/DefUseChain.md new file mode 100644 index 0000000000000000000000000000000000000000..c1ee42ad1737f68e4befb2f519293fd1623b6455 --- /dev/null +++ b/docs/api_docs/classes/DefUseChain.md @@ -0,0 +1,59 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / DefUseChain + +# Class: DefUseChain + +Defined in: src/core/base/DefUseChain.ts:19 + +## Constructors + +### new DefUseChain() + +> **new DefUseChain**(`value`, `def`, `use`): [`DefUseChain`](DefUseChain.md) + +Defined in: src/core/base/DefUseChain.ts:23 + +#### Parameters + +##### value + +[`Value`](../interfaces/Value.md) + +##### def + +[`Stmt`](Stmt.md) + +##### use + +[`Stmt`](Stmt.md) + +#### Returns + +[`DefUseChain`](DefUseChain.md) + +## Properties + +### def + +> **def**: [`Stmt`](Stmt.md) + +Defined in: src/core/base/DefUseChain.ts:21 + +*** + +### use + +> **use**: [`Stmt`](Stmt.md) + +Defined in: src/core/base/DefUseChain.ts:22 + +*** + +### value + +> **value**: [`Value`](../interfaces/Value.md) + +Defined in: src/core/base/DefUseChain.ts:20 diff --git a/docs/api_docs/classes/DiffPTData.md b/docs/api_docs/classes/DiffPTData.md new file mode 100644 index 0000000000000000000000000000000000000000..807608cd9f08b77891e6896a221c3004da41f5c3 --- /dev/null +++ b/docs/api_docs/classes/DiffPTData.md @@ -0,0 +1,357 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / DiffPTData + +# Class: DiffPTData\ + +Defined in: src/callgraph/pointerAnalysis/PtsDS.ts:134 + +## Type Parameters + +• **K** + +• **D** *extends* `Idx` + +• **DS** *extends* `IPtsCollection`\<`D`\> + +## Constructors + +### new DiffPTData() + +> **new DiffPTData**\<`K`, `D`, `DS`\>(`DSCreator`): [`DiffPTData`](DiffPTData.md)\<`K`, `D`, `DS`\> + +Defined in: src/callgraph/pointerAnalysis/PtsDS.ts:138 + +#### Parameters + +##### DSCreator + +() => `DS` + +#### Returns + +[`DiffPTData`](DiffPTData.md)\<`K`, `D`, `DS`\> + +## Properties + +### diffPtsMap + +> **diffPtsMap**: `Map`\<`K`, `DS`\> + +Defined in: src/callgraph/pointerAnalysis/PtsDS.ts:135 + +*** + +### propaPtsMap + +> **propaPtsMap**: `Map`\<`K`, `DS`\> + +Defined in: src/callgraph/pointerAnalysis/PtsDS.ts:136 + +## Methods + +### addPts() + +> **addPts**(`v`, `elem`): `boolean` + +Defined in: src/callgraph/pointerAnalysis/PtsDS.ts:148 + +#### Parameters + +##### v + +`K` + +##### elem + +`D` + +#### Returns + +`boolean` + +*** + +### calculateDiff() + +> **calculateDiff**(`src`, `dst`): `DS` + +Defined in: src/callgraph/pointerAnalysis/PtsDS.ts:262 + +#### Parameters + +##### src + +`K` + +##### dst + +`K` + +#### Returns + +`DS` + +*** + +### clear() + +> **clear**(): `void` + +Defined in: src/callgraph/pointerAnalysis/PtsDS.ts:143 + +#### Returns + +`void` + +*** + +### clearDiffPts() + +> **clearDiffPts**(`v`): `void` + +Defined in: src/callgraph/pointerAnalysis/PtsDS.ts:252 + +#### Parameters + +##### v + +`K` + +#### Returns + +`void` + +*** + +### clearPropaPts() + +> **clearPropaPts**(`v`): `void` + +Defined in: src/callgraph/pointerAnalysis/PtsDS.ts:257 + +#### Parameters + +##### v + +`K` + +#### Returns + +`void` + +*** + +### clearPts() + +> **clearPts**(`v`): `void` + +Defined in: src/callgraph/pointerAnalysis/PtsDS.ts:245 + +#### Parameters + +##### v + +`K` + +#### Returns + +`void` + +*** + +### flush() + +> **flush**(`v`): `void` + +Defined in: src/callgraph/pointerAnalysis/PtsDS.ts:236 + +#### Parameters + +##### v + +`K` + +#### Returns + +`void` + +*** + +### getDiffPts() + +> **getDiffPts**(`v`): `undefined` \| `DS` + +Defined in: src/callgraph/pointerAnalysis/PtsDS.ts:214 + +#### Parameters + +##### v + +`K` + +#### Returns + +`undefined` \| `DS` + +*** + +### getMutDiffPts() + +> **getMutDiffPts**(`v`): `undefined` \| `DS` + +Defined in: src/callgraph/pointerAnalysis/PtsDS.ts:218 + +#### Parameters + +##### v + +`K` + +#### Returns + +`undefined` \| `DS` + +*** + +### getPropaPts() + +> **getPropaPts**(`v`): `undefined` \| `DS` + +Defined in: src/callgraph/pointerAnalysis/PtsDS.ts:225 + +#### Parameters + +##### v + +`K` + +#### Returns + +`undefined` \| `DS` + +*** + +### getPropaPtsMut() + +> **getPropaPtsMut**(`v`): `DS` + +Defined in: src/callgraph/pointerAnalysis/PtsDS.ts:229 + +#### Parameters + +##### v + +`K` + +#### Returns + +`DS` + +*** + +### removePtsElem() + +> **removePtsElem**(`v`, `elem`): `boolean` + +Defined in: src/callgraph/pointerAnalysis/PtsDS.ts:208 + +#### Parameters + +##### v + +`K` + +##### elem + +`D` + +#### Returns + +`boolean` + +*** + +### resetElem() + +> **resetElem**(`v`): `boolean` + +Defined in: src/callgraph/pointerAnalysis/PtsDS.ts:158 + +#### Parameters + +##### v + +`K` + +#### Returns + +`boolean` + +*** + +### unionDiffPts() + +> **unionDiffPts**(`dstv`, `srcv`): `boolean` + +Defined in: src/callgraph/pointerAnalysis/PtsDS.ts:167 + +#### Parameters + +##### dstv + +`K` + +##### srcv + +`K` + +#### Returns + +`boolean` + +*** + +### unionPts() + +> **unionPts**(`dstv`, `srcv`): `boolean` + +Defined in: src/callgraph/pointerAnalysis/PtsDS.ts:180 + +#### Parameters + +##### dstv + +`K` + +##### srcv + +`K` + +#### Returns + +`boolean` + +*** + +### unionPtsTo() + +> **unionPtsTo**(`dstv`, `srcDs`): `boolean` + +Defined in: src/callgraph/pointerAnalysis/PtsDS.ts:198 + +#### Parameters + +##### dstv + +`K` + +##### srcDs + +`DS` + +#### Returns + +`boolean` diff --git a/docs/api_docs/classes/DominanceFinder.md b/docs/api_docs/classes/DominanceFinder.md new file mode 100644 index 0000000000000000000000000000000000000000..5c8b72e0eb109c710a3e84186832affdf21f1141 --- /dev/null +++ b/docs/api_docs/classes/DominanceFinder.md @@ -0,0 +1,81 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / DominanceFinder + +# Class: DominanceFinder + +Defined in: src/core/graph/DominanceFinder.ts:19 + +## Constructors + +### new DominanceFinder() + +> **new DominanceFinder**(`cfg`): [`DominanceFinder`](DominanceFinder.md) + +Defined in: src/core/graph/DominanceFinder.ts:25 + +#### Parameters + +##### cfg + +[`Cfg`](Cfg.md) + +#### Returns + +[`DominanceFinder`](DominanceFinder.md) + +## Methods + +### getBlocks() + +> **getBlocks**(): [`BasicBlock`](BasicBlock.md)[] + +Defined in: src/core/graph/DominanceFinder.ts:97 + +#### Returns + +[`BasicBlock`](BasicBlock.md)[] + +*** + +### getBlockToIdx() + +> **getBlockToIdx**(): `Map`\<[`BasicBlock`](BasicBlock.md), `number`\> + +Defined in: src/core/graph/DominanceFinder.ts:101 + +#### Returns + +`Map`\<[`BasicBlock`](BasicBlock.md), `number`\> + +*** + +### getDominanceFrontiers() + +> **getDominanceFrontiers**(`block`): `Set`\<[`BasicBlock`](BasicBlock.md)\> + +Defined in: src/core/graph/DominanceFinder.ts:84 + +#### Parameters + +##### block + +[`BasicBlock`](BasicBlock.md) + +#### Returns + +`Set`\<[`BasicBlock`](BasicBlock.md)\> + +*** + +### getImmediateDominators() + +> **getImmediateDominators**(): `number`[] + +Defined in: src/core/graph/DominanceFinder.ts:105 + +#### Returns + +`number`[] diff --git a/docs/api_docs/classes/DominanceTree.md b/docs/api_docs/classes/DominanceTree.md new file mode 100644 index 0000000000000000000000000000000000000000..12d846f0bda2a5b759ead1154c0fe8438657cfe2 --- /dev/null +++ b/docs/api_docs/classes/DominanceTree.md @@ -0,0 +1,69 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / DominanceTree + +# Class: DominanceTree + +Defined in: src/core/graph/DominanceTree.ts:19 + +## Constructors + +### new DominanceTree() + +> **new DominanceTree**(`dominanceFinder`): [`DominanceTree`](DominanceTree.md) + +Defined in: src/core/graph/DominanceTree.ts:25 + +#### Parameters + +##### dominanceFinder + +[`DominanceFinder`](DominanceFinder.md) + +#### Returns + +[`DominanceTree`](DominanceTree.md) + +## Methods + +### getAllNodesDFS() + +> **getAllNodesDFS**(): [`BasicBlock`](BasicBlock.md)[] + +Defined in: src/core/graph/DominanceTree.ts:46 + +#### Returns + +[`BasicBlock`](BasicBlock.md)[] + +*** + +### getChildren() + +> **getChildren**(`block`): [`BasicBlock`](BasicBlock.md)[] + +Defined in: src/core/graph/DominanceTree.ts:63 + +#### Parameters + +##### block + +[`BasicBlock`](BasicBlock.md) + +#### Returns + +[`BasicBlock`](BasicBlock.md)[] + +*** + +### getRoot() + +> **getRoot**(): [`BasicBlock`](BasicBlock.md) + +Defined in: src/core/graph/DominanceTree.ts:72 + +#### Returns + +[`BasicBlock`](BasicBlock.md) diff --git a/docs/api_docs/classes/DotClassPrinter.md b/docs/api_docs/classes/DotClassPrinter.md new file mode 100644 index 0000000000000000000000000000000000000000..2ab241b99a565ad513dc8f58f0cfd7391a64fa9a --- /dev/null +++ b/docs/api_docs/classes/DotClassPrinter.md @@ -0,0 +1,85 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / DotClassPrinter + +# Class: DotClassPrinter + +Defined in: src/save/DotPrinter.ts:108 + +## Extends + +- [`Printer`](Printer.md) + +## Constructors + +### new DotClassPrinter() + +> **new DotClassPrinter**(`cls`, `nesting`): [`DotClassPrinter`](DotClassPrinter.md) + +Defined in: src/save/DotPrinter.ts:112 + +#### Parameters + +##### cls + +[`ArkClass`](ArkClass.md) + +##### nesting + +`boolean` = `false` + +#### Returns + +[`DotClassPrinter`](DotClassPrinter.md) + +#### Overrides + +[`Printer`](Printer.md).[`constructor`](Printer.md#constructors) + +## Properties + +### cls + +> **cls**: [`ArkClass`](ArkClass.md) + +Defined in: src/save/DotPrinter.ts:109 + +*** + +### nesting + +> **nesting**: `boolean` + +Defined in: src/save/DotPrinter.ts:110 + +*** + +### printer + +> `protected` **printer**: `ArkCodeBuffer` + +Defined in: src/save/Printer.ts:22 + +#### Inherited from + +[`Printer`](Printer.md).[`printer`](Printer.md#printer-1) + +## Methods + +### dump() + +> **dump**(): `string` + +Defined in: src/save/DotPrinter.ts:118 + +ArkIR dump + +#### Returns + +`string` + +#### Overrides + +[`Printer`](Printer.md).[`dump`](Printer.md#dump) diff --git a/docs/api_docs/classes/DotFilePrinter.md b/docs/api_docs/classes/DotFilePrinter.md new file mode 100644 index 0000000000000000000000000000000000000000..526098229377f829d93ba85275efe8a4967ba046 --- /dev/null +++ b/docs/api_docs/classes/DotFilePrinter.md @@ -0,0 +1,73 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / DotFilePrinter + +# Class: DotFilePrinter + +Defined in: src/save/DotPrinter.ts:176 + +## Extends + +- [`Printer`](Printer.md) + +## Constructors + +### new DotFilePrinter() + +> **new DotFilePrinter**(`arkFile`): [`DotFilePrinter`](DotFilePrinter.md) + +Defined in: src/save/DotPrinter.ts:179 + +#### Parameters + +##### arkFile + +[`ArkFile`](ArkFile.md) + +#### Returns + +[`DotFilePrinter`](DotFilePrinter.md) + +#### Overrides + +[`Printer`](Printer.md).[`constructor`](Printer.md#constructors) + +## Properties + +### arkFile + +> **arkFile**: [`ArkFile`](ArkFile.md) + +Defined in: src/save/DotPrinter.ts:177 + +*** + +### printer + +> `protected` **printer**: `ArkCodeBuffer` + +Defined in: src/save/Printer.ts:22 + +#### Inherited from + +[`Printer`](Printer.md).[`printer`](Printer.md#printer-1) + +## Methods + +### dump() + +> **dump**(): `string` + +Defined in: src/save/DotPrinter.ts:184 + +ArkIR dump + +#### Returns + +`string` + +#### Overrides + +[`Printer`](Printer.md).[`dump`](Printer.md#dump) diff --git a/docs/api_docs/classes/DotMethodPrinter.md b/docs/api_docs/classes/DotMethodPrinter.md new file mode 100644 index 0000000000000000000000000000000000000000..e4451de2a34cd1906c41a55a0ee3d1c957d78f9d --- /dev/null +++ b/docs/api_docs/classes/DotMethodPrinter.md @@ -0,0 +1,103 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / DotMethodPrinter + +# Class: DotMethodPrinter + +Defined in: src/save/DotPrinter.ts:27 + +## Extends + +- [`Printer`](Printer.md) + +## Constructors + +### new DotMethodPrinter() + +> **new DotMethodPrinter**(`method`, `nesting`): [`DotMethodPrinter`](DotMethodPrinter.md) + +Defined in: src/save/DotPrinter.ts:31 + +#### Parameters + +##### method + +[`ArkMethod`](ArkMethod.md) + +##### nesting + +`boolean` = `false` + +#### Returns + +[`DotMethodPrinter`](DotMethodPrinter.md) + +#### Overrides + +[`Printer`](Printer.md).[`constructor`](Printer.md#constructors) + +## Properties + +### method + +> **method**: [`ArkMethod`](ArkMethod.md) + +Defined in: src/save/DotPrinter.ts:28 + +*** + +### nesting + +> **nesting**: `boolean` + +Defined in: src/save/DotPrinter.ts:29 + +*** + +### printer + +> `protected` **printer**: `ArkCodeBuffer` + +Defined in: src/save/Printer.ts:22 + +#### Inherited from + +[`Printer`](Printer.md).[`printer`](Printer.md#printer-1) + +## Methods + +### dump() + +> **dump**(): `string` + +Defined in: src/save/DotPrinter.ts:37 + +ArkIR dump + +#### Returns + +`string` + +#### Overrides + +[`Printer`](Printer.md).[`dump`](Printer.md#dump) + +*** + +### stringHashCode() + +> `protected` **stringHashCode**(`name`): `number` + +Defined in: src/save/DotPrinter.ts:57 + +#### Parameters + +##### name + +`string` + +#### Returns + +`number` diff --git a/docs/api_docs/classes/DotNamespacePrinter.md b/docs/api_docs/classes/DotNamespacePrinter.md new file mode 100644 index 0000000000000000000000000000000000000000..81fdd4355b601275b26c5375d453349ac06ae2fa --- /dev/null +++ b/docs/api_docs/classes/DotNamespacePrinter.md @@ -0,0 +1,85 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / DotNamespacePrinter + +# Class: DotNamespacePrinter + +Defined in: src/save/DotPrinter.ts:142 + +## Extends + +- [`Printer`](Printer.md) + +## Constructors + +### new DotNamespacePrinter() + +> **new DotNamespacePrinter**(`ns`, `nesting`): [`DotNamespacePrinter`](DotNamespacePrinter.md) + +Defined in: src/save/DotPrinter.ts:146 + +#### Parameters + +##### ns + +[`ArkNamespace`](ArkNamespace.md) + +##### nesting + +`boolean` = `false` + +#### Returns + +[`DotNamespacePrinter`](DotNamespacePrinter.md) + +#### Overrides + +[`Printer`](Printer.md).[`constructor`](Printer.md#constructors) + +## Properties + +### nesting + +> **nesting**: `boolean` + +Defined in: src/save/DotPrinter.ts:144 + +*** + +### ns + +> **ns**: [`ArkNamespace`](ArkNamespace.md) + +Defined in: src/save/DotPrinter.ts:143 + +*** + +### printer + +> `protected` **printer**: `ArkCodeBuffer` + +Defined in: src/save/Printer.ts:22 + +#### Inherited from + +[`Printer`](Printer.md).[`printer`](Printer.md#printer-1) + +## Methods + +### dump() + +> **dump**(): `string` + +Defined in: src/save/DotPrinter.ts:152 + +ArkIR dump + +#### Returns + +`string` + +#### Overrides + +[`Printer`](Printer.md).[`dump`](Printer.md#dump) diff --git a/docs/api_docs/classes/DummyCallCreator.md b/docs/api_docs/classes/DummyCallCreator.md new file mode 100644 index 0000000000000000000000000000000000000000..6daa553cd1d38221d63d6c18558c08118544b1dd --- /dev/null +++ b/docs/api_docs/classes/DummyCallCreator.md @@ -0,0 +1,73 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / DummyCallCreator + +# Class: DummyCallCreator + +Defined in: src/callgraph/pointerAnalysis/DummyCallCreator.ts:31 + +TODO: constructor pointer and cid + +## Constructors + +### new DummyCallCreator() + +> **new DummyCallCreator**(`scene`): [`DummyCallCreator`](DummyCallCreator.md) + +Defined in: src/callgraph/pointerAnalysis/DummyCallCreator.ts:37 + +#### Parameters + +##### scene + +[`Scene`](Scene.md) + +#### Returns + +[`DummyCallCreator`](DummyCallCreator.md) + +## Methods + +### getDummyCallByComponent() + +> **getDummyCallByComponent**(`classSig`, `baseComponent`): `Set`\<[`Stmt`](Stmt.md)\> + +Defined in: src/callgraph/pointerAnalysis/DummyCallCreator.ts:55 + +#### Parameters + +##### classSig + +[`ClassSignature`](ClassSignature.md) + +##### baseComponent + +[`Local`](Local.md) + +#### Returns + +`Set`\<[`Stmt`](Stmt.md)\> + +*** + +### getDummyCallByPage() + +> **getDummyCallByPage**(`classSig`, `basePage`): `Set`\<[`Stmt`](Stmt.md)\> + +Defined in: src/callgraph/pointerAnalysis/DummyCallCreator.ts:43 + +#### Parameters + +##### classSig + +[`ClassSignature`](ClassSignature.md) + +##### basePage + +[`Local`](Local.md) + +#### Returns + +`Set`\<[`Stmt`](Stmt.md)\> diff --git a/docs/api_docs/classes/DummyMainCreater.md b/docs/api_docs/classes/DummyMainCreater.md new file mode 100644 index 0000000000000000000000000000000000000000..63336f7df68e4369dd36f16ab2a32319b814e0d3 --- /dev/null +++ b/docs/api_docs/classes/DummyMainCreater.md @@ -0,0 +1,115 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / DummyMainCreater + +# Class: DummyMainCreater + +Defined in: src/core/common/DummyMainCreater.ts:70 + +收集所有的onCreate,onStart等函数,构造一个虚拟函数,具体为: +%statInit() +... +count = 0 +while (true) { + if (count === 1) { + temp1 = new ability + temp2 = new want + temp1.onCreate(temp2) + } + if (count === 2) { + onDestroy() + } + ... + if (count === *) { + callbackMethod1() + } + ... +} +return +如果是instanceInvoke还要先实例化对象,如果是其他文件的类或者方法还要添加import信息 + +## Constructors + +### new DummyMainCreater() + +> **new DummyMainCreater**(`scene`): [`DummyMainCreater`](DummyMainCreater.md) + +Defined in: src/core/common/DummyMainCreater.ts:78 + +#### Parameters + +##### scene + +[`Scene`](Scene.md) + +#### Returns + +[`DummyMainCreater`](DummyMainCreater.md) + +## Methods + +### createDummyMain() + +> **createDummyMain**(): `void` + +Defined in: src/core/common/DummyMainCreater.ts:92 + +#### Returns + +`void` + +*** + +### getCallbackMethods() + +> **getCallbackMethods**(): [`ArkMethod`](ArkMethod.md)[] + +Defined in: src/core/common/DummyMainCreater.ts:314 + +#### Returns + +[`ArkMethod`](ArkMethod.md)[] + +*** + +### getDummyMain() + +> **getDummyMain**(): [`ArkMethod`](ArkMethod.md) + +Defined in: src/core/common/DummyMainCreater.ts:266 + +#### Returns + +[`ArkMethod`](ArkMethod.md) + +*** + +### getMethodsFromAllAbilities() + +> **getMethodsFromAllAbilities**(): [`ArkMethod`](ArkMethod.md)[] + +Defined in: src/core/common/DummyMainCreater.ts:304 + +#### Returns + +[`ArkMethod`](ArkMethod.md)[] + +*** + +### setEntryMethods() + +> **setEntryMethods**(`methods`): `void` + +Defined in: src/core/common/DummyMainCreater.ts:88 + +#### Parameters + +##### methods + +[`ArkMethod`](ArkMethod.md)[] + +#### Returns + +`void` diff --git a/docs/api_docs/classes/DynCallSite.md b/docs/api_docs/classes/DynCallSite.md new file mode 100644 index 0000000000000000000000000000000000000000..c179fc6fa48220bb7b7c60a24a5ef0fe32e352c9 --- /dev/null +++ b/docs/api_docs/classes/DynCallSite.md @@ -0,0 +1,71 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / DynCallSite + +# Class: DynCallSite + +Defined in: src/callgraph/model/CallGraph.ts:51 + +## Constructors + +### new DynCallSite() + +> **new DynCallSite**(`caller`, `s`, `a`, `ptcCallee`): [`DynCallSite`](DynCallSite.md) + +Defined in: src/callgraph/model/CallGraph.ts:57 + +#### Parameters + +##### caller + +`number` + +##### s + +[`Stmt`](Stmt.md) + +##### a + +`undefined` | [`Value`](../interfaces/Value.md)[] + +##### ptcCallee + +`undefined` | `number` + +#### Returns + +[`DynCallSite`](DynCallSite.md) + +## Properties + +### args + +> **args**: `undefined` \| [`Value`](../interfaces/Value.md)[] + +Defined in: src/callgraph/model/CallGraph.ts:54 + +*** + +### callerFuncID + +> **callerFuncID**: `number` + +Defined in: src/callgraph/model/CallGraph.ts:52 + +*** + +### callStmt + +> **callStmt**: [`Stmt`](Stmt.md) + +Defined in: src/callgraph/model/CallGraph.ts:53 + +*** + +### protentialCalleeFuncID + +> **protentialCalleeFuncID**: `undefined` \| `number` + +Defined in: src/callgraph/model/CallGraph.ts:55 diff --git a/docs/api_docs/classes/ExportInfo.md b/docs/api_docs/classes/ExportInfo.md new file mode 100644 index 0000000000000000000000000000000000000000..39eaa89fcf4715989854ff95f48f56a32294d200 --- /dev/null +++ b/docs/api_docs/classes/ExportInfo.md @@ -0,0 +1,759 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / ExportInfo + +# Class: ExportInfo + +Defined in: src/core/model/ArkExport.ts:58 + +## Extends + +- `ArkBaseModel` + +## Implements + +- `FromInfo` + +## Properties + +### decorators? + +> `protected` `optional` **decorators**: `Set`\<[`Decorator`](Decorator.md)\> + +Defined in: src/core/model/ArkBaseModel.ts:115 + +#### Inherited from + +`ArkBaseModel.decorators` + +*** + +### metadata? + +> `protected` `optional` **metadata**: `ArkMetadata` + +Defined in: src/core/model/ArkBaseModel.ts:116 + +#### Inherited from + +`ArkBaseModel.metadata` + +*** + +### modifiers? + +> `protected` `optional` **modifiers**: `number` + +Defined in: src/core/model/ArkBaseModel.ts:114 + +#### Inherited from + +`ArkBaseModel.modifiers` + +*** + +### Builder + +> `static` **Builder**: *typeof* `ArkExportBuilder` + +Defined in: src/core/model/ArkExport.ts:129 + +## Methods + +### addDecorator() + +> **addDecorator**(`decorator`): `void` + +Defined in: src/core/model/ArkBaseModel.ts:215 + +#### Parameters + +##### decorator + +[`Decorator`](Decorator.md) + +#### Returns + +`void` + +#### Inherited from + +`ArkBaseModel.addDecorator` + +*** + +### addModifier() + +> **addModifier**(`modifier`): `void` + +Defined in: src/core/model/ArkBaseModel.ts:142 + +#### Parameters + +##### modifier + +`number` + +#### Returns + +`void` + +#### Inherited from + +`ArkBaseModel.addModifier` + +*** + +### containsModifier() + +> **containsModifier**(`modifierType`): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:194 + +#### Parameters + +##### modifierType + +`ModifierType` + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.containsModifier` + +*** + +### getArkExport() + +> **getArkExport**(): `undefined` \| `null` \| `ArkExport` + +Defined in: src/core/model/ArkExport.ts:103 + +#### Returns + +`undefined` \| `null` \| `ArkExport` + +*** + +### getDeclaringArkFile() + +> **getDeclaringArkFile**(): [`ArkFile`](ArkFile.md) + +Defined in: src/core/model/ArkExport.ts:125 + +#### Returns + +[`ArkFile`](ArkFile.md) + +#### Implementation of + +`FromInfo.getDeclaringArkFile` + +*** + +### getDecorators() + +> **getDecorators**(): [`Decorator`](Decorator.md)[] + +Defined in: src/core/model/ArkBaseModel.ts:202 + +#### Returns + +[`Decorator`](Decorator.md)[] + +#### Inherited from + +`ArkBaseModel.getDecorators` + +*** + +### getExportClauseName() + +> **getExportClauseName**(): `string` + +Defined in: src/core/model/ArkExport.ts:83 + +#### Returns + +`string` + +*** + +### getExportClauseType() + +> **getExportClauseType**(): `ExportType` + +Defined in: src/core/model/ArkExport.ts:91 + +#### Returns + +`ExportType` + +*** + +### getFrom() + +> **getFrom**(): `undefined` \| `string` + +Defined in: src/core/model/ArkExport.ts:75 + +#### Returns + +`undefined` \| `string` + +#### Implementation of + +`FromInfo.getFrom` + +*** + +### getMetadata() + +> **getMetadata**(`kind`): `undefined` \| `ArkMetadataType` + +Defined in: src/core/model/ArkBaseModel.ts:118 + +#### Parameters + +##### kind + +`ArkMetadataKind` + +#### Returns + +`undefined` \| `ArkMetadataType` + +#### Inherited from + +`ArkBaseModel.getMetadata` + +*** + +### getModifiers() + +> **getModifiers**(): `number` + +Defined in: src/core/model/ArkBaseModel.ts:129 + +#### Returns + +`number` + +#### Inherited from + +`ArkBaseModel.getModifiers` + +*** + +### getNameBeforeAs() + +> **getNameBeforeAs**(): `undefined` \| `string` + +Defined in: src/core/model/ArkExport.ts:95 + +#### Returns + +`undefined` \| `string` + +*** + +### getOriginName() + +> **getOriginName**(): `string` + +Defined in: src/core/model/ArkExport.ts:79 + +#### Returns + +`string` + +#### Implementation of + +`FromInfo.getOriginName` + +*** + +### getOriginTsPosition() + +> **getOriginTsPosition**(): [`LineColPosition`](LineColPosition.md) + +Defined in: src/core/model/ArkExport.ts:117 + +#### Returns + +[`LineColPosition`](LineColPosition.md) + +*** + +### getStateDecorators() + +> **getStateDecorators**(): [`Decorator`](Decorator.md)[] + +Defined in: src/core/model/ArkBaseModel.ts:234 + +#### Returns + +[`Decorator`](Decorator.md)[] + +#### Inherited from + +`ArkBaseModel.getStateDecorators` + +*** + +### getTsSourceCode() + +> **getTsSourceCode**(): `string` + +Defined in: src/core/model/ArkExport.ts:121 + +#### Returns + +`string` + +*** + +### hasBuilderDecorator() + +> **hasBuilderDecorator**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:230 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.hasBuilderDecorator` + +*** + +### hasBuilderParamDecorator() + +> **hasBuilderParamDecorator**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:243 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.hasBuilderParamDecorator` + +*** + +### hasComponentDecorator() + +> **hasComponentDecorator**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:251 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.hasComponentDecorator` + +*** + +### hasDecorator() + +> **hasDecorator**(`kind`): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:255 + +#### Parameters + +##### kind + +`string` | `Set`\<`string`\> + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.hasDecorator` + +*** + +### hasEntryDecorator() + +> **hasEntryDecorator**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:247 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.hasEntryDecorator` + +*** + +### isAbstract() + +> **isAbstract**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:173 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.isAbstract` + +*** + +### isDeclare() + +> **isDeclare**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:190 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.isDeclare` + +*** + +### isDefault() + +> **isDefault**(): `boolean` + +Defined in: src/core/model/ArkExport.ts:107 + +#### Returns + +`boolean` + +#### Implementation of + +`FromInfo.isDefault` + +#### Overrides + +`ArkBaseModel.isDefault` + +*** + +### isExport() + +> **isExport**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:177 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.isExport` + +*** + +### ~~isExported()~~ + +> **isExported**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:186 + +#### Returns + +`boolean` + +#### Deprecated + +Use [isExport](ArkNamespace.md#isexport) instead. + +#### Inherited from + +`ArkBaseModel.isExported` + +*** + +### isPrivate() + +> **isPrivate**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:161 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.isPrivate` + +*** + +### isProtected() + +> **isProtected**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:157 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.isProtected` + +*** + +### isPublic() + +> **isPublic**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:165 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.isPublic` + +*** + +### isReadonly() + +> **isReadonly**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:169 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.isReadonly` + +*** + +### isStatic() + +> **isStatic**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:153 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.isStatic` + +*** + +### removeDecorator() + +> **removeDecorator**(`kind`): `void` + +Defined in: src/core/model/ArkBaseModel.ts:222 + +#### Parameters + +##### kind + +`string` + +#### Returns + +`void` + +#### Inherited from + +`ArkBaseModel.removeDecorator` + +*** + +### removeModifier() + +> **removeModifier**(`modifier`): `void` + +Defined in: src/core/model/ArkBaseModel.ts:146 + +#### Parameters + +##### modifier + +`ModifierType` + +#### Returns + +`void` + +#### Inherited from + +`ArkBaseModel.removeModifier` + +*** + +### setArkExport() + +> **setArkExport**(`value`): `void` + +Defined in: src/core/model/ArkExport.ts:99 + +#### Parameters + +##### value + +`null` | `ArkExport` + +#### Returns + +`void` + +*** + +### setDecorators() + +> **setDecorators**(`decorators`): `void` + +Defined in: src/core/model/ArkBaseModel.ts:209 + +#### Parameters + +##### decorators + +`Set`\<[`Decorator`](Decorator.md)\> + +#### Returns + +`void` + +#### Inherited from + +`ArkBaseModel.setDecorators` + +*** + +### setExportClauseType() + +> **setExportClauseType**(`exportClauseType`): `void` + +Defined in: src/core/model/ArkExport.ts:87 + +#### Parameters + +##### exportClauseType + +`ExportType` + +#### Returns + +`void` + +*** + +### setMetadata() + +> **setMetadata**(`kind`, `value`): `void` + +Defined in: src/core/model/ArkBaseModel.ts:122 + +#### Parameters + +##### kind + +`ArkMetadataKind` + +##### value + +`ArkMetadataType` + +#### Returns + +`void` + +#### Inherited from + +`ArkBaseModel.setMetadata` + +*** + +### setModifiers() + +> **setModifiers**(`modifiers`): `void` + +Defined in: src/core/model/ArkBaseModel.ts:136 + +#### Parameters + +##### modifiers + +`number` + +#### Returns + +`void` + +#### Inherited from + +`ArkBaseModel.setModifiers` + +*** + +### validate() + +> **validate**(): `ArkError` + +Defined in: src/core/model/ArkExport.ts:198 + +#### Returns + +`ArkError` + +#### Overrides + +`ArkBaseModel.validate` + +*** + +### validateFields() + +> `protected` **validateFields**(`fields`): `ArkError` + +Defined in: src/core/model/ArkBaseModel.ts:267 + +#### Parameters + +##### fields + +`string`[] + +#### Returns + +`ArkError` + +#### Inherited from + +`ArkBaseModel.validateFields` diff --git a/docs/api_docs/classes/ExprUseReplacer.md b/docs/api_docs/classes/ExprUseReplacer.md new file mode 100644 index 0000000000000000000000000000000000000000..41452d5b468692c986954c4e145cdd596080262b --- /dev/null +++ b/docs/api_docs/classes/ExprUseReplacer.md @@ -0,0 +1,51 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / ExprUseReplacer + +# Class: ExprUseReplacer + +Defined in: src/core/common/ExprUseReplacer.ts:38 + +Replace old use of a Expr inplace + +## Constructors + +### new ExprUseReplacer() + +> **new ExprUseReplacer**(`oldUse`, `newUse`): [`ExprUseReplacer`](ExprUseReplacer.md) + +Defined in: src/core/common/ExprUseReplacer.ts:42 + +#### Parameters + +##### oldUse + +[`Value`](../interfaces/Value.md) + +##### newUse + +[`Value`](../interfaces/Value.md) + +#### Returns + +[`ExprUseReplacer`](ExprUseReplacer.md) + +## Methods + +### caseExpr() + +> **caseExpr**(`expr`): `void` + +Defined in: src/core/common/ExprUseReplacer.ts:47 + +#### Parameters + +##### expr + +[`AbstractExpr`](AbstractExpr.md) + +#### Returns + +`void` diff --git a/docs/api_docs/classes/Fact.md b/docs/api_docs/classes/Fact.md new file mode 100644 index 0000000000000000000000000000000000000000..a44ac1d225cf3a39b154ed9f9ad42b5773ad4aab --- /dev/null +++ b/docs/api_docs/classes/Fact.md @@ -0,0 +1,35 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / Fact + +# Class: Fact + +Defined in: src/core/dataflow/Fact.ts:19 + +## Constructors + +### new Fact() + +> **new Fact**(): [`Fact`](Fact.md) + +#### Returns + +[`Fact`](Fact.md) + +## Properties + +### valueMap + +> **valueMap**: `Map`\<[`Value`](../interfaces/Value.md), [`Stmt`](Stmt.md)\> + +Defined in: src/core/dataflow/Fact.ts:21 + +*** + +### values + +> **values**: `Set`\<[`Value`](../interfaces/Value.md)\> + +Defined in: src/core/dataflow/Fact.ts:20 diff --git a/docs/api_docs/classes/FieldSignature.md b/docs/api_docs/classes/FieldSignature.md new file mode 100644 index 0000000000000000000000000000000000000000..3b248f30d2416795badbc679ca20274fdc8dd550 --- /dev/null +++ b/docs/api_docs/classes/FieldSignature.md @@ -0,0 +1,147 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / FieldSignature + +# Class: FieldSignature + +Defined in: src/core/model/ArkSignature.ts:191 + +## Constructors + +### new FieldSignature() + +> **new FieldSignature**(`fieldName`, `declaringSignature`, `type`, `staticFlag`): [`FieldSignature`](FieldSignature.md) + +Defined in: src/core/model/ArkSignature.ts:197 + +#### Parameters + +##### fieldName + +`string` + +##### declaringSignature + +[`BaseSignature`](../type-aliases/BaseSignature.md) + +##### type + +[`Type`](Type.md) + +##### staticFlag + +`boolean` = `false` + +#### Returns + +[`FieldSignature`](FieldSignature.md) + +## Methods + +### getBaseName() + +> **getBaseName**(): `string` + +Defined in: src/core/model/ArkSignature.ts:208 + +#### Returns + +`string` + +*** + +### getDeclaringSignature() + +> **getDeclaringSignature**(): [`BaseSignature`](../type-aliases/BaseSignature.md) + +Defined in: src/core/model/ArkSignature.ts:204 + +#### Returns + +[`BaseSignature`](../type-aliases/BaseSignature.md) + +*** + +### getFieldName() + +> **getFieldName**(): `string` + +Defined in: src/core/model/ArkSignature.ts:213 + +#### Returns + +`string` + +*** + +### getType() + +> **getType**(): [`Type`](Type.md) + +Defined in: src/core/model/ArkSignature.ts:217 + +#### Returns + +[`Type`](Type.md) + +*** + +### isStatic() + +> **isStatic**(): `boolean` + +Defined in: src/core/model/ArkSignature.ts:221 + +#### Returns + +`boolean` + +*** + +### setStaticFlag() + +> **setStaticFlag**(`flag`): `void` + +Defined in: src/core/model/ArkSignature.ts:231 + +#### Parameters + +##### flag + +`boolean` + +#### Returns + +`void` + +*** + +### setType() + +> **setType**(`type`): `void` + +Defined in: src/core/model/ArkSignature.ts:226 + +#### Parameters + +##### type + +[`Type`](Type.md) + +#### Returns + +`void` + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/model/ArkSignature.ts:235 + +#### Returns + +`string` diff --git a/docs/api_docs/classes/FileSignature.md b/docs/api_docs/classes/FileSignature.md new file mode 100644 index 0000000000000000000000000000000000000000..6571979ec5491e4bee82447c89df502a7667a16d --- /dev/null +++ b/docs/api_docs/classes/FileSignature.md @@ -0,0 +1,87 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / FileSignature + +# Class: FileSignature + +Defined in: src/core/model/ArkSignature.ts:38 + +## Constructors + +### new FileSignature() + +> **new FileSignature**(`projectName`, `fileName`): [`FileSignature`](FileSignature.md) + +Defined in: src/core/model/ArkSignature.ts:45 + +#### Parameters + +##### projectName + +`string` + +##### fileName + +`string` + +#### Returns + +[`FileSignature`](FileSignature.md) + +## Properties + +### DEFAULT + +> `readonly` `static` **DEFAULT**: [`FileSignature`](FileSignature.md) + +Defined in: src/core/model/ArkSignature.ts:43 + +## Methods + +### getFileName() + +> **getFileName**(): `string` + +Defined in: src/core/model/ArkSignature.ts:55 + +#### Returns + +`string` + +*** + +### getProjectName() + +> **getProjectName**(): `string` + +Defined in: src/core/model/ArkSignature.ts:51 + +#### Returns + +`string` + +*** + +### toMapKey() + +> **toMapKey**(): `string` + +Defined in: src/core/model/ArkSignature.ts:63 + +#### Returns + +`string` + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/model/ArkSignature.ts:59 + +#### Returns + +`string` diff --git a/docs/api_docs/classes/FileUtils.md b/docs/api_docs/classes/FileUtils.md new file mode 100644 index 0000000000000000000000000000000000000000..5b5f209c15b6d6b7fbf6b732a0f9a72c97c0ee36 --- /dev/null +++ b/docs/api_docs/classes/FileUtils.md @@ -0,0 +1,107 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / FileUtils + +# Class: FileUtils + +Defined in: src/utils/FileUtils.ts:24 + +## Constructors + +### new FileUtils() + +> **new FileUtils**(): [`FileUtils`](FileUtils.md) + +#### Returns + +[`FileUtils`](FileUtils.md) + +## Properties + +### FILE\_FILTER + +> `readonly` `static` **FILE\_FILTER**: `object` + +Defined in: src/utils/FileUtils.ts:25 + +#### ignores + +> **ignores**: `string`[] + +#### include + +> **include**: `RegExp` + +## Methods + +### generateModuleMap() + +> `static` **generateModuleMap**(`ohPkgContentMap`): `Map`\<`string`, [`ModulePath`](ModulePath.md)\> + +Defined in: src/utils/FileUtils.ts:52 + +#### Parameters + +##### ohPkgContentMap + +`Map`\<`string`, \{\}\> + +#### Returns + +`Map`\<`string`, [`ModulePath`](ModulePath.md)\> + +*** + +### getIndexFileName() + +> `static` **getIndexFileName**(`srcPath`): `string` + +Defined in: src/utils/FileUtils.ts:30 + +#### Parameters + +##### srcPath + +`string` + +#### Returns + +`string` + +*** + +### isAbsolutePath() + +> `static` **isAbsolutePath**(`path`): `boolean` + +Defined in: src/utils/FileUtils.ts:48 + +#### Parameters + +##### path + +`string` + +#### Returns + +`boolean` + +*** + +### isDirectory() + +> `static` **isDirectory**(`srcPath`): `boolean` + +Defined in: src/utils/FileUtils.ts:39 + +#### Parameters + +##### srcPath + +`string` + +#### Returns + +`boolean` diff --git a/docs/api_docs/classes/FullPosition.md b/docs/api_docs/classes/FullPosition.md new file mode 100644 index 0000000000000000000000000000000000000000..2d71cb33f7ee27386893c338fe074eee10e16361 --- /dev/null +++ b/docs/api_docs/classes/FullPosition.md @@ -0,0 +1,139 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / FullPosition + +# Class: FullPosition + +Defined in: src/core/base/Position.ts:104 + +## Constructors + +### new FullPosition() + +> **new FullPosition**(`firstLine`, `firstCol`, `lastLine`, `lastCol`): [`FullPosition`](FullPosition.md) + +Defined in: src/core/base/Position.ts:110 + +#### Parameters + +##### firstLine + +`number` + +##### firstCol + +`number` + +##### lastLine + +`number` + +##### lastCol + +`number` + +#### Returns + +[`FullPosition`](FullPosition.md) + +## Properties + +### DEFAULT + +> `readonly` `static` **DEFAULT**: [`FullPosition`](FullPosition.md) + +Defined in: src/core/base/Position.ts:108 + +## Methods + +### getFirstCol() + +> **getFirstCol**(): `number` + +Defined in: src/core/base/Position.ts:123 + +#### Returns + +`number` + +*** + +### getFirstLine() + +> **getFirstLine**(): `number` + +Defined in: src/core/base/Position.ts:115 + +#### Returns + +`number` + +*** + +### getLastCol() + +> **getLastCol**(): `number` + +Defined in: src/core/base/Position.ts:127 + +#### Returns + +`number` + +*** + +### getLastLine() + +> **getLastLine**(): `number` + +Defined in: src/core/base/Position.ts:119 + +#### Returns + +`number` + +*** + +### buildFromNode() + +> `static` **buildFromNode**(`node`, `sourceFile`): [`FullPosition`](FullPosition.md) + +Defined in: src/core/base/Position.ts:131 + +#### Parameters + +##### node + +[`Node`](../namespaces/ts/interfaces/Node.md) + +##### sourceFile + +[`SourceFile`](../namespaces/ts/interfaces/SourceFile.md) + +#### Returns + +[`FullPosition`](FullPosition.md) + +*** + +### merge() + +> `static` **merge**(`leftMostPosition`, `rightMostPosition`): [`FullPosition`](FullPosition.md) + +Defined in: src/core/base/Position.ts:142 + +#### Parameters + +##### leftMostPosition + +[`FullPosition`](FullPosition.md) + +##### rightMostPosition + +[`FullPosition`](FullPosition.md) + +#### Returns + +[`FullPosition`](FullPosition.md) diff --git a/docs/api_docs/classes/FuncPag.md b/docs/api_docs/classes/FuncPag.md new file mode 100644 index 0000000000000000000000000000000000000000..cd1a582abfb678a9e9d960486edc1d53ee4fbc1f --- /dev/null +++ b/docs/api_docs/classes/FuncPag.md @@ -0,0 +1,143 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / FuncPag + +# Class: FuncPag + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:950 + +## Constructors + +### new FuncPag() + +> **new FuncPag**(): [`FuncPag`](FuncPag.md) + +#### Returns + +[`FuncPag`](FuncPag.md) + +## Methods + +### addDynamicCallSite() + +> **addDynamicCallSite**(`cs`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:970 + +#### Parameters + +##### cs + +[`DynCallSite`](DynCallSite.md) + +#### Returns + +`void` + +*** + +### addInternalEdge() + +> **addInternalEdge**(`stmt`, `k`): `boolean` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:990 + +#### Parameters + +##### stmt + +[`ArkAssignStmt`](ArkAssignStmt.md) + +##### k + +[`PagEdgeKind`](../enumerations/PagEdgeKind.md) + +#### Returns + +`boolean` + +*** + +### addNormalCallSite() + +> **addNormalCallSite**(`cs`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:960 + +#### Parameters + +##### cs + +[`CallSite`](CallSite.md) + +#### Returns + +`void` + +*** + +### addUnknownCallSite() + +> **addUnknownCallSite**(`cs`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:980 + +#### Parameters + +##### cs + +[`CallSite`](CallSite.md) + +#### Returns + +`void` + +*** + +### getDynamicCallSites() + +> **getDynamicCallSites**(): `Set`\<[`DynCallSite`](DynCallSite.md)\> + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:975 + +#### Returns + +`Set`\<[`DynCallSite`](DynCallSite.md)\> + +*** + +### getInternalEdges() + +> **getInternalEdges**(): `undefined` \| `Set`\<[`IntraProceduralEdge`](../type-aliases/IntraProceduralEdge.md)\> + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:956 + +#### Returns + +`undefined` \| `Set`\<[`IntraProceduralEdge`](../type-aliases/IntraProceduralEdge.md)\> + +*** + +### getNormalCallSites() + +> **getNormalCallSites**(): `Set`\<[`CallSite`](CallSite.md)\> + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:965 + +#### Returns + +`Set`\<[`CallSite`](CallSite.md)\> + +*** + +### getUnknownCallSites() + +> **getUnknownCallSites**(): `Set`\<[`CallSite`](CallSite.md)\> + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:985 + +#### Returns + +`Set`\<[`CallSite`](CallSite.md)\> diff --git a/docs/api_docs/classes/FunctionType.md b/docs/api_docs/classes/FunctionType.md new file mode 100644 index 0000000000000000000000000000000000000000..95a93cde41123094c644d56419cb13b66032482f --- /dev/null +++ b/docs/api_docs/classes/FunctionType.md @@ -0,0 +1,101 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / FunctionType + +# Class: FunctionType + +Defined in: src/core/base/Type.ts:309 + +function type + +## Extends + +- [`Type`](Type.md) + +## Extended by + +- [`ClosureType`](ClosureType.md) + +## Constructors + +### new FunctionType() + +> **new FunctionType**(`methodSignature`, `realGenericTypes`?): [`FunctionType`](FunctionType.md) + +Defined in: src/core/base/Type.ts:313 + +#### Parameters + +##### methodSignature + +[`MethodSignature`](MethodSignature.md) + +##### realGenericTypes? + +[`Type`](Type.md)[] + +#### Returns + +[`FunctionType`](FunctionType.md) + +#### Overrides + +[`Type`](Type.md).[`constructor`](Type.md#constructors) + +## Methods + +### getMethodSignature() + +> **getMethodSignature**(): [`MethodSignature`](MethodSignature.md) + +Defined in: src/core/base/Type.ts:319 + +#### Returns + +[`MethodSignature`](MethodSignature.md) + +*** + +### getRealGenericTypes() + +> **getRealGenericTypes**(): `undefined` \| [`Type`](Type.md)[] + +Defined in: src/core/base/Type.ts:323 + +#### Returns + +`undefined` \| [`Type`](Type.md)[] + +*** + +### getTypeString() + +> **getTypeString**(): `string` + +Defined in: src/core/base/Type.ts:327 + +#### Returns + +`string` + +#### Overrides + +[`Type`](Type.md).[`getTypeString`](Type.md#gettypestring) + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/base/Type.ts:36 + +#### Returns + +`string` + +#### Inherited from + +[`Type`](Type.md).[`toString`](Type.md#tostring) diff --git a/docs/api_docs/classes/GenericType.md b/docs/api_docs/classes/GenericType.md new file mode 100644 index 0000000000000000000000000000000000000000..1674923c5134bc650f47a213dc70264fb13888cc --- /dev/null +++ b/docs/api_docs/classes/GenericType.md @@ -0,0 +1,177 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / GenericType + +# Class: GenericType + +Defined in: src/core/base/Type.ts:520 + +## Extends + +- [`Type`](Type.md) + +## Constructors + +### new GenericType() + +> **new GenericType**(`name`, `defaultType`?, `constraint`?): [`GenericType`](GenericType.md) + +Defined in: src/core/base/Type.ts:526 + +#### Parameters + +##### name + +`string` + +##### defaultType? + +[`Type`](Type.md) + +##### constraint? + +[`Type`](Type.md) + +#### Returns + +[`GenericType`](GenericType.md) + +#### Overrides + +[`Type`](Type.md).[`constructor`](Type.md#constructors) + +## Methods + +### getConstraint() + +> **getConstraint**(): `undefined` \| [`Type`](Type.md) + +Defined in: src/core/base/Type.ts:545 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +*** + +### getDefaultType() + +> **getDefaultType**(): `undefined` \| [`Type`](Type.md) + +Defined in: src/core/base/Type.ts:537 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +*** + +### getIndex() + +> **getIndex**(): `number` + +Defined in: src/core/base/Type.ts:557 + +#### Returns + +`number` + +*** + +### getName() + +> **getName**(): `string` + +Defined in: src/core/base/Type.ts:533 + +#### Returns + +`string` + +*** + +### getTypeString() + +> **getTypeString**(): `string` + +Defined in: src/core/base/Type.ts:561 + +#### Returns + +`string` + +#### Overrides + +[`Type`](Type.md).[`getTypeString`](Type.md#gettypestring) + +*** + +### setConstraint() + +> **setConstraint**(`type`): `void` + +Defined in: src/core/base/Type.ts:549 + +#### Parameters + +##### type + +[`Type`](Type.md) + +#### Returns + +`void` + +*** + +### setDefaultType() + +> **setDefaultType**(`type`): `void` + +Defined in: src/core/base/Type.ts:541 + +#### Parameters + +##### type + +[`Type`](Type.md) + +#### Returns + +`void` + +*** + +### setIndex() + +> **setIndex**(`index`): `void` + +Defined in: src/core/base/Type.ts:553 + +#### Parameters + +##### index + +`number` + +#### Returns + +`void` + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/base/Type.ts:36 + +#### Returns + +`string` + +#### Inherited from + +[`Type`](Type.md).[`toString`](Type.md#tostring) diff --git a/docs/api_docs/classes/GlobalRef.md b/docs/api_docs/classes/GlobalRef.md new file mode 100644 index 0000000000000000000000000000000000000000..2c42bdf003a8d9e42bd13a13c91f32783ae48704 --- /dev/null +++ b/docs/api_docs/classes/GlobalRef.md @@ -0,0 +1,205 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / GlobalRef + +# Class: GlobalRef + +Defined in: src/core/base/Ref.ts:342 + +## Extends + +- [`AbstractRef`](AbstractRef.md) + +## Constructors + +### new GlobalRef() + +> **new GlobalRef**(`name`, `ref`?): [`GlobalRef`](GlobalRef.md) + +Defined in: src/core/base/Ref.ts:347 + +#### Parameters + +##### name + +`string` + +##### ref? + +[`Value`](../interfaces/Value.md) + +#### Returns + +[`GlobalRef`](GlobalRef.md) + +#### Overrides + +[`AbstractRef`](AbstractRef.md).[`constructor`](AbstractRef.md#constructors) + +## Methods + +### addUsedStmts() + +> **addUsedStmts**(`usedStmts`): `void` + +Defined in: src/core/base/Ref.ts:378 + +#### Parameters + +##### usedStmts + +[`Stmt`](Stmt.md) | [`Stmt`](Stmt.md)[] + +#### Returns + +`void` + +*** + +### getName() + +> **getName**(): `string` + +Defined in: src/core/base/Ref.ts:354 + +#### Returns + +`string` + +*** + +### getRef() + +> **getRef**(): `null` \| [`Value`](../interfaces/Value.md) + +Defined in: src/core/base/Ref.ts:366 + +#### Returns + +`null` \| [`Value`](../interfaces/Value.md) + +*** + +### getType() + +> **getType**(): [`Type`](Type.md) + +Defined in: src/core/base/Ref.ts:362 + +Return the type of this value. The interface is encapsulated in [Value](../interfaces/Value.md). +The `Type` is defined in type.ts, such as **Any**, **Unknown**, **TypeParameter**, +**UnclearReference**, **Primitive**, **Number**, **String**, etc. + +#### Returns + +[`Type`](Type.md) + +The type of this value. + +#### Example + +1. In the declaration statement, determine the left-value type and right-value type. + +```typescript +let leftValue:Value; +let rightValue:Value; +... +if (leftValue.getType() instanceof UnknownType && + !(rightValue.getType() instanceof UnknownType) && + !(rightValue.getType() instanceof UndefinedType)) { + ... +} +``` + +#### Overrides + +[`AbstractRef`](AbstractRef.md).[`getType`](AbstractRef.md#gettype) + +*** + +### getUsedStmts() + +> **getUsedStmts**(): [`Stmt`](Stmt.md)[] + +Defined in: src/core/base/Ref.ts:374 + +#### Returns + +[`Stmt`](Stmt.md)[] + +*** + +### getUses() + +> **getUses**(): [`Value`](../interfaces/Value.md)[] + +Defined in: src/core/base/Ref.ts:358 + +Return a list of values which are contained in this [Value](../interfaces/Value.md). +Value is a core interface in ArkAnalyzer, which may represent any value or expression. + +#### Returns + +[`Value`](../interfaces/Value.md)[] + +An **array** of values used by this value. + +#### Overrides + +[`AbstractRef`](AbstractRef.md).[`getUses`](AbstractRef.md#getuses) + +*** + +### inferType() + +> **inferType**(`arkMethod`): [`AbstractRef`](AbstractRef.md) + +Defined in: src/core/base/Ref.ts:37 + +#### Parameters + +##### arkMethod + +[`ArkMethod`](ArkMethod.md) + +#### Returns + +[`AbstractRef`](AbstractRef.md) + +#### Inherited from + +[`AbstractRef`](AbstractRef.md).[`inferType`](AbstractRef.md#infertype) + +*** + +### setRef() + +> **setRef**(`value`): `void` + +Defined in: src/core/base/Ref.ts:370 + +#### Parameters + +##### value + +[`Value`](../interfaces/Value.md) + +#### Returns + +`void` + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/base/Ref.ts:386 + +Returns a string representation of an object. + +#### Returns + +`string` diff --git a/docs/api_docs/classes/GraphPrinter.md b/docs/api_docs/classes/GraphPrinter.md new file mode 100644 index 0000000000000000000000000000000000000000..2620db773e3edd697b8cc5764b7918daeb8299e9 --- /dev/null +++ b/docs/api_docs/classes/GraphPrinter.md @@ -0,0 +1,181 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / GraphPrinter + +# Class: GraphPrinter\ + +Defined in: src/save/GraphPrinter.ts:64 + +## Extends + +- [`Printer`](Printer.md) + +## Type Parameters + +• **GraphType** *extends* [`GraphTraits`](../interfaces/GraphTraits.md) + +## Constructors + +### new GraphPrinter() + +> **new GraphPrinter**\<`GraphType`\>(`g`, `t`?): [`GraphPrinter`](GraphPrinter.md)\<`GraphType`\> + +Defined in: src/save/GraphPrinter.ts:69 + +#### Parameters + +##### g + +`GraphType` + +##### t? + +`string` + +#### Returns + +[`GraphPrinter`](GraphPrinter.md)\<`GraphType`\> + +#### Overrides + +[`Printer`](Printer.md).[`constructor`](Printer.md#constructors) + +## Properties + +### graph + +> **graph**: `GraphType` + +Defined in: src/save/GraphPrinter.ts:65 + +*** + +### printer + +> `protected` **printer**: `ArkCodeBuffer` + +Defined in: src/save/Printer.ts:22 + +#### Inherited from + +[`Printer`](Printer.md).[`printer`](Printer.md#printer-1) + +*** + +### startID + +> **startID**: `undefined` \| `number` = `undefined` + +Defined in: src/save/GraphPrinter.ts:67 + +*** + +### title + +> **title**: `string` + +Defined in: src/save/GraphPrinter.ts:66 + +## Methods + +### dump() + +> **dump**(): `string` + +Defined in: src/save/GraphPrinter.ts:81 + +ArkIR dump + +#### Returns + +`string` + +#### Overrides + +[`Printer`](Printer.md).[`dump`](Printer.md#dump) + +*** + +### setStartID() + +> **setStartID**(`n`): `void` + +Defined in: src/save/GraphPrinter.ts:77 + +#### Parameters + +##### n + +`number` + +#### Returns + +`void` + +*** + +### writeEdge() + +> **writeEdge**(`edge`): `void` + +Defined in: src/save/GraphPrinter.ts:128 + +#### Parameters + +##### edge + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`void` + +*** + +### writeFooter() + +> **writeFooter**(): `void` + +Defined in: src/save/GraphPrinter.ts:149 + +#### Returns + +`void` + +*** + +### writeGraph() + +> **writeGraph**(): `void` + +Defined in: src/save/GraphPrinter.ts:87 + +#### Returns + +`void` + +*** + +### writeHeader() + +> **writeHeader**(): `void` + +Defined in: src/save/GraphPrinter.ts:136 + +#### Returns + +`void` + +*** + +### writeNodes() + +> **writeNodes**(): `void` + +Defined in: src/save/GraphPrinter.ts:93 + +#### Returns + +`void` diff --git a/docs/api_docs/classes/IRUtils.md b/docs/api_docs/classes/IRUtils.md new file mode 100644 index 0000000000000000000000000000000000000000..f781e869d4d89c9c02ea1335ec1da25d4fd0a83d --- /dev/null +++ b/docs/api_docs/classes/IRUtils.md @@ -0,0 +1,199 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / IRUtils + +# Class: IRUtils + +Defined in: src/core/common/IRUtils.ts:29 + +## Constructors + +### new IRUtils() + +> **new IRUtils**(): [`IRUtils`](IRUtils.md) + +#### Returns + +[`IRUtils`](IRUtils.md) + +## Methods + +### adjustOperandOriginalPositions() + +> `static` **adjustOperandOriginalPositions**(`stmt`, `oldValue`, `newValue`): `void` + +Defined in: src/core/common/IRUtils.ts:113 + +#### Parameters + +##### stmt + +[`Stmt`](Stmt.md) + +##### oldValue + +[`Value`](../interfaces/Value.md) + +##### newValue + +[`Value`](../interfaces/Value.md) + +#### Returns + +`void` + +*** + +### findOperandIdx() + +> `static` **findOperandIdx**(`stmt`, `operand`): `number` + +Defined in: src/core/common/IRUtils.ts:101 + +#### Parameters + +##### stmt + +[`Stmt`](Stmt.md) + +##### operand + +[`Value`](../interfaces/Value.md) + +#### Returns + +`number` + +*** + +### generateDefaultPositions() + +> `static` **generateDefaultPositions**(`count`): [`FullPosition`](FullPosition.md)[] + +Defined in: src/core/common/IRUtils.ts:155 + +#### Parameters + +##### count + +`number` + +#### Returns + +[`FullPosition`](FullPosition.md)[] + +*** + +### generateTextForStmt() + +> `static` **generateTextForStmt**(`scene`): `void` + +Defined in: src/core/common/IRUtils.ts:44 + +#### Parameters + +##### scene + +[`Scene`](Scene.md) + +#### Returns + +`void` + +*** + +### getCommentsMetadata() + +> `static` **getCommentsMetadata**(`node`, `sourceFile`, `options`, `isLeading`): `CommentsMetadata` + +Defined in: src/core/common/IRUtils.ts:70 + +#### Parameters + +##### node + +[`Node`](../namespaces/ts/interfaces/Node.md) + +##### sourceFile + +[`SourceFile`](../namespaces/ts/interfaces/SourceFile.md) + +##### options + +`SceneOptions` + +##### isLeading + +`boolean` + +#### Returns + +`CommentsMetadata` + +*** + +### isTempLocal() + +> `static` **isTempLocal**(`value`): `boolean` + +Defined in: src/core/common/IRUtils.ts:97 + +#### Parameters + +##### value + +[`Value`](../interfaces/Value.md) + +#### Returns + +`boolean` + +*** + +### moreThanOneAddress() + +> `static` **moreThanOneAddress**(`value`): `boolean` + +Defined in: src/core/common/IRUtils.ts:30 + +#### Parameters + +##### value + +[`Value`](../interfaces/Value.md) + +#### Returns + +`boolean` + +*** + +### setComments() + +> `static` **setComments**(`metadata`, `node`, `sourceFile`, `options`): `void` + +Defined in: src/core/common/IRUtils.ts:55 + +#### Parameters + +##### metadata + +`ArkBaseModel` | [`Stmt`](Stmt.md) + +##### node + +[`Node`](../namespaces/ts/interfaces/Node.md) + +##### sourceFile + +[`SourceFile`](../namespaces/ts/interfaces/SourceFile.md) + +##### options + +`SceneOptions` + +#### Returns + +`void` diff --git a/docs/api_docs/classes/ImportInfo.md b/docs/api_docs/classes/ImportInfo.md new file mode 100644 index 0000000000000000000000000000000000000000..9e7eba269ef7af3fd9b458f3a5777cc3c085d2b0 --- /dev/null +++ b/docs/api_docs/classes/ImportInfo.md @@ -0,0 +1,901 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / ImportInfo + +# Class: ImportInfo + +Defined in: src/core/model/ArkImport.ts:26 + +## Extends + +- `ArkBaseModel` + +## Implements + +- `FromInfo` + +## Constructors + +### new ImportInfo() + +> **new ImportInfo**(): [`ImportInfo`](ImportInfo.md) + +Defined in: src/core/model/ArkImport.ts:37 + +#### Returns + +[`ImportInfo`](ImportInfo.md) + +#### Overrides + +`ArkBaseModel.constructor` + +## Properties + +### decorators? + +> `protected` `optional` **decorators**: `Set`\<[`Decorator`](Decorator.md)\> + +Defined in: src/core/model/ArkBaseModel.ts:115 + +#### Inherited from + +`ArkBaseModel.decorators` + +*** + +### metadata? + +> `protected` `optional` **metadata**: `ArkMetadata` + +Defined in: src/core/model/ArkBaseModel.ts:116 + +#### Inherited from + +`ArkBaseModel.metadata` + +*** + +### modifiers? + +> `protected` `optional` **modifiers**: `number` + +Defined in: src/core/model/ArkBaseModel.ts:114 + +#### Inherited from + +`ArkBaseModel.modifiers` + +## Methods + +### addDecorator() + +> **addDecorator**(`decorator`): `void` + +Defined in: src/core/model/ArkBaseModel.ts:215 + +#### Parameters + +##### decorator + +[`Decorator`](Decorator.md) + +#### Returns + +`void` + +#### Inherited from + +`ArkBaseModel.addDecorator` + +*** + +### addModifier() + +> **addModifier**(`modifier`): `void` + +Defined in: src/core/model/ArkBaseModel.ts:142 + +#### Parameters + +##### modifier + +`number` + +#### Returns + +`void` + +#### Inherited from + +`ArkBaseModel.addModifier` + +*** + +### build() + +> **build**(`importClauseName`, `importType`, `importFrom`, `originTsPosition`, `modifiers`, `nameBeforeAs`?): `void` + +Defined in: src/core/model/ArkImport.ts:41 + +#### Parameters + +##### importClauseName + +`string` + +##### importType + +`string` + +##### importFrom + +`string` + +##### originTsPosition + +[`LineColPosition`](LineColPosition.md) + +##### modifiers + +`number` + +##### nameBeforeAs? + +`string` + +#### Returns + +`void` + +*** + +### containsModifier() + +> **containsModifier**(`modifierType`): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:194 + +#### Parameters + +##### modifierType + +`ModifierType` + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.containsModifier` + +*** + +### getDeclaringArkFile() + +> **getDeclaringArkFile**(): [`ArkFile`](ArkFile.md) + +Defined in: src/core/model/ArkImport.ts:72 + +#### Returns + +[`ArkFile`](ArkFile.md) + +#### Implementation of + +`FromInfo.getDeclaringArkFile` + +*** + +### getDecorators() + +> **getDecorators**(): [`Decorator`](Decorator.md)[] + +Defined in: src/core/model/ArkBaseModel.ts:202 + +#### Returns + +[`Decorator`](Decorator.md)[] + +#### Inherited from + +`ArkBaseModel.getDecorators` + +*** + +### getFrom() + +> **getFrom**(): `undefined` \| `string` + +Defined in: src/core/model/ArkImport.ts:120 + +#### Returns + +`undefined` \| `string` + +#### Implementation of + +`FromInfo.getFrom` + +*** + +### getImportClauseName() + +> **getImportClauseName**(): `string` + +Defined in: src/core/model/ArkImport.ts:76 + +#### Returns + +`string` + +*** + +### getImportType() + +> **getImportType**(): `string` + +Defined in: src/core/model/ArkImport.ts:84 + +#### Returns + +`string` + +*** + +### getLazyExportInfo() + +> **getLazyExportInfo**(): `null` \| [`ExportInfo`](ExportInfo.md) + +Defined in: src/core/model/ArkImport.ts:61 + +Returns the export information, i.e., the actual reference generated at the time of call. +The export information includes: clause's name, clause's type, modifiers, location +where it is exported from, etc. If the export information could not be found, **null** will be returned. + +#### Returns + +`null` \| [`ExportInfo`](ExportInfo.md) + +The export information. If there is no export information, the return will be a **null**. + +*** + +### getMetadata() + +> **getMetadata**(`kind`): `undefined` \| `ArkMetadataType` + +Defined in: src/core/model/ArkBaseModel.ts:118 + +#### Parameters + +##### kind + +`ArkMetadataKind` + +#### Returns + +`undefined` \| `ArkMetadataType` + +#### Inherited from + +`ArkBaseModel.getMetadata` + +*** + +### getModifiers() + +> **getModifiers**(): `number` + +Defined in: src/core/model/ArkBaseModel.ts:129 + +#### Returns + +`number` + +#### Inherited from + +`ArkBaseModel.getModifiers` + +*** + +### getNameBeforeAs() + +> **getNameBeforeAs**(): `undefined` \| `string` + +Defined in: src/core/model/ArkImport.ts:96 + +#### Returns + +`undefined` \| `string` + +*** + +### getOriginName() + +> **getOriginName**(): `string` + +Defined in: src/core/model/ArkImport.ts:51 + +#### Returns + +`string` + +#### Implementation of + +`FromInfo.getOriginName` + +*** + +### getOriginTsPosition() + +> **getOriginTsPosition**(): [`LineColPosition`](LineColPosition.md) + +Defined in: src/core/model/ArkImport.ts:108 + +#### Returns + +[`LineColPosition`](LineColPosition.md) + +*** + +### getStateDecorators() + +> **getStateDecorators**(): [`Decorator`](Decorator.md)[] + +Defined in: src/core/model/ArkBaseModel.ts:234 + +#### Returns + +[`Decorator`](Decorator.md)[] + +#### Inherited from + +`ArkBaseModel.getStateDecorators` + +*** + +### getTsSourceCode() + +> **getTsSourceCode**(): `string` + +Defined in: src/core/model/ArkImport.ts:116 + +#### Returns + +`string` + +*** + +### hasBuilderDecorator() + +> **hasBuilderDecorator**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:230 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.hasBuilderDecorator` + +*** + +### hasBuilderParamDecorator() + +> **hasBuilderParamDecorator**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:243 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.hasBuilderParamDecorator` + +*** + +### hasComponentDecorator() + +> **hasComponentDecorator**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:251 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.hasComponentDecorator` + +*** + +### hasDecorator() + +> **hasDecorator**(`kind`): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:255 + +#### Parameters + +##### kind + +`string` | `Set`\<`string`\> + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.hasDecorator` + +*** + +### hasEntryDecorator() + +> **hasEntryDecorator**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:247 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.hasEntryDecorator` + +*** + +### isAbstract() + +> **isAbstract**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:173 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.isAbstract` + +*** + +### isDeclare() + +> **isDeclare**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:190 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.isDeclare` + +*** + +### isDefault() + +> **isDefault**(): `boolean` + +Defined in: src/core/model/ArkImport.ts:124 + +#### Returns + +`boolean` + +#### Implementation of + +`FromInfo.isDefault` + +#### Overrides + +`ArkBaseModel.isDefault` + +*** + +### isExport() + +> **isExport**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:177 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.isExport` + +*** + +### ~~isExported()~~ + +> **isExported**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:186 + +#### Returns + +`boolean` + +#### Deprecated + +Use [isExport](ArkNamespace.md#isexport) instead. + +#### Inherited from + +`ArkBaseModel.isExported` + +*** + +### isPrivate() + +> **isPrivate**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:161 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.isPrivate` + +*** + +### isProtected() + +> **isProtected**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:157 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.isProtected` + +*** + +### isPublic() + +> **isPublic**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:165 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.isPublic` + +*** + +### isReadonly() + +> **isReadonly**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:169 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.isReadonly` + +*** + +### isStatic() + +> **isStatic**(): `boolean` + +Defined in: src/core/model/ArkBaseModel.ts:153 + +#### Returns + +`boolean` + +#### Inherited from + +`ArkBaseModel.isStatic` + +*** + +### removeDecorator() + +> **removeDecorator**(`kind`): `void` + +Defined in: src/core/model/ArkBaseModel.ts:222 + +#### Parameters + +##### kind + +`string` + +#### Returns + +`void` + +#### Inherited from + +`ArkBaseModel.removeDecorator` + +*** + +### removeModifier() + +> **removeModifier**(`modifier`): `void` + +Defined in: src/core/model/ArkBaseModel.ts:146 + +#### Parameters + +##### modifier + +`ModifierType` + +#### Returns + +`void` + +#### Inherited from + +`ArkBaseModel.removeModifier` + +*** + +### setDeclaringArkFile() + +> **setDeclaringArkFile**(`declaringArkFile`): `void` + +Defined in: src/core/model/ArkImport.ts:68 + +#### Parameters + +##### declaringArkFile + +[`ArkFile`](ArkFile.md) + +#### Returns + +`void` + +*** + +### setDecorators() + +> **setDecorators**(`decorators`): `void` + +Defined in: src/core/model/ArkBaseModel.ts:209 + +#### Parameters + +##### decorators + +`Set`\<[`Decorator`](Decorator.md)\> + +#### Returns + +`void` + +#### Inherited from + +`ArkBaseModel.setDecorators` + +*** + +### setImportClauseName() + +> **setImportClauseName**(`importClauseName`): `void` + +Defined in: src/core/model/ArkImport.ts:80 + +#### Parameters + +##### importClauseName + +`string` + +#### Returns + +`void` + +*** + +### setImportFrom() + +> **setImportFrom**(`importFrom`): `void` + +Defined in: src/core/model/ArkImport.ts:92 + +#### Parameters + +##### importFrom + +`string` + +#### Returns + +`void` + +*** + +### setImportType() + +> **setImportType**(`importType`): `void` + +Defined in: src/core/model/ArkImport.ts:88 + +#### Parameters + +##### importType + +`string` + +#### Returns + +`void` + +*** + +### setMetadata() + +> **setMetadata**(`kind`, `value`): `void` + +Defined in: src/core/model/ArkBaseModel.ts:122 + +#### Parameters + +##### kind + +`ArkMetadataKind` + +##### value + +`ArkMetadataType` + +#### Returns + +`void` + +#### Inherited from + +`ArkBaseModel.setMetadata` + +*** + +### setModifiers() + +> **setModifiers**(`modifiers`): `void` + +Defined in: src/core/model/ArkBaseModel.ts:136 + +#### Parameters + +##### modifiers + +`number` + +#### Returns + +`void` + +#### Inherited from + +`ArkBaseModel.setModifiers` + +*** + +### setNameBeforeAs() + +> **setNameBeforeAs**(`nameBeforeAs`): `void` + +Defined in: src/core/model/ArkImport.ts:100 + +#### Parameters + +##### nameBeforeAs + +`undefined` | `string` + +#### Returns + +`void` + +*** + +### setOriginTsPosition() + +> **setOriginTsPosition**(`originTsPosition`): `void` + +Defined in: src/core/model/ArkImport.ts:104 + +#### Parameters + +##### originTsPosition + +[`LineColPosition`](LineColPosition.md) + +#### Returns + +`void` + +*** + +### setTsSourceCode() + +> **setTsSourceCode**(`tsSourceCode`): `void` + +Defined in: src/core/model/ArkImport.ts:112 + +#### Parameters + +##### tsSourceCode + +`string` + +#### Returns + +`void` + +*** + +### validate() + +> **validate**(): `ArkError` + +Defined in: src/core/model/ArkImport.ts:131 + +#### Returns + +`ArkError` + +#### Overrides + +`ArkBaseModel.validate` + +*** + +### validateFields() + +> `protected` **validateFields**(`fields`): `ArkError` + +Defined in: src/core/model/ArkBaseModel.ts:267 + +#### Parameters + +##### fields + +`string`[] + +#### Returns + +`ArkError` + +#### Inherited from + +`ArkBaseModel.validateFields` diff --git a/docs/api_docs/classes/InterFuncPag.md b/docs/api_docs/classes/InterFuncPag.md new file mode 100644 index 0000000000000000000000000000000000000000..a12ed2f324b6c49f8eae6db77345ce32c1623dfc --- /dev/null +++ b/docs/api_docs/classes/InterFuncPag.md @@ -0,0 +1,51 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / InterFuncPag + +# Class: InterFuncPag + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:1006 + +## Constructors + +### new InterFuncPag() + +> **new InterFuncPag**(): [`InterFuncPag`](InterFuncPag.md) + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:1009 + +#### Returns + +[`InterFuncPag`](InterFuncPag.md) + +## Methods + +### addToInterProceduralEdgeSet() + +> **addToInterProceduralEdgeSet**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:1017 + +#### Parameters + +##### e + +[`InterProceduralEdge`](../type-aliases/InterProceduralEdge.md) + +#### Returns + +`void` + +*** + +### getInterProceduralEdges() + +> **getInterProceduralEdges**(): `Set`\<[`InterProceduralEdge`](../type-aliases/InterProceduralEdge.md)\> + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:1013 + +#### Returns + +`Set`\<[`InterProceduralEdge`](../type-aliases/InterProceduralEdge.md)\> diff --git a/docs/api_docs/classes/JsonPrinter.md b/docs/api_docs/classes/JsonPrinter.md new file mode 100644 index 0000000000000000000000000000000000000000..66a1ee8f0d35de0f8d9fd0e9bd99184402e79c77 --- /dev/null +++ b/docs/api_docs/classes/JsonPrinter.md @@ -0,0 +1,65 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / JsonPrinter + +# Class: JsonPrinter + +Defined in: src/save/JsonPrinter.ts:98 + +## Extends + +- [`Printer`](Printer.md) + +## Constructors + +### new JsonPrinter() + +> **new JsonPrinter**(`arkFile`): [`JsonPrinter`](JsonPrinter.md) + +Defined in: src/save/JsonPrinter.ts:99 + +#### Parameters + +##### arkFile + +[`ArkFile`](ArkFile.md) + +#### Returns + +[`JsonPrinter`](JsonPrinter.md) + +#### Overrides + +[`Printer`](Printer.md).[`constructor`](Printer.md#constructors) + +## Properties + +### printer + +> `protected` **printer**: `ArkCodeBuffer` + +Defined in: src/save/Printer.ts:22 + +#### Inherited from + +[`Printer`](Printer.md).[`printer`](Printer.md#printer-1) + +## Methods + +### dump() + +> **dump**(): `string` + +Defined in: src/save/JsonPrinter.ts:103 + +ArkIR dump + +#### Returns + +`string` + +#### Overrides + +[`Printer`](Printer.md).[`dump`](Printer.md#dump) diff --git a/docs/api_docs/classes/KLimitedContextSensitive.md b/docs/api_docs/classes/KLimitedContextSensitive.md new file mode 100644 index 0000000000000000000000000000000000000000..987a867e84231fdaeeaba95bc684d304f60751a7 --- /dev/null +++ b/docs/api_docs/classes/KLimitedContextSensitive.md @@ -0,0 +1,147 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / KLimitedContextSensitive + +# Class: KLimitedContextSensitive + +Defined in: src/callgraph/pointerAnalysis/Context.ts:132 + +## Constructors + +### new KLimitedContextSensitive() + +> **new KLimitedContextSensitive**(`k`): [`KLimitedContextSensitive`](KLimitedContextSensitive.md) + +Defined in: src/callgraph/pointerAnalysis/Context.ts:136 + +#### Parameters + +##### k + +`number` + +#### Returns + +[`KLimitedContextSensitive`](KLimitedContextSensitive.md) + +## Properties + +### ctxCache + +> **ctxCache**: `ContextCache` + +Defined in: src/callgraph/pointerAnalysis/Context.ts:134 + +*** + +### k + +> **k**: `number` + +Defined in: src/callgraph/pointerAnalysis/Context.ts:133 + +## Methods + +### emptyContext() + +> **emptyContext**(): `Context` + +Defined in: src/callgraph/pointerAnalysis/Context.ts:143 + +#### Returns + +`Context` + +*** + +### getContextByID() + +> **getContextByID**(`context_id`): `undefined` \| `Context` + +Defined in: src/callgraph/pointerAnalysis/Context.ts:155 + +#### Parameters + +##### context\_id + +`number` + +#### Returns + +`undefined` \| `Context` + +*** + +### getContextID() + +> **getContextID**(`context`): `number` + +Defined in: src/callgraph/pointerAnalysis/Context.ts:151 + +#### Parameters + +##### context + +`Context` + +#### Returns + +`number` + +*** + +### getEmptyContextID() + +> **getEmptyContextID**(): `number` + +Defined in: src/callgraph/pointerAnalysis/Context.ts:147 + +#### Returns + +`number` + +*** + +### getNewContextID() + +> **getNewContextID**(`callerFuncId`): `number` + +Defined in: src/callgraph/pointerAnalysis/Context.ts:159 + +#### Parameters + +##### callerFuncId + +`number` + +#### Returns + +`number` + +*** + +### getOrNewContext() + +> **getOrNewContext**(`callerCid`, `calleeFuncId`, `findCalleeAsTop`): `number` + +Defined in: src/callgraph/pointerAnalysis/Context.ts:163 + +#### Parameters + +##### callerCid + +`number` + +##### calleeFuncId + +`number` + +##### findCalleeAsTop + +`boolean` = `false` + +#### Returns + +`number` diff --git a/docs/api_docs/classes/LexicalEnvType.md b/docs/api_docs/classes/LexicalEnvType.md new file mode 100644 index 0000000000000000000000000000000000000000..8ceee967b05207233a8e4c0d0ed8feadb921d71e --- /dev/null +++ b/docs/api_docs/classes/LexicalEnvType.md @@ -0,0 +1,113 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / LexicalEnvType + +# Class: LexicalEnvType + +Defined in: src/core/base/Type.ts:622 + +## Extends + +- [`Type`](Type.md) + +## Constructors + +### new LexicalEnvType() + +> **new LexicalEnvType**(`nestedMethod`, `closures`?): [`LexicalEnvType`](LexicalEnvType.md) + +Defined in: src/core/base/Type.ts:626 + +#### Parameters + +##### nestedMethod + +[`MethodSignature`](MethodSignature.md) + +##### closures? + +[`Local`](Local.md)[] + +#### Returns + +[`LexicalEnvType`](LexicalEnvType.md) + +#### Overrides + +[`Type`](Type.md).[`constructor`](Type.md#constructors) + +## Methods + +### addClosure() + +> **addClosure**(`closure`): `void` + +Defined in: src/core/base/Type.ts:640 + +#### Parameters + +##### closure + +[`Local`](Local.md) + +#### Returns + +`void` + +*** + +### getClosures() + +> **getClosures**(): [`Local`](Local.md)[] + +Defined in: src/core/base/Type.ts:636 + +#### Returns + +[`Local`](Local.md)[] + +*** + +### getNestedMethod() + +> **getNestedMethod**(): [`MethodSignature`](MethodSignature.md) + +Defined in: src/core/base/Type.ts:632 + +#### Returns + +[`MethodSignature`](MethodSignature.md) + +*** + +### getTypeString() + +> **getTypeString**(): `string` + +Defined in: src/core/base/Type.ts:644 + +#### Returns + +`string` + +#### Overrides + +[`Type`](Type.md).[`getTypeString`](Type.md#gettypestring) + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/base/Type.ts:36 + +#### Returns + +`string` + +#### Inherited from + +[`Type`](Type.md).[`toString`](Type.md#tostring) diff --git a/docs/api_docs/classes/LineColPosition.md b/docs/api_docs/classes/LineColPosition.md new file mode 100644 index 0000000000000000000000000000000000000000..076d8ebb50f98236361e45c55ed8ad9847c79830 --- /dev/null +++ b/docs/api_docs/classes/LineColPosition.md @@ -0,0 +1,85 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / LineColPosition + +# Class: LineColPosition + +Defined in: src/core/base/Position.ts:80 + +## Constructors + +### new LineColPosition() + +> **new LineColPosition**(`lineNo`, `colNo`): [`LineColPosition`](LineColPosition.md) + +Defined in: src/core/base/Position.ts:85 + +#### Parameters + +##### lineNo + +`number` + +##### colNo + +`number` + +#### Returns + +[`LineColPosition`](LineColPosition.md) + +## Properties + +### DEFAULT + +> `readonly` `static` **DEFAULT**: [`LineColPosition`](LineColPosition.md) + +Defined in: src/core/base/Position.ts:83 + +## Methods + +### getColNo() + +> **getColNo**(): `number` + +Defined in: src/core/base/Position.ts:93 + +#### Returns + +`number` + +*** + +### getLineNo() + +> **getLineNo**(): `number` + +Defined in: src/core/base/Position.ts:89 + +#### Returns + +`number` + +*** + +### buildFromNode() + +> `static` **buildFromNode**(`node`, `sourceFile`): [`LineColPosition`](LineColPosition.md) + +Defined in: src/core/base/Position.ts:97 + +#### Parameters + +##### node + +[`Node`](../namespaces/ts/interfaces/Node.md) + +##### sourceFile + +[`SourceFile`](../namespaces/ts/interfaces/SourceFile.md) + +#### Returns + +[`LineColPosition`](LineColPosition.md) diff --git a/docs/api_docs/classes/LiteralType.md b/docs/api_docs/classes/LiteralType.md new file mode 100644 index 0000000000000000000000000000000000000000..c4a500a8b112b78cf95977cb4fa49e2bd85ce01f --- /dev/null +++ b/docs/api_docs/classes/LiteralType.md @@ -0,0 +1,113 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / LiteralType + +# Class: LiteralType + +Defined in: src/core/base/Type.ts:207 + +literal type + +## Extends + +- [`PrimitiveType`](PrimitiveType.md) + +## Constructors + +### new LiteralType() + +> **new LiteralType**(`literalName`): [`LiteralType`](LiteralType.md) + +Defined in: src/core/base/Type.ts:213 + +#### Parameters + +##### literalName + +`string` | `number` | `boolean` + +#### Returns + +[`LiteralType`](LiteralType.md) + +#### Overrides + +[`PrimitiveType`](PrimitiveType.md).[`constructor`](PrimitiveType.md#constructors) + +## Properties + +### FALSE + +> `readonly` `static` **FALSE**: [`LiteralType`](LiteralType.md) + +Defined in: src/core/base/Type.ts:209 + +*** + +### TRUE + +> `readonly` `static` **TRUE**: [`LiteralType`](LiteralType.md) + +Defined in: src/core/base/Type.ts:208 + +## Methods + +### getLiteralName() + +> **getLiteralName**(): `string` \| `number` \| `boolean` + +Defined in: src/core/base/Type.ts:218 + +#### Returns + +`string` \| `number` \| `boolean` + +*** + +### getName() + +> **getName**(): `string` + +Defined in: src/core/base/Type.ts:126 + +#### Returns + +`string` + +#### Inherited from + +[`PrimitiveType`](PrimitiveType.md).[`getName`](PrimitiveType.md#getname) + +*** + +### getTypeString() + +> **getTypeString**(): `string` + +Defined in: src/core/base/Type.ts:222 + +#### Returns + +`string` + +#### Overrides + +[`PrimitiveType`](PrimitiveType.md).[`getTypeString`](PrimitiveType.md#gettypestring) + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/base/Type.ts:36 + +#### Returns + +`string` + +#### Inherited from + +[`PrimitiveType`](PrimitiveType.md).[`toString`](PrimitiveType.md#tostring) diff --git a/docs/api_docs/classes/LoadPagEdge.md b/docs/api_docs/classes/LoadPagEdge.md new file mode 100644 index 0000000000000000000000000000000000000000..99473ffb93cef3665cf33ae2ca8d9270eba2d56d --- /dev/null +++ b/docs/api_docs/classes/LoadPagEdge.md @@ -0,0 +1,197 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / LoadPagEdge + +# Class: LoadPagEdge + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:100 + +## Extends + +- [`PagEdge`](PagEdge.md) + +## Constructors + +### new LoadPagEdge() + +> **new LoadPagEdge**(`n`, `d`, `s`): [`LoadPagEdge`](LoadPagEdge.md) + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:101 + +#### Parameters + +##### n + +[`PagNode`](PagNode.md) + +##### d + +[`PagNode`](PagNode.md) + +##### s + +[`Stmt`](Stmt.md) + +#### Returns + +[`LoadPagEdge`](LoadPagEdge.md) + +#### Overrides + +[`PagEdge`](PagEdge.md).[`constructor`](PagEdge.md#constructors) + +## Properties + +### kind + +> `protected` **kind**: `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:27 + +#### Inherited from + +[`PagEdge`](PagEdge.md).[`kind`](PagEdge.md#kind) + +## Methods + +### getDotAttr() + +> **getDotAttr**(): `string` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:65 + +#### Returns + +`string` + +#### Inherited from + +[`PagEdge`](PagEdge.md).[`getDotAttr`](PagEdge.md#getdotattr) + +*** + +### getDstID() + +> **getDstID**(): `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:39 + +#### Returns + +`number` + +#### Inherited from + +[`PagEdge`](PagEdge.md).[`getDstID`](PagEdge.md#getdstid) + +*** + +### getDstNode() + +> **getDstNode**(): [`BaseNode`](BaseNode.md) + +Defined in: src/core/graph/BaseExplicitGraph.ts:47 + +#### Returns + +[`BaseNode`](BaseNode.md) + +#### Inherited from + +[`PagEdge`](PagEdge.md).[`getDstNode`](PagEdge.md#getdstnode) + +*** + +### getEndPoints() + +> **getEndPoints**(): `object` + +Defined in: src/core/graph/BaseExplicitGraph.ts:59 + +#### Returns + +`object` + +##### dst + +> **dst**: `number` + +##### src + +> **src**: `number` + +#### Inherited from + +[`PagEdge`](PagEdge.md).[`getEndPoints`](PagEdge.md#getendpoints) + +*** + +### getKind() + +> **getKind**(): `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:51 + +#### Returns + +`number` + +#### Inherited from + +[`PagEdge`](PagEdge.md).[`getKind`](PagEdge.md#getkind) + +*** + +### getSrcID() + +> **getSrcID**(): `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:35 + +#### Returns + +`number` + +#### Inherited from + +[`PagEdge`](PagEdge.md).[`getSrcID`](PagEdge.md#getsrcid) + +*** + +### getSrcNode() + +> **getSrcNode**(): [`BaseNode`](BaseNode.md) + +Defined in: src/core/graph/BaseExplicitGraph.ts:43 + +#### Returns + +[`BaseNode`](BaseNode.md) + +#### Inherited from + +[`PagEdge`](PagEdge.md).[`getSrcNode`](PagEdge.md#getsrcnode) + +*** + +### setKind() + +> **setKind**(`kind`): `void` + +Defined in: src/core/graph/BaseExplicitGraph.ts:55 + +#### Parameters + +##### kind + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`PagEdge`](PagEdge.md).[`setKind`](PagEdge.md#setkind) diff --git a/docs/api_docs/classes/Local.md b/docs/api_docs/classes/Local.md new file mode 100644 index 0000000000000000000000000000000000000000..182f71b4b939a9d5249240d203b21044ddc2e9a0 --- /dev/null +++ b/docs/api_docs/classes/Local.md @@ -0,0 +1,428 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / Local + +# Class: Local + +Defined in: src/core/base/Local.ts:31 + +## Implements + +- [`Value`](../interfaces/Value.md) +- `ArkExport` + +## Constructors + +### new Local() + +> **new Local**(`name`, `type`): [`Local`](Local.md) + +Defined in: src/core/base/Local.ts:42 + +#### Parameters + +##### name + +`string` + +##### type + +[`Type`](Type.md) = `...` + +#### Returns + +[`Local`](Local.md) + +## Methods + +### addUsedStmt() + +> **addUsedStmt**(`usedStmt`): `void` + +Defined in: src/core/base/Local.ts:142 + +#### Parameters + +##### usedStmt + +[`Stmt`](Stmt.md) + +#### Returns + +`void` + +*** + +### containsModifier() + +> **containsModifier**(`modifierType`): `boolean` + +Defined in: src/core/base/Local.ts:182 + +#### Parameters + +##### modifierType + +`ModifierType` + +#### Returns + +`boolean` + +#### Implementation of + +`ArkExport.containsModifier` + +*** + +### getConstFlag() + +> **getConstFlag**(): `boolean` + +Defined in: src/core/base/Local.ts:198 + +#### Returns + +`boolean` + +*** + +### getDeclaringStmt() + +> **getDeclaringStmt**(): `null` \| [`Stmt`](Stmt.md) + +Defined in: src/core/base/Local.ts:126 + +Returns the declaring statement, which may also be a **null**. +For example, if the code snippet in a function is `let dd = cc + 5;` where `cc` is a **number** +and `dd` is not defined before, then the declaring statemet of local `dd`: +- its **string** text is "dd = cc + 5". +- the **strings** of right operand and left operand are "cc + 5" and "dd", respectively. +- three values are used in this statement: `cc + 5` (i.e., a normal binary operation expression), `cc` (a local), and `5` (a constant), respectively. + +#### Returns + +`null` \| [`Stmt`](Stmt.md) + +The declaring statement (maybe a **null**) of the local. + +#### Example + +1. get the statement that defines the local for the first time. + +```typescript +let stmt = local.getDeclaringStmt(); +if (stmt !== null) { +... +} +``` + +*** + +### getExportType() + +> **getExportType**(): `ExportType` + +Defined in: src/core/base/Local.ts:174 + +#### Returns + +`ExportType` + +#### Implementation of + +`ArkExport.getExportType` + +*** + +### getModifiers() + +> **getModifiers**(): `number` + +Defined in: src/core/base/Local.ts:178 + +#### Returns + +`number` + +#### Implementation of + +`ArkExport.getModifiers` + +*** + +### getName() + +> **getName**(): `string` + +Defined in: src/core/base/Local.ts:80 + +Returns the name of local value. + +#### Returns + +`string` + +The name of local value. + +#### Example + +1. get the name of local value. + +```typescript +arkClass.getDefaultArkMethod()?.getBody().getLocals().forEach(local => { +const arkField = new ArkField(); +arkField.setFieldType(ArkField.DEFAULT_ARK_Field); +arkField.setDeclaringClass(defaultClass); +arkField.setType(local.getType()); +arkField.setName(local.getName()); +arkField.genSignature(); +defaultClass.addField(arkField); +}); +``` + +#### Implementation of + +`ArkExport.getName` + +*** + +### getOriginalValue() + +> **getOriginalValue**(): `null` \| [`Value`](../interfaces/Value.md) + +Defined in: src/core/base/Local.ts:100 + +#### Returns + +`null` \| [`Value`](../interfaces/Value.md) + +*** + +### getSignature() + +> **getSignature**(): [`LocalSignature`](LocalSignature.md) + +Defined in: src/core/base/Local.ts:189 + +#### Returns + +[`LocalSignature`](LocalSignature.md) + +#### Implementation of + +`ArkExport.getSignature` + +*** + +### getType() + +> **getType**(): [`Type`](Type.md) + +Defined in: src/core/base/Local.ts:92 + +Returns the type of this local. + +#### Returns + +[`Type`](Type.md) + +The type of this local. + +#### Implementation of + +[`Value`](../interfaces/Value.md).[`getType`](../interfaces/Value.md#gettype) + +*** + +### getUsedStmts() + +> **getUsedStmts**(): [`Stmt`](Stmt.md)[] + +Defined in: src/core/base/Local.ts:153 + +Returns an array of statements used by the local, i.e., the statements in which the local participate. +For example, if the code snippet is `let dd = cc + 5;` where `cc` is a local and `cc` only appears once, +then the length of **array** returned is 1 and `Stmts[0]` will be same as the example described +in the `Local.getDeclaringStmt()`. + +#### Returns + +[`Stmt`](Stmt.md)[] + +An array of statements used by the local. + +*** + +### getUses() + +> **getUses**(): [`Value`](../interfaces/Value.md)[] + +Defined in: src/core/base/Local.ts:138 + +Returns an **array** of values which are contained in this local. + +#### Returns + +[`Value`](../interfaces/Value.md)[] + +An **array** of values used by this local. + +#### Implementation of + +[`Value`](../interfaces/Value.md).[`getUses`](../interfaces/Value.md#getuses) + +*** + +### inferType() + +> **inferType**(`arkMethod`): [`Local`](Local.md) + +Defined in: src/core/base/Local.ts:51 + +#### Parameters + +##### arkMethod + +[`ArkMethod`](ArkMethod.md) + +#### Returns + +[`Local`](Local.md) + +*** + +### setConstFlag() + +> **setConstFlag**(`newConstFlag`): `void` + +Defined in: src/core/base/Local.ts:205 + +#### Parameters + +##### newConstFlag + +`boolean` + +#### Returns + +`void` + +*** + +### setDeclaringStmt() + +> **setDeclaringStmt**(`declaringStmt`): `void` + +Defined in: src/core/base/Local.ts:130 + +#### Parameters + +##### declaringStmt + +[`Stmt`](Stmt.md) + +#### Returns + +`void` + +*** + +### setName() + +> **setName**(`name`): `void` + +Defined in: src/core/base/Local.ts:84 + +#### Parameters + +##### name + +`string` + +#### Returns + +`void` + +*** + +### setOriginalValue() + +> **setOriginalValue**(`originalValue`): `void` + +Defined in: src/core/base/Local.ts:104 + +#### Parameters + +##### originalValue + +[`Value`](../interfaces/Value.md) + +#### Returns + +`void` + +*** + +### setSignature() + +> **setSignature**(`signature`): `void` + +Defined in: src/core/base/Local.ts:194 + +#### Parameters + +##### signature + +[`LocalSignature`](LocalSignature.md) + +#### Returns + +`void` + +*** + +### setType() + +> **setType**(`newType`): `void` + +Defined in: src/core/base/Local.ts:96 + +#### Parameters + +##### newType + +[`Type`](Type.md) + +#### Returns + +`void` + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/base/Local.ts:170 + +Get a string of local name in Local + +#### Returns + +`string` + +The string of local name. + +#### Example + +1. get a name string. + +```typescript +for (const value of stmt.getUses()) { +const name = value.toString(); +... +} +``` diff --git a/docs/api_docs/classes/LocalSignature.md b/docs/api_docs/classes/LocalSignature.md new file mode 100644 index 0000000000000000000000000000000000000000..fbb2e4046284c389a880a74e31313d96348a3d19 --- /dev/null +++ b/docs/api_docs/classes/LocalSignature.md @@ -0,0 +1,67 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / LocalSignature + +# Class: LocalSignature + +Defined in: src/core/model/ArkSignature.ts:362 + +## Constructors + +### new LocalSignature() + +> **new LocalSignature**(`name`, `declaringMethodSignature`): [`LocalSignature`](LocalSignature.md) + +Defined in: src/core/model/ArkSignature.ts:366 + +#### Parameters + +##### name + +`string` + +##### declaringMethodSignature + +[`MethodSignature`](MethodSignature.md) + +#### Returns + +[`LocalSignature`](LocalSignature.md) + +## Methods + +### getDeclaringMethodSignature() + +> **getDeclaringMethodSignature**(): [`MethodSignature`](MethodSignature.md) + +Defined in: src/core/model/ArkSignature.ts:375 + +#### Returns + +[`MethodSignature`](MethodSignature.md) + +*** + +### getName() + +> **getName**(): `string` + +Defined in: src/core/model/ArkSignature.ts:371 + +#### Returns + +`string` + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/model/ArkSignature.ts:379 + +#### Returns + +`string` diff --git a/docs/api_docs/classes/MethodSignature.md b/docs/api_docs/classes/MethodSignature.md new file mode 100644 index 0000000000000000000000000000000000000000..bdd4aa8da0c659e3081b8622ddb4d262a0556efa --- /dev/null +++ b/docs/api_docs/classes/MethodSignature.md @@ -0,0 +1,144 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / MethodSignature + +# Class: MethodSignature + +Defined in: src/core/model/ArkSignature.ts:302 + +## Constructors + +### new MethodSignature() + +> **new MethodSignature**(`declaringClassSignature`, `methodSubSignature`): [`MethodSignature`](MethodSignature.md) + +Defined in: src/core/model/ArkSignature.ts:306 + +#### Parameters + +##### declaringClassSignature + +[`ClassSignature`](ClassSignature.md) + +##### methodSubSignature + +[`MethodSubSignature`](MethodSubSignature.md) + +#### Returns + +[`MethodSignature`](MethodSignature.md) + +## Methods + +### getDeclaringClassSignature() + +> **getDeclaringClassSignature**(): [`ClassSignature`](ClassSignature.md) + +Defined in: src/core/model/ArkSignature.ts:327 + +Return the declaring class signature. +A [ClassSignature](ClassSignature.md) includes: +- File Signature: including the **string** names of the project and file, respectively. The default value of project's name is "%unk" and the default value of file's name is "%unk". +- Namespace Signature | **null**: it may be a namespace signature or **null**. A namespace signature can indicate its **string** name of namespace and its file signature. +- Class Name: the **string** name of this class. + +#### Returns + +[`ClassSignature`](ClassSignature.md) + +The declaring class signature. + +#### Example + +1. get class signature from ArkMethod. + +```typescript +let methodSignature = expr.getMethodSignature(); +let name = methodSignature.getDeclaringClassSignature().getClassName(); +``` + +*** + +### getMethodSubSignature() + +> **getMethodSubSignature**(): [`MethodSubSignature`](MethodSubSignature.md) + +Defined in: src/core/model/ArkSignature.ts:337 + +Returns the sub-signature of this method signature. +The sub-signature is part of the method signature, which is used to +identify the name of the method, its parameters and the return value type. + +#### Returns + +[`MethodSubSignature`](MethodSubSignature.md) + +The sub-signature of this method signature. + +*** + +### getParamLength() + +> **getParamLength**(): `number` + +Defined in: src/core/model/ArkSignature.ts:357 + +#### Returns + +`number` + +*** + +### getType() + +> **getType**(): [`Type`](Type.md) + +Defined in: src/core/model/ArkSignature.ts:341 + +#### Returns + +[`Type`](Type.md) + +*** + +### isMatch() + +> **isMatch**(`signature`): `boolean` + +Defined in: src/core/model/ArkSignature.ts:353 + +#### Parameters + +##### signature + +[`MethodSignature`](MethodSignature.md) + +#### Returns + +`boolean` + +*** + +### toMapKey() + +> **toMapKey**(): `string` + +Defined in: src/core/model/ArkSignature.ts:349 + +#### Returns + +`string` + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/model/ArkSignature.ts:345 + +#### Returns + +`string` diff --git a/docs/api_docs/classes/MethodSignatureManager.md b/docs/api_docs/classes/MethodSignatureManager.md new file mode 100644 index 0000000000000000000000000000000000000000..3c6bd98c356e43f327bd61dead904a546623dd52 --- /dev/null +++ b/docs/api_docs/classes/MethodSignatureManager.md @@ -0,0 +1,187 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / MethodSignatureManager + +# Class: MethodSignatureManager + +Defined in: src/utils/callGraphUtils.ts:25 + +## Constructors + +### new MethodSignatureManager() + +> **new MethodSignatureManager**(): [`MethodSignatureManager`](MethodSignatureManager.md) + +#### Returns + +[`MethodSignatureManager`](MethodSignatureManager.md) + +## Accessors + +### processedList + +#### Get Signature + +> **get** **processedList**(): [`MethodSignature`](MethodSignature.md)[] + +Defined in: src/utils/callGraphUtils.ts:37 + +##### Returns + +[`MethodSignature`](MethodSignature.md)[] + +#### Set Signature + +> **set** **processedList**(`list`): `void` + +Defined in: src/utils/callGraphUtils.ts:41 + +##### Parameters + +###### list + +[`MethodSignature`](MethodSignature.md)[] + +##### Returns + +`void` + +*** + +### workList + +#### Get Signature + +> **get** **workList**(): [`MethodSignature`](MethodSignature.md)[] + +Defined in: src/utils/callGraphUtils.ts:29 + +##### Returns + +[`MethodSignature`](MethodSignature.md)[] + +#### Set Signature + +> **set** **workList**(`list`): `void` + +Defined in: src/utils/callGraphUtils.ts:33 + +##### Parameters + +###### list + +[`MethodSignature`](MethodSignature.md)[] + +##### Returns + +`void` + +## Methods + +### addToProcessedList() + +> **addToProcessedList**(`signature`): `void` + +Defined in: src/utils/callGraphUtils.ts:64 + +#### Parameters + +##### signature + +[`MethodSignature`](MethodSignature.md) + +#### Returns + +`void` + +*** + +### addToWorkList() + +> **addToWorkList**(`signature`): `void` + +Defined in: src/utils/callGraphUtils.ts:54 + +#### Parameters + +##### signature + +[`MethodSignature`](MethodSignature.md) + +#### Returns + +`void` + +*** + +### findInProcessedList() + +> **findInProcessedList**(`signature`): `boolean` + +Defined in: src/utils/callGraphUtils.ts:49 + +#### Parameters + +##### signature + +[`MethodSignature`](MethodSignature.md) + +#### Returns + +`boolean` + +*** + +### findInWorkList() + +> **findInWorkList**(`signature`): `undefined` \| [`MethodSignature`](MethodSignature.md) + +Defined in: src/utils/callGraphUtils.ts:45 + +#### Parameters + +##### signature + +[`MethodSignature`](MethodSignature.md) + +#### Returns + +`undefined` \| [`MethodSignature`](MethodSignature.md) + +*** + +### removeFromProcessedList() + +> **removeFromProcessedList**(`signature`): `void` + +Defined in: src/utils/callGraphUtils.ts:78 + +#### Parameters + +##### signature + +[`MethodSignature`](MethodSignature.md) + +#### Returns + +`void` + +*** + +### removeFromWorkList() + +> **removeFromWorkList**(`signature`): `void` + +Defined in: src/utils/callGraphUtils.ts:74 + +#### Parameters + +##### signature + +[`MethodSignature`](MethodSignature.md) + +#### Returns + +`void` diff --git a/docs/api_docs/classes/MethodSubSignature.md b/docs/api_docs/classes/MethodSubSignature.md new file mode 100644 index 0000000000000000000000000000000000000000..a56d873f7b10a84b6fe3756c7f6ff3d2ac821f88 --- /dev/null +++ b/docs/api_docs/classes/MethodSubSignature.md @@ -0,0 +1,129 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / MethodSubSignature + +# Class: MethodSubSignature + +Defined in: src/core/model/ArkSignature.ts:244 + +## Constructors + +### new MethodSubSignature() + +> **new MethodSubSignature**(`methodName`, `parameters`, `returnType`, `staticFlag`): [`MethodSubSignature`](MethodSubSignature.md) + +Defined in: src/core/model/ArkSignature.ts:250 + +#### Parameters + +##### methodName + +`string` + +##### parameters + +`MethodParameter`[] + +##### returnType + +[`Type`](Type.md) + +##### staticFlag + +`boolean` = `false` + +#### Returns + +[`MethodSubSignature`](MethodSubSignature.md) + +## Methods + +### getMethodName() + +> **getMethodName**(): `string` + +Defined in: src/core/model/ArkSignature.ts:257 + +#### Returns + +`string` + +*** + +### getParameters() + +> **getParameters**(): `MethodParameter`[] + +Defined in: src/core/model/ArkSignature.ts:261 + +#### Returns + +`MethodParameter`[] + +*** + +### getParameterTypes() + +> **getParameterTypes**(): [`Type`](Type.md)[] + +Defined in: src/core/model/ArkSignature.ts:265 + +#### Returns + +[`Type`](Type.md)[] + +*** + +### getReturnType() + +> **getReturnType**(): [`Type`](Type.md) + +Defined in: src/core/model/ArkSignature.ts:273 + +#### Returns + +[`Type`](Type.md) + +*** + +### isStatic() + +> **isStatic**(): `boolean` + +Defined in: src/core/model/ArkSignature.ts:281 + +#### Returns + +`boolean` + +*** + +### setReturnType() + +> **setReturnType**(`returnType`): `void` + +Defined in: src/core/model/ArkSignature.ts:277 + +#### Parameters + +##### returnType + +[`Type`](Type.md) + +#### Returns + +`void` + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/model/ArkSignature.ts:285 + +#### Returns + +`string` diff --git a/docs/api_docs/classes/ModelUtils.md b/docs/api_docs/classes/ModelUtils.md new file mode 100644 index 0000000000000000000000000000000000000000..56a6ae7d0806008bb2b19ee9c1f660b74cc572a7 --- /dev/null +++ b/docs/api_docs/classes/ModelUtils.md @@ -0,0 +1,679 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / ModelUtils + +# Class: ModelUtils + +Defined in: src/core/common/ModelUtils.ts:44 + +## Constructors + +### new ModelUtils() + +> **new ModelUtils**(): [`ModelUtils`](ModelUtils.md) + +#### Returns + +[`ModelUtils`](ModelUtils.md) + +## Properties + +### implicitArkUIBuilderMethods + +> `static` **implicitArkUIBuilderMethods**: `Set`\<[`ArkMethod`](ArkMethod.md)\> + +Defined in: src/core/common/ModelUtils.ts:45 + +## Methods + +### findArkModel() + +> `static` **findArkModel**(`baseName`, `arkClass`): `null` \| `ArkExport` \| [`ArkField`](ArkField.md) + +Defined in: src/core/common/ModelUtils.ts:403 + +#### Parameters + +##### baseName + +`string` + +##### arkClass + +[`ArkClass`](ArkClass.md) + +#### Returns + +`null` \| `ArkExport` \| [`ArkField`](ArkField.md) + +*** + +### findArkModelByRefName() + +> `static` **findArkModelByRefName**(`refName`, `arkClass`): `null` \| `ArkExport` \| [`ArkField`](ArkField.md) + +Defined in: src/core/common/ModelUtils.ts:422 + +#### Parameters + +##### refName + +`string` + +##### arkClass + +[`ArkClass`](ArkClass.md) + +#### Returns + +`null` \| `ArkExport` \| [`ArkField`](ArkField.md) + +*** + +### findArkModelBySignature() + +> `static` **findArkModelBySignature**(`signature`, `scene`): `null` \| `ArkExport` \| [`ArkField`](ArkField.md) + +Defined in: src/core/common/ModelUtils.ts:450 + +#### Parameters + +##### signature + +[`Signature`](../type-aliases/Signature.md) + +##### scene + +[`Scene`](Scene.md) + +#### Returns + +`null` \| `ArkExport` \| [`ArkField`](ArkField.md) + +*** + +### findDeclaredLocal() + +> `static` **findDeclaredLocal**(`local`, `arkMethod`, `times`): `null` \| [`Local`](Local.md) + +Defined in: src/core/common/ModelUtils.ts:366 + +#### Parameters + +##### local + +[`Local`](Local.md) + +##### arkMethod + +[`ArkMethod`](ArkMethod.md) + +##### times + +`number` = `0` + +#### Returns + +`null` \| [`Local`](Local.md) + +*** + +### findPropertyInClass() + +> `static` **findPropertyInClass**(`name`, `arkClass`): `null` \| `ArkExport` \| [`ArkField`](ArkField.md) + +Defined in: src/core/common/ModelUtils.ts:347 + +#### Parameters + +##### name + +`string` + +##### arkClass + +[`ArkClass`](ArkClass.md) + +#### Returns + +`null` \| `ArkExport` \| [`ArkField`](ArkField.md) + +*** + +### findPropertyInNamespace() + +> `static` **findPropertyInNamespace**(`name`, `namespace`): `undefined` \| `ArkExport` + +Defined in: src/core/common/ModelUtils.ts:338 + +#### Parameters + +##### name + +`string` + +##### namespace + +[`ArkNamespace`](ArkNamespace.md) + +#### Returns + +`undefined` \| `ArkExport` + +*** + +### getAllClassesInFile() + +> `static` **getAllClassesInFile**(`arkFile`): [`ArkClass`](ArkClass.md)[] + +Defined in: src/core/common/ModelUtils.ts:264 + +#### Parameters + +##### arkFile + +[`ArkFile`](ArkFile.md) + +#### Returns + +[`ArkClass`](ArkClass.md)[] + +*** + +### getAllMethodsInFile() + +> `static` **getAllMethodsInFile**(`arkFile`): [`ArkMethod`](ArkMethod.md)[] + +Defined in: src/core/common/ModelUtils.ts:272 + +#### Parameters + +##### arkFile + +[`ArkFile`](ArkFile.md) + +#### Returns + +[`ArkMethod`](ArkMethod.md)[] + +*** + +### getAllNamespacesInFile() + +> `static` **getAllNamespacesInFile**(`arkFile`): [`ArkNamespace`](ArkNamespace.md)[] + +Defined in: src/core/common/ModelUtils.ts:248 + +#### Parameters + +##### arkFile + +[`ArkFile`](ArkFile.md) + +#### Returns + +[`ArkNamespace`](ArkNamespace.md)[] + +*** + +### getAllNamespacesInNamespace() + +> `static` **getAllNamespacesInNamespace**(`arkNamespace`, `allNamespaces`): `void` + +Defined in: src/core/common/ModelUtils.ts:257 + +#### Parameters + +##### arkNamespace + +[`ArkNamespace`](ArkNamespace.md) + +##### allNamespaces + +[`ArkNamespace`](ArkNamespace.md)[] + +#### Returns + +`void` + +*** + +### getArkClassInBuild() + +> `static` **getArkClassInBuild**(`scene`, `classType`): `null` \| [`ArkClass`](ArkClass.md) + +Defined in: src/core/common/ModelUtils.ts:297 + +#### Parameters + +##### scene + +[`Scene`](Scene.md) + +##### classType + +[`ClassType`](ClassType.md) + +#### Returns + +`null` \| [`ArkClass`](ArkClass.md) + +*** + +### getArkExportInImportInfoWithName() + +> `static` **getArkExportInImportInfoWithName**(`name`, `arkFile`): `null` \| `ArkExport` + +Defined in: src/core/common/ModelUtils.ts:129 + +search type within the given file import infos + +#### Parameters + +##### name + +`string` + +##### arkFile + +[`ArkFile`](ArkFile.md) + +#### Returns + +`null` \| `ArkExport` + +*** + +### getClass() + +> `static` **getClass**(`method`, `signature`): `null` \| [`ArkClass`](ArkClass.md) + +Defined in: src/core/common/ModelUtils.ts:311 + +#### Parameters + +##### method + +[`ArkMethod`](ArkMethod.md) + +##### signature + +[`ClassSignature`](ClassSignature.md) + +#### Returns + +`null` \| [`ArkClass`](ArkClass.md) + +*** + +### getClassInFileWithName() + +> `static` **getClassInFileWithName**(`className`, `arkFile`): `null` \| [`ArkClass`](ArkClass.md) + +Defined in: src/core/common/ModelUtils.ts:112 + +search class within the given file + +#### Parameters + +##### className + +`string` + +##### arkFile + +[`ArkFile`](ArkFile.md) + +#### Returns + +`null` \| [`ArkClass`](ArkClass.md) + +*** + +### getClassInImportInfoWithName() + +> `static` **getClassInImportInfoWithName**(`className`, `arkFile`): `null` \| [`ArkClass`](ArkClass.md) + +Defined in: src/core/common/ModelUtils.ts:120 + +#### Parameters + +##### className + +`string` + +##### arkFile + +[`ArkFile`](ArkFile.md) + +#### Returns + +`null` \| [`ArkClass`](ArkClass.md) + +*** + +### getClassWithName() + +> `static` **getClassWithName**(`className`, `thisClass`): `null` \| [`ArkClass`](ArkClass.md) + +Defined in: src/core/common/ModelUtils.ts:100 + +search class within the file that contain the given method + +#### Parameters + +##### className + +`string` + +##### thisClass + +[`ArkClass`](ArkClass.md) + +#### Returns + +`null` \| [`ArkClass`](ArkClass.md) + +*** + +### getClassWithNameFromClass() + +> `static` **getClassWithNameFromClass**(`className`, `startFrom`): `null` \| [`ArkClass`](ArkClass.md) + +Defined in: src/core/common/ModelUtils.ts:73 + +#### Parameters + +##### className + +`string` + +##### startFrom + +[`ArkClass`](ArkClass.md) + +#### Returns + +`null` \| [`ArkClass`](ArkClass.md) + +*** + +### getClassWithNameInNamespaceRecursively() + +> `static` **getClassWithNameInNamespaceRecursively**(`className`, `ns`): `null` \| [`ArkClass`](ArkClass.md) + +Defined in: src/core/common/ModelUtils.ts:56 + +#### Parameters + +##### className + +`string` + +##### ns + +[`ArkNamespace`](ArkNamespace.md) + +#### Returns + +`null` \| [`ArkClass`](ArkClass.md) + +*** + +### getDefaultClass() + +> `static` **getDefaultClass**(`arkClass`): `null` \| [`ArkClass`](ArkClass.md) + +Defined in: src/core/common/ModelUtils.ts:307 + +#### Parameters + +##### arkClass + +[`ArkClass`](ArkClass.md) + +#### Returns + +`null` \| [`ArkClass`](ArkClass.md) + +*** + +### getLocalInImportInfoWithName() + +> `static` **getLocalInImportInfoWithName**(`localName`, `arkFile`): `null` \| [`Local`](Local.md) + +Defined in: src/core/common/ModelUtils.ts:239 + +#### Parameters + +##### localName + +`string` + +##### arkFile + +[`ArkFile`](ArkFile.md) + +#### Returns + +`null` \| [`Local`](Local.md) + +*** + +### getMethodSignatureFromArkClass() + +> `static` **getMethodSignatureFromArkClass**(`arkClass`, `methodName`): `null` \| [`MethodSignature`](MethodSignature.md) + +Defined in: src/core/common/ModelUtils.ts:47 + +#### Parameters + +##### arkClass + +[`ArkClass`](ArkClass.md) + +##### methodName + +`string` + +#### Returns + +`null` \| [`MethodSignature`](MethodSignature.md) + +*** + +### getMethodWithName() + +> `static` **getMethodWithName**(`methodName`, `startFrom`): `null` \| [`ArkMethod`](ArkMethod.md) + +Defined in: src/core/common/ModelUtils.ts:134 + +search method within the file that contain the given method + +#### Parameters + +##### methodName + +`string` + +##### startFrom + +[`ArkMethod`](ArkMethod.md) + +#### Returns + +`null` \| [`ArkMethod`](ArkMethod.md) + +*** + +### getNamespaceInFileWithName() + +> `static` **getNamespaceInFileWithName**(`namespaceName`, `arkFile`): `null` \| [`ArkNamespace`](ArkNamespace.md) + +Defined in: src/core/common/ModelUtils.ts:188 + +#### Parameters + +##### namespaceName + +`string` + +##### arkFile + +[`ArkFile`](ArkFile.md) + +#### Returns + +`null` \| [`ArkNamespace`](ArkNamespace.md) + +*** + +### getNamespaceInImportInfoWithName() + +> `static` **getNamespaceInImportInfoWithName**(`namespaceName`, `arkFile`): `null` \| [`ArkNamespace`](ArkNamespace.md) + +Defined in: src/core/common/ModelUtils.ts:197 + +#### Parameters + +##### namespaceName + +`string` + +##### arkFile + +[`ArkFile`](ArkFile.md) + +#### Returns + +`null` \| [`ArkNamespace`](ArkNamespace.md) + +*** + +### getNamespaceWithName() + +> `static` **getNamespaceWithName**(`namespaceName`, `thisClass`): `null` \| [`ArkNamespace`](ArkNamespace.md) + +Defined in: src/core/common/ModelUtils.ts:175 + +#### Parameters + +##### namespaceName + +`string` + +##### thisClass + +[`ArkClass`](ArkClass.md) + +#### Returns + +`null` \| [`ArkNamespace`](ArkNamespace.md) + +*** + +### getNamespaceWithNameFromClass() + +> `static` **getNamespaceWithNameFromClass**(`namespaceName`, `startFrom`): `null` \| [`ArkNamespace`](ArkNamespace.md) + +Defined in: src/core/common/ModelUtils.ts:161 + +#### Parameters + +##### namespaceName + +`string` + +##### startFrom + +[`ArkClass`](ArkClass.md) + +#### Returns + +`null` \| [`ArkNamespace`](ArkNamespace.md) + +*** + +### getStaticMethodInFileWithName() + +> `static` **getStaticMethodInFileWithName**(`methodName`, `arkFile`): `null` \| [`ArkMethod`](ArkMethod.md) + +Defined in: src/core/common/ModelUtils.ts:220 + +#### Parameters + +##### methodName + +`string` + +##### arkFile + +[`ArkFile`](ArkFile.md) + +#### Returns + +`null` \| [`ArkMethod`](ArkMethod.md) + +*** + +### getStaticMethodInImportInfoWithName() + +> `static` **getStaticMethodInImportInfoWithName**(`methodName`, `arkFile`): `null` \| [`ArkMethod`](ArkMethod.md) + +Defined in: src/core/common/ModelUtils.ts:231 + +#### Parameters + +##### methodName + +`string` + +##### arkFile + +[`ArkFile`](ArkFile.md) + +#### Returns + +`null` \| [`ArkMethod`](ArkMethod.md) + +*** + +### getStaticMethodWithName() + +> `static` **getStaticMethodWithName**(`methodName`, `thisClass`): `null` \| [`ArkMethod`](ArkMethod.md) + +Defined in: src/core/common/ModelUtils.ts:205 + +#### Parameters + +##### methodName + +`string` + +##### thisClass + +[`ArkClass`](ArkClass.md) + +#### Returns + +`null` \| [`ArkMethod`](ArkMethod.md) + +*** + +### isArkUIBuilderMethod() + +> `static` **isArkUIBuilderMethod**(`arkMethod`): `boolean` + +Defined in: src/core/common/ModelUtils.ts:280 + +#### Parameters + +##### arkMethod + +[`ArkMethod`](ArkMethod.md) + +#### Returns + +`boolean` diff --git a/docs/api_docs/classes/ModulePath.md b/docs/api_docs/classes/ModulePath.md new file mode 100644 index 0000000000000000000000000000000000000000..a9279d5e1929bd5b3e34514948ee1fffa3f4e28b --- /dev/null +++ b/docs/api_docs/classes/ModulePath.md @@ -0,0 +1,47 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / ModulePath + +# Class: ModulePath + +Defined in: src/utils/FileUtils.ts:82 + +## Constructors + +### new ModulePath() + +> **new ModulePath**(`path`, `main`): [`ModulePath`](ModulePath.md) + +Defined in: src/utils/FileUtils.ts:86 + +#### Parameters + +##### path + +`string` + +##### main + +`string` + +#### Returns + +[`ModulePath`](ModulePath.md) + +## Properties + +### main + +> **main**: `string` + +Defined in: src/utils/FileUtils.ts:84 + +*** + +### path + +> **path**: `string` + +Defined in: src/utils/FileUtils.ts:83 diff --git a/docs/api_docs/classes/NamespaceSignature.md b/docs/api_docs/classes/NamespaceSignature.md new file mode 100644 index 0000000000000000000000000000000000000000..90a05439bb71c0cc8fcbd49cde42c81536917f68 --- /dev/null +++ b/docs/api_docs/classes/NamespaceSignature.md @@ -0,0 +1,103 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / NamespaceSignature + +# Class: NamespaceSignature + +Defined in: src/core/model/ArkSignature.ts:68 + +## Constructors + +### new NamespaceSignature() + +> **new NamespaceSignature**(`namespaceName`, `declaringFileSignature`, `declaringNamespaceSignature`): [`NamespaceSignature`](NamespaceSignature.md) + +Defined in: src/core/model/ArkSignature.ts:76 + +#### Parameters + +##### namespaceName + +`string` + +##### declaringFileSignature + +[`FileSignature`](FileSignature.md) + +##### declaringNamespaceSignature + +`null` | [`NamespaceSignature`](NamespaceSignature.md) + +#### Returns + +[`NamespaceSignature`](NamespaceSignature.md) + +## Properties + +### DEFAULT + +> `readonly` `static` **DEFAULT**: [`NamespaceSignature`](NamespaceSignature.md) + +Defined in: src/core/model/ArkSignature.ts:73 + +## Methods + +### getDeclaringFileSignature() + +> **getDeclaringFileSignature**(): [`FileSignature`](FileSignature.md) + +Defined in: src/core/model/ArkSignature.ts:87 + +#### Returns + +[`FileSignature`](FileSignature.md) + +*** + +### getDeclaringNamespaceSignature() + +> **getDeclaringNamespaceSignature**(): `null` \| [`NamespaceSignature`](NamespaceSignature.md) + +Defined in: src/core/model/ArkSignature.ts:91 + +#### Returns + +`null` \| [`NamespaceSignature`](NamespaceSignature.md) + +*** + +### getNamespaceName() + +> **getNamespaceName**(): `string` + +Defined in: src/core/model/ArkSignature.ts:83 + +#### Returns + +`string` + +*** + +### toMapKey() + +> **toMapKey**(): `string` + +Defined in: src/core/model/ArkSignature.ts:103 + +#### Returns + +`string` + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/model/ArkSignature.ts:95 + +#### Returns + +`string` diff --git a/docs/api_docs/classes/NeverType.md b/docs/api_docs/classes/NeverType.md new file mode 100644 index 0000000000000000000000000000000000000000..eb1c177739247c6f81cf500904c73e0d11b93c4a --- /dev/null +++ b/docs/api_docs/classes/NeverType.md @@ -0,0 +1,57 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / NeverType + +# Class: NeverType + +Defined in: src/core/base/Type.ts:289 + +## Extends + +- [`Type`](Type.md) + +## Methods + +### getTypeString() + +> **getTypeString**(): `string` + +Defined in: src/core/base/Type.ts:300 + +#### Returns + +`string` + +#### Overrides + +[`Type`](Type.md).[`getTypeString`](Type.md#gettypestring) + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/base/Type.ts:36 + +#### Returns + +`string` + +#### Inherited from + +[`Type`](Type.md).[`toString`](Type.md#tostring) + +*** + +### getInstance() + +> `static` **getInstance**(): [`NeverType`](NeverType.md) + +Defined in: src/core/base/Type.ts:292 + +#### Returns + +[`NeverType`](NeverType.md) diff --git a/docs/api_docs/classes/NullType.md b/docs/api_docs/classes/NullType.md new file mode 100644 index 0000000000000000000000000000000000000000..e3a29775e4aa0fdc259aeb37e7b14796f0970067 --- /dev/null +++ b/docs/api_docs/classes/NullType.md @@ -0,0 +1,75 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / NullType + +# Class: NullType + +Defined in: src/core/base/Type.ts:175 + +null type + +## Extends + +- [`PrimitiveType`](PrimitiveType.md) + +## Methods + +### getName() + +> **getName**(): `string` + +Defined in: src/core/base/Type.ts:126 + +#### Returns + +`string` + +#### Inherited from + +[`PrimitiveType`](PrimitiveType.md).[`getName`](PrimitiveType.md#getname) + +*** + +### getTypeString() + +> **getTypeString**(): `string` + +Defined in: src/core/base/Type.ts:130 + +#### Returns + +`string` + +#### Inherited from + +[`PrimitiveType`](PrimitiveType.md).[`getTypeString`](PrimitiveType.md#gettypestring) + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/base/Type.ts:36 + +#### Returns + +`string` + +#### Inherited from + +[`PrimitiveType`](PrimitiveType.md).[`toString`](PrimitiveType.md#tostring) + +*** + +### getInstance() + +> `static` **getInstance**(): [`NullType`](NullType.md) + +Defined in: src/core/base/Type.ts:178 + +#### Returns + +[`NullType`](NullType.md) diff --git a/docs/api_docs/classes/NumberType.md b/docs/api_docs/classes/NumberType.md new file mode 100644 index 0000000000000000000000000000000000000000..c143f188b0bd1863a93cdc5f4d18e703cd358874 --- /dev/null +++ b/docs/api_docs/classes/NumberType.md @@ -0,0 +1,75 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / NumberType + +# Class: NumberType + +Defined in: src/core/base/Type.ts:147 + +primitive type + +## Extends + +- [`PrimitiveType`](PrimitiveType.md) + +## Methods + +### getName() + +> **getName**(): `string` + +Defined in: src/core/base/Type.ts:126 + +#### Returns + +`string` + +#### Inherited from + +[`PrimitiveType`](PrimitiveType.md).[`getName`](PrimitiveType.md#getname) + +*** + +### getTypeString() + +> **getTypeString**(): `string` + +Defined in: src/core/base/Type.ts:130 + +#### Returns + +`string` + +#### Inherited from + +[`PrimitiveType`](PrimitiveType.md).[`getTypeString`](PrimitiveType.md#gettypestring) + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/base/Type.ts:36 + +#### Returns + +`string` + +#### Inherited from + +[`PrimitiveType`](PrimitiveType.md).[`toString`](PrimitiveType.md#tostring) + +*** + +### getInstance() + +> `static` **getInstance**(): [`NumberType`](NumberType.md) + +Defined in: src/core/base/Type.ts:154 + +#### Returns + +[`NumberType`](NumberType.md) diff --git a/docs/api_docs/classes/PAGStat.md b/docs/api_docs/classes/PAGStat.md new file mode 100644 index 0000000000000000000000000000000000000000..8c5d938f139c0423c7444f19a164274a6d0ca9bb --- /dev/null +++ b/docs/api_docs/classes/PAGStat.md @@ -0,0 +1,79 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / PAGStat + +# Class: PAGStat + +Defined in: src/callgraph/common/Statistics.ts:168 + +## Implements + +- `StatTraits` + +## Constructors + +### new PAGStat() + +> **new PAGStat**(): [`PAGStat`](PAGStat.md) + +#### Returns + +[`PAGStat`](PAGStat.md) + +## Properties + +### numDynamicCall + +> **numDynamicCall**: `number` = `0` + +Defined in: src/callgraph/common/Statistics.ts:169 + +*** + +### numTotalFunction + +> **numTotalFunction**: `number` = `0` + +Defined in: src/callgraph/common/Statistics.ts:170 + +*** + +### numTotalNode + +> **numTotalNode**: `number` = `0` + +Defined in: src/callgraph/common/Statistics.ts:171 + +## Methods + +### getStat() + +> **getStat**(): `string` + +Defined in: src/callgraph/common/Statistics.ts:173 + +#### Returns + +`string` + +#### Implementation of + +`StatTraits.getStat` + +*** + +### printStat() + +> **printStat**(): `void` + +Defined in: src/callgraph/common/Statistics.ts:182 + +#### Returns + +`void` + +#### Implementation of + +`StatTraits.printStat` diff --git a/docs/api_docs/classes/PTAStat.md b/docs/api_docs/classes/PTAStat.md new file mode 100644 index 0000000000000000000000000000000000000000..afe2fea01cd3aec165552f85522764242fbbfe03 --- /dev/null +++ b/docs/api_docs/classes/PTAStat.md @@ -0,0 +1,291 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / PTAStat + +# Class: PTAStat + +Defined in: src/callgraph/common/Statistics.ts:34 + +## Implements + +- `StatTraits` + +## Constructors + +### new PTAStat() + +> **new PTAStat**(`pta`): [`PTAStat`](PTAStat.md) + +Defined in: src/callgraph/common/Statistics.ts:69 + +#### Parameters + +##### pta + +[`PointerAnalysis`](PointerAnalysis.md) + +#### Returns + +[`PTAStat`](PTAStat.md) + +## Properties + +### endMemUsage + +> **endMemUsage**: `any` + +Defined in: src/callgraph/common/Statistics.ts:65 + +*** + +### endTime + +> **endTime**: `number` = `0` + +Defined in: src/callgraph/common/Statistics.ts:62 + +*** + +### heapUsed + +> **heapUsed**: `number` = `0` + +Defined in: src/callgraph/common/Statistics.ts:67 + +*** + +### iterTimes + +> **iterTimes**: `number` = `0` + +Defined in: src/callgraph/common/Statistics.ts:58 + +*** + +### numInferedDiffTypeValue + +> **numInferedDiffTypeValue**: `number` = `0` + +Defined in: src/callgraph/common/Statistics.ts:51 + +*** + +### numInferedUnknownValue + +> **numInferedUnknownValue**: `number` = `0` + +Defined in: src/callgraph/common/Statistics.ts:49 + +*** + +### numNotInferedUnknownValue + +> **numNotInferedUnknownValue**: `number` = `0` + +Defined in: src/callgraph/common/Statistics.ts:55 + +*** + +### numProcessedAddr + +> **numProcessedAddr**: `number` = `0` + +Defined in: src/callgraph/common/Statistics.ts:36 + +*** + +### numProcessedCopy + +> **numProcessedCopy**: `number` = `0` + +Defined in: src/callgraph/common/Statistics.ts:37 + +*** + +### numProcessedLoad + +> **numProcessedLoad**: `number` = `0` + +Defined in: src/callgraph/common/Statistics.ts:38 + +*** + +### numProcessedThis + +> **numProcessedThis**: `number` = `0` + +Defined in: src/callgraph/common/Statistics.ts:40 + +*** + +### numProcessedWrite + +> **numProcessedWrite**: `number` = `0` + +Defined in: src/callgraph/common/Statistics.ts:39 + +*** + +### numRealLoad + +> **numRealLoad**: `number` = `0` + +Defined in: src/callgraph/common/Statistics.ts:42 + +*** + +### numRealWrite + +> **numRealWrite**: `number` = `0` + +Defined in: src/callgraph/common/Statistics.ts:41 + +*** + +### numTotalHandledValue + +> **numTotalHandledValue**: `number` = `0` + +Defined in: src/callgraph/common/Statistics.ts:46 + +*** + +### numTotalValuesInHandedFun + +> **numTotalValuesInHandedFun**: `number` = `0` + +Defined in: src/callgraph/common/Statistics.ts:45 + +*** + +### numUnhandledFun + +> **numUnhandledFun**: `number` = `0` + +Defined in: src/callgraph/common/Statistics.ts:44 + +*** + +### numUnhandledFunc + +> **numUnhandledFunc**: `number` = `0` + +Defined in: src/callgraph/common/Statistics.ts:56 + +*** + +### pta + +> **pta**: [`PointerAnalysis`](PointerAnalysis.md) + +Defined in: src/callgraph/common/Statistics.ts:35 + +*** + +### rssUsed + +> **rssUsed**: `number` = `0` + +Defined in: src/callgraph/common/Statistics.ts:66 + +*** + +### startMemUsage + +> **startMemUsage**: `any` + +Defined in: src/callgraph/common/Statistics.ts:64 + +*** + +### startTime + +> **startTime**: `number` = `0` + +Defined in: src/callgraph/common/Statistics.ts:61 + +*** + +### TotalTime + +> **TotalTime**: `number` = `0` + +Defined in: src/callgraph/common/Statistics.ts:59 + +*** + +### totalValuesInVisitedFunc + +> **totalValuesInVisitedFunc**: `number` = `0` + +Defined in: src/callgraph/common/Statistics.ts:53 + +## Methods + +### endStat() + +> **endStat**(): `void` + +Defined in: src/callgraph/common/Statistics.ts:78 + +#### Returns + +`void` + +*** + +### getNow() + +> **getNow**(): `number` + +Defined in: src/callgraph/common/Statistics.ts:88 + +#### Returns + +`number` + +*** + +### getStat() + +> **getStat**(): `string` + +Defined in: src/callgraph/common/Statistics.ts:141 + +#### Returns + +`string` + +#### Implementation of + +`StatTraits.getStat` + +*** + +### printStat() + +> **printStat**(): `void` + +Defined in: src/callgraph/common/Statistics.ts:163 + +#### Returns + +`void` + +#### Implementation of + +`StatTraits.printStat` + +*** + +### startStat() + +> **startStat**(): `void` + +Defined in: src/callgraph/common/Statistics.ts:73 + +#### Returns + +`void` diff --git a/docs/api_docs/classes/Pag.md b/docs/api_docs/classes/Pag.md new file mode 100644 index 0000000000000000000000000000000000000000..0c5a65dfc693aa7f4d378861958d91a088f83618 --- /dev/null +++ b/docs/api_docs/classes/Pag.md @@ -0,0 +1,677 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / Pag + +# Class: Pag + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:574 + +## Extends + +- [`BaseExplicitGraph`](BaseExplicitGraph.md) + +## Constructors + +### new Pag() + +> **new Pag**(): [`Pag`](Pag.md) + +Defined in: src/core/graph/BaseExplicitGraph.ts:147 + +#### Returns + +[`Pag`](Pag.md) + +#### Inherited from + +[`BaseExplicitGraph`](BaseExplicitGraph.md).[`constructor`](BaseExplicitGraph.md#constructors) + +## Properties + +### edgeMarkSet + +> `protected` **edgeMarkSet**: `Set`\<`string`\> + +Defined in: src/core/graph/BaseExplicitGraph.ts:145 + +#### Inherited from + +[`BaseExplicitGraph`](BaseExplicitGraph.md).[`edgeMarkSet`](BaseExplicitGraph.md#edgemarkset) + +*** + +### edgeNum + +> `protected` **edgeNum**: `number` = `0` + +Defined in: src/core/graph/BaseExplicitGraph.ts:142 + +#### Inherited from + +[`BaseExplicitGraph`](BaseExplicitGraph.md).[`edgeNum`](BaseExplicitGraph.md#edgenum) + +*** + +### idToNodeMap + +> `protected` **idToNodeMap**: `Map`\<`number`, [`BaseNode`](BaseNode.md)\> + +Defined in: src/core/graph/BaseExplicitGraph.ts:144 + +#### Inherited from + +[`BaseExplicitGraph`](BaseExplicitGraph.md).[`idToNodeMap`](BaseExplicitGraph.md#idtonodemap) + +*** + +### nodeNum + +> `protected` **nodeNum**: `number` = `0` + +Defined in: src/core/graph/BaseExplicitGraph.ts:143 + +#### Inherited from + +[`BaseExplicitGraph`](BaseExplicitGraph.md).[`nodeNum`](BaseExplicitGraph.md#nodenum) + +## Methods + +### addNode() + +> **addNode**(`n`): `void` + +Defined in: src/core/graph/BaseExplicitGraph.ts:160 + +#### Parameters + +##### n + +[`BaseNode`](BaseNode.md) + +#### Returns + +`void` + +#### Inherited from + +[`BaseExplicitGraph`](BaseExplicitGraph.md).[`addNode`](BaseExplicitGraph.md#addnode) + +*** + +### addPagEdge() + +> **addPagEdge**(`src`, `dst`, `kind`, `stmt`?): `boolean` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:883 + +#### Parameters + +##### src + +[`PagNode`](PagNode.md) + +##### dst + +[`PagNode`](PagNode.md) + +##### kind + +[`PagEdgeKind`](../enumerations/PagEdgeKind.md) + +##### stmt? + +[`Stmt`](Stmt.md) + +#### Returns + +`boolean` + +*** + +### addPagNode() + +> **addPagNode**(`cid`, `value`, `stmt`?, `refresh`?): [`PagNode`](PagNode.md) + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:667 + +#### Parameters + +##### cid + +`number` + +##### value + +[`Value`](../interfaces/Value.md) + +##### stmt? + +[`Stmt`](Stmt.md) + +##### refresh? + +`boolean` = `true` + +#### Returns + +[`PagNode`](PagNode.md) + +*** + +### addPagThisLocalNode() + +> **addPagThisLocalNode**(`ptNode`, `value`): [`PagNode`](PagNode.md) + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:801 + +#### Parameters + +##### ptNode + +`number` + +##### value + +[`Local`](Local.md) + +#### Returns + +[`PagNode`](PagNode.md) + +*** + +### addPagThisRefNode() + +> **addPagThisRefNode**(`value`): [`PagNode`](PagNode.md) + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:793 + +#### Parameters + +##### value + +[`ArkThisRef`](ArkThisRef.md) + +#### Returns + +[`PagNode`](PagNode.md) + +*** + +### dump() + +> **dump**(`name`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:940 + +#### Parameters + +##### name + +`string` + +#### Returns + +`void` + +*** + +### getAddrEdges() + +> **getAddrEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:928 + +#### Returns + +`PagEdgeSet` + +*** + +### getCG() + +> **getCG**(): [`CallGraph`](CallGraph.md) + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:587 + +#### Returns + +[`CallGraph`](CallGraph.md) + +*** + +### getGraphName() + +> **getGraphName**(): `string` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:936 + +#### Returns + +`string` + +#### Overrides + +[`BaseExplicitGraph`](BaseExplicitGraph.md).[`getGraphName`](BaseExplicitGraph.md#getgraphname) + +*** + +### getNode() + +> **getNode**(`id`): `undefined` \| [`BaseNode`](BaseNode.md) + +Defined in: src/core/graph/BaseExplicitGraph.ts:165 + +#### Parameters + +##### id + +`number` + +#### Returns + +`undefined` \| [`BaseNode`](BaseNode.md) + +#### Inherited from + +[`BaseExplicitGraph`](BaseExplicitGraph.md).[`getNode`](BaseExplicitGraph.md#getnode) + +*** + +### getNodeNum() + +> **getNodeNum**(): `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:152 + +#### Returns + +`number` + +#### Inherited from + +[`BaseExplicitGraph`](BaseExplicitGraph.md).[`getNodeNum`](BaseExplicitGraph.md#getnodenum) + +*** + +### getNodesByBaseValue() + +> **getNodesByBaseValue**(`v`): `undefined` \| `Map`\<`number`, `number`[]\> + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:879 + +#### Parameters + +##### v + +[`Value`](../interfaces/Value.md) + +#### Returns + +`undefined` \| `Map`\<`number`, `number`[]\> + +*** + +### getNodesByValue() + +> **getNodesByValue**(`v`): `undefined` \| `Map`\<`number`, `number`\> + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:875 + +#### Parameters + +##### v + +[`Value`](../interfaces/Value.md) + +#### Returns + +`undefined` \| `Map`\<`number`, `number`\> + +*** + +### getNodesIter() + +> **getNodesIter**(): `IterableIterator`\<[`BaseNode`](BaseNode.md)\> + +Defined in: src/core/graph/BaseExplicitGraph.ts:205 + +#### Returns + +`IterableIterator`\<[`BaseNode`](BaseNode.md)\> + +#### Inherited from + +[`BaseExplicitGraph`](BaseExplicitGraph.md).[`getNodesIter`](BaseExplicitGraph.md#getnodesiter) + +*** + +### getOrClonePagContainerFieldNode() + +> **getOrClonePagContainerFieldNode**(`basePt`, `src`?, `base`?): [`PagInstanceFieldNode`](PagInstanceFieldNode.md) + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:637 + +#### Parameters + +##### basePt + +`number` + +##### src? + +[`PagArrayNode`](PagArrayNode.md) + +##### base? + +[`Local`](Local.md) + +#### Returns + +[`PagInstanceFieldNode`](PagInstanceFieldNode.md) + +*** + +### getOrClonePagFieldNode() + +> **getOrClonePagFieldNode**(`src`, `basePt`): `undefined` \| [`PagInstanceFieldNode`](PagInstanceFieldNode.md) + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:618 + +#### Parameters + +##### src + +[`PagInstanceFieldNode`](PagInstanceFieldNode.md) + +##### basePt + +`number` + +#### Returns + +`undefined` \| [`PagInstanceFieldNode`](PagInstanceFieldNode.md) + +*** + +### getOrClonePagNode() + +> **getOrClonePagNode**(`src`, `basePt`): [`PagNode`](PagNode.md) + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:595 + +#### Parameters + +##### src + +[`PagNode`](PagNode.md) + +##### basePt + +`number` + +#### Returns + +[`PagNode`](PagNode.md) + +*** + +### getOrNewNode() + +> **getOrNewNode**(`cid`, `v`, `s`?): [`PagNode`](PagNode.md) + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:858 + +#### Parameters + +##### cid + +`number` + +##### v + +[`Value`](../interfaces/Value.md) + +##### s? + +[`Stmt`](Stmt.md) + +#### Returns + +[`PagNode`](PagNode.md) + +*** + +### getOrNewThisLocalNode() + +> **getOrNewThisLocalNode**(`cid`, `ptNode`, `value`, `s`?): [`PagNode`](PagNode.md) + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:818 + +#### Parameters + +##### cid + +`number` + +##### ptNode + +`number` + +##### value + +[`Local`](Local.md) + +##### s? + +[`Stmt`](Stmt.md) + +#### Returns + +[`PagNode`](PagNode.md) + +*** + +### getOrNewThisRefNode() + +> **getOrNewThisRefNode**(`thisRefNodeID`, `value`): [`PagNode`](PagNode.md) + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:809 + +#### Parameters + +##### thisRefNodeID + +`number` + +##### value + +[`ArkThisRef`](ArkThisRef.md) + +#### Returns + +[`PagNode`](PagNode.md) + +*** + +### hasCtxNode() + +> **hasCtxNode**(`cid`, `v`): `undefined` \| `number` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:831 + +#### Parameters + +##### cid + +`number` + +##### v + +[`Value`](../interfaces/Value.md) + +#### Returns + +`undefined` \| `number` + +*** + +### hasCtxRetNode() + +> **hasCtxRetNode**(`cid`, `v`): `undefined` \| `number` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:845 + +#### Parameters + +##### cid + +`number` + +##### v + +[`Value`](../interfaces/Value.md) + +#### Returns + +`undefined` \| `number` + +*** + +### hasEdge() + +> **hasEdge**(`src`, `dst`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:185 + +#### Parameters + +##### src + +[`BaseNode`](BaseNode.md) + +##### dst + +[`BaseNode`](BaseNode.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`BaseExplicitGraph`](BaseExplicitGraph.md).[`hasEdge`](BaseExplicitGraph.md#hasedge) + +*** + +### hasExportNode() + +> **hasExportNode**(`v`): `undefined` \| `number` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:826 + +#### Parameters + +##### v + +[`ExportInfo`](ExportInfo.md) + +#### Returns + +`undefined` \| `number` + +*** + +### hasNode() + +> **hasNode**(`id`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:173 + +#### Parameters + +##### id + +`number` + +#### Returns + +`boolean` + +#### Inherited from + +[`BaseExplicitGraph`](BaseExplicitGraph.md).[`hasNode`](BaseExplicitGraph.md#hasnode) + +*** + +### ifEdgeExisting() + +> **ifEdgeExisting**(`edge`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:195 + +#### Parameters + +##### edge + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`BaseExplicitGraph`](BaseExplicitGraph.md).[`ifEdgeExisting`](BaseExplicitGraph.md#ifedgeexisting) + +*** + +### nodesItor() + +> **nodesItor**(): `IterableIterator`\<[`BaseNode`](BaseNode.md)\> + +Defined in: src/core/graph/BaseExplicitGraph.ts:156 + +#### Returns + +`IterableIterator`\<[`BaseNode`](BaseNode.md)\> + +#### Inherited from + +[`BaseExplicitGraph`](BaseExplicitGraph.md).[`nodesItor`](BaseExplicitGraph.md#nodesitor) + +*** + +### removeNode() + +> **removeNode**(`id`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:177 + +#### Parameters + +##### id + +`number` + +#### Returns + +`boolean` + +#### Inherited from + +[`BaseExplicitGraph`](BaseExplicitGraph.md).[`removeNode`](BaseExplicitGraph.md#removenode) + +*** + +### resetAddrEdges() + +> **resetAddrEdges**(): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:932 + +#### Returns + +`void` diff --git a/docs/api_docs/classes/PagArrayNode.md b/docs/api_docs/classes/PagArrayNode.md new file mode 100644 index 0000000000000000000000000000000000000000..799d94612fa5330b3bbfbe4563e259de03ad364b --- /dev/null +++ b/docs/api_docs/classes/PagArrayNode.md @@ -0,0 +1,981 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / PagArrayNode + +# Class: PagArrayNode + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:449 + +## Extends + +- [`PagNode`](PagNode.md) + +## Constructors + +### new PagArrayNode() + +> **new PagArrayNode**(`id`, `cid`, `expr`, `stmt`?): [`PagArrayNode`](PagArrayNode.md) + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:452 + +#### Parameters + +##### id + +`number` + +##### cid + +`undefined` | `number` + +##### expr + +[`ArkArrayRef`](ArkArrayRef.md) + +##### stmt? + +[`Stmt`](Stmt.md) + +#### Returns + +[`PagArrayNode`](PagArrayNode.md) + +#### Overrides + +[`PagNode`](PagNode.md).[`constructor`](PagNode.md#constructors) + +## Properties + +### base + +> **base**: [`Value`](../interfaces/Value.md) + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:450 + +*** + +### basePt + +> `protected` **basePt**: `number` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:141 + +#### Inherited from + +[`PagNode`](PagNode.md).[`basePt`](PagNode.md#basept) + +*** + +### clonedFrom + +> `protected` **clonedFrom**: `number` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:142 + +#### Inherited from + +[`PagNode`](PagNode.md).[`clonedFrom`](PagNode.md#clonedfrom) + +*** + +### kind + +> `protected` **kind**: `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:73 + +#### Inherited from + +[`PagNode`](PagNode.md).[`kind`](PagNode.md#kind) + +## Methods + +### addAddressInEdge() + +> **addAddressInEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:211 + +#### Parameters + +##### e + +[`AddrPagEdge`](AddrPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addAddressInEdge`](PagNode.md#addaddressinedge) + +*** + +### addAddressOutEdge() + +> **addAddressOutEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:217 + +#### Parameters + +##### e + +[`AddrPagEdge`](AddrPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addAddressOutEdge`](PagNode.md#addaddressoutedge) + +*** + +### addCopyInEdge() + +> **addCopyInEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:223 + +#### Parameters + +##### e + +[`CopyPagEdge`](CopyPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addCopyInEdge`](PagNode.md#addcopyinedge) + +*** + +### addCopyOutEdge() + +> **addCopyOutEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:229 + +#### Parameters + +##### e + +[`CopyPagEdge`](CopyPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addCopyOutEdge`](PagNode.md#addcopyoutedge) + +*** + +### addIncomingEdge() + +> **addIncomingEdge**(`e`): `void` + +Defined in: src/core/graph/BaseExplicitGraph.ts:110 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addIncomingEdge`](PagNode.md#addincomingedge) + +*** + +### addLoadInEdge() + +> **addLoadInEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:236 + +#### Parameters + +##### e + +[`LoadPagEdge`](LoadPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addLoadInEdge`](PagNode.md#addloadinedge) + +*** + +### addLoadOutEdge() + +> **addLoadOutEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:242 + +#### Parameters + +##### e + +[`LoadPagEdge`](LoadPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addLoadOutEdge`](PagNode.md#addloadoutedge) + +*** + +### addOutgoingEdge() + +> **addOutgoingEdge**(`e`): `void` + +Defined in: src/core/graph/BaseExplicitGraph.ts:114 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addOutgoingEdge`](PagNode.md#addoutgoingedge) + +*** + +### addPointToElement() + +> **addPointToElement**(`node`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:280 + +#### Parameters + +##### node + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addPointToElement`](PagNode.md#addpointtoelement) + +*** + +### addThisInEdge() + +> **addThisInEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:260 + +#### Parameters + +##### e + +[`ThisPagEdge`](ThisPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addThisInEdge`](PagNode.md#addthisinedge) + +*** + +### addThisOutEdge() + +> **addThisOutEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:266 + +#### Parameters + +##### e + +[`ThisPagEdge`](ThisPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addThisOutEdge`](PagNode.md#addthisoutedge) + +*** + +### addWriteInEdge() + +> **addWriteInEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:248 + +#### Parameters + +##### e + +[`WritePagEdge`](WritePagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addWriteInEdge`](PagNode.md#addwriteinedge) + +*** + +### addWriteOutEdge() + +> **addWriteOutEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:254 + +#### Parameters + +##### e + +[`LoadPagEdge`](LoadPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addWriteOutEdge`](PagNode.md#addwriteoutedge) + +*** + +### getBasePt() + +> **getBasePt**(): `number` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:152 + +#### Returns + +`number` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getBasePt`](PagNode.md#getbasept) + +*** + +### getCid() + +> **getCid**(): `number` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:160 + +#### Returns + +`number` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getCid`](PagNode.md#getcid) + +*** + +### getClonedFrom() + +> **getClonedFrom**(): `number` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:297 + +#### Returns + +`number` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getClonedFrom`](PagNode.md#getclonedfrom) + +*** + +### getDotAttr() + +> **getDotAttr**(): `string` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:305 + +#### Returns + +`string` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getDotAttr`](PagNode.md#getdotattr) + +*** + +### getDotLabel() + +> **getDotLabel**(): `string` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:326 + +#### Returns + +`string` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getDotLabel`](PagNode.md#getdotlabel) + +*** + +### getID() + +> **getID**(): `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:82 + +#### Returns + +`number` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getID`](PagNode.md#getid) + +*** + +### getIncomingCopyEdges() + +> **getIncomingCopyEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:187 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getIncomingCopyEdges`](PagNode.md#getincomingcopyedges) + +*** + +### getIncomingEdge() + +> **getIncomingEdge**(): `Set`\<[`BaseEdge`](BaseEdge.md)\> + +Defined in: src/core/graph/BaseExplicitGraph.ts:126 + +#### Returns + +`Set`\<[`BaseEdge`](BaseEdge.md)\> + +#### Inherited from + +[`PagNode`](PagNode.md).[`getIncomingEdge`](PagNode.md#getincomingedge) + +*** + +### getIncomingThisEdges() + +> **getIncomingThisEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:207 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getIncomingThisEdges`](PagNode.md#getincomingthisedges) + +*** + +### getIncomingWriteEdges() + +> **getIncomingWriteEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:199 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getIncomingWriteEdges`](PagNode.md#getincomingwriteedges) + +*** + +### getKind() + +> **getKind**(): `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:86 + +#### Returns + +`number` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getKind`](PagNode.md#getkind) + +*** + +### getOutEdges() + +> **getOutEdges**(): `object` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:288 + +#### Returns + +`object` + +##### AddressEdge + +> **AddressEdge**: `PagEdgeSet` + +##### CopyEdge + +> **CopyEdge**: `PagEdgeSet` + +##### LoadEdge + +> **LoadEdge**: `PagEdgeSet` + +##### WriteEdge + +> **WriteEdge**: `PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getOutEdges`](PagNode.md#getoutedges) + +*** + +### getOutgoingCopyEdges() + +> **getOutgoingCopyEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:183 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getOutgoingCopyEdges`](PagNode.md#getoutgoingcopyedges) + +*** + +### getOutgoingEdges() + +> **getOutgoingEdges**(): `Set`\<[`BaseEdge`](BaseEdge.md)\> + +Defined in: src/core/graph/BaseExplicitGraph.ts:130 + +#### Returns + +`Set`\<[`BaseEdge`](BaseEdge.md)\> + +#### Inherited from + +[`PagNode`](PagNode.md).[`getOutgoingEdges`](PagNode.md#getoutgoingedges) + +*** + +### getOutgoingLoadEdges() + +> **getOutgoingLoadEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:191 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getOutgoingLoadEdges`](PagNode.md#getoutgoingloadedges) + +*** + +### getOutgoingThisEdges() + +> **getOutgoingThisEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:203 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getOutgoingThisEdges`](PagNode.md#getoutgoingthisedges) + +*** + +### getOutgoingWriteEdges() + +> **getOutgoingWriteEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:195 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getOutgoingWriteEdges`](PagNode.md#getoutgoingwriteedges) + +*** + +### getPointTo() + +> **getPointTo**(): `Set`\<`number`\> + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:276 + +#### Returns + +`Set`\<`number`\> + +#### Inherited from + +[`PagNode`](PagNode.md).[`getPointTo`](PagNode.md#getpointto) + +*** + +### getStmt() + +> **getStmt**(): `undefined` \| [`Stmt`](Stmt.md) + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:175 + +#### Returns + +`undefined` \| [`Stmt`](Stmt.md) + +#### Inherited from + +[`PagNode`](PagNode.md).[`getStmt`](PagNode.md#getstmt) + +*** + +### getValue() + +> **getValue**(): [`Value`](../interfaces/Value.md) + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:272 + +#### Returns + +[`Value`](../interfaces/Value.md) + +#### Inherited from + +[`PagNode`](PagNode.md).[`getValue`](PagNode.md#getvalue) + +*** + +### hasIncomingEdge() + +> **hasIncomingEdge**(`e`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:102 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`hasIncomingEdge`](PagNode.md#hasincomingedge) + +*** + +### hasIncomingEdges() + +> **hasIncomingEdges**(): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:94 + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`hasIncomingEdges`](PagNode.md#hasincomingedges) + +*** + +### hasOutgoingCopyEdge() + +> **hasOutgoingCopyEdge**(): `boolean` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:179 + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`hasOutgoingCopyEdge`](PagNode.md#hasoutgoingcopyedge) + +*** + +### hasOutgoingEdge() + +> **hasOutgoingEdge**(`e`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:106 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`hasOutgoingEdge`](PagNode.md#hasoutgoingedge) + +*** + +### hasOutgoingEdges() + +> **hasOutgoingEdges**(): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:98 + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`hasOutgoingEdges`](PagNode.md#hasoutgoingedges) + +*** + +### removeIncomingEdge() + +> **removeIncomingEdge**(`e`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:118 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`removeIncomingEdge`](PagNode.md#removeincomingedge) + +*** + +### removeOutgoingEdge() + +> **removeOutgoingEdge**(`e`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:122 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`removeOutgoingEdge`](PagNode.md#removeoutgoingedge) + +*** + +### setBasePt() + +> **setBasePt**(`pt`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:156 + +#### Parameters + +##### pt + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`setBasePt`](PagNode.md#setbasept) + +*** + +### setCid() + +> **setCid**(`cid`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:167 + +#### Parameters + +##### cid + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`setCid`](PagNode.md#setcid) + +*** + +### setClonedFrom() + +> **setClonedFrom**(`id`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:301 + +#### Parameters + +##### id + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`setClonedFrom`](PagNode.md#setclonedfrom) + +*** + +### setKind() + +> **setKind**(`kind`): `void` + +Defined in: src/core/graph/BaseExplicitGraph.ts:90 + +#### Parameters + +##### kind + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`setKind`](PagNode.md#setkind) + +*** + +### setPointTo() + +> **setPointTo**(`pts`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:284 + +#### Parameters + +##### pts + +`Set`\<`number`\> + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`setPointTo`](PagNode.md#setpointto) + +*** + +### setStmt() + +> **setStmt**(`s`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:171 + +#### Parameters + +##### s + +[`Stmt`](Stmt.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`setStmt`](PagNode.md#setstmt) diff --git a/docs/api_docs/classes/PagBuilder.md b/docs/api_docs/classes/PagBuilder.md new file mode 100644 index 0000000000000000000000000000000000000000..5a3d5ae5cd9a3812aea0e9089425e57a12603357 --- /dev/null +++ b/docs/api_docs/classes/PagBuilder.md @@ -0,0 +1,772 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / PagBuilder + +# Class: PagBuilder + +Defined in: src/callgraph/pointerAnalysis/PagBuilder.ts:49 + +## Constructors + +### new PagBuilder() + +> **new PagBuilder**(`p`, `cg`, `s`, `kLimit`): [`PagBuilder`](PagBuilder.md) + +Defined in: src/callgraph/pointerAnalysis/PagBuilder.ts:77 + +#### Parameters + +##### p + +[`Pag`](Pag.md) + +##### cg + +[`CallGraph`](CallGraph.md) + +##### s + +[`Scene`](Scene.md) + +##### kLimit + +`number` + +#### Returns + +[`PagBuilder`](PagBuilder.md) + +## Methods + +### addCallsEdgesFromFuncPag() + +> **addCallsEdgesFromFuncPag**(`funcPag`, `cid`): `boolean` + +Defined in: src/callgraph/pointerAnalysis/PagBuilder.ts:300 + +#### Parameters + +##### funcPag + +[`FuncPag`](FuncPag.md) + +##### cid + +`number` + +#### Returns + +`boolean` + +*** + +### addDynamicCallEdge() + +> **addDynamicCallEdge**(`cs`, `baseClassPTNode`, `cid`): `number`[] + +Defined in: src/callgraph/pointerAnalysis/PagBuilder.ts:539 + +#### Parameters + +##### cs + +[`CallSite`](CallSite.md) | [`DynCallSite`](DynCallSite.md) + +##### baseClassPTNode + +`number` + +##### cid + +`number` + +#### Returns + +`number`[] + +*** + +### addDynamicCallSite() + +> **addDynamicCallSite**(`funcPag`, `funcID`): `void` + +Defined in: src/callgraph/pointerAnalysis/PagBuilder.ts:470 + +#### Parameters + +##### funcPag + +[`FuncPag`](FuncPag.md) + +##### funcID + +`number` + +#### Returns + +`void` + +*** + +### addEdgesFromFuncPag() + +> **addEdgesFromFuncPag**(`funcPag`, `cid`): `boolean` + +Defined in: src/callgraph/pointerAnalysis/PagBuilder.ts:278 + +#### Parameters + +##### funcPag + +[`FuncPag`](FuncPag.md) + +##### cid + +`number` + +#### Returns + +`boolean` + +*** + +### addEdgesFromInterFuncPag() + +> **addEdgesFromInterFuncPag**(`interFuncPag`, `cid`): `boolean` + +Defined in: src/callgraph/pointerAnalysis/PagBuilder.ts:1574 + +#### Parameters + +##### interFuncPag + +[`InterFuncPag`](InterFuncPag.md) + +##### cid + +`number` + +#### Returns + +`boolean` + +*** + +### addPropertyLinkEdge() + +> **addPropertyLinkEdge**(`propertyNode`, `storageObj`, `cid`, `stmt`, `edgeKind`): `boolean` + +Defined in: src/callgraph/pointerAnalysis/PagBuilder.ts:1104 + +add PagEdge + +#### Parameters + +##### propertyNode + +[`PagNode`](PagNode.md) + +##### storageObj + +[`Value`](../interfaces/Value.md) + +##### cid + +`number` + +##### stmt + +[`Stmt`](Stmt.md) + +##### edgeKind + +`number` + +#### Returns + +`boolean` + +*** + +### addStaticPagCallEdge() + +> **addStaticPagCallEdge**(`cs`, `callerCid`, `calleeCid`?): `number`[] + +Defined in: src/callgraph/pointerAnalysis/PagBuilder.ts:778 + +#### Parameters + +##### cs + +[`CallSite`](CallSite.md) + +##### callerCid + +`number` + +##### calleeCid? + +`number` + +#### Returns + +`number`[] + +*** + +### addToDynamicCallSite() + +> **addToDynamicCallSite**(`funcPag`, `cs`): `void` + +Defined in: src/callgraph/pointerAnalysis/PagBuilder.ts:1385 + +#### Parameters + +##### funcPag + +[`FuncPag`](FuncPag.md) + +##### cs + +[`DynCallSite`](DynCallSite.md) + +#### Returns + +`void` + +*** + +### addUnknownCallSite() + +> **addUnknownCallSite**(`funcPag`, `funcID`): `void` + +Defined in: src/callgraph/pointerAnalysis/PagBuilder.ts:506 + +#### Parameters + +##### funcPag + +[`FuncPag`](FuncPag.md) + +##### funcID + +`number` + +#### Returns + +`void` + +*** + +### addUpdatedNode() + +> **addUpdatedNode**(`nodeID`, `diffPT`): `void` + +Defined in: src/callgraph/pointerAnalysis/PagBuilder.ts:633 + +#### Parameters + +##### nodeID + +`number` + +##### diffPT + +[`PtsSet`](PtsSet.md)\<`number`\> + +#### Returns + +`void` + +*** + +### build() + +> **build**(): `void` + +Defined in: src/callgraph/pointerAnalysis/PagBuilder.ts:136 + +#### Returns + +`void` + +*** + +### buildForEntries() + +> **buildForEntries**(`funcIDs`): `void` + +Defined in: src/callgraph/pointerAnalysis/PagBuilder.ts:108 + +#### Parameters + +##### funcIDs + +`number`[] + +#### Returns + +`void` + +*** + +### buildFuncPag() + +> **buildFuncPag**(`funcID`): `boolean` + +Defined in: src/callgraph/pointerAnalysis/PagBuilder.ts:146 + +#### Parameters + +##### funcID + +`number` + +#### Returns + +`boolean` + +*** + +### buildPagFromFuncPag() + +> **buildPagFromFuncPag**(`funcID`, `cid`): `void` + +Defined in: src/callgraph/pointerAnalysis/PagBuilder.ts:256 + +#### Parameters + +##### funcID + +`number` + +##### cid + +`number` + +#### Returns + +`void` + +*** + +### doStat() + +> **doStat**(): `void` + +Defined in: src/callgraph/pointerAnalysis/PagBuilder.ts:1417 + +#### Returns + +`void` + +*** + +### getExportVariableMap() + +> **getExportVariableMap**(`src`): [`Local`](Local.md)[] + +Defined in: src/callgraph/pointerAnalysis/PagBuilder.ts:1569 + +#### Parameters + +##### src + +[`Local`](Local.md) + +#### Returns + +[`Local`](Local.md)[] + +*** + +### getGlobalThisValue() + +> **getGlobalThisValue**(): [`Local`](Local.md) + +Defined in: src/callgraph/pointerAnalysis/PagBuilder.ts:1271 + +#### Returns + +[`Local`](Local.md) + +*** + +### getHandledFuncs() + +> **getHandledFuncs**(): `number`[] + +Defined in: src/callgraph/pointerAnalysis/PagBuilder.ts:1437 + +#### Returns + +`number`[] + +*** + +### getOrNewGlobalThisNode() + +> **getOrNewGlobalThisNode**(`cid`): [`PagNode`](PagNode.md) + +Defined in: src/callgraph/pointerAnalysis/PagBuilder.ts:1049 + +#### Parameters + +##### cid + +`number` + +#### Returns + +[`PagNode`](PagNode.md) + +*** + +### getOrNewPagNode() + +> **getOrNewPagNode**(`cid`, `v`, `s`?): [`PagNode`](PagNode.md) + +Defined in: src/callgraph/pointerAnalysis/PagBuilder.ts:997 + +#### Parameters + +##### cid + +`number` + +##### v + +[`Value`](../interfaces/Value.md) + +##### s? + +[`Stmt`](Stmt.md) + +#### Returns + +[`PagNode`](PagNode.md) + +*** + +### getOrNewPropertyNode() + +> **getOrNewPropertyNode**(`storage`, `propertyName`, `stmt`): [`PagNode`](PagNode.md) + +Defined in: src/callgraph/pointerAnalysis/PagBuilder.ts:1063 + +search the storage map to get propertyNode with given storage and propertyFieldName + +#### Parameters + +##### storage + +[`StorageType`](../enumerations/StorageType.md) + +storage type: AppStorage, LocalStorage etc. + +##### propertyName + +`string` + +string property key + +##### stmt + +[`Stmt`](Stmt.md) + +#### Returns + +[`PagNode`](PagNode.md) + +propertyNode: PagLocalNode + +*** + +### getOrNewThisLoalNode() + +> **getOrNewThisLoalNode**(`cid`, `v`, `s`?): [`PagNode`](PagNode.md) + +Defined in: src/callgraph/pointerAnalysis/PagBuilder.ts:1038 + +#### Parameters + +##### cid + +`number` + +##### v + +[`Local`](Local.md) + +##### s? + +[`Stmt`](Stmt.md) + +#### Returns + +[`PagNode`](PagNode.md) + +*** + +### getOrNewThisRefNode() + +> **getOrNewThisRefNode**(`cid`, `v`): [`PagNode`](PagNode.md) + +Defined in: src/callgraph/pointerAnalysis/PagBuilder.ts:1026 + +return ThisRef PAG node according to cid, a cid has a unique ThisRef node + +#### Parameters + +##### cid + +`number` + +##### v + +[`ArkThisRef`](ArkThisRef.md) + +#### Returns + +[`PagNode`](PagNode.md) + +*** + +### getPropertyNode() + +> **getPropertyNode**(`storage`, `propertyName`, `stmt`): `undefined` \| [`PagNode`](PagNode.md) + +Defined in: src/callgraph/pointerAnalysis/PagBuilder.ts:1078 + +#### Parameters + +##### storage + +[`StorageType`](../enumerations/StorageType.md) + +##### propertyName + +`string` + +##### stmt + +[`Stmt`](Stmt.md) + +#### Returns + +`undefined` \| [`PagNode`](PagNode.md) + +*** + +### getRealInstanceRef() + +> **getRealInstanceRef**(`v`): [`Value`](../interfaces/Value.md) + +Defined in: src/callgraph/pointerAnalysis/PagBuilder.ts:1133 + +#### Parameters + +##### v + +[`Value`](../interfaces/Value.md) + +#### Returns + +[`Value`](../interfaces/Value.md) + +*** + +### getRealThisLocal() + +> **getRealThisLocal**(`input`, `funcId`): [`Local`](Local.md) + +Defined in: src/callgraph/pointerAnalysis/PagBuilder.ts:1400 + +#### Parameters + +##### input + +[`Local`](Local.md) + +##### funcId + +`number` + +#### Returns + +[`Local`](Local.md) + +*** + +### getStat() + +> **getStat**(): `string` + +Defined in: src/callgraph/pointerAnalysis/PagBuilder.ts:1425 + +#### Returns + +`string` + +*** + +### getUnhandledFuncs() + +> **getUnhandledFuncs**(): `number`[] + +Defined in: src/callgraph/pointerAnalysis/PagBuilder.ts:1429 + +#### Returns + +`number`[] + +*** + +### getUniqThisLocalNode() + +> **getUniqThisLocalNode**(`cid`): `undefined` \| `number` + +Defined in: src/callgraph/pointerAnalysis/PagBuilder.ts:1053 + +#### Parameters + +##### cid + +`number` + +#### Returns + +`undefined` \| `number` + +*** + +### getUpdatedNodes() + +> **getUpdatedNodes**(): `Map`\<`number`, [`PtsSet`](PtsSet.md)\<`number`\>\> + +Defined in: src/callgraph/pointerAnalysis/PagBuilder.ts:639 + +#### Returns + +`Map`\<`number`, [`PtsSet`](PtsSet.md)\<`number`\>\> + +*** + +### handleReachable() + +> **handleReachable**(): `boolean` + +Defined in: src/callgraph/pointerAnalysis/PagBuilder.ts:121 + +#### Returns + +`boolean` + +*** + +### handleUnkownDynamicCall() + +> **handleUnkownDynamicCall**(`cs`, `cid`): `number`[] + +Defined in: src/callgraph/pointerAnalysis/PagBuilder.ts:647 + +#### Parameters + +##### cs + +[`DynCallSite`](DynCallSite.md) + +##### cid + +`number` + +#### Returns + +`number`[] + +*** + +### handleUnprocessedCallSites() + +> **handleUnprocessedCallSites**(`processedCallSites`): `number`[] + +Defined in: src/callgraph/pointerAnalysis/PagBuilder.ts:700 + +#### Parameters + +##### processedCallSites + +`Set`\<[`DynCallSite`](DynCallSite.md)\> + +#### Returns + +`number`[] + +*** + +### isSingletonFunction() + +> **isSingletonFunction**(`funcID`): `boolean` + +Defined in: src/callgraph/pointerAnalysis/PagBuilder.ts:1171 + +check if a method is singleton function +rule: static method, assign heap obj to global var or static field, return the receiver + +#### Parameters + +##### funcID + +`number` + +#### Returns + +`boolean` + +*** + +### printStat() + +> **printStat**(): `void` + +Defined in: src/callgraph/pointerAnalysis/PagBuilder.ts:1421 + +#### Returns + +`void` + +*** + +### resetUpdatedNodes() + +> **resetUpdatedNodes**(): `void` + +Defined in: src/callgraph/pointerAnalysis/PagBuilder.ts:643 + +#### Returns + +`void` + +*** + +### setPtForNode() + +> **setPtForNode**(`node`, `pts`): `void` + +Defined in: src/callgraph/pointerAnalysis/PagBuilder.ts:1392 + +#### Parameters + +##### node + +`number` + +##### pts + +`undefined` | [`PtsSet`](PtsSet.md)\<`number`\> + +#### Returns + +`void` diff --git a/docs/api_docs/classes/PagEdge.md b/docs/api_docs/classes/PagEdge.md new file mode 100644 index 0000000000000000000000000000000000000000..1d7c081b758c386aeeb473af55a5eeeccfb6f9e4 --- /dev/null +++ b/docs/api_docs/classes/PagEdge.md @@ -0,0 +1,209 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / PagEdge + +# Class: PagEdge + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:57 + +## Extends + +- [`BaseEdge`](BaseEdge.md) + +## Extended by + +- [`AddrPagEdge`](AddrPagEdge.md) +- [`CopyPagEdge`](CopyPagEdge.md) +- [`LoadPagEdge`](LoadPagEdge.md) +- [`WritePagEdge`](WritePagEdge.md) +- [`ThisPagEdge`](ThisPagEdge.md) + +## Constructors + +### new PagEdge() + +> **new PagEdge**(`n`, `d`, `k`, `s`?): [`PagEdge`](PagEdge.md) + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:60 + +#### Parameters + +##### n + +[`PagNode`](PagNode.md) + +##### d + +[`PagNode`](PagNode.md) + +##### k + +[`PagEdgeKind`](../enumerations/PagEdgeKind.md) + +##### s? + +[`Stmt`](Stmt.md) + +#### Returns + +[`PagEdge`](PagEdge.md) + +#### Overrides + +[`BaseEdge`](BaseEdge.md).[`constructor`](BaseEdge.md#constructors) + +## Properties + +### kind + +> `protected` **kind**: `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:27 + +#### Inherited from + +[`BaseEdge`](BaseEdge.md).[`kind`](BaseEdge.md#kind) + +## Methods + +### getDotAttr() + +> **getDotAttr**(): `string` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:65 + +#### Returns + +`string` + +#### Overrides + +[`BaseEdge`](BaseEdge.md).[`getDotAttr`](BaseEdge.md#getdotattr) + +*** + +### getDstID() + +> **getDstID**(): `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:39 + +#### Returns + +`number` + +#### Inherited from + +[`BaseEdge`](BaseEdge.md).[`getDstID`](BaseEdge.md#getdstid) + +*** + +### getDstNode() + +> **getDstNode**(): [`BaseNode`](BaseNode.md) + +Defined in: src/core/graph/BaseExplicitGraph.ts:47 + +#### Returns + +[`BaseNode`](BaseNode.md) + +#### Inherited from + +[`BaseEdge`](BaseEdge.md).[`getDstNode`](BaseEdge.md#getdstnode) + +*** + +### getEndPoints() + +> **getEndPoints**(): `object` + +Defined in: src/core/graph/BaseExplicitGraph.ts:59 + +#### Returns + +`object` + +##### dst + +> **dst**: `number` + +##### src + +> **src**: `number` + +#### Inherited from + +[`BaseEdge`](BaseEdge.md).[`getEndPoints`](BaseEdge.md#getendpoints) + +*** + +### getKind() + +> **getKind**(): `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:51 + +#### Returns + +`number` + +#### Inherited from + +[`BaseEdge`](BaseEdge.md).[`getKind`](BaseEdge.md#getkind) + +*** + +### getSrcID() + +> **getSrcID**(): `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:35 + +#### Returns + +`number` + +#### Inherited from + +[`BaseEdge`](BaseEdge.md).[`getSrcID`](BaseEdge.md#getsrcid) + +*** + +### getSrcNode() + +> **getSrcNode**(): [`BaseNode`](BaseNode.md) + +Defined in: src/core/graph/BaseExplicitGraph.ts:43 + +#### Returns + +[`BaseNode`](BaseNode.md) + +#### Inherited from + +[`BaseEdge`](BaseEdge.md).[`getSrcNode`](BaseEdge.md#getsrcnode) + +*** + +### setKind() + +> **setKind**(`kind`): `void` + +Defined in: src/core/graph/BaseExplicitGraph.ts:55 + +#### Parameters + +##### kind + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`BaseEdge`](BaseEdge.md).[`setKind`](BaseEdge.md#setkind) diff --git a/docs/api_docs/classes/PagFuncNode.md b/docs/api_docs/classes/PagFuncNode.md new file mode 100644 index 0000000000000000000000000000000000000000..44b3c2d1cc1869f8f25bbb9964ce8ef5d3933f80 --- /dev/null +++ b/docs/api_docs/classes/PagFuncNode.md @@ -0,0 +1,1007 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / PagFuncNode + +# Class: PagFuncNode + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:526 + +## Extends + +- [`PagNode`](PagNode.md) + +## Constructors + +### new PagFuncNode() + +> **new PagFuncNode**(`id`, `cid`, `r`, `stmt`?, `method`?): [`PagFuncNode`](PagFuncNode.md) + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:530 + +#### Parameters + +##### id + +`number` + +##### cid + +`undefined` | `number` + +##### r + +[`Value`](../interfaces/Value.md) + +##### stmt? + +[`Stmt`](Stmt.md) + +##### method? + +[`MethodSignature`](MethodSignature.md) + +#### Returns + +[`PagFuncNode`](PagFuncNode.md) + +#### Overrides + +[`PagNode`](PagNode.md).[`constructor`](PagNode.md#constructors) + +## Properties + +### basePt + +> `protected` **basePt**: `number` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:141 + +#### Inherited from + +[`PagNode`](PagNode.md).[`basePt`](PagNode.md#basept) + +*** + +### clonedFrom + +> `protected` **clonedFrom**: `number` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:142 + +#### Inherited from + +[`PagNode`](PagNode.md).[`clonedFrom`](PagNode.md#clonedfrom) + +*** + +### kind + +> `protected` **kind**: `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:73 + +#### Inherited from + +[`PagNode`](PagNode.md).[`kind`](PagNode.md#kind) + +## Methods + +### addAddressInEdge() + +> **addAddressInEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:211 + +#### Parameters + +##### e + +[`AddrPagEdge`](AddrPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addAddressInEdge`](PagNode.md#addaddressinedge) + +*** + +### addAddressOutEdge() + +> **addAddressOutEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:217 + +#### Parameters + +##### e + +[`AddrPagEdge`](AddrPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addAddressOutEdge`](PagNode.md#addaddressoutedge) + +*** + +### addCopyInEdge() + +> **addCopyInEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:223 + +#### Parameters + +##### e + +[`CopyPagEdge`](CopyPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addCopyInEdge`](PagNode.md#addcopyinedge) + +*** + +### addCopyOutEdge() + +> **addCopyOutEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:229 + +#### Parameters + +##### e + +[`CopyPagEdge`](CopyPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addCopyOutEdge`](PagNode.md#addcopyoutedge) + +*** + +### addIncomingEdge() + +> **addIncomingEdge**(`e`): `void` + +Defined in: src/core/graph/BaseExplicitGraph.ts:110 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addIncomingEdge`](PagNode.md#addincomingedge) + +*** + +### addLoadInEdge() + +> **addLoadInEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:236 + +#### Parameters + +##### e + +[`LoadPagEdge`](LoadPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addLoadInEdge`](PagNode.md#addloadinedge) + +*** + +### addLoadOutEdge() + +> **addLoadOutEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:242 + +#### Parameters + +##### e + +[`LoadPagEdge`](LoadPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addLoadOutEdge`](PagNode.md#addloadoutedge) + +*** + +### addOutgoingEdge() + +> **addOutgoingEdge**(`e`): `void` + +Defined in: src/core/graph/BaseExplicitGraph.ts:114 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addOutgoingEdge`](PagNode.md#addoutgoingedge) + +*** + +### addPointToElement() + +> **addPointToElement**(`node`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:280 + +#### Parameters + +##### node + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addPointToElement`](PagNode.md#addpointtoelement) + +*** + +### addThisInEdge() + +> **addThisInEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:260 + +#### Parameters + +##### e + +[`ThisPagEdge`](ThisPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addThisInEdge`](PagNode.md#addthisinedge) + +*** + +### addThisOutEdge() + +> **addThisOutEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:266 + +#### Parameters + +##### e + +[`ThisPagEdge`](ThisPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addThisOutEdge`](PagNode.md#addthisoutedge) + +*** + +### addWriteInEdge() + +> **addWriteInEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:248 + +#### Parameters + +##### e + +[`WritePagEdge`](WritePagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addWriteInEdge`](PagNode.md#addwriteinedge) + +*** + +### addWriteOutEdge() + +> **addWriteOutEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:254 + +#### Parameters + +##### e + +[`LoadPagEdge`](LoadPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addWriteOutEdge`](PagNode.md#addwriteoutedge) + +*** + +### getBasePt() + +> **getBasePt**(): `number` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:152 + +#### Returns + +`number` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getBasePt`](PagNode.md#getbasept) + +*** + +### getCid() + +> **getCid**(): `number` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:160 + +#### Returns + +`number` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getCid`](PagNode.md#getcid) + +*** + +### getClonedFrom() + +> **getClonedFrom**(): `number` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:297 + +#### Returns + +`number` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getClonedFrom`](PagNode.md#getclonedfrom) + +*** + +### getDotAttr() + +> **getDotAttr**(): `string` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:305 + +#### Returns + +`string` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getDotAttr`](PagNode.md#getdotattr) + +*** + +### getDotLabel() + +> **getDotLabel**(): `string` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:326 + +#### Returns + +`string` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getDotLabel`](PagNode.md#getdotlabel) + +*** + +### getID() + +> **getID**(): `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:82 + +#### Returns + +`number` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getID`](PagNode.md#getid) + +*** + +### getIncomingCopyEdges() + +> **getIncomingCopyEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:187 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getIncomingCopyEdges`](PagNode.md#getincomingcopyedges) + +*** + +### getIncomingEdge() + +> **getIncomingEdge**(): `Set`\<[`BaseEdge`](BaseEdge.md)\> + +Defined in: src/core/graph/BaseExplicitGraph.ts:126 + +#### Returns + +`Set`\<[`BaseEdge`](BaseEdge.md)\> + +#### Inherited from + +[`PagNode`](PagNode.md).[`getIncomingEdge`](PagNode.md#getincomingedge) + +*** + +### getIncomingThisEdges() + +> **getIncomingThisEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:207 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getIncomingThisEdges`](PagNode.md#getincomingthisedges) + +*** + +### getIncomingWriteEdges() + +> **getIncomingWriteEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:199 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getIncomingWriteEdges`](PagNode.md#getincomingwriteedges) + +*** + +### getKind() + +> **getKind**(): `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:86 + +#### Returns + +`number` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getKind`](PagNode.md#getkind) + +*** + +### getMethod() + +> **getMethod**(): [`MethodSignature`](MethodSignature.md) + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:541 + +#### Returns + +[`MethodSignature`](MethodSignature.md) + +*** + +### getOutEdges() + +> **getOutEdges**(): `object` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:288 + +#### Returns + +`object` + +##### AddressEdge + +> **AddressEdge**: `PagEdgeSet` + +##### CopyEdge + +> **CopyEdge**: `PagEdgeSet` + +##### LoadEdge + +> **LoadEdge**: `PagEdgeSet` + +##### WriteEdge + +> **WriteEdge**: `PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getOutEdges`](PagNode.md#getoutedges) + +*** + +### getOutgoingCopyEdges() + +> **getOutgoingCopyEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:183 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getOutgoingCopyEdges`](PagNode.md#getoutgoingcopyedges) + +*** + +### getOutgoingEdges() + +> **getOutgoingEdges**(): `Set`\<[`BaseEdge`](BaseEdge.md)\> + +Defined in: src/core/graph/BaseExplicitGraph.ts:130 + +#### Returns + +`Set`\<[`BaseEdge`](BaseEdge.md)\> + +#### Inherited from + +[`PagNode`](PagNode.md).[`getOutgoingEdges`](PagNode.md#getoutgoingedges) + +*** + +### getOutgoingLoadEdges() + +> **getOutgoingLoadEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:191 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getOutgoingLoadEdges`](PagNode.md#getoutgoingloadedges) + +*** + +### getOutgoingThisEdges() + +> **getOutgoingThisEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:203 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getOutgoingThisEdges`](PagNode.md#getoutgoingthisedges) + +*** + +### getOutgoingWriteEdges() + +> **getOutgoingWriteEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:195 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getOutgoingWriteEdges`](PagNode.md#getoutgoingwriteedges) + +*** + +### getPointTo() + +> **getPointTo**(): `Set`\<`number`\> + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:276 + +#### Returns + +`Set`\<`number`\> + +#### Inherited from + +[`PagNode`](PagNode.md).[`getPointTo`](PagNode.md#getpointto) + +*** + +### getStmt() + +> **getStmt**(): `undefined` \| [`Stmt`](Stmt.md) + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:175 + +#### Returns + +`undefined` \| [`Stmt`](Stmt.md) + +#### Inherited from + +[`PagNode`](PagNode.md).[`getStmt`](PagNode.md#getstmt) + +*** + +### getValue() + +> **getValue**(): [`Value`](../interfaces/Value.md) + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:272 + +#### Returns + +[`Value`](../interfaces/Value.md) + +#### Inherited from + +[`PagNode`](PagNode.md).[`getValue`](PagNode.md#getvalue) + +*** + +### hasIncomingEdge() + +> **hasIncomingEdge**(`e`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:102 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`hasIncomingEdge`](PagNode.md#hasincomingedge) + +*** + +### hasIncomingEdges() + +> **hasIncomingEdges**(): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:94 + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`hasIncomingEdges`](PagNode.md#hasincomingedges) + +*** + +### hasOutgoingCopyEdge() + +> **hasOutgoingCopyEdge**(): `boolean` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:179 + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`hasOutgoingCopyEdge`](PagNode.md#hasoutgoingcopyedge) + +*** + +### hasOutgoingEdge() + +> **hasOutgoingEdge**(`e`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:106 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`hasOutgoingEdge`](PagNode.md#hasoutgoingedge) + +*** + +### hasOutgoingEdges() + +> **hasOutgoingEdges**(): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:98 + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`hasOutgoingEdges`](PagNode.md#hasoutgoingedges) + +*** + +### removeIncomingEdge() + +> **removeIncomingEdge**(`e`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:118 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`removeIncomingEdge`](PagNode.md#removeincomingedge) + +*** + +### removeOutgoingEdge() + +> **removeOutgoingEdge**(`e`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:122 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`removeOutgoingEdge`](PagNode.md#removeoutgoingedge) + +*** + +### setBasePt() + +> **setBasePt**(`pt`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:156 + +#### Parameters + +##### pt + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`setBasePt`](PagNode.md#setbasept) + +*** + +### setCid() + +> **setCid**(`cid`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:167 + +#### Parameters + +##### cid + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`setCid`](PagNode.md#setcid) + +*** + +### setClonedFrom() + +> **setClonedFrom**(`id`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:301 + +#### Parameters + +##### id + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`setClonedFrom`](PagNode.md#setclonedfrom) + +*** + +### setKind() + +> **setKind**(`kind`): `void` + +Defined in: src/core/graph/BaseExplicitGraph.ts:90 + +#### Parameters + +##### kind + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`setKind`](PagNode.md#setkind) + +*** + +### setMethod() + +> **setMethod**(`method`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:537 + +#### Parameters + +##### method + +[`MethodSignature`](MethodSignature.md) + +#### Returns + +`void` + +*** + +### setPointTo() + +> **setPointTo**(`pts`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:284 + +#### Parameters + +##### pts + +`Set`\<`number`\> + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`setPointTo`](PagNode.md#setpointto) + +*** + +### setStmt() + +> **setStmt**(`s`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:171 + +#### Parameters + +##### s + +[`Stmt`](Stmt.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`setStmt`](PagNode.md#setstmt) diff --git a/docs/api_docs/classes/PagGlobalThisNode.md b/docs/api_docs/classes/PagGlobalThisNode.md new file mode 100644 index 0000000000000000000000000000000000000000..c8cc3a675a3bf14fa6116338343945b6df2fefee --- /dev/null +++ b/docs/api_docs/classes/PagGlobalThisNode.md @@ -0,0 +1,1035 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / PagGlobalThisNode + +# Class: PagGlobalThisNode + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:549 + +almost same as PagNewExprNode, used only for globalThis and its field reference + +## Extends + +- [`PagNode`](PagNode.md) + +## Constructors + +### new PagGlobalThisNode() + +> **new PagGlobalThisNode**(`id`, `cid`, `r`, `stmt`?): [`PagGlobalThisNode`](PagGlobalThisNode.md) + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:552 + +#### Parameters + +##### id + +`number` + +##### cid + +`undefined` | `number` + +##### r + +[`Value`](../interfaces/Value.md) + +##### stmt? + +[`Stmt`](Stmt.md) + +#### Returns + +[`PagGlobalThisNode`](PagGlobalThisNode.md) + +#### Overrides + +[`PagNode`](PagNode.md).[`constructor`](PagNode.md#constructors) + +## Properties + +### basePt + +> `protected` **basePt**: `number` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:141 + +#### Inherited from + +[`PagNode`](PagNode.md).[`basePt`](PagNode.md#basept) + +*** + +### clonedFrom + +> `protected` **clonedFrom**: `number` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:142 + +#### Inherited from + +[`PagNode`](PagNode.md).[`clonedFrom`](PagNode.md#clonedfrom) + +*** + +### fieldNodes + +> **fieldNodes**: `Map`\<`string`, `number`\> + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:550 + +*** + +### kind + +> `protected` **kind**: `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:73 + +#### Inherited from + +[`PagNode`](PagNode.md).[`kind`](PagNode.md#kind) + +## Methods + +### addAddressInEdge() + +> **addAddressInEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:211 + +#### Parameters + +##### e + +[`AddrPagEdge`](AddrPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addAddressInEdge`](PagNode.md#addaddressinedge) + +*** + +### addAddressOutEdge() + +> **addAddressOutEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:217 + +#### Parameters + +##### e + +[`AddrPagEdge`](AddrPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addAddressOutEdge`](PagNode.md#addaddressoutedge) + +*** + +### addCopyInEdge() + +> **addCopyInEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:223 + +#### Parameters + +##### e + +[`CopyPagEdge`](CopyPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addCopyInEdge`](PagNode.md#addcopyinedge) + +*** + +### addCopyOutEdge() + +> **addCopyOutEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:229 + +#### Parameters + +##### e + +[`CopyPagEdge`](CopyPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addCopyOutEdge`](PagNode.md#addcopyoutedge) + +*** + +### addFieldNode() + +> **addFieldNode**(`fieldSignature`, `nodeID`): `boolean` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:557 + +#### Parameters + +##### fieldSignature + +[`AbstractFieldRef`](AbstractFieldRef.md) + +##### nodeID + +`number` + +#### Returns + +`boolean` + +*** + +### addIncomingEdge() + +> **addIncomingEdge**(`e`): `void` + +Defined in: src/core/graph/BaseExplicitGraph.ts:110 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addIncomingEdge`](PagNode.md#addincomingedge) + +*** + +### addLoadInEdge() + +> **addLoadInEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:236 + +#### Parameters + +##### e + +[`LoadPagEdge`](LoadPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addLoadInEdge`](PagNode.md#addloadinedge) + +*** + +### addLoadOutEdge() + +> **addLoadOutEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:242 + +#### Parameters + +##### e + +[`LoadPagEdge`](LoadPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addLoadOutEdge`](PagNode.md#addloadoutedge) + +*** + +### addOutgoingEdge() + +> **addOutgoingEdge**(`e`): `void` + +Defined in: src/core/graph/BaseExplicitGraph.ts:114 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addOutgoingEdge`](PagNode.md#addoutgoingedge) + +*** + +### addPointToElement() + +> **addPointToElement**(`node`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:280 + +#### Parameters + +##### node + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addPointToElement`](PagNode.md#addpointtoelement) + +*** + +### addThisInEdge() + +> **addThisInEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:260 + +#### Parameters + +##### e + +[`ThisPagEdge`](ThisPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addThisInEdge`](PagNode.md#addthisinedge) + +*** + +### addThisOutEdge() + +> **addThisOutEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:266 + +#### Parameters + +##### e + +[`ThisPagEdge`](ThisPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addThisOutEdge`](PagNode.md#addthisoutedge) + +*** + +### addWriteInEdge() + +> **addWriteInEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:248 + +#### Parameters + +##### e + +[`WritePagEdge`](WritePagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addWriteInEdge`](PagNode.md#addwriteinedge) + +*** + +### addWriteOutEdge() + +> **addWriteOutEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:254 + +#### Parameters + +##### e + +[`LoadPagEdge`](LoadPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addWriteOutEdge`](PagNode.md#addwriteoutedge) + +*** + +### getBasePt() + +> **getBasePt**(): `number` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:152 + +#### Returns + +`number` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getBasePt`](PagNode.md#getbasept) + +*** + +### getCid() + +> **getCid**(): `number` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:160 + +#### Returns + +`number` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getCid`](PagNode.md#getcid) + +*** + +### getClonedFrom() + +> **getClonedFrom**(): `number` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:297 + +#### Returns + +`number` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getClonedFrom`](PagNode.md#getclonedfrom) + +*** + +### getDotAttr() + +> **getDotAttr**(): `string` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:305 + +#### Returns + +`string` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getDotAttr`](PagNode.md#getdotattr) + +*** + +### getDotLabel() + +> **getDotLabel**(): `string` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:326 + +#### Returns + +`string` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getDotLabel`](PagNode.md#getdotlabel) + +*** + +### getFieldNode() + +> **getFieldNode**(`fieldSignature`): `undefined` \| `number` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:565 + +#### Parameters + +##### fieldSignature + +[`AbstractFieldRef`](AbstractFieldRef.md) + +#### Returns + +`undefined` \| `number` + +*** + +### getFieldNodes() + +> **getFieldNodes**(): `undefined` \| `Map`\<`string`, `number`\> + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:569 + +#### Returns + +`undefined` \| `Map`\<`string`, `number`\> + +*** + +### getID() + +> **getID**(): `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:82 + +#### Returns + +`number` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getID`](PagNode.md#getid) + +*** + +### getIncomingCopyEdges() + +> **getIncomingCopyEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:187 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getIncomingCopyEdges`](PagNode.md#getincomingcopyedges) + +*** + +### getIncomingEdge() + +> **getIncomingEdge**(): `Set`\<[`BaseEdge`](BaseEdge.md)\> + +Defined in: src/core/graph/BaseExplicitGraph.ts:126 + +#### Returns + +`Set`\<[`BaseEdge`](BaseEdge.md)\> + +#### Inherited from + +[`PagNode`](PagNode.md).[`getIncomingEdge`](PagNode.md#getincomingedge) + +*** + +### getIncomingThisEdges() + +> **getIncomingThisEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:207 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getIncomingThisEdges`](PagNode.md#getincomingthisedges) + +*** + +### getIncomingWriteEdges() + +> **getIncomingWriteEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:199 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getIncomingWriteEdges`](PagNode.md#getincomingwriteedges) + +*** + +### getKind() + +> **getKind**(): `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:86 + +#### Returns + +`number` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getKind`](PagNode.md#getkind) + +*** + +### getOutEdges() + +> **getOutEdges**(): `object` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:288 + +#### Returns + +`object` + +##### AddressEdge + +> **AddressEdge**: `PagEdgeSet` + +##### CopyEdge + +> **CopyEdge**: `PagEdgeSet` + +##### LoadEdge + +> **LoadEdge**: `PagEdgeSet` + +##### WriteEdge + +> **WriteEdge**: `PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getOutEdges`](PagNode.md#getoutedges) + +*** + +### getOutgoingCopyEdges() + +> **getOutgoingCopyEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:183 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getOutgoingCopyEdges`](PagNode.md#getoutgoingcopyedges) + +*** + +### getOutgoingEdges() + +> **getOutgoingEdges**(): `Set`\<[`BaseEdge`](BaseEdge.md)\> + +Defined in: src/core/graph/BaseExplicitGraph.ts:130 + +#### Returns + +`Set`\<[`BaseEdge`](BaseEdge.md)\> + +#### Inherited from + +[`PagNode`](PagNode.md).[`getOutgoingEdges`](PagNode.md#getoutgoingedges) + +*** + +### getOutgoingLoadEdges() + +> **getOutgoingLoadEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:191 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getOutgoingLoadEdges`](PagNode.md#getoutgoingloadedges) + +*** + +### getOutgoingThisEdges() + +> **getOutgoingThisEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:203 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getOutgoingThisEdges`](PagNode.md#getoutgoingthisedges) + +*** + +### getOutgoingWriteEdges() + +> **getOutgoingWriteEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:195 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getOutgoingWriteEdges`](PagNode.md#getoutgoingwriteedges) + +*** + +### getPointTo() + +> **getPointTo**(): `Set`\<`number`\> + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:276 + +#### Returns + +`Set`\<`number`\> + +#### Inherited from + +[`PagNode`](PagNode.md).[`getPointTo`](PagNode.md#getpointto) + +*** + +### getStmt() + +> **getStmt**(): `undefined` \| [`Stmt`](Stmt.md) + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:175 + +#### Returns + +`undefined` \| [`Stmt`](Stmt.md) + +#### Inherited from + +[`PagNode`](PagNode.md).[`getStmt`](PagNode.md#getstmt) + +*** + +### getValue() + +> **getValue**(): [`Value`](../interfaces/Value.md) + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:272 + +#### Returns + +[`Value`](../interfaces/Value.md) + +#### Inherited from + +[`PagNode`](PagNode.md).[`getValue`](PagNode.md#getvalue) + +*** + +### hasIncomingEdge() + +> **hasIncomingEdge**(`e`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:102 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`hasIncomingEdge`](PagNode.md#hasincomingedge) + +*** + +### hasIncomingEdges() + +> **hasIncomingEdges**(): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:94 + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`hasIncomingEdges`](PagNode.md#hasincomingedges) + +*** + +### hasOutgoingCopyEdge() + +> **hasOutgoingCopyEdge**(): `boolean` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:179 + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`hasOutgoingCopyEdge`](PagNode.md#hasoutgoingcopyedge) + +*** + +### hasOutgoingEdge() + +> **hasOutgoingEdge**(`e`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:106 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`hasOutgoingEdge`](PagNode.md#hasoutgoingedge) + +*** + +### hasOutgoingEdges() + +> **hasOutgoingEdges**(): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:98 + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`hasOutgoingEdges`](PagNode.md#hasoutgoingedges) + +*** + +### removeIncomingEdge() + +> **removeIncomingEdge**(`e`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:118 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`removeIncomingEdge`](PagNode.md#removeincomingedge) + +*** + +### removeOutgoingEdge() + +> **removeOutgoingEdge**(`e`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:122 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`removeOutgoingEdge`](PagNode.md#removeoutgoingedge) + +*** + +### setBasePt() + +> **setBasePt**(`pt`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:156 + +#### Parameters + +##### pt + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`setBasePt`](PagNode.md#setbasept) + +*** + +### setCid() + +> **setCid**(`cid`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:167 + +#### Parameters + +##### cid + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`setCid`](PagNode.md#setcid) + +*** + +### setClonedFrom() + +> **setClonedFrom**(`id`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:301 + +#### Parameters + +##### id + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`setClonedFrom`](PagNode.md#setclonedfrom) + +*** + +### setKind() + +> **setKind**(`kind`): `void` + +Defined in: src/core/graph/BaseExplicitGraph.ts:90 + +#### Parameters + +##### kind + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`setKind`](PagNode.md#setkind) + +*** + +### setPointTo() + +> **setPointTo**(`pts`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:284 + +#### Parameters + +##### pts + +`Set`\<`number`\> + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`setPointTo`](PagNode.md#setpointto) + +*** + +### setStmt() + +> **setStmt**(`s`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:171 + +#### Parameters + +##### s + +[`Stmt`](Stmt.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`setStmt`](PagNode.md#setstmt) diff --git a/docs/api_docs/classes/PagInstanceFieldNode.md b/docs/api_docs/classes/PagInstanceFieldNode.md new file mode 100644 index 0000000000000000000000000000000000000000..7ceaad6d37e99996e486838e2ff9a7d264accb7c --- /dev/null +++ b/docs/api_docs/classes/PagInstanceFieldNode.md @@ -0,0 +1,973 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / PagInstanceFieldNode + +# Class: PagInstanceFieldNode + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:420 + +## Extends + +- [`PagNode`](PagNode.md) + +## Constructors + +### new PagInstanceFieldNode() + +> **new PagInstanceFieldNode**(`id`, `cid`, `instanceFieldRef`, `stmt`?): [`PagInstanceFieldNode`](PagInstanceFieldNode.md) + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:421 + +#### Parameters + +##### id + +`number` + +##### cid + +`undefined` | `number` + +##### instanceFieldRef + +[`ArkInstanceFieldRef`](ArkInstanceFieldRef.md) + +##### stmt? + +[`Stmt`](Stmt.md) + +#### Returns + +[`PagInstanceFieldNode`](PagInstanceFieldNode.md) + +#### Overrides + +[`PagNode`](PagNode.md).[`constructor`](PagNode.md#constructors) + +## Properties + +### basePt + +> `protected` **basePt**: `number` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:141 + +#### Inherited from + +[`PagNode`](PagNode.md).[`basePt`](PagNode.md#basept) + +*** + +### clonedFrom + +> `protected` **clonedFrom**: `number` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:142 + +#### Inherited from + +[`PagNode`](PagNode.md).[`clonedFrom`](PagNode.md#clonedfrom) + +*** + +### kind + +> `protected` **kind**: `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:73 + +#### Inherited from + +[`PagNode`](PagNode.md).[`kind`](PagNode.md#kind) + +## Methods + +### addAddressInEdge() + +> **addAddressInEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:211 + +#### Parameters + +##### e + +[`AddrPagEdge`](AddrPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addAddressInEdge`](PagNode.md#addaddressinedge) + +*** + +### addAddressOutEdge() + +> **addAddressOutEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:217 + +#### Parameters + +##### e + +[`AddrPagEdge`](AddrPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addAddressOutEdge`](PagNode.md#addaddressoutedge) + +*** + +### addCopyInEdge() + +> **addCopyInEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:223 + +#### Parameters + +##### e + +[`CopyPagEdge`](CopyPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addCopyInEdge`](PagNode.md#addcopyinedge) + +*** + +### addCopyOutEdge() + +> **addCopyOutEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:229 + +#### Parameters + +##### e + +[`CopyPagEdge`](CopyPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addCopyOutEdge`](PagNode.md#addcopyoutedge) + +*** + +### addIncomingEdge() + +> **addIncomingEdge**(`e`): `void` + +Defined in: src/core/graph/BaseExplicitGraph.ts:110 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addIncomingEdge`](PagNode.md#addincomingedge) + +*** + +### addLoadInEdge() + +> **addLoadInEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:236 + +#### Parameters + +##### e + +[`LoadPagEdge`](LoadPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addLoadInEdge`](PagNode.md#addloadinedge) + +*** + +### addLoadOutEdge() + +> **addLoadOutEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:242 + +#### Parameters + +##### e + +[`LoadPagEdge`](LoadPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addLoadOutEdge`](PagNode.md#addloadoutedge) + +*** + +### addOutgoingEdge() + +> **addOutgoingEdge**(`e`): `void` + +Defined in: src/core/graph/BaseExplicitGraph.ts:114 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addOutgoingEdge`](PagNode.md#addoutgoingedge) + +*** + +### addPointToElement() + +> **addPointToElement**(`node`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:280 + +#### Parameters + +##### node + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addPointToElement`](PagNode.md#addpointtoelement) + +*** + +### addThisInEdge() + +> **addThisInEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:260 + +#### Parameters + +##### e + +[`ThisPagEdge`](ThisPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addThisInEdge`](PagNode.md#addthisinedge) + +*** + +### addThisOutEdge() + +> **addThisOutEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:266 + +#### Parameters + +##### e + +[`ThisPagEdge`](ThisPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addThisOutEdge`](PagNode.md#addthisoutedge) + +*** + +### addWriteInEdge() + +> **addWriteInEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:248 + +#### Parameters + +##### e + +[`WritePagEdge`](WritePagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addWriteInEdge`](PagNode.md#addwriteinedge) + +*** + +### addWriteOutEdge() + +> **addWriteOutEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:254 + +#### Parameters + +##### e + +[`LoadPagEdge`](LoadPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addWriteOutEdge`](PagNode.md#addwriteoutedge) + +*** + +### getBasePt() + +> **getBasePt**(): `number` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:152 + +#### Returns + +`number` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getBasePt`](PagNode.md#getbasept) + +*** + +### getCid() + +> **getCid**(): `number` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:160 + +#### Returns + +`number` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getCid`](PagNode.md#getcid) + +*** + +### getClonedFrom() + +> **getClonedFrom**(): `number` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:297 + +#### Returns + +`number` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getClonedFrom`](PagNode.md#getclonedfrom) + +*** + +### getDotAttr() + +> **getDotAttr**(): `string` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:305 + +#### Returns + +`string` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getDotAttr`](PagNode.md#getdotattr) + +*** + +### getDotLabel() + +> **getDotLabel**(): `string` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:326 + +#### Returns + +`string` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getDotLabel`](PagNode.md#getdotlabel) + +*** + +### getID() + +> **getID**(): `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:82 + +#### Returns + +`number` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getID`](PagNode.md#getid) + +*** + +### getIncomingCopyEdges() + +> **getIncomingCopyEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:187 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getIncomingCopyEdges`](PagNode.md#getincomingcopyedges) + +*** + +### getIncomingEdge() + +> **getIncomingEdge**(): `Set`\<[`BaseEdge`](BaseEdge.md)\> + +Defined in: src/core/graph/BaseExplicitGraph.ts:126 + +#### Returns + +`Set`\<[`BaseEdge`](BaseEdge.md)\> + +#### Inherited from + +[`PagNode`](PagNode.md).[`getIncomingEdge`](PagNode.md#getincomingedge) + +*** + +### getIncomingThisEdges() + +> **getIncomingThisEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:207 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getIncomingThisEdges`](PagNode.md#getincomingthisedges) + +*** + +### getIncomingWriteEdges() + +> **getIncomingWriteEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:199 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getIncomingWriteEdges`](PagNode.md#getincomingwriteedges) + +*** + +### getKind() + +> **getKind**(): `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:86 + +#### Returns + +`number` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getKind`](PagNode.md#getkind) + +*** + +### getOutEdges() + +> **getOutEdges**(): `object` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:288 + +#### Returns + +`object` + +##### AddressEdge + +> **AddressEdge**: `PagEdgeSet` + +##### CopyEdge + +> **CopyEdge**: `PagEdgeSet` + +##### LoadEdge + +> **LoadEdge**: `PagEdgeSet` + +##### WriteEdge + +> **WriteEdge**: `PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getOutEdges`](PagNode.md#getoutedges) + +*** + +### getOutgoingCopyEdges() + +> **getOutgoingCopyEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:183 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getOutgoingCopyEdges`](PagNode.md#getoutgoingcopyedges) + +*** + +### getOutgoingEdges() + +> **getOutgoingEdges**(): `Set`\<[`BaseEdge`](BaseEdge.md)\> + +Defined in: src/core/graph/BaseExplicitGraph.ts:130 + +#### Returns + +`Set`\<[`BaseEdge`](BaseEdge.md)\> + +#### Inherited from + +[`PagNode`](PagNode.md).[`getOutgoingEdges`](PagNode.md#getoutgoingedges) + +*** + +### getOutgoingLoadEdges() + +> **getOutgoingLoadEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:191 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getOutgoingLoadEdges`](PagNode.md#getoutgoingloadedges) + +*** + +### getOutgoingThisEdges() + +> **getOutgoingThisEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:203 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getOutgoingThisEdges`](PagNode.md#getoutgoingthisedges) + +*** + +### getOutgoingWriteEdges() + +> **getOutgoingWriteEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:195 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getOutgoingWriteEdges`](PagNode.md#getoutgoingwriteedges) + +*** + +### getPointTo() + +> **getPointTo**(): `Set`\<`number`\> + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:276 + +#### Returns + +`Set`\<`number`\> + +#### Inherited from + +[`PagNode`](PagNode.md).[`getPointTo`](PagNode.md#getpointto) + +*** + +### getStmt() + +> **getStmt**(): `undefined` \| [`Stmt`](Stmt.md) + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:175 + +#### Returns + +`undefined` \| [`Stmt`](Stmt.md) + +#### Inherited from + +[`PagNode`](PagNode.md).[`getStmt`](PagNode.md#getstmt) + +*** + +### getValue() + +> **getValue**(): [`Value`](../interfaces/Value.md) + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:272 + +#### Returns + +[`Value`](../interfaces/Value.md) + +#### Inherited from + +[`PagNode`](PagNode.md).[`getValue`](PagNode.md#getvalue) + +*** + +### hasIncomingEdge() + +> **hasIncomingEdge**(`e`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:102 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`hasIncomingEdge`](PagNode.md#hasincomingedge) + +*** + +### hasIncomingEdges() + +> **hasIncomingEdges**(): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:94 + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`hasIncomingEdges`](PagNode.md#hasincomingedges) + +*** + +### hasOutgoingCopyEdge() + +> **hasOutgoingCopyEdge**(): `boolean` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:179 + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`hasOutgoingCopyEdge`](PagNode.md#hasoutgoingcopyedge) + +*** + +### hasOutgoingEdge() + +> **hasOutgoingEdge**(`e`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:106 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`hasOutgoingEdge`](PagNode.md#hasoutgoingedge) + +*** + +### hasOutgoingEdges() + +> **hasOutgoingEdges**(): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:98 + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`hasOutgoingEdges`](PagNode.md#hasoutgoingedges) + +*** + +### removeIncomingEdge() + +> **removeIncomingEdge**(`e`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:118 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`removeIncomingEdge`](PagNode.md#removeincomingedge) + +*** + +### removeOutgoingEdge() + +> **removeOutgoingEdge**(`e`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:122 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`removeOutgoingEdge`](PagNode.md#removeoutgoingedge) + +*** + +### setBasePt() + +> **setBasePt**(`pt`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:156 + +#### Parameters + +##### pt + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`setBasePt`](PagNode.md#setbasept) + +*** + +### setCid() + +> **setCid**(`cid`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:167 + +#### Parameters + +##### cid + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`setCid`](PagNode.md#setcid) + +*** + +### setClonedFrom() + +> **setClonedFrom**(`id`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:301 + +#### Parameters + +##### id + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`setClonedFrom`](PagNode.md#setclonedfrom) + +*** + +### setKind() + +> **setKind**(`kind`): `void` + +Defined in: src/core/graph/BaseExplicitGraph.ts:90 + +#### Parameters + +##### kind + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`setKind`](PagNode.md#setkind) + +*** + +### setPointTo() + +> **setPointTo**(`pts`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:284 + +#### Parameters + +##### pts + +`Set`\<`number`\> + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`setPointTo`](PagNode.md#setpointto) + +*** + +### setStmt() + +> **setStmt**(`s`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:171 + +#### Parameters + +##### s + +[`Stmt`](Stmt.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`setStmt`](PagNode.md#setstmt) diff --git a/docs/api_docs/classes/PagLocalNode.md b/docs/api_docs/classes/PagLocalNode.md new file mode 100644 index 0000000000000000000000000000000000000000..6b6c0e20786d40c674f18df2b3513e2cc46a831d --- /dev/null +++ b/docs/api_docs/classes/PagLocalNode.md @@ -0,0 +1,1111 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / PagLocalNode + +# Class: PagLocalNode + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:361 + +## Extends + +- [`PagNode`](PagNode.md) + +## Constructors + +### new PagLocalNode() + +> **new PagLocalNode**(`id`, `cid`, `value`, `stmt`?): [`PagLocalNode`](PagLocalNode.md) + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:370 + +#### Parameters + +##### id + +`number` + +##### cid + +`undefined` | `number` + +##### value + +[`Local`](Local.md) + +##### stmt? + +[`Stmt`](Stmt.md) + +#### Returns + +[`PagLocalNode`](PagLocalNode.md) + +#### Overrides + +[`PagNode`](PagNode.md).[`constructor`](PagNode.md#constructors) + +## Properties + +### basePt + +> `protected` **basePt**: `number` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:141 + +#### Inherited from + +[`PagNode`](PagNode.md).[`basePt`](PagNode.md#basept) + +*** + +### clonedFrom + +> `protected` **clonedFrom**: `number` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:142 + +#### Inherited from + +[`PagNode`](PagNode.md).[`clonedFrom`](PagNode.md#clonedfrom) + +*** + +### kind + +> `protected` **kind**: `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:73 + +#### Inherited from + +[`PagNode`](PagNode.md).[`kind`](PagNode.md#kind) + +## Methods + +### addAddressInEdge() + +> **addAddressInEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:211 + +#### Parameters + +##### e + +[`AddrPagEdge`](AddrPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addAddressInEdge`](PagNode.md#addaddressinedge) + +*** + +### addAddressOutEdge() + +> **addAddressOutEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:217 + +#### Parameters + +##### e + +[`AddrPagEdge`](AddrPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addAddressOutEdge`](PagNode.md#addaddressoutedge) + +*** + +### addCopyInEdge() + +> **addCopyInEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:223 + +#### Parameters + +##### e + +[`CopyPagEdge`](CopyPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addCopyInEdge`](PagNode.md#addcopyinedge) + +*** + +### addCopyOutEdge() + +> **addCopyOutEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:229 + +#### Parameters + +##### e + +[`CopyPagEdge`](CopyPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addCopyOutEdge`](PagNode.md#addcopyoutedge) + +*** + +### addIncomingEdge() + +> **addIncomingEdge**(`e`): `void` + +Defined in: src/core/graph/BaseExplicitGraph.ts:110 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addIncomingEdge`](PagNode.md#addincomingedge) + +*** + +### addLoadInEdge() + +> **addLoadInEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:236 + +#### Parameters + +##### e + +[`LoadPagEdge`](LoadPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addLoadInEdge`](PagNode.md#addloadinedge) + +*** + +### addLoadOutEdge() + +> **addLoadOutEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:242 + +#### Parameters + +##### e + +[`LoadPagEdge`](LoadPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addLoadOutEdge`](PagNode.md#addloadoutedge) + +*** + +### addOutgoingEdge() + +> **addOutgoingEdge**(`e`): `void` + +Defined in: src/core/graph/BaseExplicitGraph.ts:114 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addOutgoingEdge`](PagNode.md#addoutgoingedge) + +*** + +### addPointToElement() + +> **addPointToElement**(`node`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:280 + +#### Parameters + +##### node + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addPointToElement`](PagNode.md#addpointtoelement) + +*** + +### addRelatedDynCallSite() + +> **addRelatedDynCallSite**(`cs`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:374 + +#### Parameters + +##### cs + +[`DynCallSite`](DynCallSite.md) + +#### Returns + +`void` + +*** + +### addRelatedUnknownCallSite() + +> **addRelatedUnknownCallSite**(`cs`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:384 + +#### Parameters + +##### cs + +[`CallSite`](CallSite.md) + +#### Returns + +`void` + +*** + +### addThisInEdge() + +> **addThisInEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:260 + +#### Parameters + +##### e + +[`ThisPagEdge`](ThisPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addThisInEdge`](PagNode.md#addthisinedge) + +*** + +### addThisOutEdge() + +> **addThisOutEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:266 + +#### Parameters + +##### e + +[`ThisPagEdge`](ThisPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addThisOutEdge`](PagNode.md#addthisoutedge) + +*** + +### addWriteInEdge() + +> **addWriteInEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:248 + +#### Parameters + +##### e + +[`WritePagEdge`](WritePagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addWriteInEdge`](PagNode.md#addwriteinedge) + +*** + +### addWriteOutEdge() + +> **addWriteOutEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:254 + +#### Parameters + +##### e + +[`LoadPagEdge`](LoadPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addWriteOutEdge`](PagNode.md#addwriteoutedge) + +*** + +### getBasePt() + +> **getBasePt**(): `number` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:152 + +#### Returns + +`number` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getBasePt`](PagNode.md#getbasept) + +*** + +### getCid() + +> **getCid**(): `number` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:160 + +#### Returns + +`number` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getCid`](PagNode.md#getcid) + +*** + +### getClonedFrom() + +> **getClonedFrom**(): `number` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:297 + +#### Returns + +`number` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getClonedFrom`](PagNode.md#getclonedfrom) + +*** + +### getDotAttr() + +> **getDotAttr**(): `string` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:305 + +#### Returns + +`string` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getDotAttr`](PagNode.md#getdotattr) + +*** + +### getDotLabel() + +> **getDotLabel**(): `string` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:326 + +#### Returns + +`string` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getDotLabel`](PagNode.md#getdotlabel) + +*** + +### getID() + +> **getID**(): `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:82 + +#### Returns + +`number` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getID`](PagNode.md#getid) + +*** + +### getIncomingCopyEdges() + +> **getIncomingCopyEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:187 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getIncomingCopyEdges`](PagNode.md#getincomingcopyedges) + +*** + +### getIncomingEdge() + +> **getIncomingEdge**(): `Set`\<[`BaseEdge`](BaseEdge.md)\> + +Defined in: src/core/graph/BaseExplicitGraph.ts:126 + +#### Returns + +`Set`\<[`BaseEdge`](BaseEdge.md)\> + +#### Inherited from + +[`PagNode`](PagNode.md).[`getIncomingEdge`](PagNode.md#getincomingedge) + +*** + +### getIncomingThisEdges() + +> **getIncomingThisEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:207 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getIncomingThisEdges`](PagNode.md#getincomingthisedges) + +*** + +### getIncomingWriteEdges() + +> **getIncomingWriteEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:199 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getIncomingWriteEdges`](PagNode.md#getincomingwriteedges) + +*** + +### getKind() + +> **getKind**(): `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:86 + +#### Returns + +`number` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getKind`](PagNode.md#getkind) + +*** + +### getOutEdges() + +> **getOutEdges**(): `object` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:288 + +#### Returns + +`object` + +##### AddressEdge + +> **AddressEdge**: `PagEdgeSet` + +##### CopyEdge + +> **CopyEdge**: `PagEdgeSet` + +##### LoadEdge + +> **LoadEdge**: `PagEdgeSet` + +##### WriteEdge + +> **WriteEdge**: `PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getOutEdges`](PagNode.md#getoutedges) + +*** + +### getOutgoingCopyEdges() + +> **getOutgoingCopyEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:183 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getOutgoingCopyEdges`](PagNode.md#getoutgoingcopyedges) + +*** + +### getOutgoingEdges() + +> **getOutgoingEdges**(): `Set`\<[`BaseEdge`](BaseEdge.md)\> + +Defined in: src/core/graph/BaseExplicitGraph.ts:130 + +#### Returns + +`Set`\<[`BaseEdge`](BaseEdge.md)\> + +#### Inherited from + +[`PagNode`](PagNode.md).[`getOutgoingEdges`](PagNode.md#getoutgoingedges) + +*** + +### getOutgoingLoadEdges() + +> **getOutgoingLoadEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:191 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getOutgoingLoadEdges`](PagNode.md#getoutgoingloadedges) + +*** + +### getOutgoingThisEdges() + +> **getOutgoingThisEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:203 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getOutgoingThisEdges`](PagNode.md#getoutgoingthisedges) + +*** + +### getOutgoingWriteEdges() + +> **getOutgoingWriteEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:195 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getOutgoingWriteEdges`](PagNode.md#getoutgoingwriteedges) + +*** + +### getPointTo() + +> **getPointTo**(): `Set`\<`number`\> + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:276 + +#### Returns + +`Set`\<`number`\> + +#### Inherited from + +[`PagNode`](PagNode.md).[`getPointTo`](PagNode.md#getpointto) + +*** + +### getRelatedDynCallSites() + +> **getRelatedDynCallSites**(): `Set`\<[`DynCallSite`](DynCallSite.md)\> + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:380 + +#### Returns + +`Set`\<[`DynCallSite`](DynCallSite.md)\> + +*** + +### getRelatedUnknownCallSites() + +> **getRelatedUnknownCallSites**(): `Set`\<[`CallSite`](CallSite.md)\> + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:390 + +#### Returns + +`Set`\<[`CallSite`](CallSite.md)\> + +*** + +### getStmt() + +> **getStmt**(): `undefined` \| [`Stmt`](Stmt.md) + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:175 + +#### Returns + +`undefined` \| [`Stmt`](Stmt.md) + +#### Inherited from + +[`PagNode`](PagNode.md).[`getStmt`](PagNode.md#getstmt) + +*** + +### getStorage() + +> **getStorage**(): `object` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:400 + +#### Returns + +`object` + +##### PropertyName + +> **PropertyName**: `string` + +##### StorageType + +> **StorageType**: [`StorageType`](../enumerations/StorageType.md) + +*** + +### getValue() + +> **getValue**(): [`Value`](../interfaces/Value.md) + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:272 + +#### Returns + +[`Value`](../interfaces/Value.md) + +#### Inherited from + +[`PagNode`](PagNode.md).[`getValue`](PagNode.md#getvalue) + +*** + +### hasIncomingEdge() + +> **hasIncomingEdge**(`e`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:102 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`hasIncomingEdge`](PagNode.md#hasincomingedge) + +*** + +### hasIncomingEdges() + +> **hasIncomingEdges**(): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:94 + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`hasIncomingEdges`](PagNode.md#hasincomingedges) + +*** + +### hasOutgoingCopyEdge() + +> **hasOutgoingCopyEdge**(): `boolean` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:179 + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`hasOutgoingCopyEdge`](PagNode.md#hasoutgoingcopyedge) + +*** + +### hasOutgoingEdge() + +> **hasOutgoingEdge**(`e`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:106 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`hasOutgoingEdge`](PagNode.md#hasoutgoingedge) + +*** + +### hasOutgoingEdges() + +> **hasOutgoingEdges**(): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:98 + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`hasOutgoingEdges`](PagNode.md#hasoutgoingedges) + +*** + +### isSdkParam() + +> **isSdkParam**(): `boolean` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:415 + +#### Returns + +`boolean` + +*** + +### isStorageLinked() + +> **isStorageLinked**(): `boolean` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:407 + +#### Returns + +`boolean` + +*** + +### removeIncomingEdge() + +> **removeIncomingEdge**(`e`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:118 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`removeIncomingEdge`](PagNode.md#removeincomingedge) + +*** + +### removeOutgoingEdge() + +> **removeOutgoingEdge**(`e`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:122 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`removeOutgoingEdge`](PagNode.md#removeoutgoingedge) + +*** + +### setBasePt() + +> **setBasePt**(`pt`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:156 + +#### Parameters + +##### pt + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`setBasePt`](PagNode.md#setbasept) + +*** + +### setCid() + +> **setCid**(`cid`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:167 + +#### Parameters + +##### cid + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`setCid`](PagNode.md#setcid) + +*** + +### setClonedFrom() + +> **setClonedFrom**(`id`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:301 + +#### Parameters + +##### id + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`setClonedFrom`](PagNode.md#setclonedfrom) + +*** + +### setKind() + +> **setKind**(`kind`): `void` + +Defined in: src/core/graph/BaseExplicitGraph.ts:90 + +#### Parameters + +##### kind + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`setKind`](PagNode.md#setkind) + +*** + +### setPointTo() + +> **setPointTo**(`pts`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:284 + +#### Parameters + +##### pts + +`Set`\<`number`\> + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`setPointTo`](PagNode.md#setpointto) + +*** + +### setSdkParam() + +> **setSdkParam**(): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:411 + +#### Returns + +`void` + +*** + +### setStmt() + +> **setStmt**(`s`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:171 + +#### Parameters + +##### s + +[`Stmt`](Stmt.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`setStmt`](PagNode.md#setstmt) + +*** + +### setStorageLink() + +> **setStorageLink**(`storageType`, `propertyName`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:394 + +#### Parameters + +##### storageType + +[`StorageType`](../enumerations/StorageType.md) + +##### propertyName + +`string` + +#### Returns + +`void` diff --git a/docs/api_docs/classes/PagNewContainerExprNode.md b/docs/api_docs/classes/PagNewContainerExprNode.md new file mode 100644 index 0000000000000000000000000000000000000000..0d7d86db33293438fc06c44bf0616f7accb710e8 --- /dev/null +++ b/docs/api_docs/classes/PagNewContainerExprNode.md @@ -0,0 +1,1011 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / PagNewContainerExprNode + +# Class: PagNewContainerExprNode + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:496 + +## Extends + +- [`PagNode`](PagNode.md) + +## Constructors + +### new PagNewContainerExprNode() + +> **new PagNewContainerExprNode**(`id`, `cid`, `expr`, `stmt`?): [`PagNewContainerExprNode`](PagNewContainerExprNode.md) + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:500 + +#### Parameters + +##### id + +`number` + +##### cid + +`undefined` | `number` + +##### expr + +[`Value`](../interfaces/Value.md) + +##### stmt? + +[`Stmt`](Stmt.md) + +#### Returns + +[`PagNewContainerExprNode`](PagNewContainerExprNode.md) + +#### Overrides + +[`PagNode`](PagNode.md).[`constructor`](PagNode.md#constructors) + +## Properties + +### basePt + +> `protected` **basePt**: `number` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:141 + +#### Inherited from + +[`PagNode`](PagNode.md).[`basePt`](PagNode.md#basept) + +*** + +### clonedFrom + +> `protected` **clonedFrom**: `number` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:142 + +#### Inherited from + +[`PagNode`](PagNode.md).[`clonedFrom`](PagNode.md#clonedfrom) + +*** + +### elementNode + +> **elementNode**: `undefined` \| `number` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:498 + +*** + +### kind + +> `protected` **kind**: `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:73 + +#### Inherited from + +[`PagNode`](PagNode.md).[`kind`](PagNode.md#kind) + +## Methods + +### addAddressInEdge() + +> **addAddressInEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:211 + +#### Parameters + +##### e + +[`AddrPagEdge`](AddrPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addAddressInEdge`](PagNode.md#addaddressinedge) + +*** + +### addAddressOutEdge() + +> **addAddressOutEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:217 + +#### Parameters + +##### e + +[`AddrPagEdge`](AddrPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addAddressOutEdge`](PagNode.md#addaddressoutedge) + +*** + +### addCopyInEdge() + +> **addCopyInEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:223 + +#### Parameters + +##### e + +[`CopyPagEdge`](CopyPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addCopyInEdge`](PagNode.md#addcopyinedge) + +*** + +### addCopyOutEdge() + +> **addCopyOutEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:229 + +#### Parameters + +##### e + +[`CopyPagEdge`](CopyPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addCopyOutEdge`](PagNode.md#addcopyoutedge) + +*** + +### addElementNode() + +> **addElementNode**(`nodeID`): `boolean` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:504 + +#### Parameters + +##### nodeID + +`number` + +#### Returns + +`boolean` + +*** + +### addIncomingEdge() + +> **addIncomingEdge**(`e`): `void` + +Defined in: src/core/graph/BaseExplicitGraph.ts:110 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addIncomingEdge`](PagNode.md#addincomingedge) + +*** + +### addLoadInEdge() + +> **addLoadInEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:236 + +#### Parameters + +##### e + +[`LoadPagEdge`](LoadPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addLoadInEdge`](PagNode.md#addloadinedge) + +*** + +### addLoadOutEdge() + +> **addLoadOutEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:242 + +#### Parameters + +##### e + +[`LoadPagEdge`](LoadPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addLoadOutEdge`](PagNode.md#addloadoutedge) + +*** + +### addOutgoingEdge() + +> **addOutgoingEdge**(`e`): `void` + +Defined in: src/core/graph/BaseExplicitGraph.ts:114 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addOutgoingEdge`](PagNode.md#addoutgoingedge) + +*** + +### addPointToElement() + +> **addPointToElement**(`node`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:280 + +#### Parameters + +##### node + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addPointToElement`](PagNode.md#addpointtoelement) + +*** + +### addThisInEdge() + +> **addThisInEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:260 + +#### Parameters + +##### e + +[`ThisPagEdge`](ThisPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addThisInEdge`](PagNode.md#addthisinedge) + +*** + +### addThisOutEdge() + +> **addThisOutEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:266 + +#### Parameters + +##### e + +[`ThisPagEdge`](ThisPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addThisOutEdge`](PagNode.md#addthisoutedge) + +*** + +### addWriteInEdge() + +> **addWriteInEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:248 + +#### Parameters + +##### e + +[`WritePagEdge`](WritePagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addWriteInEdge`](PagNode.md#addwriteinedge) + +*** + +### addWriteOutEdge() + +> **addWriteOutEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:254 + +#### Parameters + +##### e + +[`LoadPagEdge`](LoadPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addWriteOutEdge`](PagNode.md#addwriteoutedge) + +*** + +### getBasePt() + +> **getBasePt**(): `number` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:152 + +#### Returns + +`number` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getBasePt`](PagNode.md#getbasept) + +*** + +### getCid() + +> **getCid**(): `number` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:160 + +#### Returns + +`number` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getCid`](PagNode.md#getcid) + +*** + +### getClonedFrom() + +> **getClonedFrom**(): `number` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:297 + +#### Returns + +`number` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getClonedFrom`](PagNode.md#getclonedfrom) + +*** + +### getDotAttr() + +> **getDotAttr**(): `string` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:305 + +#### Returns + +`string` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getDotAttr`](PagNode.md#getdotattr) + +*** + +### getDotLabel() + +> **getDotLabel**(): `string` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:326 + +#### Returns + +`string` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getDotLabel`](PagNode.md#getdotlabel) + +*** + +### getElementNode() + +> **getElementNode**(): `undefined` \| `number` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:512 + +#### Returns + +`undefined` \| `number` + +*** + +### getID() + +> **getID**(): `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:82 + +#### Returns + +`number` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getID`](PagNode.md#getid) + +*** + +### getIncomingCopyEdges() + +> **getIncomingCopyEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:187 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getIncomingCopyEdges`](PagNode.md#getincomingcopyedges) + +*** + +### getIncomingEdge() + +> **getIncomingEdge**(): `Set`\<[`BaseEdge`](BaseEdge.md)\> + +Defined in: src/core/graph/BaseExplicitGraph.ts:126 + +#### Returns + +`Set`\<[`BaseEdge`](BaseEdge.md)\> + +#### Inherited from + +[`PagNode`](PagNode.md).[`getIncomingEdge`](PagNode.md#getincomingedge) + +*** + +### getIncomingThisEdges() + +> **getIncomingThisEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:207 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getIncomingThisEdges`](PagNode.md#getincomingthisedges) + +*** + +### getIncomingWriteEdges() + +> **getIncomingWriteEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:199 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getIncomingWriteEdges`](PagNode.md#getincomingwriteedges) + +*** + +### getKind() + +> **getKind**(): `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:86 + +#### Returns + +`number` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getKind`](PagNode.md#getkind) + +*** + +### getOutEdges() + +> **getOutEdges**(): `object` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:288 + +#### Returns + +`object` + +##### AddressEdge + +> **AddressEdge**: `PagEdgeSet` + +##### CopyEdge + +> **CopyEdge**: `PagEdgeSet` + +##### LoadEdge + +> **LoadEdge**: `PagEdgeSet` + +##### WriteEdge + +> **WriteEdge**: `PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getOutEdges`](PagNode.md#getoutedges) + +*** + +### getOutgoingCopyEdges() + +> **getOutgoingCopyEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:183 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getOutgoingCopyEdges`](PagNode.md#getoutgoingcopyedges) + +*** + +### getOutgoingEdges() + +> **getOutgoingEdges**(): `Set`\<[`BaseEdge`](BaseEdge.md)\> + +Defined in: src/core/graph/BaseExplicitGraph.ts:130 + +#### Returns + +`Set`\<[`BaseEdge`](BaseEdge.md)\> + +#### Inherited from + +[`PagNode`](PagNode.md).[`getOutgoingEdges`](PagNode.md#getoutgoingedges) + +*** + +### getOutgoingLoadEdges() + +> **getOutgoingLoadEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:191 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getOutgoingLoadEdges`](PagNode.md#getoutgoingloadedges) + +*** + +### getOutgoingThisEdges() + +> **getOutgoingThisEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:203 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getOutgoingThisEdges`](PagNode.md#getoutgoingthisedges) + +*** + +### getOutgoingWriteEdges() + +> **getOutgoingWriteEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:195 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getOutgoingWriteEdges`](PagNode.md#getoutgoingwriteedges) + +*** + +### getPointTo() + +> **getPointTo**(): `Set`\<`number`\> + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:276 + +#### Returns + +`Set`\<`number`\> + +#### Inherited from + +[`PagNode`](PagNode.md).[`getPointTo`](PagNode.md#getpointto) + +*** + +### getStmt() + +> **getStmt**(): `undefined` \| [`Stmt`](Stmt.md) + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:175 + +#### Returns + +`undefined` \| [`Stmt`](Stmt.md) + +#### Inherited from + +[`PagNode`](PagNode.md).[`getStmt`](PagNode.md#getstmt) + +*** + +### getValue() + +> **getValue**(): [`Value`](../interfaces/Value.md) + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:272 + +#### Returns + +[`Value`](../interfaces/Value.md) + +#### Inherited from + +[`PagNode`](PagNode.md).[`getValue`](PagNode.md#getvalue) + +*** + +### hasIncomingEdge() + +> **hasIncomingEdge**(`e`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:102 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`hasIncomingEdge`](PagNode.md#hasincomingedge) + +*** + +### hasIncomingEdges() + +> **hasIncomingEdges**(): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:94 + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`hasIncomingEdges`](PagNode.md#hasincomingedges) + +*** + +### hasOutgoingCopyEdge() + +> **hasOutgoingCopyEdge**(): `boolean` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:179 + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`hasOutgoingCopyEdge`](PagNode.md#hasoutgoingcopyedge) + +*** + +### hasOutgoingEdge() + +> **hasOutgoingEdge**(`e`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:106 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`hasOutgoingEdge`](PagNode.md#hasoutgoingedge) + +*** + +### hasOutgoingEdges() + +> **hasOutgoingEdges**(): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:98 + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`hasOutgoingEdges`](PagNode.md#hasoutgoingedges) + +*** + +### removeIncomingEdge() + +> **removeIncomingEdge**(`e`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:118 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`removeIncomingEdge`](PagNode.md#removeincomingedge) + +*** + +### removeOutgoingEdge() + +> **removeOutgoingEdge**(`e`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:122 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`removeOutgoingEdge`](PagNode.md#removeoutgoingedge) + +*** + +### setBasePt() + +> **setBasePt**(`pt`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:156 + +#### Parameters + +##### pt + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`setBasePt`](PagNode.md#setbasept) + +*** + +### setCid() + +> **setCid**(`cid`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:167 + +#### Parameters + +##### cid + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`setCid`](PagNode.md#setcid) + +*** + +### setClonedFrom() + +> **setClonedFrom**(`id`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:301 + +#### Parameters + +##### id + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`setClonedFrom`](PagNode.md#setclonedfrom) + +*** + +### setKind() + +> **setKind**(`kind`): `void` + +Defined in: src/core/graph/BaseExplicitGraph.ts:90 + +#### Parameters + +##### kind + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`setKind`](PagNode.md#setkind) + +*** + +### setPointTo() + +> **setPointTo**(`pts`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:284 + +#### Parameters + +##### pts + +`Set`\<`number`\> + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`setPointTo`](PagNode.md#setpointto) + +*** + +### setStmt() + +> **setStmt**(`s`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:171 + +#### Parameters + +##### s + +[`Stmt`](Stmt.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`setStmt`](PagNode.md#setstmt) diff --git a/docs/api_docs/classes/PagNewExprNode.md b/docs/api_docs/classes/PagNewExprNode.md new file mode 100644 index 0000000000000000000000000000000000000000..6b486ad29e27cca377befc2694ae916e3126d36e --- /dev/null +++ b/docs/api_docs/classes/PagNewExprNode.md @@ -0,0 +1,1035 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / PagNewExprNode + +# Class: PagNewExprNode + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:462 + +below is heapObj like Node + +## Extends + +- [`PagNode`](PagNode.md) + +## Constructors + +### new PagNewExprNode() + +> **new PagNewExprNode**(`id`, `cid`, `expr`, `stmt`?): [`PagNewExprNode`](PagNewExprNode.md) + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:466 + +#### Parameters + +##### id + +`number` + +##### cid + +`undefined` | `number` + +##### expr + +[`AbstractExpr`](AbstractExpr.md) + +##### stmt? + +[`Stmt`](Stmt.md) + +#### Returns + +[`PagNewExprNode`](PagNewExprNode.md) + +#### Overrides + +[`PagNode`](PagNode.md).[`constructor`](PagNode.md#constructors) + +## Properties + +### basePt + +> `protected` **basePt**: `number` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:141 + +#### Inherited from + +[`PagNode`](PagNode.md).[`basePt`](PagNode.md#basept) + +*** + +### clonedFrom + +> `protected` **clonedFrom**: `number` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:142 + +#### Inherited from + +[`PagNode`](PagNode.md).[`clonedFrom`](PagNode.md#clonedfrom) + +*** + +### fieldNodes + +> **fieldNodes**: `Map`\<`string`, `number`\> + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:464 + +*** + +### kind + +> `protected` **kind**: `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:73 + +#### Inherited from + +[`PagNode`](PagNode.md).[`kind`](PagNode.md#kind) + +## Methods + +### addAddressInEdge() + +> **addAddressInEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:211 + +#### Parameters + +##### e + +[`AddrPagEdge`](AddrPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addAddressInEdge`](PagNode.md#addaddressinedge) + +*** + +### addAddressOutEdge() + +> **addAddressOutEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:217 + +#### Parameters + +##### e + +[`AddrPagEdge`](AddrPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addAddressOutEdge`](PagNode.md#addaddressoutedge) + +*** + +### addCopyInEdge() + +> **addCopyInEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:223 + +#### Parameters + +##### e + +[`CopyPagEdge`](CopyPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addCopyInEdge`](PagNode.md#addcopyinedge) + +*** + +### addCopyOutEdge() + +> **addCopyOutEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:229 + +#### Parameters + +##### e + +[`CopyPagEdge`](CopyPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addCopyOutEdge`](PagNode.md#addcopyoutedge) + +*** + +### addFieldNode() + +> **addFieldNode**(`fieldSignature`, `nodeID`): `boolean` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:470 + +#### Parameters + +##### fieldSignature + +[`AbstractFieldRef`](AbstractFieldRef.md) + +##### nodeID + +`number` + +#### Returns + +`boolean` + +*** + +### addIncomingEdge() + +> **addIncomingEdge**(`e`): `void` + +Defined in: src/core/graph/BaseExplicitGraph.ts:110 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addIncomingEdge`](PagNode.md#addincomingedge) + +*** + +### addLoadInEdge() + +> **addLoadInEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:236 + +#### Parameters + +##### e + +[`LoadPagEdge`](LoadPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addLoadInEdge`](PagNode.md#addloadinedge) + +*** + +### addLoadOutEdge() + +> **addLoadOutEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:242 + +#### Parameters + +##### e + +[`LoadPagEdge`](LoadPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addLoadOutEdge`](PagNode.md#addloadoutedge) + +*** + +### addOutgoingEdge() + +> **addOutgoingEdge**(`e`): `void` + +Defined in: src/core/graph/BaseExplicitGraph.ts:114 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addOutgoingEdge`](PagNode.md#addoutgoingedge) + +*** + +### addPointToElement() + +> **addPointToElement**(`node`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:280 + +#### Parameters + +##### node + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addPointToElement`](PagNode.md#addpointtoelement) + +*** + +### addThisInEdge() + +> **addThisInEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:260 + +#### Parameters + +##### e + +[`ThisPagEdge`](ThisPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addThisInEdge`](PagNode.md#addthisinedge) + +*** + +### addThisOutEdge() + +> **addThisOutEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:266 + +#### Parameters + +##### e + +[`ThisPagEdge`](ThisPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addThisOutEdge`](PagNode.md#addthisoutedge) + +*** + +### addWriteInEdge() + +> **addWriteInEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:248 + +#### Parameters + +##### e + +[`WritePagEdge`](WritePagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addWriteInEdge`](PagNode.md#addwriteinedge) + +*** + +### addWriteOutEdge() + +> **addWriteOutEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:254 + +#### Parameters + +##### e + +[`LoadPagEdge`](LoadPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addWriteOutEdge`](PagNode.md#addwriteoutedge) + +*** + +### getBasePt() + +> **getBasePt**(): `number` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:152 + +#### Returns + +`number` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getBasePt`](PagNode.md#getbasept) + +*** + +### getCid() + +> **getCid**(): `number` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:160 + +#### Returns + +`number` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getCid`](PagNode.md#getcid) + +*** + +### getClonedFrom() + +> **getClonedFrom**(): `number` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:297 + +#### Returns + +`number` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getClonedFrom`](PagNode.md#getclonedfrom) + +*** + +### getDotAttr() + +> **getDotAttr**(): `string` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:305 + +#### Returns + +`string` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getDotAttr`](PagNode.md#getdotattr) + +*** + +### getDotLabel() + +> **getDotLabel**(): `string` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:326 + +#### Returns + +`string` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getDotLabel`](PagNode.md#getdotlabel) + +*** + +### getFieldNode() + +> **getFieldNode**(`fieldSignature`): `undefined` \| `number` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:481 + +#### Parameters + +##### fieldSignature + +[`AbstractFieldRef`](AbstractFieldRef.md) + +#### Returns + +`undefined` \| `number` + +*** + +### getFieldNodes() + +> **getFieldNodes**(): `undefined` \| `Map`\<`string`, `number`\> + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:488 + +#### Returns + +`undefined` \| `Map`\<`string`, `number`\> + +*** + +### getID() + +> **getID**(): `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:82 + +#### Returns + +`number` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getID`](PagNode.md#getid) + +*** + +### getIncomingCopyEdges() + +> **getIncomingCopyEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:187 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getIncomingCopyEdges`](PagNode.md#getincomingcopyedges) + +*** + +### getIncomingEdge() + +> **getIncomingEdge**(): `Set`\<[`BaseEdge`](BaseEdge.md)\> + +Defined in: src/core/graph/BaseExplicitGraph.ts:126 + +#### Returns + +`Set`\<[`BaseEdge`](BaseEdge.md)\> + +#### Inherited from + +[`PagNode`](PagNode.md).[`getIncomingEdge`](PagNode.md#getincomingedge) + +*** + +### getIncomingThisEdges() + +> **getIncomingThisEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:207 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getIncomingThisEdges`](PagNode.md#getincomingthisedges) + +*** + +### getIncomingWriteEdges() + +> **getIncomingWriteEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:199 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getIncomingWriteEdges`](PagNode.md#getincomingwriteedges) + +*** + +### getKind() + +> **getKind**(): `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:86 + +#### Returns + +`number` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getKind`](PagNode.md#getkind) + +*** + +### getOutEdges() + +> **getOutEdges**(): `object` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:288 + +#### Returns + +`object` + +##### AddressEdge + +> **AddressEdge**: `PagEdgeSet` + +##### CopyEdge + +> **CopyEdge**: `PagEdgeSet` + +##### LoadEdge + +> **LoadEdge**: `PagEdgeSet` + +##### WriteEdge + +> **WriteEdge**: `PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getOutEdges`](PagNode.md#getoutedges) + +*** + +### getOutgoingCopyEdges() + +> **getOutgoingCopyEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:183 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getOutgoingCopyEdges`](PagNode.md#getoutgoingcopyedges) + +*** + +### getOutgoingEdges() + +> **getOutgoingEdges**(): `Set`\<[`BaseEdge`](BaseEdge.md)\> + +Defined in: src/core/graph/BaseExplicitGraph.ts:130 + +#### Returns + +`Set`\<[`BaseEdge`](BaseEdge.md)\> + +#### Inherited from + +[`PagNode`](PagNode.md).[`getOutgoingEdges`](PagNode.md#getoutgoingedges) + +*** + +### getOutgoingLoadEdges() + +> **getOutgoingLoadEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:191 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getOutgoingLoadEdges`](PagNode.md#getoutgoingloadedges) + +*** + +### getOutgoingThisEdges() + +> **getOutgoingThisEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:203 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getOutgoingThisEdges`](PagNode.md#getoutgoingthisedges) + +*** + +### getOutgoingWriteEdges() + +> **getOutgoingWriteEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:195 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getOutgoingWriteEdges`](PagNode.md#getoutgoingwriteedges) + +*** + +### getPointTo() + +> **getPointTo**(): `Set`\<`number`\> + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:276 + +#### Returns + +`Set`\<`number`\> + +#### Inherited from + +[`PagNode`](PagNode.md).[`getPointTo`](PagNode.md#getpointto) + +*** + +### getStmt() + +> **getStmt**(): `undefined` \| [`Stmt`](Stmt.md) + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:175 + +#### Returns + +`undefined` \| [`Stmt`](Stmt.md) + +#### Inherited from + +[`PagNode`](PagNode.md).[`getStmt`](PagNode.md#getstmt) + +*** + +### getValue() + +> **getValue**(): [`Value`](../interfaces/Value.md) + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:272 + +#### Returns + +[`Value`](../interfaces/Value.md) + +#### Inherited from + +[`PagNode`](PagNode.md).[`getValue`](PagNode.md#getvalue) + +*** + +### hasIncomingEdge() + +> **hasIncomingEdge**(`e`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:102 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`hasIncomingEdge`](PagNode.md#hasincomingedge) + +*** + +### hasIncomingEdges() + +> **hasIncomingEdges**(): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:94 + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`hasIncomingEdges`](PagNode.md#hasincomingedges) + +*** + +### hasOutgoingCopyEdge() + +> **hasOutgoingCopyEdge**(): `boolean` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:179 + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`hasOutgoingCopyEdge`](PagNode.md#hasoutgoingcopyedge) + +*** + +### hasOutgoingEdge() + +> **hasOutgoingEdge**(`e`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:106 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`hasOutgoingEdge`](PagNode.md#hasoutgoingedge) + +*** + +### hasOutgoingEdges() + +> **hasOutgoingEdges**(): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:98 + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`hasOutgoingEdges`](PagNode.md#hasoutgoingedges) + +*** + +### removeIncomingEdge() + +> **removeIncomingEdge**(`e`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:118 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`removeIncomingEdge`](PagNode.md#removeincomingedge) + +*** + +### removeOutgoingEdge() + +> **removeOutgoingEdge**(`e`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:122 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`removeOutgoingEdge`](PagNode.md#removeoutgoingedge) + +*** + +### setBasePt() + +> **setBasePt**(`pt`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:156 + +#### Parameters + +##### pt + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`setBasePt`](PagNode.md#setbasept) + +*** + +### setCid() + +> **setCid**(`cid`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:167 + +#### Parameters + +##### cid + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`setCid`](PagNode.md#setcid) + +*** + +### setClonedFrom() + +> **setClonedFrom**(`id`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:301 + +#### Parameters + +##### id + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`setClonedFrom`](PagNode.md#setclonedfrom) + +*** + +### setKind() + +> **setKind**(`kind`): `void` + +Defined in: src/core/graph/BaseExplicitGraph.ts:90 + +#### Parameters + +##### kind + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`setKind`](PagNode.md#setkind) + +*** + +### setPointTo() + +> **setPointTo**(`pts`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:284 + +#### Parameters + +##### pts + +`Set`\<`number`\> + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`setPointTo`](PagNode.md#setpointto) + +*** + +### setStmt() + +> **setStmt**(`s`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:171 + +#### Parameters + +##### s + +[`Stmt`](Stmt.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`setStmt`](PagNode.md#setstmt) diff --git a/docs/api_docs/classes/PagNode.md b/docs/api_docs/classes/PagNode.md new file mode 100644 index 0000000000000000000000000000000000000000..bea51ec4001d46c10330829b534b755494246513 --- /dev/null +++ b/docs/api_docs/classes/PagNode.md @@ -0,0 +1,858 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / PagNode + +# Class: PagNode + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:121 + +## Extends + +- [`BaseNode`](BaseNode.md) + +## Extended by + +- [`PagLocalNode`](PagLocalNode.md) +- [`PagInstanceFieldNode`](PagInstanceFieldNode.md) +- [`PagStaticFieldNode`](PagStaticFieldNode.md) +- [`PagThisRefNode`](PagThisRefNode.md) +- [`PagArrayNode`](PagArrayNode.md) +- [`PagNewExprNode`](PagNewExprNode.md) +- [`PagNewContainerExprNode`](PagNewContainerExprNode.md) +- [`PagParamNode`](PagParamNode.md) +- [`PagFuncNode`](PagFuncNode.md) +- [`PagGlobalThisNode`](PagGlobalThisNode.md) + +## Constructors + +### new PagNode() + +> **new PagNode**(`id`, `cid`, `value`, `k`, `s`?): [`PagNode`](PagNode.md) + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:144 + +#### Parameters + +##### id + +`number` + +##### cid + +`undefined` | `number` + +##### value + +[`Value`](../interfaces/Value.md) + +##### k + +`number` + +##### s? + +[`Stmt`](Stmt.md) + +#### Returns + +[`PagNode`](PagNode.md) + +#### Overrides + +[`BaseNode`](BaseNode.md).[`constructor`](BaseNode.md#constructors) + +## Properties + +### basePt + +> `protected` **basePt**: `number` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:141 + +*** + +### clonedFrom + +> `protected` **clonedFrom**: `number` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:142 + +*** + +### kind + +> `protected` **kind**: `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:73 + +#### Inherited from + +[`BaseNode`](BaseNode.md).[`kind`](BaseNode.md#kind) + +## Methods + +### addAddressInEdge() + +> **addAddressInEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:211 + +#### Parameters + +##### e + +[`AddrPagEdge`](AddrPagEdge.md) + +#### Returns + +`void` + +*** + +### addAddressOutEdge() + +> **addAddressOutEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:217 + +#### Parameters + +##### e + +[`AddrPagEdge`](AddrPagEdge.md) + +#### Returns + +`void` + +*** + +### addCopyInEdge() + +> **addCopyInEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:223 + +#### Parameters + +##### e + +[`CopyPagEdge`](CopyPagEdge.md) + +#### Returns + +`void` + +*** + +### addCopyOutEdge() + +> **addCopyOutEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:229 + +#### Parameters + +##### e + +[`CopyPagEdge`](CopyPagEdge.md) + +#### Returns + +`void` + +*** + +### addIncomingEdge() + +> **addIncomingEdge**(`e`): `void` + +Defined in: src/core/graph/BaseExplicitGraph.ts:110 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`BaseNode`](BaseNode.md).[`addIncomingEdge`](BaseNode.md#addincomingedge) + +*** + +### addLoadInEdge() + +> **addLoadInEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:236 + +#### Parameters + +##### e + +[`LoadPagEdge`](LoadPagEdge.md) + +#### Returns + +`void` + +*** + +### addLoadOutEdge() + +> **addLoadOutEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:242 + +#### Parameters + +##### e + +[`LoadPagEdge`](LoadPagEdge.md) + +#### Returns + +`void` + +*** + +### addOutgoingEdge() + +> **addOutgoingEdge**(`e`): `void` + +Defined in: src/core/graph/BaseExplicitGraph.ts:114 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`BaseNode`](BaseNode.md).[`addOutgoingEdge`](BaseNode.md#addoutgoingedge) + +*** + +### addPointToElement() + +> **addPointToElement**(`node`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:280 + +#### Parameters + +##### node + +`number` + +#### Returns + +`void` + +*** + +### addThisInEdge() + +> **addThisInEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:260 + +#### Parameters + +##### e + +[`ThisPagEdge`](ThisPagEdge.md) + +#### Returns + +`void` + +*** + +### addThisOutEdge() + +> **addThisOutEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:266 + +#### Parameters + +##### e + +[`ThisPagEdge`](ThisPagEdge.md) + +#### Returns + +`void` + +*** + +### addWriteInEdge() + +> **addWriteInEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:248 + +#### Parameters + +##### e + +[`WritePagEdge`](WritePagEdge.md) + +#### Returns + +`void` + +*** + +### addWriteOutEdge() + +> **addWriteOutEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:254 + +#### Parameters + +##### e + +[`LoadPagEdge`](LoadPagEdge.md) + +#### Returns + +`void` + +*** + +### getBasePt() + +> **getBasePt**(): `number` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:152 + +#### Returns + +`number` + +*** + +### getCid() + +> **getCid**(): `number` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:160 + +#### Returns + +`number` + +*** + +### getClonedFrom() + +> **getClonedFrom**(): `number` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:297 + +#### Returns + +`number` + +*** + +### getDotAttr() + +> **getDotAttr**(): `string` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:305 + +#### Returns + +`string` + +#### Overrides + +[`BaseNode`](BaseNode.md).[`getDotAttr`](BaseNode.md#getdotattr) + +*** + +### getDotLabel() + +> **getDotLabel**(): `string` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:326 + +#### Returns + +`string` + +#### Overrides + +[`BaseNode`](BaseNode.md).[`getDotLabel`](BaseNode.md#getdotlabel) + +*** + +### getID() + +> **getID**(): `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:82 + +#### Returns + +`number` + +#### Inherited from + +[`BaseNode`](BaseNode.md).[`getID`](BaseNode.md#getid) + +*** + +### getIncomingCopyEdges() + +> **getIncomingCopyEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:187 + +#### Returns + +`PagEdgeSet` + +*** + +### getIncomingEdge() + +> **getIncomingEdge**(): `Set`\<[`BaseEdge`](BaseEdge.md)\> + +Defined in: src/core/graph/BaseExplicitGraph.ts:126 + +#### Returns + +`Set`\<[`BaseEdge`](BaseEdge.md)\> + +#### Inherited from + +[`BaseNode`](BaseNode.md).[`getIncomingEdge`](BaseNode.md#getincomingedge) + +*** + +### getIncomingThisEdges() + +> **getIncomingThisEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:207 + +#### Returns + +`PagEdgeSet` + +*** + +### getIncomingWriteEdges() + +> **getIncomingWriteEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:199 + +#### Returns + +`PagEdgeSet` + +*** + +### getKind() + +> **getKind**(): `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:86 + +#### Returns + +`number` + +#### Inherited from + +[`BaseNode`](BaseNode.md).[`getKind`](BaseNode.md#getkind) + +*** + +### getOutEdges() + +> **getOutEdges**(): `object` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:288 + +#### Returns + +`object` + +##### AddressEdge + +> **AddressEdge**: `PagEdgeSet` + +##### CopyEdge + +> **CopyEdge**: `PagEdgeSet` + +##### LoadEdge + +> **LoadEdge**: `PagEdgeSet` + +##### WriteEdge + +> **WriteEdge**: `PagEdgeSet` + +*** + +### getOutgoingCopyEdges() + +> **getOutgoingCopyEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:183 + +#### Returns + +`PagEdgeSet` + +*** + +### getOutgoingEdges() + +> **getOutgoingEdges**(): `Set`\<[`BaseEdge`](BaseEdge.md)\> + +Defined in: src/core/graph/BaseExplicitGraph.ts:130 + +#### Returns + +`Set`\<[`BaseEdge`](BaseEdge.md)\> + +#### Inherited from + +[`BaseNode`](BaseNode.md).[`getOutgoingEdges`](BaseNode.md#getoutgoingedges) + +*** + +### getOutgoingLoadEdges() + +> **getOutgoingLoadEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:191 + +#### Returns + +`PagEdgeSet` + +*** + +### getOutgoingThisEdges() + +> **getOutgoingThisEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:203 + +#### Returns + +`PagEdgeSet` + +*** + +### getOutgoingWriteEdges() + +> **getOutgoingWriteEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:195 + +#### Returns + +`PagEdgeSet` + +*** + +### getPointTo() + +> **getPointTo**(): `Set`\<`number`\> + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:276 + +#### Returns + +`Set`\<`number`\> + +*** + +### getStmt() + +> **getStmt**(): `undefined` \| [`Stmt`](Stmt.md) + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:175 + +#### Returns + +`undefined` \| [`Stmt`](Stmt.md) + +*** + +### getValue() + +> **getValue**(): [`Value`](../interfaces/Value.md) + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:272 + +#### Returns + +[`Value`](../interfaces/Value.md) + +*** + +### hasIncomingEdge() + +> **hasIncomingEdge**(`e`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:102 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`BaseNode`](BaseNode.md).[`hasIncomingEdge`](BaseNode.md#hasincomingedge) + +*** + +### hasIncomingEdges() + +> **hasIncomingEdges**(): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:94 + +#### Returns + +`boolean` + +#### Inherited from + +[`BaseNode`](BaseNode.md).[`hasIncomingEdges`](BaseNode.md#hasincomingedges) + +*** + +### hasOutgoingCopyEdge() + +> **hasOutgoingCopyEdge**(): `boolean` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:179 + +#### Returns + +`boolean` + +*** + +### hasOutgoingEdge() + +> **hasOutgoingEdge**(`e`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:106 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`BaseNode`](BaseNode.md).[`hasOutgoingEdge`](BaseNode.md#hasoutgoingedge) + +*** + +### hasOutgoingEdges() + +> **hasOutgoingEdges**(): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:98 + +#### Returns + +`boolean` + +#### Inherited from + +[`BaseNode`](BaseNode.md).[`hasOutgoingEdges`](BaseNode.md#hasoutgoingedges) + +*** + +### removeIncomingEdge() + +> **removeIncomingEdge**(`e`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:118 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`BaseNode`](BaseNode.md).[`removeIncomingEdge`](BaseNode.md#removeincomingedge) + +*** + +### removeOutgoingEdge() + +> **removeOutgoingEdge**(`e`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:122 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`BaseNode`](BaseNode.md).[`removeOutgoingEdge`](BaseNode.md#removeoutgoingedge) + +*** + +### setBasePt() + +> **setBasePt**(`pt`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:156 + +#### Parameters + +##### pt + +`number` + +#### Returns + +`void` + +*** + +### setCid() + +> **setCid**(`cid`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:167 + +#### Parameters + +##### cid + +`number` + +#### Returns + +`void` + +*** + +### setClonedFrom() + +> **setClonedFrom**(`id`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:301 + +#### Parameters + +##### id + +`number` + +#### Returns + +`void` + +*** + +### setKind() + +> **setKind**(`kind`): `void` + +Defined in: src/core/graph/BaseExplicitGraph.ts:90 + +#### Parameters + +##### kind + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`BaseNode`](BaseNode.md).[`setKind`](BaseNode.md#setkind) + +*** + +### setPointTo() + +> **setPointTo**(`pts`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:284 + +#### Parameters + +##### pts + +`Set`\<`number`\> + +#### Returns + +`void` + +*** + +### setStmt() + +> **setStmt**(`s`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:171 + +#### Parameters + +##### s + +[`Stmt`](Stmt.md) + +#### Returns + +`void` diff --git a/docs/api_docs/classes/PagParamNode.md b/docs/api_docs/classes/PagParamNode.md new file mode 100644 index 0000000000000000000000000000000000000000..72afa1e1409124b7505167a831c980ac4297c7a2 --- /dev/null +++ b/docs/api_docs/classes/PagParamNode.md @@ -0,0 +1,973 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / PagParamNode + +# Class: PagParamNode + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:520 + +## Extends + +- [`PagNode`](PagNode.md) + +## Constructors + +### new PagParamNode() + +> **new PagParamNode**(`id`, `cid`, `r`, `stmt`?): [`PagParamNode`](PagParamNode.md) + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:521 + +#### Parameters + +##### id + +`number` + +##### cid + +`undefined` | `number` + +##### r + +[`ArkParameterRef`](ArkParameterRef.md) + +##### stmt? + +[`Stmt`](Stmt.md) + +#### Returns + +[`PagParamNode`](PagParamNode.md) + +#### Overrides + +[`PagNode`](PagNode.md).[`constructor`](PagNode.md#constructors) + +## Properties + +### basePt + +> `protected` **basePt**: `number` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:141 + +#### Inherited from + +[`PagNode`](PagNode.md).[`basePt`](PagNode.md#basept) + +*** + +### clonedFrom + +> `protected` **clonedFrom**: `number` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:142 + +#### Inherited from + +[`PagNode`](PagNode.md).[`clonedFrom`](PagNode.md#clonedfrom) + +*** + +### kind + +> `protected` **kind**: `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:73 + +#### Inherited from + +[`PagNode`](PagNode.md).[`kind`](PagNode.md#kind) + +## Methods + +### addAddressInEdge() + +> **addAddressInEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:211 + +#### Parameters + +##### e + +[`AddrPagEdge`](AddrPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addAddressInEdge`](PagNode.md#addaddressinedge) + +*** + +### addAddressOutEdge() + +> **addAddressOutEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:217 + +#### Parameters + +##### e + +[`AddrPagEdge`](AddrPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addAddressOutEdge`](PagNode.md#addaddressoutedge) + +*** + +### addCopyInEdge() + +> **addCopyInEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:223 + +#### Parameters + +##### e + +[`CopyPagEdge`](CopyPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addCopyInEdge`](PagNode.md#addcopyinedge) + +*** + +### addCopyOutEdge() + +> **addCopyOutEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:229 + +#### Parameters + +##### e + +[`CopyPagEdge`](CopyPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addCopyOutEdge`](PagNode.md#addcopyoutedge) + +*** + +### addIncomingEdge() + +> **addIncomingEdge**(`e`): `void` + +Defined in: src/core/graph/BaseExplicitGraph.ts:110 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addIncomingEdge`](PagNode.md#addincomingedge) + +*** + +### addLoadInEdge() + +> **addLoadInEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:236 + +#### Parameters + +##### e + +[`LoadPagEdge`](LoadPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addLoadInEdge`](PagNode.md#addloadinedge) + +*** + +### addLoadOutEdge() + +> **addLoadOutEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:242 + +#### Parameters + +##### e + +[`LoadPagEdge`](LoadPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addLoadOutEdge`](PagNode.md#addloadoutedge) + +*** + +### addOutgoingEdge() + +> **addOutgoingEdge**(`e`): `void` + +Defined in: src/core/graph/BaseExplicitGraph.ts:114 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addOutgoingEdge`](PagNode.md#addoutgoingedge) + +*** + +### addPointToElement() + +> **addPointToElement**(`node`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:280 + +#### Parameters + +##### node + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addPointToElement`](PagNode.md#addpointtoelement) + +*** + +### addThisInEdge() + +> **addThisInEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:260 + +#### Parameters + +##### e + +[`ThisPagEdge`](ThisPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addThisInEdge`](PagNode.md#addthisinedge) + +*** + +### addThisOutEdge() + +> **addThisOutEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:266 + +#### Parameters + +##### e + +[`ThisPagEdge`](ThisPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addThisOutEdge`](PagNode.md#addthisoutedge) + +*** + +### addWriteInEdge() + +> **addWriteInEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:248 + +#### Parameters + +##### e + +[`WritePagEdge`](WritePagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addWriteInEdge`](PagNode.md#addwriteinedge) + +*** + +### addWriteOutEdge() + +> **addWriteOutEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:254 + +#### Parameters + +##### e + +[`LoadPagEdge`](LoadPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addWriteOutEdge`](PagNode.md#addwriteoutedge) + +*** + +### getBasePt() + +> **getBasePt**(): `number` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:152 + +#### Returns + +`number` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getBasePt`](PagNode.md#getbasept) + +*** + +### getCid() + +> **getCid**(): `number` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:160 + +#### Returns + +`number` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getCid`](PagNode.md#getcid) + +*** + +### getClonedFrom() + +> **getClonedFrom**(): `number` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:297 + +#### Returns + +`number` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getClonedFrom`](PagNode.md#getclonedfrom) + +*** + +### getDotAttr() + +> **getDotAttr**(): `string` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:305 + +#### Returns + +`string` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getDotAttr`](PagNode.md#getdotattr) + +*** + +### getDotLabel() + +> **getDotLabel**(): `string` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:326 + +#### Returns + +`string` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getDotLabel`](PagNode.md#getdotlabel) + +*** + +### getID() + +> **getID**(): `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:82 + +#### Returns + +`number` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getID`](PagNode.md#getid) + +*** + +### getIncomingCopyEdges() + +> **getIncomingCopyEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:187 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getIncomingCopyEdges`](PagNode.md#getincomingcopyedges) + +*** + +### getIncomingEdge() + +> **getIncomingEdge**(): `Set`\<[`BaseEdge`](BaseEdge.md)\> + +Defined in: src/core/graph/BaseExplicitGraph.ts:126 + +#### Returns + +`Set`\<[`BaseEdge`](BaseEdge.md)\> + +#### Inherited from + +[`PagNode`](PagNode.md).[`getIncomingEdge`](PagNode.md#getincomingedge) + +*** + +### getIncomingThisEdges() + +> **getIncomingThisEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:207 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getIncomingThisEdges`](PagNode.md#getincomingthisedges) + +*** + +### getIncomingWriteEdges() + +> **getIncomingWriteEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:199 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getIncomingWriteEdges`](PagNode.md#getincomingwriteedges) + +*** + +### getKind() + +> **getKind**(): `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:86 + +#### Returns + +`number` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getKind`](PagNode.md#getkind) + +*** + +### getOutEdges() + +> **getOutEdges**(): `object` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:288 + +#### Returns + +`object` + +##### AddressEdge + +> **AddressEdge**: `PagEdgeSet` + +##### CopyEdge + +> **CopyEdge**: `PagEdgeSet` + +##### LoadEdge + +> **LoadEdge**: `PagEdgeSet` + +##### WriteEdge + +> **WriteEdge**: `PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getOutEdges`](PagNode.md#getoutedges) + +*** + +### getOutgoingCopyEdges() + +> **getOutgoingCopyEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:183 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getOutgoingCopyEdges`](PagNode.md#getoutgoingcopyedges) + +*** + +### getOutgoingEdges() + +> **getOutgoingEdges**(): `Set`\<[`BaseEdge`](BaseEdge.md)\> + +Defined in: src/core/graph/BaseExplicitGraph.ts:130 + +#### Returns + +`Set`\<[`BaseEdge`](BaseEdge.md)\> + +#### Inherited from + +[`PagNode`](PagNode.md).[`getOutgoingEdges`](PagNode.md#getoutgoingedges) + +*** + +### getOutgoingLoadEdges() + +> **getOutgoingLoadEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:191 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getOutgoingLoadEdges`](PagNode.md#getoutgoingloadedges) + +*** + +### getOutgoingThisEdges() + +> **getOutgoingThisEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:203 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getOutgoingThisEdges`](PagNode.md#getoutgoingthisedges) + +*** + +### getOutgoingWriteEdges() + +> **getOutgoingWriteEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:195 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getOutgoingWriteEdges`](PagNode.md#getoutgoingwriteedges) + +*** + +### getPointTo() + +> **getPointTo**(): `Set`\<`number`\> + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:276 + +#### Returns + +`Set`\<`number`\> + +#### Inherited from + +[`PagNode`](PagNode.md).[`getPointTo`](PagNode.md#getpointto) + +*** + +### getStmt() + +> **getStmt**(): `undefined` \| [`Stmt`](Stmt.md) + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:175 + +#### Returns + +`undefined` \| [`Stmt`](Stmt.md) + +#### Inherited from + +[`PagNode`](PagNode.md).[`getStmt`](PagNode.md#getstmt) + +*** + +### getValue() + +> **getValue**(): [`Value`](../interfaces/Value.md) + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:272 + +#### Returns + +[`Value`](../interfaces/Value.md) + +#### Inherited from + +[`PagNode`](PagNode.md).[`getValue`](PagNode.md#getvalue) + +*** + +### hasIncomingEdge() + +> **hasIncomingEdge**(`e`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:102 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`hasIncomingEdge`](PagNode.md#hasincomingedge) + +*** + +### hasIncomingEdges() + +> **hasIncomingEdges**(): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:94 + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`hasIncomingEdges`](PagNode.md#hasincomingedges) + +*** + +### hasOutgoingCopyEdge() + +> **hasOutgoingCopyEdge**(): `boolean` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:179 + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`hasOutgoingCopyEdge`](PagNode.md#hasoutgoingcopyedge) + +*** + +### hasOutgoingEdge() + +> **hasOutgoingEdge**(`e`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:106 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`hasOutgoingEdge`](PagNode.md#hasoutgoingedge) + +*** + +### hasOutgoingEdges() + +> **hasOutgoingEdges**(): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:98 + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`hasOutgoingEdges`](PagNode.md#hasoutgoingedges) + +*** + +### removeIncomingEdge() + +> **removeIncomingEdge**(`e`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:118 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`removeIncomingEdge`](PagNode.md#removeincomingedge) + +*** + +### removeOutgoingEdge() + +> **removeOutgoingEdge**(`e`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:122 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`removeOutgoingEdge`](PagNode.md#removeoutgoingedge) + +*** + +### setBasePt() + +> **setBasePt**(`pt`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:156 + +#### Parameters + +##### pt + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`setBasePt`](PagNode.md#setbasept) + +*** + +### setCid() + +> **setCid**(`cid`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:167 + +#### Parameters + +##### cid + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`setCid`](PagNode.md#setcid) + +*** + +### setClonedFrom() + +> **setClonedFrom**(`id`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:301 + +#### Parameters + +##### id + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`setClonedFrom`](PagNode.md#setclonedfrom) + +*** + +### setKind() + +> **setKind**(`kind`): `void` + +Defined in: src/core/graph/BaseExplicitGraph.ts:90 + +#### Parameters + +##### kind + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`setKind`](PagNode.md#setkind) + +*** + +### setPointTo() + +> **setPointTo**(`pts`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:284 + +#### Parameters + +##### pts + +`Set`\<`number`\> + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`setPointTo`](PagNode.md#setpointto) + +*** + +### setStmt() + +> **setStmt**(`s`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:171 + +#### Parameters + +##### s + +[`Stmt`](Stmt.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`setStmt`](PagNode.md#setstmt) diff --git a/docs/api_docs/classes/PagStaticFieldNode.md b/docs/api_docs/classes/PagStaticFieldNode.md new file mode 100644 index 0000000000000000000000000000000000000000..72414a239a8f167d5c162b8dc5d33ea83c581e55 --- /dev/null +++ b/docs/api_docs/classes/PagStaticFieldNode.md @@ -0,0 +1,973 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / PagStaticFieldNode + +# Class: PagStaticFieldNode + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:427 + +## Extends + +- [`PagNode`](PagNode.md) + +## Constructors + +### new PagStaticFieldNode() + +> **new PagStaticFieldNode**(`id`, `cid`, `staticFieldRef`, `stmt`?): [`PagStaticFieldNode`](PagStaticFieldNode.md) + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:428 + +#### Parameters + +##### id + +`number` + +##### cid + +`undefined` | `number` + +##### staticFieldRef + +[`ArkStaticFieldRef`](ArkStaticFieldRef.md) + +##### stmt? + +[`Stmt`](Stmt.md) + +#### Returns + +[`PagStaticFieldNode`](PagStaticFieldNode.md) + +#### Overrides + +[`PagNode`](PagNode.md).[`constructor`](PagNode.md#constructors) + +## Properties + +### basePt + +> `protected` **basePt**: `number` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:141 + +#### Inherited from + +[`PagNode`](PagNode.md).[`basePt`](PagNode.md#basept) + +*** + +### clonedFrom + +> `protected` **clonedFrom**: `number` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:142 + +#### Inherited from + +[`PagNode`](PagNode.md).[`clonedFrom`](PagNode.md#clonedfrom) + +*** + +### kind + +> `protected` **kind**: `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:73 + +#### Inherited from + +[`PagNode`](PagNode.md).[`kind`](PagNode.md#kind) + +## Methods + +### addAddressInEdge() + +> **addAddressInEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:211 + +#### Parameters + +##### e + +[`AddrPagEdge`](AddrPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addAddressInEdge`](PagNode.md#addaddressinedge) + +*** + +### addAddressOutEdge() + +> **addAddressOutEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:217 + +#### Parameters + +##### e + +[`AddrPagEdge`](AddrPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addAddressOutEdge`](PagNode.md#addaddressoutedge) + +*** + +### addCopyInEdge() + +> **addCopyInEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:223 + +#### Parameters + +##### e + +[`CopyPagEdge`](CopyPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addCopyInEdge`](PagNode.md#addcopyinedge) + +*** + +### addCopyOutEdge() + +> **addCopyOutEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:229 + +#### Parameters + +##### e + +[`CopyPagEdge`](CopyPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addCopyOutEdge`](PagNode.md#addcopyoutedge) + +*** + +### addIncomingEdge() + +> **addIncomingEdge**(`e`): `void` + +Defined in: src/core/graph/BaseExplicitGraph.ts:110 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addIncomingEdge`](PagNode.md#addincomingedge) + +*** + +### addLoadInEdge() + +> **addLoadInEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:236 + +#### Parameters + +##### e + +[`LoadPagEdge`](LoadPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addLoadInEdge`](PagNode.md#addloadinedge) + +*** + +### addLoadOutEdge() + +> **addLoadOutEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:242 + +#### Parameters + +##### e + +[`LoadPagEdge`](LoadPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addLoadOutEdge`](PagNode.md#addloadoutedge) + +*** + +### addOutgoingEdge() + +> **addOutgoingEdge**(`e`): `void` + +Defined in: src/core/graph/BaseExplicitGraph.ts:114 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addOutgoingEdge`](PagNode.md#addoutgoingedge) + +*** + +### addPointToElement() + +> **addPointToElement**(`node`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:280 + +#### Parameters + +##### node + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addPointToElement`](PagNode.md#addpointtoelement) + +*** + +### addThisInEdge() + +> **addThisInEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:260 + +#### Parameters + +##### e + +[`ThisPagEdge`](ThisPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addThisInEdge`](PagNode.md#addthisinedge) + +*** + +### addThisOutEdge() + +> **addThisOutEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:266 + +#### Parameters + +##### e + +[`ThisPagEdge`](ThisPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addThisOutEdge`](PagNode.md#addthisoutedge) + +*** + +### addWriteInEdge() + +> **addWriteInEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:248 + +#### Parameters + +##### e + +[`WritePagEdge`](WritePagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addWriteInEdge`](PagNode.md#addwriteinedge) + +*** + +### addWriteOutEdge() + +> **addWriteOutEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:254 + +#### Parameters + +##### e + +[`LoadPagEdge`](LoadPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addWriteOutEdge`](PagNode.md#addwriteoutedge) + +*** + +### getBasePt() + +> **getBasePt**(): `number` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:152 + +#### Returns + +`number` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getBasePt`](PagNode.md#getbasept) + +*** + +### getCid() + +> **getCid**(): `number` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:160 + +#### Returns + +`number` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getCid`](PagNode.md#getcid) + +*** + +### getClonedFrom() + +> **getClonedFrom**(): `number` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:297 + +#### Returns + +`number` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getClonedFrom`](PagNode.md#getclonedfrom) + +*** + +### getDotAttr() + +> **getDotAttr**(): `string` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:305 + +#### Returns + +`string` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getDotAttr`](PagNode.md#getdotattr) + +*** + +### getDotLabel() + +> **getDotLabel**(): `string` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:326 + +#### Returns + +`string` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getDotLabel`](PagNode.md#getdotlabel) + +*** + +### getID() + +> **getID**(): `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:82 + +#### Returns + +`number` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getID`](PagNode.md#getid) + +*** + +### getIncomingCopyEdges() + +> **getIncomingCopyEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:187 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getIncomingCopyEdges`](PagNode.md#getincomingcopyedges) + +*** + +### getIncomingEdge() + +> **getIncomingEdge**(): `Set`\<[`BaseEdge`](BaseEdge.md)\> + +Defined in: src/core/graph/BaseExplicitGraph.ts:126 + +#### Returns + +`Set`\<[`BaseEdge`](BaseEdge.md)\> + +#### Inherited from + +[`PagNode`](PagNode.md).[`getIncomingEdge`](PagNode.md#getincomingedge) + +*** + +### getIncomingThisEdges() + +> **getIncomingThisEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:207 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getIncomingThisEdges`](PagNode.md#getincomingthisedges) + +*** + +### getIncomingWriteEdges() + +> **getIncomingWriteEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:199 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getIncomingWriteEdges`](PagNode.md#getincomingwriteedges) + +*** + +### getKind() + +> **getKind**(): `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:86 + +#### Returns + +`number` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getKind`](PagNode.md#getkind) + +*** + +### getOutEdges() + +> **getOutEdges**(): `object` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:288 + +#### Returns + +`object` + +##### AddressEdge + +> **AddressEdge**: `PagEdgeSet` + +##### CopyEdge + +> **CopyEdge**: `PagEdgeSet` + +##### LoadEdge + +> **LoadEdge**: `PagEdgeSet` + +##### WriteEdge + +> **WriteEdge**: `PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getOutEdges`](PagNode.md#getoutedges) + +*** + +### getOutgoingCopyEdges() + +> **getOutgoingCopyEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:183 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getOutgoingCopyEdges`](PagNode.md#getoutgoingcopyedges) + +*** + +### getOutgoingEdges() + +> **getOutgoingEdges**(): `Set`\<[`BaseEdge`](BaseEdge.md)\> + +Defined in: src/core/graph/BaseExplicitGraph.ts:130 + +#### Returns + +`Set`\<[`BaseEdge`](BaseEdge.md)\> + +#### Inherited from + +[`PagNode`](PagNode.md).[`getOutgoingEdges`](PagNode.md#getoutgoingedges) + +*** + +### getOutgoingLoadEdges() + +> **getOutgoingLoadEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:191 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getOutgoingLoadEdges`](PagNode.md#getoutgoingloadedges) + +*** + +### getOutgoingThisEdges() + +> **getOutgoingThisEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:203 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getOutgoingThisEdges`](PagNode.md#getoutgoingthisedges) + +*** + +### getOutgoingWriteEdges() + +> **getOutgoingWriteEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:195 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getOutgoingWriteEdges`](PagNode.md#getoutgoingwriteedges) + +*** + +### getPointTo() + +> **getPointTo**(): `Set`\<`number`\> + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:276 + +#### Returns + +`Set`\<`number`\> + +#### Inherited from + +[`PagNode`](PagNode.md).[`getPointTo`](PagNode.md#getpointto) + +*** + +### getStmt() + +> **getStmt**(): `undefined` \| [`Stmt`](Stmt.md) + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:175 + +#### Returns + +`undefined` \| [`Stmt`](Stmt.md) + +#### Inherited from + +[`PagNode`](PagNode.md).[`getStmt`](PagNode.md#getstmt) + +*** + +### getValue() + +> **getValue**(): [`Value`](../interfaces/Value.md) + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:272 + +#### Returns + +[`Value`](../interfaces/Value.md) + +#### Inherited from + +[`PagNode`](PagNode.md).[`getValue`](PagNode.md#getvalue) + +*** + +### hasIncomingEdge() + +> **hasIncomingEdge**(`e`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:102 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`hasIncomingEdge`](PagNode.md#hasincomingedge) + +*** + +### hasIncomingEdges() + +> **hasIncomingEdges**(): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:94 + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`hasIncomingEdges`](PagNode.md#hasincomingedges) + +*** + +### hasOutgoingCopyEdge() + +> **hasOutgoingCopyEdge**(): `boolean` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:179 + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`hasOutgoingCopyEdge`](PagNode.md#hasoutgoingcopyedge) + +*** + +### hasOutgoingEdge() + +> **hasOutgoingEdge**(`e`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:106 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`hasOutgoingEdge`](PagNode.md#hasoutgoingedge) + +*** + +### hasOutgoingEdges() + +> **hasOutgoingEdges**(): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:98 + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`hasOutgoingEdges`](PagNode.md#hasoutgoingedges) + +*** + +### removeIncomingEdge() + +> **removeIncomingEdge**(`e`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:118 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`removeIncomingEdge`](PagNode.md#removeincomingedge) + +*** + +### removeOutgoingEdge() + +> **removeOutgoingEdge**(`e`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:122 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`removeOutgoingEdge`](PagNode.md#removeoutgoingedge) + +*** + +### setBasePt() + +> **setBasePt**(`pt`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:156 + +#### Parameters + +##### pt + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`setBasePt`](PagNode.md#setbasept) + +*** + +### setCid() + +> **setCid**(`cid`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:167 + +#### Parameters + +##### cid + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`setCid`](PagNode.md#setcid) + +*** + +### setClonedFrom() + +> **setClonedFrom**(`id`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:301 + +#### Parameters + +##### id + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`setClonedFrom`](PagNode.md#setclonedfrom) + +*** + +### setKind() + +> **setKind**(`kind`): `void` + +Defined in: src/core/graph/BaseExplicitGraph.ts:90 + +#### Parameters + +##### kind + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`setKind`](PagNode.md#setkind) + +*** + +### setPointTo() + +> **setPointTo**(`pts`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:284 + +#### Parameters + +##### pts + +`Set`\<`number`\> + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`setPointTo`](PagNode.md#setpointto) + +*** + +### setStmt() + +> **setStmt**(`s`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:171 + +#### Parameters + +##### s + +[`Stmt`](Stmt.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`setStmt`](PagNode.md#setstmt) diff --git a/docs/api_docs/classes/PagThisRefNode.md b/docs/api_docs/classes/PagThisRefNode.md new file mode 100644 index 0000000000000000000000000000000000000000..8fd23cd0ea0749d524086588f1aa651e1259010b --- /dev/null +++ b/docs/api_docs/classes/PagThisRefNode.md @@ -0,0 +1,1003 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / PagThisRefNode + +# Class: PagThisRefNode + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:433 + +## Extends + +- [`PagNode`](PagNode.md) + +## Constructors + +### new PagThisRefNode() + +> **new PagThisRefNode**(`id`, `thisRef`): [`PagThisRefNode`](PagThisRefNode.md) + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:435 + +#### Parameters + +##### id + +`number` + +##### thisRef + +[`ArkThisRef`](ArkThisRef.md) + +#### Returns + +[`PagThisRefNode`](PagThisRefNode.md) + +#### Overrides + +[`PagNode`](PagNode.md).[`constructor`](PagNode.md#constructors) + +## Properties + +### basePt + +> `protected` **basePt**: `number` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:141 + +#### Inherited from + +[`PagNode`](PagNode.md).[`basePt`](PagNode.md#basept) + +*** + +### clonedFrom + +> `protected` **clonedFrom**: `number` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:142 + +#### Inherited from + +[`PagNode`](PagNode.md).[`clonedFrom`](PagNode.md#clonedfrom) + +*** + +### kind + +> `protected` **kind**: `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:73 + +#### Inherited from + +[`PagNode`](PagNode.md).[`kind`](PagNode.md#kind) + +*** + +### pointToNode + +> **pointToNode**: `number`[] + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:434 + +## Methods + +### addAddressInEdge() + +> **addAddressInEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:211 + +#### Parameters + +##### e + +[`AddrPagEdge`](AddrPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addAddressInEdge`](PagNode.md#addaddressinedge) + +*** + +### addAddressOutEdge() + +> **addAddressOutEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:217 + +#### Parameters + +##### e + +[`AddrPagEdge`](AddrPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addAddressOutEdge`](PagNode.md#addaddressoutedge) + +*** + +### addCopyInEdge() + +> **addCopyInEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:223 + +#### Parameters + +##### e + +[`CopyPagEdge`](CopyPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addCopyInEdge`](PagNode.md#addcopyinedge) + +*** + +### addCopyOutEdge() + +> **addCopyOutEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:229 + +#### Parameters + +##### e + +[`CopyPagEdge`](CopyPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addCopyOutEdge`](PagNode.md#addcopyoutedge) + +*** + +### addIncomingEdge() + +> **addIncomingEdge**(`e`): `void` + +Defined in: src/core/graph/BaseExplicitGraph.ts:110 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addIncomingEdge`](PagNode.md#addincomingedge) + +*** + +### addLoadInEdge() + +> **addLoadInEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:236 + +#### Parameters + +##### e + +[`LoadPagEdge`](LoadPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addLoadInEdge`](PagNode.md#addloadinedge) + +*** + +### addLoadOutEdge() + +> **addLoadOutEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:242 + +#### Parameters + +##### e + +[`LoadPagEdge`](LoadPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addLoadOutEdge`](PagNode.md#addloadoutedge) + +*** + +### addOutgoingEdge() + +> **addOutgoingEdge**(`e`): `void` + +Defined in: src/core/graph/BaseExplicitGraph.ts:114 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addOutgoingEdge`](PagNode.md#addoutgoingedge) + +*** + +### addPointToElement() + +> **addPointToElement**(`node`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:280 + +#### Parameters + +##### node + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addPointToElement`](PagNode.md#addpointtoelement) + +*** + +### addPTNode() + +> **addPTNode**(`ptNode`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:444 + +#### Parameters + +##### ptNode + +`number` + +#### Returns + +`void` + +*** + +### addThisInEdge() + +> **addThisInEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:260 + +#### Parameters + +##### e + +[`ThisPagEdge`](ThisPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addThisInEdge`](PagNode.md#addthisinedge) + +*** + +### addThisOutEdge() + +> **addThisOutEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:266 + +#### Parameters + +##### e + +[`ThisPagEdge`](ThisPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addThisOutEdge`](PagNode.md#addthisoutedge) + +*** + +### addWriteInEdge() + +> **addWriteInEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:248 + +#### Parameters + +##### e + +[`WritePagEdge`](WritePagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addWriteInEdge`](PagNode.md#addwriteinedge) + +*** + +### addWriteOutEdge() + +> **addWriteOutEdge**(`e`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:254 + +#### Parameters + +##### e + +[`LoadPagEdge`](LoadPagEdge.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`addWriteOutEdge`](PagNode.md#addwriteoutedge) + +*** + +### getBasePt() + +> **getBasePt**(): `number` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:152 + +#### Returns + +`number` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getBasePt`](PagNode.md#getbasept) + +*** + +### getCid() + +> **getCid**(): `number` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:160 + +#### Returns + +`number` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getCid`](PagNode.md#getcid) + +*** + +### getClonedFrom() + +> **getClonedFrom**(): `number` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:297 + +#### Returns + +`number` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getClonedFrom`](PagNode.md#getclonedfrom) + +*** + +### getDotAttr() + +> **getDotAttr**(): `string` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:305 + +#### Returns + +`string` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getDotAttr`](PagNode.md#getdotattr) + +*** + +### getDotLabel() + +> **getDotLabel**(): `string` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:326 + +#### Returns + +`string` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getDotLabel`](PagNode.md#getdotlabel) + +*** + +### getID() + +> **getID**(): `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:82 + +#### Returns + +`number` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getID`](PagNode.md#getid) + +*** + +### getIncomingCopyEdges() + +> **getIncomingCopyEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:187 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getIncomingCopyEdges`](PagNode.md#getincomingcopyedges) + +*** + +### getIncomingEdge() + +> **getIncomingEdge**(): `Set`\<[`BaseEdge`](BaseEdge.md)\> + +Defined in: src/core/graph/BaseExplicitGraph.ts:126 + +#### Returns + +`Set`\<[`BaseEdge`](BaseEdge.md)\> + +#### Inherited from + +[`PagNode`](PagNode.md).[`getIncomingEdge`](PagNode.md#getincomingedge) + +*** + +### getIncomingThisEdges() + +> **getIncomingThisEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:207 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getIncomingThisEdges`](PagNode.md#getincomingthisedges) + +*** + +### getIncomingWriteEdges() + +> **getIncomingWriteEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:199 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getIncomingWriteEdges`](PagNode.md#getincomingwriteedges) + +*** + +### getKind() + +> **getKind**(): `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:86 + +#### Returns + +`number` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getKind`](PagNode.md#getkind) + +*** + +### getOutEdges() + +> **getOutEdges**(): `object` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:288 + +#### Returns + +`object` + +##### AddressEdge + +> **AddressEdge**: `PagEdgeSet` + +##### CopyEdge + +> **CopyEdge**: `PagEdgeSet` + +##### LoadEdge + +> **LoadEdge**: `PagEdgeSet` + +##### WriteEdge + +> **WriteEdge**: `PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getOutEdges`](PagNode.md#getoutedges) + +*** + +### getOutgoingCopyEdges() + +> **getOutgoingCopyEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:183 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getOutgoingCopyEdges`](PagNode.md#getoutgoingcopyedges) + +*** + +### getOutgoingEdges() + +> **getOutgoingEdges**(): `Set`\<[`BaseEdge`](BaseEdge.md)\> + +Defined in: src/core/graph/BaseExplicitGraph.ts:130 + +#### Returns + +`Set`\<[`BaseEdge`](BaseEdge.md)\> + +#### Inherited from + +[`PagNode`](PagNode.md).[`getOutgoingEdges`](PagNode.md#getoutgoingedges) + +*** + +### getOutgoingLoadEdges() + +> **getOutgoingLoadEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:191 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getOutgoingLoadEdges`](PagNode.md#getoutgoingloadedges) + +*** + +### getOutgoingThisEdges() + +> **getOutgoingThisEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:203 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getOutgoingThisEdges`](PagNode.md#getoutgoingthisedges) + +*** + +### getOutgoingWriteEdges() + +> **getOutgoingWriteEdges**(): `PagEdgeSet` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:195 + +#### Returns + +`PagEdgeSet` + +#### Inherited from + +[`PagNode`](PagNode.md).[`getOutgoingWriteEdges`](PagNode.md#getoutgoingwriteedges) + +*** + +### getPointTo() + +> **getPointTo**(): `Set`\<`number`\> + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:276 + +#### Returns + +`Set`\<`number`\> + +#### Inherited from + +[`PagNode`](PagNode.md).[`getPointTo`](PagNode.md#getpointto) + +*** + +### getStmt() + +> **getStmt**(): `undefined` \| [`Stmt`](Stmt.md) + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:175 + +#### Returns + +`undefined` \| [`Stmt`](Stmt.md) + +#### Inherited from + +[`PagNode`](PagNode.md).[`getStmt`](PagNode.md#getstmt) + +*** + +### getThisPTNode() + +> **getThisPTNode**(): `number`[] + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:440 + +#### Returns + +`number`[] + +*** + +### getValue() + +> **getValue**(): [`Value`](../interfaces/Value.md) + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:272 + +#### Returns + +[`Value`](../interfaces/Value.md) + +#### Inherited from + +[`PagNode`](PagNode.md).[`getValue`](PagNode.md#getvalue) + +*** + +### hasIncomingEdge() + +> **hasIncomingEdge**(`e`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:102 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`hasIncomingEdge`](PagNode.md#hasincomingedge) + +*** + +### hasIncomingEdges() + +> **hasIncomingEdges**(): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:94 + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`hasIncomingEdges`](PagNode.md#hasincomingedges) + +*** + +### hasOutgoingCopyEdge() + +> **hasOutgoingCopyEdge**(): `boolean` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:179 + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`hasOutgoingCopyEdge`](PagNode.md#hasoutgoingcopyedge) + +*** + +### hasOutgoingEdge() + +> **hasOutgoingEdge**(`e`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:106 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`hasOutgoingEdge`](PagNode.md#hasoutgoingedge) + +*** + +### hasOutgoingEdges() + +> **hasOutgoingEdges**(): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:98 + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`hasOutgoingEdges`](PagNode.md#hasoutgoingedges) + +*** + +### removeIncomingEdge() + +> **removeIncomingEdge**(`e`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:118 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`removeIncomingEdge`](PagNode.md#removeincomingedge) + +*** + +### removeOutgoingEdge() + +> **removeOutgoingEdge**(`e`): `boolean` + +Defined in: src/core/graph/BaseExplicitGraph.ts:122 + +#### Parameters + +##### e + +[`BaseEdge`](BaseEdge.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`PagNode`](PagNode.md).[`removeOutgoingEdge`](PagNode.md#removeoutgoingedge) + +*** + +### setBasePt() + +> **setBasePt**(`pt`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:156 + +#### Parameters + +##### pt + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`setBasePt`](PagNode.md#setbasept) + +*** + +### setCid() + +> **setCid**(`cid`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:167 + +#### Parameters + +##### cid + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`setCid`](PagNode.md#setcid) + +*** + +### setClonedFrom() + +> **setClonedFrom**(`id`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:301 + +#### Parameters + +##### id + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`setClonedFrom`](PagNode.md#setclonedfrom) + +*** + +### setKind() + +> **setKind**(`kind`): `void` + +Defined in: src/core/graph/BaseExplicitGraph.ts:90 + +#### Parameters + +##### kind + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`setKind`](PagNode.md#setkind) + +*** + +### setPointTo() + +> **setPointTo**(`pts`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:284 + +#### Parameters + +##### pts + +`Set`\<`number`\> + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`setPointTo`](PagNode.md#setpointto) + +*** + +### setStmt() + +> **setStmt**(`s`): `void` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:171 + +#### Parameters + +##### s + +[`Stmt`](Stmt.md) + +#### Returns + +`void` + +#### Inherited from + +[`PagNode`](PagNode.md).[`setStmt`](PagNode.md#setstmt) diff --git a/docs/api_docs/classes/PathEdge.md b/docs/api_docs/classes/PathEdge.md new file mode 100644 index 0000000000000000000000000000000000000000..c5efcf33666dfe785d554e2a23ddcb5f65e4e4cd --- /dev/null +++ b/docs/api_docs/classes/PathEdge.md @@ -0,0 +1,51 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / PathEdge + +# Class: PathEdge\ + +Defined in: src/core/dataflow/Edge.ts:28 + +## Type Parameters + +• **D** + +## Constructors + +### new PathEdge() + +> **new PathEdge**\<`D`\>(`start`, `end`): [`PathEdge`](PathEdge.md)\<`D`\> + +Defined in: src/core/dataflow/Edge.ts:32 + +#### Parameters + +##### start + +[`PathEdgePoint`](PathEdgePoint.md)\<`D`\> + +##### end + +[`PathEdgePoint`](PathEdgePoint.md)\<`D`\> + +#### Returns + +[`PathEdge`](PathEdge.md)\<`D`\> + +## Properties + +### edgeEnd + +> **edgeEnd**: [`PathEdgePoint`](PathEdgePoint.md)\<`D`\> + +Defined in: src/core/dataflow/Edge.ts:30 + +*** + +### edgeStart + +> **edgeStart**: [`PathEdgePoint`](PathEdgePoint.md)\<`D`\> + +Defined in: src/core/dataflow/Edge.ts:29 diff --git a/docs/api_docs/classes/PathEdgePoint.md b/docs/api_docs/classes/PathEdgePoint.md new file mode 100644 index 0000000000000000000000000000000000000000..826cf92a271c2e332b1ee04a960805df81dba619 --- /dev/null +++ b/docs/api_docs/classes/PathEdgePoint.md @@ -0,0 +1,51 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / PathEdgePoint + +# Class: PathEdgePoint\ + +Defined in: src/core/dataflow/Edge.ts:18 + +## Type Parameters + +• **D** + +## Constructors + +### new PathEdgePoint() + +> **new PathEdgePoint**\<`D`\>(`node`, `fact`): [`PathEdgePoint`](PathEdgePoint.md)\<`D`\> + +Defined in: src/core/dataflow/Edge.ts:22 + +#### Parameters + +##### node + +[`Stmt`](Stmt.md) + +##### fact + +`D` + +#### Returns + +[`PathEdgePoint`](PathEdgePoint.md)\<`D`\> + +## Properties + +### fact + +> **fact**: `D` + +Defined in: src/core/dataflow/Edge.ts:20 + +*** + +### node + +> **node**: [`Stmt`](Stmt.md) + +Defined in: src/core/dataflow/Edge.ts:19 diff --git a/docs/api_docs/classes/PointerAnalysis.md b/docs/api_docs/classes/PointerAnalysis.md new file mode 100644 index 0000000000000000000000000000000000000000..dc5c4a724ee43df950332114398bac83b302df5c --- /dev/null +++ b/docs/api_docs/classes/PointerAnalysis.md @@ -0,0 +1,527 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / PointerAnalysis + +# Class: PointerAnalysis + +Defined in: src/callgraph/pointerAnalysis/PointerAnalysis.ts:37 + +## Extends + +- [`AbstractAnalysis`](AbstractAnalysis.md) + +## Constructors + +### new PointerAnalysis() + +> **new PointerAnalysis**(`p`, `cg`, `s`, `config`): [`PointerAnalysis`](PointerAnalysis.md) + +Defined in: src/callgraph/pointerAnalysis/PointerAnalysis.ts:48 + +#### Parameters + +##### p + +[`Pag`](Pag.md) + +##### cg + +[`CallGraph`](CallGraph.md) + +##### s + +[`Scene`](Scene.md) + +##### config + +[`PointerAnalysisConfig`](PointerAnalysisConfig.md) + +#### Returns + +[`PointerAnalysis`](PointerAnalysis.md) + +#### Overrides + +[`AbstractAnalysis`](AbstractAnalysis.md).[`constructor`](AbstractAnalysis.md#constructors) + +## Properties + +### cg + +> `protected` **cg**: [`CallGraph`](CallGraph.md) + +Defined in: src/callgraph/algorithm/AbstractAnalysis.ts:32 + +#### Inherited from + +[`AbstractAnalysis`](AbstractAnalysis.md).[`cg`](AbstractAnalysis.md#cg) + +*** + +### cgBuilder + +> `protected` **cgBuilder**: [`CallGraphBuilder`](CallGraphBuilder.md) + +Defined in: src/callgraph/algorithm/AbstractAnalysis.ts:33 + +#### Inherited from + +[`AbstractAnalysis`](AbstractAnalysis.md).[`cgBuilder`](AbstractAnalysis.md#cgbuilder) + +*** + +### processedMethod + +> `protected` **processedMethod**: `Set`\<`number`\> + +Defined in: src/callgraph/algorithm/AbstractAnalysis.ts:35 + +#### Inherited from + +[`AbstractAnalysis`](AbstractAnalysis.md).[`processedMethod`](AbstractAnalysis.md#processedmethod) + +*** + +### scene + +> `protected` **scene**: [`Scene`](Scene.md) + +Defined in: src/callgraph/algorithm/AbstractAnalysis.ts:31 + +#### Inherited from + +[`AbstractAnalysis`](AbstractAnalysis.md).[`scene`](AbstractAnalysis.md#scene) + +*** + +### workList + +> `protected` **workList**: `number`[] = `[]` + +Defined in: src/callgraph/algorithm/AbstractAnalysis.ts:34 + +#### Inherited from + +[`AbstractAnalysis`](AbstractAnalysis.md).[`workList`](AbstractAnalysis.md#worklist) + +## Methods + +### addCallGraphEdge() + +> `protected` **addCallGraphEdge**(`caller`, `callee`, `cs`, `displayGeneratedMethod`): `void` + +Defined in: src/callgraph/algorithm/AbstractAnalysis.ts:147 + +#### Parameters + +##### caller + +`number` + +##### callee + +`null` | [`ArkMethod`](ArkMethod.md) + +##### cs + +[`CallSite`](CallSite.md) + +##### displayGeneratedMethod + +`boolean` + +#### Returns + +`void` + +#### Inherited from + +[`AbstractAnalysis`](AbstractAnalysis.md).[`addCallGraphEdge`](AbstractAnalysis.md#addcallgraphedge) + +*** + +### getCallGraph() + +> **getCallGraph**(): [`CallGraph`](CallGraph.md) + +Defined in: src/callgraph/algorithm/AbstractAnalysis.ts:45 + +#### Returns + +[`CallGraph`](CallGraph.md) + +#### Inherited from + +[`AbstractAnalysis`](AbstractAnalysis.md).[`getCallGraph`](AbstractAnalysis.md#getcallgraph) + +*** + +### getClassHierarchy() + +> **getClassHierarchy**(`arkClass`): [`ArkClass`](ArkClass.md)[] + +Defined in: src/callgraph/algorithm/AbstractAnalysis.ts:59 + +#### Parameters + +##### arkClass + +[`ArkClass`](ArkClass.md) + +#### Returns + +[`ArkClass`](ArkClass.md)[] + +#### Inherited from + +[`AbstractAnalysis`](AbstractAnalysis.md).[`getClassHierarchy`](AbstractAnalysis.md#getclasshierarchy) + +*** + +### getHandledFuncs() + +> **getHandledFuncs**(): `number`[] + +Defined in: src/callgraph/pointerAnalysis/PointerAnalysis.ts:588 + +#### Returns + +`number`[] + +*** + +### getParamAnonymousMethod() + +> `protected` **getParamAnonymousMethod**(`invokeExpr`): [`MethodSignature`](MethodSignature.md)[] + +Defined in: src/callgraph/algorithm/AbstractAnalysis.ts:134 + +#### Parameters + +##### invokeExpr + +[`AbstractInvokeExpr`](AbstractInvokeExpr.md) + +#### Returns + +[`MethodSignature`](MethodSignature.md)[] + +#### Inherited from + +[`AbstractAnalysis`](AbstractAnalysis.md).[`getParamAnonymousMethod`](AbstractAnalysis.md#getparamanonymousmethod) + +*** + +### getPTAConfig() + +> **getPTAConfig**(): [`PointerAnalysisConfig`](PointerAnalysisConfig.md) + +Defined in: src/callgraph/pointerAnalysis/PointerAnalysis.ts:592 + +#### Returns + +[`PointerAnalysisConfig`](PointerAnalysisConfig.md) + +*** + +### getRelatedNodes() + +> **getRelatedNodes**(`value`): `Set`\<[`Value`](../interfaces/Value.md)\> + +Defined in: src/callgraph/pointerAnalysis/PointerAnalysis.ts:471 + +#### Parameters + +##### value + +[`Value`](../interfaces/Value.md) + +#### Returns + +`Set`\<[`Value`](../interfaces/Value.md)\> + +*** + +### getScene() + +> **getScene**(): [`Scene`](Scene.md) + +Defined in: src/callgraph/algorithm/AbstractAnalysis.ts:41 + +#### Returns + +[`Scene`](Scene.md) + +#### Inherited from + +[`AbstractAnalysis`](AbstractAnalysis.md).[`getScene`](AbstractAnalysis.md#getscene) + +*** + +### getStat() + +> **getStat**(): `string` + +Defined in: src/callgraph/pointerAnalysis/PointerAnalysis.ts:116 + +#### Returns + +`string` + +*** + +### getTypeDiffMap() + +> **getTypeDiffMap**(): `Map`\<[`Value`](../interfaces/Value.md), `Set`\<[`Type`](Type.md)\>\> + +Defined in: src/callgraph/pointerAnalysis/PointerAnalysis.ts:576 + +#### Returns + +`Map`\<[`Value`](../interfaces/Value.md), `Set`\<[`Type`](Type.md)\>\> + +*** + +### getUnhandledFuncs() + +> **getUnhandledFuncs**(): `number`[] + +Defined in: src/callgraph/pointerAnalysis/PointerAnalysis.ts:584 + +#### Returns + +`number`[] + +*** + +### init() + +> `protected` **init**(): `void` + +Defined in: src/callgraph/pointerAnalysis/PointerAnalysis.ts:82 + +#### Returns + +`void` + +#### Overrides + +[`AbstractAnalysis`](AbstractAnalysis.md).[`init`](AbstractAnalysis.md#init) + +*** + +### mayAlias() + +> **mayAlias**(`leftValue`, `rightValue`): `boolean` + +Defined in: src/callgraph/pointerAnalysis/PointerAnalysis.ts:467 + +#### Parameters + +##### leftValue + +[`Value`](../interfaces/Value.md) + +##### rightValue + +[`Value`](../interfaces/Value.md) + +#### Returns + +`boolean` + +*** + +### mergeInstanceFieldMap() + +> **mergeInstanceFieldMap**(`src`, `dst`): `Map`\<`number`, `number`[]\> + +Defined in: src/callgraph/pointerAnalysis/PointerAnalysis.ts:628 + +#### Parameters + +##### src + +`Map`\<`number`, `number`[]\> + +##### dst + +`Map`\<`number`, `number`[]\> + +#### Returns + +`Map`\<`number`, `number`[]\> + +*** + +### noAlias() + +> **noAlias**(`leftValue`, `rightValue`): `boolean` + +Defined in: src/callgraph/pointerAnalysis/PointerAnalysis.ts:432 + +compare interface + +#### Parameters + +##### leftValue + +[`Value`](../interfaces/Value.md) + +##### rightValue + +[`Value`](../interfaces/Value.md) + +#### Returns + +`boolean` + +*** + +### preProcessMethod() + +> `protected` **preProcessMethod**(`funcID`): [`CallSite`](CallSite.md)[] + +Defined in: src/callgraph/pointerAnalysis/PointerAnalysis.ts:124 + +#### Parameters + +##### funcID + +`number` + +#### Returns + +[`CallSite`](CallSite.md)[] + +#### Overrides + +[`AbstractAnalysis`](AbstractAnalysis.md).[`preProcessMethod`](AbstractAnalysis.md#preprocessmethod) + +*** + +### processMethod() + +> `protected` **processMethod**(`methodID`): [`CallSite`](CallSite.md)[] + +Defined in: src/callgraph/algorithm/AbstractAnalysis.ts:112 + +#### Parameters + +##### methodID + +`number` + +#### Returns + +[`CallSite`](CallSite.md)[] + +#### Inherited from + +[`AbstractAnalysis`](AbstractAnalysis.md).[`processMethod`](AbstractAnalysis.md#processmethod) + +*** + +### resolveCall() + +> `protected` **resolveCall**(`sourceMethod`, `invokeStmt`): [`CallSite`](CallSite.md)[] + +Defined in: src/callgraph/pointerAnalysis/PointerAnalysis.ts:580 + +#### Parameters + +##### sourceMethod + +`number` + +##### invokeStmt + +[`Stmt`](Stmt.md) + +#### Returns + +[`CallSite`](CallSite.md)[] + +#### Overrides + +[`AbstractAnalysis`](AbstractAnalysis.md).[`resolveCall`](AbstractAnalysis.md#resolvecall) + +*** + +### resolveInvokeExpr() + +> **resolveInvokeExpr**(`invokeExpr`): `undefined` \| [`ArkMethod`](ArkMethod.md) + +Defined in: src/callgraph/algorithm/AbstractAnalysis.ts:52 + +#### Parameters + +##### invokeExpr + +[`AbstractInvokeExpr`](AbstractInvokeExpr.md) + +#### Returns + +`undefined` \| [`ArkMethod`](ArkMethod.md) + +#### Inherited from + +[`AbstractAnalysis`](AbstractAnalysis.md).[`resolveInvokeExpr`](AbstractAnalysis.md#resolveinvokeexpr) + +*** + +### setEntries() + +> **setEntries**(`fIds`): `void` + +Defined in: src/callgraph/pointerAnalysis/PointerAnalysis.ts:129 + +#### Parameters + +##### fIds + +`number`[] + +#### Returns + +`void` + +*** + +### start() + +> **start**(): `void` + +Defined in: src/callgraph/pointerAnalysis/PointerAnalysis.ts:94 + +#### Returns + +`void` + +#### Overrides + +[`AbstractAnalysis`](AbstractAnalysis.md).[`start`](AbstractAnalysis.md#start) + +*** + +### pointerAnalysisForWholeProject() + +> `static` **pointerAnalysisForWholeProject**(`projectScene`, `config`?): [`PointerAnalysis`](PointerAnalysis.md) + +Defined in: src/callgraph/pointerAnalysis/PointerAnalysis.ts:59 + +#### Parameters + +##### projectScene + +[`Scene`](Scene.md) + +##### config? + +[`PointerAnalysisConfig`](PointerAnalysisConfig.md) + +#### Returns + +[`PointerAnalysis`](PointerAnalysis.md) diff --git a/docs/api_docs/classes/PointerAnalysisConfig.md b/docs/api_docs/classes/PointerAnalysisConfig.md new file mode 100644 index 0000000000000000000000000000000000000000..38cb0aa009a540685a919d2f5c5aeee22265d399 --- /dev/null +++ b/docs/api_docs/classes/PointerAnalysisConfig.md @@ -0,0 +1,83 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / PointerAnalysisConfig + +# Class: PointerAnalysisConfig + +Defined in: src/callgraph/pointerAnalysis/PointerAnalysisConfig.ts:18 + +## Constructors + +### new PointerAnalysisConfig() + +> **new PointerAnalysisConfig**(`kLimit`, `outputDirectory`, `detectTypeDiff`, `dotDump`, `unhandledFuncDump`): [`PointerAnalysisConfig`](PointerAnalysisConfig.md) + +Defined in: src/callgraph/pointerAnalysis/PointerAnalysisConfig.ts:25 + +#### Parameters + +##### kLimit + +`number` + +##### outputDirectory + +`string` + +##### detectTypeDiff + +`boolean` = `false` + +##### dotDump + +`boolean` = `false` + +##### unhandledFuncDump + +`boolean` = `false` + +#### Returns + +[`PointerAnalysisConfig`](PointerAnalysisConfig.md) + +## Properties + +### detectTypeDiff + +> **detectTypeDiff**: `boolean` + +Defined in: src/callgraph/pointerAnalysis/PointerAnalysisConfig.ts:21 + +*** + +### dotDump + +> **dotDump**: `boolean` + +Defined in: src/callgraph/pointerAnalysis/PointerAnalysisConfig.ts:22 + +*** + +### kLimit + +> **kLimit**: `number` + +Defined in: src/callgraph/pointerAnalysis/PointerAnalysisConfig.ts:19 + +*** + +### outputDirectory + +> **outputDirectory**: `string` + +Defined in: src/callgraph/pointerAnalysis/PointerAnalysisConfig.ts:20 + +*** + +### unhandledFuncDump + +> **unhandledFuncDump**: `boolean` + +Defined in: src/callgraph/pointerAnalysis/PointerAnalysisConfig.ts:23 diff --git a/docs/api_docs/classes/PrimitiveType.md b/docs/api_docs/classes/PrimitiveType.md new file mode 100644 index 0000000000000000000000000000000000000000..70f678d2be6e9b004240b076029d7715e07c3e4c --- /dev/null +++ b/docs/api_docs/classes/PrimitiveType.md @@ -0,0 +1,90 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / PrimitiveType + +# Class: `abstract` PrimitiveType + +Defined in: src/core/base/Type.ts:118 + +primitive type + +## Extends + +- [`Type`](Type.md) + +## Extended by + +- [`BooleanType`](BooleanType.md) +- [`NumberType`](NumberType.md) +- [`StringType`](StringType.md) +- [`NullType`](NullType.md) +- [`UndefinedType`](UndefinedType.md) +- [`LiteralType`](LiteralType.md) + +## Constructors + +### new PrimitiveType() + +> **new PrimitiveType**(`name`): [`PrimitiveType`](PrimitiveType.md) + +Defined in: src/core/base/Type.ts:121 + +#### Parameters + +##### name + +`string` + +#### Returns + +[`PrimitiveType`](PrimitiveType.md) + +#### Overrides + +[`Type`](Type.md).[`constructor`](Type.md#constructors) + +## Methods + +### getName() + +> **getName**(): `string` + +Defined in: src/core/base/Type.ts:126 + +#### Returns + +`string` + +*** + +### getTypeString() + +> **getTypeString**(): `string` + +Defined in: src/core/base/Type.ts:130 + +#### Returns + +`string` + +#### Overrides + +[`Type`](Type.md).[`getTypeString`](Type.md#gettypestring) + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/base/Type.ts:36 + +#### Returns + +`string` + +#### Inherited from + +[`Type`](Type.md).[`toString`](Type.md#tostring) diff --git a/docs/api_docs/classes/Printer.md b/docs/api_docs/classes/Printer.md new file mode 100644 index 0000000000000000000000000000000000000000..6bd2c5d18c25c2097dc720b6b156168600570c46 --- /dev/null +++ b/docs/api_docs/classes/Printer.md @@ -0,0 +1,60 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / Printer + +# Class: `abstract` Printer + +Defined in: src/save/Printer.ts:21 + +## Extended by + +- [`DotMethodPrinter`](DotMethodPrinter.md) +- [`DotClassPrinter`](DotClassPrinter.md) +- [`DotNamespacePrinter`](DotNamespacePrinter.md) +- [`DotFilePrinter`](DotFilePrinter.md) +- [`SourceFilePrinter`](SourceFilePrinter.md) +- [`JsonPrinter`](JsonPrinter.md) +- [`GraphPrinter`](GraphPrinter.md) +- [`ViewTreePrinter`](ViewTreePrinter.md) + +## Constructors + +### new Printer() + +> **new Printer**(`indent`): [`Printer`](Printer.md) + +Defined in: src/save/Printer.ts:24 + +#### Parameters + +##### indent + +`string` = `''` + +#### Returns + +[`Printer`](Printer.md) + +## Properties + +### printer + +> `protected` **printer**: `ArkCodeBuffer` + +Defined in: src/save/Printer.ts:22 + +## Methods + +### dump() + +> `abstract` **dump**(): `string` + +Defined in: src/save/Printer.ts:31 + +ArkIR dump + +#### Returns + +`string` diff --git a/docs/api_docs/classes/PrinterBuilder.md b/docs/api_docs/classes/PrinterBuilder.md new file mode 100644 index 0000000000000000000000000000000000000000..b4dba0d8776dc565390a4c9fd0e8646b01b6cb6d --- /dev/null +++ b/docs/api_docs/classes/PrinterBuilder.md @@ -0,0 +1,160 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / PrinterBuilder + +# Class: PrinterBuilder + +Defined in: src/save/PrinterBuilder.ts:44 + +## Example + +```ts +// dump method IR to ts source +let method: Method = xx; +let srcPrinter = new SourceMethodPrinter(method); +PrinterBuilder.dump(srcPrinter, 'output.ts'); + +// dump method cfg to dot +let dotPrinter = new DotMethodPrinter(method); +PrinterBuilder.dump(dotPrinter, 'output.dot'); + +// dump project +let printer = new PrinterBuilder('output'); +for (let f of scene.getFiles()) { + printer.dumpToTs(f); +} +``` + +## Constructors + +### new PrinterBuilder() + +> **new PrinterBuilder**(`outputDir`): [`PrinterBuilder`](PrinterBuilder.md) + +Defined in: src/save/PrinterBuilder.ts:46 + +#### Parameters + +##### outputDir + +`string` = `''` + +#### Returns + +[`PrinterBuilder`](PrinterBuilder.md) + +## Properties + +### outputDir + +> **outputDir**: `string` + +Defined in: src/save/PrinterBuilder.ts:45 + +## Methods + +### dumpToDot() + +> **dumpToDot**(`arkFile`, `output`): `void` + +Defined in: src/save/PrinterBuilder.ts:62 + +#### Parameters + +##### arkFile + +[`ArkFile`](ArkFile.md) + +##### output + +`undefined` | `string` + +#### Returns + +`void` + +*** + +### dumpToJson() + +> **dumpToJson**(`arkFile`, `output`): `void` + +Defined in: src/save/PrinterBuilder.ts:93 + +#### Parameters + +##### arkFile + +[`ArkFile`](ArkFile.md) + +##### output + +`undefined` | `string` + +#### Returns + +`void` + +*** + +### dumpToTs() + +> **dumpToTs**(`arkFile`, `output`): `void` + +Defined in: src/save/PrinterBuilder.ts:76 + +#### Parameters + +##### arkFile + +[`ArkFile`](ArkFile.md) + +##### output + +`undefined` | `string` + +#### Returns + +`void` + +*** + +### getOutputDir() + +> `protected` **getOutputDir**(`arkFile`): `string` + +Defined in: src/save/PrinterBuilder.ts:54 + +#### Parameters + +##### arkFile + +[`ArkFile`](ArkFile.md) + +#### Returns + +`string` + +*** + +### dump() + +> `static` **dump**(`source`, `output`): `void` + +Defined in: src/save/PrinterBuilder.ts:50 + +#### Parameters + +##### source + +[`Printer`](Printer.md) + +##### output + +`string` + +#### Returns + +`void` diff --git a/docs/api_docs/classes/PtsSet.md b/docs/api_docs/classes/PtsSet.md new file mode 100644 index 0000000000000000000000000000000000000000..bfa356a85de44bfbdcd44f59dbb9ebba7fba0dc2 --- /dev/null +++ b/docs/api_docs/classes/PtsSet.md @@ -0,0 +1,283 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / PtsSet + +# Class: PtsSet\ + +Defined in: src/callgraph/pointerAnalysis/PtsDS.ts:39 + +## Type Parameters + +• **T** *extends* `Idx` + +## Implements + +- `IPtsCollection`\<`T`\> + +## Constructors + +### new PtsSet() + +> **new PtsSet**\<`T`\>(): [`PtsSet`](PtsSet.md)\<`T`\> + +Defined in: src/callgraph/pointerAnalysis/PtsDS.ts:45 + +#### Returns + +[`PtsSet`](PtsSet.md)\<`T`\> + +## Properties + +### pts + +> **pts**: `Set`\<`T`\> + +Defined in: src/callgraph/pointerAnalysis/PtsDS.ts:40 + +## Methods + +### \[iterator\]() + +> **\[iterator\]**(): `IterableIterator`\<`T`\> + +Defined in: src/callgraph/pointerAnalysis/PtsDS.ts:129 + +#### Returns + +`IterableIterator`\<`T`\> + +#### Implementation of + +`IPtsCollection.[iterator]` + +*** + +### clear() + +> **clear**(): `void` + +Defined in: src/callgraph/pointerAnalysis/PtsDS.ts:93 + +#### Returns + +`void` + +#### Implementation of + +`IPtsCollection.clear` + +*** + +### clone() + +> **clone**(): `this` + +Defined in: src/callgraph/pointerAnalysis/PtsDS.ts:69 + +#### Returns + +`this` + +#### Implementation of + +`IPtsCollection.clone` + +*** + +### contains() + +> **contains**(`elem`): `boolean` + +Defined in: src/callgraph/pointerAnalysis/PtsDS.ts:49 + +#### Parameters + +##### elem + +`T` + +#### Returns + +`boolean` + +#### Implementation of + +`IPtsCollection.contains` + +*** + +### count() + +> **count**(): `number` + +Defined in: src/callgraph/pointerAnalysis/PtsDS.ts:97 + +#### Returns + +`number` + +#### Implementation of + +`IPtsCollection.count` + +*** + +### getProtoPtsSet() + +> **getProtoPtsSet**(): `Set`\<`T`\> + +Defined in: src/callgraph/pointerAnalysis/PtsDS.ts:125 + +#### Returns + +`Set`\<`T`\> + +*** + +### insert() + +> **insert**(`elem`): `boolean` + +Defined in: src/callgraph/pointerAnalysis/PtsDS.ts:53 + +#### Parameters + +##### elem + +`T` + +#### Returns + +`boolean` + +#### Implementation of + +`IPtsCollection.insert` + +*** + +### intersect() + +> **intersect**(`other`): `boolean` + +Defined in: src/callgraph/pointerAnalysis/PtsDS.ts:116 + +#### Parameters + +##### other + +`this` + +#### Returns + +`boolean` + +#### Implementation of + +`IPtsCollection.intersect` + +*** + +### isEmpty() + +> **isEmpty**(): `boolean` + +Defined in: src/callgraph/pointerAnalysis/PtsDS.ts:101 + +#### Returns + +`boolean` + +#### Implementation of + +`IPtsCollection.isEmpty` + +*** + +### remove() + +> **remove**(`elem`): `boolean` + +Defined in: src/callgraph/pointerAnalysis/PtsDS.ts:61 + +#### Parameters + +##### elem + +`T` + +#### Returns + +`boolean` + +#### Implementation of + +`IPtsCollection.remove` + +*** + +### subtract() + +> **subtract**(`other`): `boolean` + +Defined in: src/callgraph/pointerAnalysis/PtsDS.ts:84 + +#### Parameters + +##### other + +`this` + +#### Returns + +`boolean` + +#### Implementation of + +`IPtsCollection.subtract` + +*** + +### superset() + +> **superset**(`other`): `boolean` + +Defined in: src/callgraph/pointerAnalysis/PtsDS.ts:106 + +#### Parameters + +##### other + +`this` + +#### Returns + +`boolean` + +#### Implementation of + +`IPtsCollection.superset` + +*** + +### union() + +> **union**(`other`): `boolean` + +Defined in: src/callgraph/pointerAnalysis/PtsDS.ts:76 + +#### Parameters + +##### other + +`this` + +#### Returns + +`boolean` + +#### Implementation of + +`IPtsCollection.union` diff --git a/docs/api_docs/classes/RapidTypeAnalysis.md b/docs/api_docs/classes/RapidTypeAnalysis.md new file mode 100644 index 0000000000000000000000000000000000000000..e272f9f5dc15d8236f0092c443cf7ad1c3db2108 --- /dev/null +++ b/docs/api_docs/classes/RapidTypeAnalysis.md @@ -0,0 +1,369 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / RapidTypeAnalysis + +# Class: RapidTypeAnalysis + +Defined in: src/callgraph/algorithm/RapidTypeAnalysis.ts:29 + +## Extends + +- [`AbstractAnalysis`](AbstractAnalysis.md) + +## Constructors + +### new RapidTypeAnalysis() + +> **new RapidTypeAnalysis**(`scene`, `cg`): [`RapidTypeAnalysis`](RapidTypeAnalysis.md) + +Defined in: src/callgraph/algorithm/RapidTypeAnalysis.ts:35 + +#### Parameters + +##### scene + +[`Scene`](Scene.md) + +##### cg + +[`CallGraph`](CallGraph.md) + +#### Returns + +[`RapidTypeAnalysis`](RapidTypeAnalysis.md) + +#### Overrides + +[`AbstractAnalysis`](AbstractAnalysis.md).[`constructor`](AbstractAnalysis.md#constructors) + +## Properties + +### cg + +> `protected` **cg**: [`CallGraph`](CallGraph.md) + +Defined in: src/callgraph/algorithm/AbstractAnalysis.ts:32 + +#### Inherited from + +[`AbstractAnalysis`](AbstractAnalysis.md).[`cg`](AbstractAnalysis.md#cg) + +*** + +### cgBuilder + +> `protected` **cgBuilder**: [`CallGraphBuilder`](CallGraphBuilder.md) + +Defined in: src/callgraph/algorithm/AbstractAnalysis.ts:33 + +#### Inherited from + +[`AbstractAnalysis`](AbstractAnalysis.md).[`cgBuilder`](AbstractAnalysis.md#cgbuilder) + +*** + +### processedMethod + +> `protected` **processedMethod**: `Set`\<`number`\> + +Defined in: src/callgraph/algorithm/AbstractAnalysis.ts:35 + +#### Inherited from + +[`AbstractAnalysis`](AbstractAnalysis.md).[`processedMethod`](AbstractAnalysis.md#processedmethod) + +*** + +### scene + +> `protected` **scene**: [`Scene`](Scene.md) + +Defined in: src/callgraph/algorithm/AbstractAnalysis.ts:31 + +#### Inherited from + +[`AbstractAnalysis`](AbstractAnalysis.md).[`scene`](AbstractAnalysis.md#scene) + +*** + +### workList + +> `protected` **workList**: `number`[] = `[]` + +Defined in: src/callgraph/algorithm/AbstractAnalysis.ts:34 + +#### Inherited from + +[`AbstractAnalysis`](AbstractAnalysis.md).[`workList`](AbstractAnalysis.md#worklist) + +## Methods + +### addCallGraphEdge() + +> `protected` **addCallGraphEdge**(`caller`, `callee`, `cs`, `displayGeneratedMethod`): `void` + +Defined in: src/callgraph/algorithm/AbstractAnalysis.ts:147 + +#### Parameters + +##### caller + +`number` + +##### callee + +`null` | [`ArkMethod`](ArkMethod.md) + +##### cs + +[`CallSite`](CallSite.md) + +##### displayGeneratedMethod + +`boolean` + +#### Returns + +`void` + +#### Inherited from + +[`AbstractAnalysis`](AbstractAnalysis.md).[`addCallGraphEdge`](AbstractAnalysis.md#addcallgraphedge) + +*** + +### addIgnoredCalls() + +> **addIgnoredCalls**(`arkClass`, `callerID`, `calleeID`, `invokeStmt`): `void` + +Defined in: src/callgraph/algorithm/RapidTypeAnalysis.ts:149 + +#### Parameters + +##### arkClass + +[`ClassSignature`](ClassSignature.md) + +##### callerID + +`number` + +##### calleeID + +`number` + +##### invokeStmt + +[`Stmt`](Stmt.md) + +#### Returns + +`void` + +*** + +### getCallGraph() + +> **getCallGraph**(): [`CallGraph`](CallGraph.md) + +Defined in: src/callgraph/algorithm/AbstractAnalysis.ts:45 + +#### Returns + +[`CallGraph`](CallGraph.md) + +#### Inherited from + +[`AbstractAnalysis`](AbstractAnalysis.md).[`getCallGraph`](AbstractAnalysis.md#getcallgraph) + +*** + +### getClassHierarchy() + +> **getClassHierarchy**(`arkClass`): [`ArkClass`](ArkClass.md)[] + +Defined in: src/callgraph/algorithm/AbstractAnalysis.ts:59 + +#### Parameters + +##### arkClass + +[`ArkClass`](ArkClass.md) + +#### Returns + +[`ArkClass`](ArkClass.md)[] + +#### Inherited from + +[`AbstractAnalysis`](AbstractAnalysis.md).[`getClassHierarchy`](AbstractAnalysis.md#getclasshierarchy) + +*** + +### getParamAnonymousMethod() + +> `protected` **getParamAnonymousMethod**(`invokeExpr`): [`MethodSignature`](MethodSignature.md)[] + +Defined in: src/callgraph/algorithm/AbstractAnalysis.ts:134 + +#### Parameters + +##### invokeExpr + +[`AbstractInvokeExpr`](AbstractInvokeExpr.md) + +#### Returns + +[`MethodSignature`](MethodSignature.md)[] + +#### Inherited from + +[`AbstractAnalysis`](AbstractAnalysis.md).[`getParamAnonymousMethod`](AbstractAnalysis.md#getparamanonymousmethod) + +*** + +### getScene() + +> **getScene**(): [`Scene`](Scene.md) + +Defined in: src/callgraph/algorithm/AbstractAnalysis.ts:41 + +#### Returns + +[`Scene`](Scene.md) + +#### Inherited from + +[`AbstractAnalysis`](AbstractAnalysis.md).[`getScene`](AbstractAnalysis.md#getscene) + +*** + +### init() + +> `protected` **init**(): `void` + +Defined in: src/callgraph/algorithm/AbstractAnalysis.ts:105 + +#### Returns + +`void` + +#### Inherited from + +[`AbstractAnalysis`](AbstractAnalysis.md).[`init`](AbstractAnalysis.md#init) + +*** + +### preProcessMethod() + +> `protected` **preProcessMethod**(`funcID`): [`CallSite`](CallSite.md)[] + +Defined in: src/callgraph/algorithm/RapidTypeAnalysis.ts:100 + +#### Parameters + +##### funcID + +`number` + +#### Returns + +[`CallSite`](CallSite.md)[] + +#### Overrides + +[`AbstractAnalysis`](AbstractAnalysis.md).[`preProcessMethod`](AbstractAnalysis.md#preprocessmethod) + +*** + +### processMethod() + +> `protected` **processMethod**(`methodID`): [`CallSite`](CallSite.md)[] + +Defined in: src/callgraph/algorithm/AbstractAnalysis.ts:112 + +#### Parameters + +##### methodID + +`number` + +#### Returns + +[`CallSite`](CallSite.md)[] + +#### Inherited from + +[`AbstractAnalysis`](AbstractAnalysis.md).[`processMethod`](AbstractAnalysis.md#processmethod) + +*** + +### resolveCall() + +> **resolveCall**(`callerMethod`, `invokeStmt`): [`CallSite`](CallSite.md)[] + +Defined in: src/callgraph/algorithm/RapidTypeAnalysis.ts:40 + +#### Parameters + +##### callerMethod + +`number` + +##### invokeStmt + +[`Stmt`](Stmt.md) + +#### Returns + +[`CallSite`](CallSite.md)[] + +#### Overrides + +[`AbstractAnalysis`](AbstractAnalysis.md).[`resolveCall`](AbstractAnalysis.md#resolvecall) + +*** + +### resolveInvokeExpr() + +> **resolveInvokeExpr**(`invokeExpr`): `undefined` \| [`ArkMethod`](ArkMethod.md) + +Defined in: src/callgraph/algorithm/AbstractAnalysis.ts:52 + +#### Parameters + +##### invokeExpr + +[`AbstractInvokeExpr`](AbstractInvokeExpr.md) + +#### Returns + +`undefined` \| [`ArkMethod`](ArkMethod.md) + +#### Inherited from + +[`AbstractAnalysis`](AbstractAnalysis.md).[`resolveInvokeExpr`](AbstractAnalysis.md#resolveinvokeexpr) + +*** + +### start() + +> **start**(`displayGeneratedMethod`): `void` + +Defined in: src/callgraph/algorithm/AbstractAnalysis.ts:75 + +#### Parameters + +##### displayGeneratedMethod + +`boolean` + +#### Returns + +`void` + +#### Inherited from + +[`AbstractAnalysis`](AbstractAnalysis.md).[`start`](AbstractAnalysis.md#start) diff --git a/docs/api_docs/classes/RefUseReplacer.md b/docs/api_docs/classes/RefUseReplacer.md new file mode 100644 index 0000000000000000000000000000000000000000..035c24abe5d1c068e86b67ed639e15a1e10f4e09 --- /dev/null +++ b/docs/api_docs/classes/RefUseReplacer.md @@ -0,0 +1,51 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / RefUseReplacer + +# Class: RefUseReplacer + +Defined in: src/core/common/RefUseReplacer.ts:23 + +Replace old use of a Ref inplace + +## Constructors + +### new RefUseReplacer() + +> **new RefUseReplacer**(`oldUse`, `newUse`): [`RefUseReplacer`](RefUseReplacer.md) + +Defined in: src/core/common/RefUseReplacer.ts:27 + +#### Parameters + +##### oldUse + +[`Value`](../interfaces/Value.md) + +##### newUse + +[`Value`](../interfaces/Value.md) + +#### Returns + +[`RefUseReplacer`](RefUseReplacer.md) + +## Methods + +### caseRef() + +> **caseRef**(`ref`): `void` + +Defined in: src/core/common/RefUseReplacer.ts:32 + +#### Parameters + +##### ref + +[`AbstractRef`](AbstractRef.md) + +#### Returns + +`void` diff --git a/docs/api_docs/classes/SCCDetection.md b/docs/api_docs/classes/SCCDetection.md new file mode 100644 index 0000000000000000000000000000000000000000..d092ab43154b4a64c10b740b7ba9e735b5396864 --- /dev/null +++ b/docs/api_docs/classes/SCCDetection.md @@ -0,0 +1,162 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / SCCDetection + +# Class: SCCDetection\ + +Defined in: src/core/graph/Scc.ts:59 + +Detect strongly connected components in a directed graph +A topological graph is an extra product from this algorithm +Advanced Nuutila’s algorithm which come from the following paper: + Wave Propagation and Deep Propagation for pointer Analysis + CGO 2009 + +## Type Parameters + +• **Graph** *extends* [`GraphTraits`](../interfaces/GraphTraits.md) + +## Constructors + +### new SCCDetection() + +> **new SCCDetection**\<`Graph`\>(`GT`): [`SCCDetection`](SCCDetection.md)\<`Graph`\> + +Defined in: src/core/graph/Scc.ts:83 + +#### Parameters + +##### GT + +`Graph` + +#### Returns + +[`SCCDetection`](SCCDetection.md)\<`Graph`\> + +## Methods + +### find() + +> **find**(): `void` + +Defined in: src/core/graph/Scc.ts:217 + +Start to detect and collapse SCC + +#### Returns + +`void` + +*** + +### getMySCCNodes() + +> **getMySCCNodes**(`n`): `NodeSet` + +Defined in: src/core/graph/Scc.ts:254 + +#### Parameters + +##### n + +`number` + +#### Returns + +`NodeSet` + +*** + +### getNode2SCCInfoMap() + +> **getNode2SCCInfoMap**(): `Node2RepSCCInfoMap` + +Defined in: src/core/graph/Scc.ts:232 + +#### Returns + +`Node2RepSCCInfoMap` + +*** + +### getRepNode() + +> **getRepNode**(`n`): `number` + +Defined in: src/core/graph/Scc.ts:205 + +Get the rep node +If not found return itself + +#### Parameters + +##### n + +`number` + +#### Returns + +`number` + +*** + +### getRepNodes() + +> **getRepNodes**(): `NodeSet` + +Defined in: src/core/graph/Scc.ts:274 + +#### Returns + +`NodeSet` + +*** + +### getSubNodes() + +> **getSubNodes**(`n`): `NodeSet` + +Defined in: src/core/graph/Scc.ts:260 + +#### Parameters + +##### n + +`number` + +#### Returns + +`NodeSet` + +*** + +### getTopoAndCollapsedNodeStack() + +> **getTopoAndCollapsedNodeStack**(): `NodeStack` + +Defined in: src/core/graph/Scc.ts:228 + +#### Returns + +`NodeStack` + +*** + +### nodeIsInCycle() + +> **nodeIsInCycle**(`n`): `boolean` + +Defined in: src/core/graph/Scc.ts:237 + +#### Parameters + +##### n + +`number` + +#### Returns + +`boolean` diff --git a/docs/api_docs/classes/Scene.md b/docs/api_docs/classes/Scene.md new file mode 100644 index 0000000000000000000000000000000000000000..284f7761addec74a4b7ca57c5c4c6769601645c2 --- /dev/null +++ b/docs/api_docs/classes/Scene.md @@ -0,0 +1,907 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / Scene + +# Class: Scene + +Defined in: src/Scene.ts:61 + +The Scene class includes everything in the analyzed project. +We should be able to re-generate the project's code based on this class. + +## Constructors + +### new Scene() + +> **new Scene**(): [`Scene`](Scene.md) + +Defined in: src/Scene.ts:95 + +#### Returns + +[`Scene`](Scene.md) + +## Methods + +### addToMethodsMap() + +> **addToMethodsMap**(`method`): `void` + +Defined in: src/Scene.ts:894 + +#### Parameters + +##### method + +[`ArkMethod`](ArkMethod.md) + +#### Returns + +`void` + +*** + +### buildBasicInfo() + +> **buildBasicInfo**(`sceneConfig`): `void` + +Defined in: src/Scene.ts:170 + +Set the basic information of the scene using a config, +such as the project's name, real path and files. + +#### Parameters + +##### sceneConfig + +[`SceneConfig`](SceneConfig.md) + +the config used to set the basic information of scene. + +#### Returns + +`void` + +*** + +### buildClassDone() + +> **buildClassDone**(): `boolean` + +Defined in: src/Scene.ts:1239 + +#### Returns + +`boolean` + +*** + +### buildModuleScene() + +> **buildModuleScene**(`moduleName`, `modulePath`, `supportFileExts`): `void` + +Defined in: src/Scene.ts:585 + +#### Parameters + +##### moduleName + +`string` + +##### modulePath + +`string` + +##### supportFileExts + +`string`[] + +#### Returns + +`void` + +*** + +### buildScene4HarmonyProject() + +> **buildScene4HarmonyProject**(): `void` + +Defined in: src/Scene.ts:563 + +Build the scene for harmony project. It resolves the file path of the project first, and then fetches dependencies from this file. +Next, build a `ModuleScene` for this project to generate [ArkFile](ArkFile.md). Finally, it build bodies of all methods, generate extended classes, and add DefaultConstructors. + +#### Returns + +`void` + +*** + +### buildSceneFromFiles() + +> **buildSceneFromFiles**(`sceneConfig`): `void` + +Defined in: src/Scene.ts:158 + +#### Parameters + +##### sceneConfig + +[`SceneConfig`](SceneConfig.md) + +#### Returns + +`void` + +*** + +### buildSceneFromProjectDir() + +> **buildSceneFromProjectDir**(`sceneConfig`): `void` + +Defined in: src/Scene.ts:153 + +Build scene object according to the [SceneConfig](SceneConfig.md). This API implements 3 functions. +First is to build scene object from [SceneConfig](SceneConfig.md), second is to generate [ArkFile](ArkFile.md)s, +and the last is to collect project import infomation. + +#### Parameters + +##### sceneConfig + +[`SceneConfig`](SceneConfig.md) + +a sceneConfig object, which is usally defined by user or Json file. + +#### Returns + +`void` + +#### Example + +1. Build Scene object from scene config + +```typescript +// build config +const projectDir = ... ...; +const sceneConfig = new SceneConfig(); +sceneConfig.buildFromProjectDir(projectDir); + +// build scene +const scene = new Scene(); +scene.buildSceneFromProjectDir(sceneConfig); +``` + +*** + +### clear() + +> **clear**(): `void` + +Defined in: src/Scene.ts:110 + +#### Returns + +`void` + +*** + +### getbaseUrl() + +> **getbaseUrl**(): `undefined` \| `string` + +Defined in: src/Scene.ts:1255 + +#### Returns + +`undefined` \| `string` + +*** + +### getClass() + +> **getClass**(`classSignature`): `null` \| [`ArkClass`](ArkClass.md) + +Defined in: src/Scene.ts:788 + +Returns the class according to the input class signature. + +#### Parameters + +##### classSignature + +[`ClassSignature`](ClassSignature.md) + +signature of the class to be obtained. + +#### Returns + +`null` \| [`ArkClass`](ArkClass.md) + +A class. + +*** + +### getClasses() + +> **getClasses**(): [`ArkClass`](ArkClass.md)[] + +Defined in: src/Scene.ts:830 + +#### Returns + +[`ArkClass`](ArkClass.md)[] + +*** + +### getClassMap() + +> **getClassMap**(): `Map`\<[`NamespaceSignature`](NamespaceSignature.md) \| [`FileSignature`](FileSignature.md), [`ArkClass`](ArkClass.md)[]\> + +Defined in: src/Scene.ts:1003 + +#### Returns + +`Map`\<[`NamespaceSignature`](NamespaceSignature.md) \| [`FileSignature`](FileSignature.md), [`ArkClass`](ArkClass.md)[]\> + +*** + +### getEntryPoints() + +> **getEntryPoints**(): `never`[] + +Defined in: src/Scene.ts:919 + +#### Returns + +`never`[] + +*** + +### getFile() + +> **getFile**(`fileSignature`): `null` \| [`ArkFile`](ArkFile.md) + +Defined in: src/Scene.ts:682 + +Returns the file based on its signature. +If no file can be found according to the input signature, **null** will be returned. +A typical [ArkFile](ArkFile.md) contains: file's name (i.e., its relative path), project's name, +project's dir, file's signature etc. + +#### Parameters + +##### fileSignature + +[`FileSignature`](FileSignature.md) + +the signature of file. + +#### Returns + +`null` \| [`ArkFile`](ArkFile.md) + +a file defined by ArkAnalyzer. **null** will be returned if no file could be found. + +#### Example + +1. get ArkFile based on file signature. + +```typescript +if (...) { +const fromSignature = new FileSignature(); +fromSignature.setProjectName(im.getDeclaringArkFile().getProjectName()); +fromSignature.setFileName(fileName); +return scene.getFile(fromSignature); +} +``` + +*** + +### getFiles() + +> **getFiles**(): [`ArkFile`](ArkFile.md)[] + +Defined in: src/Scene.ts:725 + +Get files of a [Scene](Scene.md). Generally, a project includes several ets/ts files that define the different class. We need to generate [ArkFile](ArkFile.md) objects from these ets/ts files. + +#### Returns + +[`ArkFile`](ArkFile.md)[] + +The array of [ArkFile](ArkFile.md) from `scene.filesMap.values()`. + +#### Example + +1. In inferSimpleTypes() to check arkClass and arkMethod. +```typescript +public inferSimpleTypes() { + for (let arkFile of this.getFiles()) { + for (let arkClass of arkFile.getClasses()) { + for (let arkMethod of arkClass.getMethods()) { + // ... ...; + } + } + } +} +``` +2. To iterate each method +```typescript +for (const file of this.getFiles()) { + for (const cls of file.getClasses()) { + for (const method of cls.getMethods()) { + // ... ... + } + } +} +``` + +*** + +### getGlobalModule2PathMapping() + +> **getGlobalModule2PathMapping**(): `undefined` \| \{\} + +Defined in: src/Scene.ts:1251 + +#### Returns + +`undefined` \| \{\} + +*** + +### getGlobalVariableMap() + +> **getGlobalVariableMap**(): `Map`\<[`NamespaceSignature`](NamespaceSignature.md) \| [`FileSignature`](FileSignature.md), [`Local`](Local.md)[]\> + +Defined in: src/Scene.ts:1110 + +#### Returns + +`Map`\<[`NamespaceSignature`](NamespaceSignature.md) \| [`FileSignature`](FileSignature.md), [`Local`](Local.md)[]\> + +*** + +### getMethod() + +> **getMethod**(`methodSignature`, `refresh`?): `null` \| [`ArkMethod`](ArkMethod.md) + +Defined in: src/Scene.ts:834 + +#### Parameters + +##### methodSignature + +[`MethodSignature`](MethodSignature.md) + +##### refresh? + +`boolean` + +#### Returns + +`null` \| [`ArkMethod`](ArkMethod.md) + +*** + +### getMethods() + +> **getMethods**(): [`ArkMethod`](ArkMethod.md)[] + +Defined in: src/Scene.ts:890 + +Returns the method associated with the method signature. +If no method is associated with this signature, **null** will be returned. +An [ArkMethod](ArkMethod.md) includes: +- Name: the **string** name of method. +- Code: the **string** code of the method. +- Line: a **number** indicating the line location, initialized as -1. +- Column: a **number** indicating the column location, initialized as -1. +- Parameters & Types of parameters: the parameters of method and their types. +- View tree: the view tree of the method. +- ... + +#### Returns + +[`ArkMethod`](ArkMethod.md)[] + +The method associated with the method signature. + +#### Example + +1. get method from getMethod. + +```typescript +const methodSignatures = this.CHA.resolveCall(xxx, yyy); +for (const methodSignature of methodSignatures) { +const method = this.scene.getMethod(methodSignature); +... ... +} +``` + +*** + +### getModuleScene() + +> **getModuleScene**(`moduleName`): `undefined` \| `ModuleScene` + +Defined in: src/Scene.ts:1243 + +#### Parameters + +##### moduleName + +`string` + +#### Returns + +`undefined` \| `ModuleScene` + +*** + +### getModuleSceneMap() + +> **getModuleSceneMap**(): `Map`\<`string`, `ModuleScene`\> + +Defined in: src/Scene.ts:1247 + +#### Returns + +`Map`\<`string`, `ModuleScene`\> + +*** + +### getModuleSdkMap() + +> **getModuleSdkMap**(): `Map`\<`string`, `Sdk`[]\> + +Defined in: src/Scene.ts:733 + +#### Returns + +`Map`\<`string`, `Sdk`[]\> + +*** + +### getNamespace() + +> **getNamespace**(`namespaceSignature`): `null` \| [`ArkNamespace`](ArkNamespace.md) + +Defined in: src/Scene.ts:741 + +#### Parameters + +##### namespaceSignature + +[`NamespaceSignature`](NamespaceSignature.md) + +#### Returns + +`null` \| [`ArkNamespace`](ArkNamespace.md) + +*** + +### getNamespaces() + +> **getNamespaces**(): [`ArkNamespace`](ArkNamespace.md)[] + +Defined in: src/Scene.ts:779 + +#### Returns + +[`ArkNamespace`](ArkNamespace.md)[] + +*** + +### getOhPkgContent() + +> **getOhPkgContent**(): `object` + +Defined in: src/Scene.ts:928 + +#### Returns + +`object` + +*** + +### getOhPkgContentMap() + +> **getOhPkgContentMap**(): `Map`\<`string`, \{\}\> + +Defined in: src/Scene.ts:932 + +#### Returns + +`Map`\<`string`, \{\}\> + +*** + +### getOhPkgFilePath() + +> **getOhPkgFilePath**(): `string` + +Defined in: src/Scene.ts:936 + +#### Returns + +`string` + +*** + +### getOptions() + +> **getOptions**(): `SceneOptions` + +Defined in: src/Scene.ts:98 + +#### Returns + +`SceneOptions` + +*** + +### getOverRideDependencyMap() + +> **getOverRideDependencyMap**(): `Map`\<`string`, `unknown`\> + +Defined in: src/Scene.ts:106 + +#### Returns + +`Map`\<`string`, `unknown`\> + +*** + +### getOverRides() + +> **getOverRides**(): `Map`\<`string`, `string`\> + +Defined in: src/Scene.ts:102 + +#### Returns + +`Map`\<`string`, `string`\> + +*** + +### getProjectFiles() + +> **getProjectFiles**(): `string`[] + +Defined in: src/Scene.ts:655 + +#### Returns + +`string`[] + +*** + +### getProjectName() + +> **getProjectName**(): `string` + +Defined in: src/Scene.ts:651 + +Returns the **string** name of the project. + +#### Returns + +`string` + +The name of the project. + +*** + +### getProjectSdkMap() + +> **getProjectSdkMap**(): `Map`\<`string`, `Sdk`\> + +Defined in: src/Scene.ts:737 + +#### Returns + +`Map`\<`string`, `Sdk`\> + +*** + +### getRealProjectDir() + +> **getRealProjectDir**(): `string` + +Defined in: src/Scene.ts:643 + +Get the absolute path of current project. + +#### Returns + +`string` + +The real project's directiory. + +#### Example + +1. get real project directory, such as: +```typescript +let projectDir = projectScene.getRealProjectDir(); +``` + +*** + +### getSdkArkFiles() + +> **getSdkArkFiles**(): [`ArkFile`](ArkFile.md)[] + +Defined in: src/Scene.ts:729 + +#### Returns + +[`ArkFile`](ArkFile.md)[] + +*** + +### getSdkGlobal() + +> **getSdkGlobal**(`globalName`): `null` \| `ArkExport` + +Defined in: src/Scene.ts:659 + +#### Parameters + +##### globalName + +`string` + +#### Returns + +`null` \| `ArkExport` + +*** + +### getStage() + +> **getStage**(): `SceneBuildStage` + +Defined in: src/Scene.ts:130 + +#### Returns + +`SceneBuildStage` + +*** + +### getStaticInitMethods() + +> **getStaticInitMethods**(): [`ArkMethod`](ArkMethod.md)[] + +Defined in: src/Scene.ts:1229 + +#### Returns + +[`ArkMethod`](ArkMethod.md)[] + +*** + +### getVisibleValue() + +> **getVisibleValue**(): [`VisibleValue`](VisibleValue.md) + +Defined in: src/Scene.ts:924 + +get values that is visible in curr scope + +#### Returns + +[`VisibleValue`](VisibleValue.md) + +*** + +### hasMainMethod() + +> **hasMainMethod**(): `boolean` + +Defined in: src/Scene.ts:914 + +#### Returns + +`boolean` + +*** + +### hasSdkFile() + +> **hasSdkFile**(`fileSignature`): `boolean` + +Defined in: src/Scene.ts:694 + +#### Parameters + +##### fileSignature + +[`FileSignature`](FileSignature.md) + +#### Returns + +`boolean` + +*** + +### inferSimpleTypes() + +> **inferSimpleTypes**(): `void` + +Defined in: src/Scene.ts:992 + +Iterate all assignment statements in methods, +and set the type of left operand based on the type of right operand +if the left operand is a local variable as well as an unknown. + +#### Returns + +`void` + +#### Deprecated + +#### Example + +1. Infer simple type when scene building. + +```typescript +let scene = new Scene(); +scene.buildSceneFromProjectDir(config); +scene.inferSimpleTypes(); +``` + +*** + +### inferTypes() + +> **inferTypes**(): `void` + +Defined in: src/Scene.ts:966 + +Infer type for each non-default method. It infers the type of each field/local/reference. +For example, the statement `let b = 5;`, the type of local `b` is `NumberType`; and for the statement `let s = 'hello';`, the type of local `s` is `StringType`. The detailed types are defined in the Type.ts file. + +#### Returns + +`void` + +#### Example + +1. Infer the type of each class field and method field. + +```typescript +const scene = new Scene(); +scene.buildSceneFromProjectDir(sceneConfig); +scene.inferTypes(); +``` + +*** + +### makeCallGraphCHA() + +> **makeCallGraphCHA**(`entryPoints`): [`CallGraph`](CallGraph.md) + +Defined in: src/Scene.ts:940 + +#### Parameters + +##### entryPoints + +[`MethodSignature`](MethodSignature.md)[] + +#### Returns + +[`CallGraph`](CallGraph.md) + +*** + +### makeCallGraphRTA() + +> **makeCallGraphRTA**(`entryPoints`): [`CallGraph`](CallGraph.md) + +Defined in: src/Scene.ts:947 + +#### Parameters + +##### entryPoints + +[`MethodSignature`](MethodSignature.md)[] + +#### Returns + +[`CallGraph`](CallGraph.md) + +*** + +### removeClass() + +> **removeClass**(`arkClass`): `boolean` + +Defined in: src/Scene.ts:902 + +#### Parameters + +##### arkClass + +[`ArkClass`](ArkClass.md) + +#### Returns + +`boolean` + +*** + +### removeFile() + +> **removeFile**(`file`): `boolean` + +Defined in: src/Scene.ts:910 + +#### Parameters + +##### file + +[`ArkFile`](ArkFile.md) + +#### Returns + +`boolean` + +*** + +### removeMethod() + +> **removeMethod**(`method`): `boolean` + +Defined in: src/Scene.ts:898 + +#### Parameters + +##### method + +[`ArkMethod`](ArkMethod.md) + +#### Returns + +`boolean` + +*** + +### removeNamespace() + +> **removeNamespace**(`namespace`): `boolean` + +Defined in: src/Scene.ts:906 + +#### Parameters + +##### namespace + +[`ArkNamespace`](ArkNamespace.md) + +#### Returns + +`boolean` + +*** + +### setFile() + +> **setFile**(`file`): `void` + +Defined in: src/Scene.ts:690 + +#### Parameters + +##### file + +[`ArkFile`](ArkFile.md) + +#### Returns + +`void` diff --git a/docs/api_docs/classes/SceneConfig.md b/docs/api_docs/classes/SceneConfig.md new file mode 100644 index 0000000000000000000000000000000000000000..6c77f1c52f5c565801ec2c1a6b15b688ae8c9784 --- /dev/null +++ b/docs/api_docs/classes/SceneConfig.md @@ -0,0 +1,244 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / SceneConfig + +# Class: SceneConfig + +Defined in: src/Config.ts:53 + +## Constructors + +### new SceneConfig() + +> **new SceneConfig**(`options`?): [`SceneConfig`](SceneConfig.md) + +Defined in: src/Config.ts:67 + +#### Parameters + +##### options? + +`SceneOptions` + +#### Returns + +[`SceneConfig`](SceneConfig.md) + +## Methods + +### buildConfig() + +> **buildConfig**(`targetProjectName`, `targetProjectDirectory`, `sdks`, `fullFilePath`?): `void` + +Defined in: src/Config.ts:84 + +Set the scene's config, +such as the target project's name, the used sdks and the full path. + +#### Parameters + +##### targetProjectName + +`string` + +the target project's name. + +##### targetProjectDirectory + +`string` + +the target project's directory. + +##### sdks + +`Sdk`[] + +sdks used in this scene. + +##### fullFilePath? + +`string`[] + +the full file path. + +#### Returns + +`void` + +*** + +### buildFromJson() + +> **buildFromJson**(`configJsonPath`): `void` + +Defined in: src/Config.ts:151 + +#### Parameters + +##### configJsonPath + +`string` + +#### Returns + +`void` + +*** + +### buildFromProjectDir() + +> **buildFromProjectDir**(`targetProjectDirectory`): `void` + +Defined in: src/Config.ts:110 + +Create a sceneConfig object for a specified project path and set the target project directory to the targetProjectDirectory property of the sceneConfig object. + +#### Parameters + +##### targetProjectDirectory + +`string` + +the target project directory, such as xxx/xxx/xxx, started from project directory. + +#### Returns + +`void` + +#### Example + +1. build a sceneConfig object. + +```typescript +const projectDir = 'xxx/xxx/xxx'; +const sceneConfig: SceneConfig = new SceneConfig(); +sceneConfig.buildFromProjectDir(projectDir); +``` + +*** + +### buildFromProjectFiles() + +> **buildFromProjectFiles**(`projectName`, `projectDir`, `filesAndDirectorys`, `sdks`?): `void` + +Defined in: src/Config.ts:120 + +#### Parameters + +##### projectName + +`string` + +##### projectDir + +`string` + +##### filesAndDirectorys + +`string`[] + +##### sdks? + +`Sdk`[] + +#### Returns + +`void` + +*** + +### getEtsSdkPath() + +> **getEtsSdkPath**(): `string` + +Defined in: src/Config.ts:206 + +#### Returns + +`string` + +*** + +### getOptions() + +> **getOptions**(): `SceneOptions` + +Defined in: src/Config.ts:72 + +#### Returns + +`SceneOptions` + +*** + +### getProjectFiles() + +> **getProjectFiles**(): `string`[] + +Defined in: src/Config.ts:194 + +#### Returns + +`string`[] + +*** + +### getSdkFiles() + +> **getSdkFiles**(): `string`[] + +Defined in: src/Config.ts:198 + +#### Returns + +`string`[] + +*** + +### getSdkFilesMap() + +> **getSdkFilesMap**(): `Map`\<`string`[], `string`\> + +Defined in: src/Config.ts:202 + +#### Returns + +`Map`\<`string`[], `string`\> + +*** + +### getSdksObj() + +> **getSdksObj**(): `Sdk`[] + +Defined in: src/Config.ts:210 + +#### Returns + +`Sdk`[] + +*** + +### getTargetProjectDirectory() + +> **getTargetProjectDirectory**(): `string` + +Defined in: src/Config.ts:190 + +#### Returns + +`string` + +*** + +### getTargetProjectName() + +> **getTargetProjectName**(): `string` + +Defined in: src/Config.ts:186 + +#### Returns + +`string` diff --git a/docs/api_docs/classes/SceneManager.md b/docs/api_docs/classes/SceneManager.md new file mode 100644 index 0000000000000000000000000000000000000000..df95f8ba2dede0a5e219c16ce6c527739c1df52b --- /dev/null +++ b/docs/api_docs/classes/SceneManager.md @@ -0,0 +1,103 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / SceneManager + +# Class: SceneManager + +Defined in: src/utils/callGraphUtils.ts:83 + +## Constructors + +### new SceneManager() + +> **new SceneManager**(): [`SceneManager`](SceneManager.md) + +#### Returns + +[`SceneManager`](SceneManager.md) + +## Accessors + +### scene + +#### Get Signature + +> **get** **scene**(): [`Scene`](Scene.md) + +Defined in: src/utils/callGraphUtils.ts:86 + +##### Returns + +[`Scene`](Scene.md) + +#### Set Signature + +> **set** **scene**(`value`): `void` + +Defined in: src/utils/callGraphUtils.ts:90 + +##### Parameters + +###### value + +[`Scene`](Scene.md) + +##### Returns + +`void` + +## Methods + +### getClass() + +> **getClass**(`arkClass`): `null` \| [`ArkClass`](ArkClass.md) + +Defined in: src/utils/callGraphUtils.ts:111 + +#### Parameters + +##### arkClass + +[`ClassSignature`](ClassSignature.md) + +#### Returns + +`null` \| [`ArkClass`](ArkClass.md) + +*** + +### getExtendedClasses() + +> **getExtendedClasses**(`arkClass`): [`ArkClass`](ArkClass.md)[] + +Defined in: src/utils/callGraphUtils.ts:129 + +#### Parameters + +##### arkClass + +[`ClassSignature`](ClassSignature.md) + +#### Returns + +[`ArkClass`](ArkClass.md)[] + +*** + +### getMethod() + +> **getMethod**(`method`): `null` \| [`ArkMethod`](ArkMethod.md) + +Defined in: src/utils/callGraphUtils.ts:94 + +#### Parameters + +##### method + +[`MethodSignature`](MethodSignature.md) + +#### Returns + +`null` \| [`ArkMethod`](ArkMethod.md) diff --git a/docs/api_docs/classes/Scope.md b/docs/api_docs/classes/Scope.md new file mode 100644 index 0000000000000000000000000000000000000000..2dcc424539b9c97e7d81fb4a889533119cff0989 --- /dev/null +++ b/docs/api_docs/classes/Scope.md @@ -0,0 +1,59 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / Scope + +# Class: Scope + +Defined in: src/core/common/VisibleValue.ts:199 + +## Constructors + +### new Scope() + +> **new Scope**(`values`, `depth`, `arkModel`): [`Scope`](Scope.md) + +Defined in: src/core/common/VisibleValue.ts:203 + +#### Parameters + +##### values + +[`Value`](../interfaces/Value.md)[] + +##### depth + +`number` = `-1` + +##### arkModel + +`null` | `ArkModel` + +#### Returns + +[`Scope`](Scope.md) + +## Properties + +### arkModel + +> **arkModel**: `null` \| `ArkModel` + +Defined in: src/core/common/VisibleValue.ts:202 + +*** + +### depth + +> **depth**: `number` + +Defined in: src/core/common/VisibleValue.ts:201 + +*** + +### values + +> **values**: [`Value`](../interfaces/Value.md)[] + +Defined in: src/core/common/VisibleValue.ts:200 diff --git a/docs/api_docs/classes/SourceClassPrinter.md b/docs/api_docs/classes/SourceClassPrinter.md new file mode 100644 index 0000000000000000000000000000000000000000..0b9892ca6e245120d3e712b9623c5409475ffd93 --- /dev/null +++ b/docs/api_docs/classes/SourceClassPrinter.md @@ -0,0 +1,347 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / SourceClassPrinter + +# Class: SourceClassPrinter + +Defined in: src/save/source/SourceClass.ts:31 + +## Extends + +- `SourceBase` + +## Constructors + +### new SourceClassPrinter() + +> **new SourceClassPrinter**(`cls`, `indent`): [`SourceClassPrinter`](SourceClassPrinter.md) + +Defined in: src/save/source/SourceClass.ts:35 + +#### Parameters + +##### cls + +[`ArkClass`](ArkClass.md) + +##### indent + +`string` = `''` + +#### Returns + +[`SourceClassPrinter`](SourceClassPrinter.md) + +#### Overrides + +`SourceBase.constructor` + +## Properties + +### arkFile + +> `protected` **arkFile**: [`ArkFile`](ArkFile.md) + +Defined in: src/save/source/SourceBase.ts:37 + +#### Inherited from + +`SourceBase.arkFile` + +*** + +### cls + +> `protected` **cls**: [`ArkClass`](ArkClass.md) + +Defined in: src/save/source/SourceClass.ts:32 + +*** + +### inBuilder + +> `protected` **inBuilder**: `boolean` = `false` + +Defined in: src/save/source/SourceBase.ts:38 + +#### Inherited from + +`SourceBase.inBuilder` + +*** + +### printer + +> `protected` **printer**: `ArkCodeBuffer` + +Defined in: src/save/Printer.ts:22 + +#### Inherited from + +`SourceBase.printer` + +## Methods + +### dump() + +> **dump**(): `string` + +Defined in: src/save/source/SourceClass.ts:49 + +ArkIR dump + +#### Returns + +`string` + +#### Overrides + +`SourceBase.dump` + +*** + +### getArkFile() + +> **getArkFile**(): [`ArkFile`](ArkFile.md) + +Defined in: src/save/source/SourceBase.ts:49 + +#### Returns + +[`ArkFile`](ArkFile.md) + +#### Inherited from + +`SourceBase.getArkFile` + +*** + +### getClass() + +> **getClass**(`signature`): `null` \| [`ArkClass`](ArkClass.md) + +Defined in: src/save/source/SourceBase.ts:57 + +#### Parameters + +##### signature + +[`ClassSignature`](ClassSignature.md) + +#### Returns + +`null` \| [`ArkClass`](ArkClass.md) + +#### Inherited from + +`SourceBase.getClass` + +*** + +### getDeclaringArkNamespace() + +> **getDeclaringArkNamespace**(): `undefined` \| [`ArkNamespace`](ArkNamespace.md) + +Defined in: src/save/source/SourceClass.ts:41 + +#### Returns + +`undefined` \| [`ArkNamespace`](ArkNamespace.md) + +#### Overrides + +`SourceBase.getDeclaringArkNamespace` + +*** + +### getLine() + +> **getLine**(): `number` + +Defined in: src/save/source/SourceClass.ts:45 + +#### Returns + +`number` + +#### Overrides + +`SourceBase.getLine` + +*** + +### getMethod() + +> **getMethod**(`signature`): `null` \| [`ArkMethod`](ArkMethod.md) + +Defined in: src/save/source/SourceBase.ts:53 + +#### Parameters + +##### signature + +[`MethodSignature`](MethodSignature.md) + +#### Returns + +`null` \| [`ArkMethod`](ArkMethod.md) + +#### Inherited from + +`SourceBase.getMethod` + +*** + +### getPrinter() + +> **getPrinter**(): `ArkCodeBuffer` + +Defined in: src/save/source/SourceBase.ts:61 + +#### Returns + +`ArkCodeBuffer` + +#### Inherited from + +`SourceBase.getPrinter` + +*** + +### isInBuilderMethod() + +> **isInBuilderMethod**(): `boolean` + +Defined in: src/save/source/SourceBase.ts:69 + +#### Returns + +`boolean` + +#### Inherited from + +`SourceBase.isInBuilderMethod` + +*** + +### modifiersToString() + +> `protected` **modifiersToString**(`modifiers`): `string` + +Defined in: src/save/source/SourceBase.ts:81 + +#### Parameters + +##### modifiers + +`number` + +#### Returns + +`string` + +#### Inherited from + +`SourceBase.modifiersToString` + +*** + +### printDecorator() + +> `protected` **printDecorator**(`docorator`): `void` + +Defined in: src/save/source/SourceBase.ts:75 + +#### Parameters + +##### docorator + +[`Decorator`](Decorator.md)[] + +#### Returns + +`void` + +#### Inherited from + +`SourceBase.printDecorator` + +*** + +### printMethods() + +> `protected` **printMethods**(): `Dump`[] + +Defined in: src/save/source/SourceClass.ts:150 + +#### Returns + +`Dump`[] + +*** + +### resolveKeywordType() + +> `protected` **resolveKeywordType**(`keywordStr`): `string` + +Defined in: src/save/source/SourceBase.ts:86 + +#### Parameters + +##### keywordStr + +`string` + +#### Returns + +`string` + +#### Inherited from + +`SourceBase.resolveKeywordType` + +*** + +### resolveMethodName() + +> `protected` **resolveMethodName**(`name`): `string` + +Defined in: src/save/source/SourceBase.ts:105 + +#### Parameters + +##### name + +`string` + +#### Returns + +`string` + +#### Inherited from + +`SourceBase.resolveMethodName` + +*** + +### transTemp2Code() + +> **transTemp2Code**(`temp`): `string` + +Defined in: src/save/source/SourceBase.ts:65 + +#### Parameters + +##### temp + +[`Local`](Local.md) + +#### Returns + +`string` + +#### Inherited from + +`SourceBase.transTemp2Code` diff --git a/docs/api_docs/classes/SourceFilePrinter.md b/docs/api_docs/classes/SourceFilePrinter.md new file mode 100644 index 0000000000000000000000000000000000000000..4021b3fbdd4688f00a9867f130e68cee8206baf6 --- /dev/null +++ b/docs/api_docs/classes/SourceFilePrinter.md @@ -0,0 +1,81 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / SourceFilePrinter + +# Class: SourceFilePrinter + +Defined in: src/save/source/SourceFilePrinter.ts:47 + +## Extends + +- [`Printer`](Printer.md) + +## Constructors + +### new SourceFilePrinter() + +> **new SourceFilePrinter**(`arkFile`): [`SourceFilePrinter`](SourceFilePrinter.md) + +Defined in: src/save/source/SourceFilePrinter.ts:51 + +#### Parameters + +##### arkFile + +[`ArkFile`](ArkFile.md) + +#### Returns + +[`SourceFilePrinter`](SourceFilePrinter.md) + +#### Overrides + +[`Printer`](Printer.md).[`constructor`](Printer.md#constructors) + +## Properties + +### arkFile + +> **arkFile**: [`ArkFile`](ArkFile.md) + +Defined in: src/save/source/SourceFilePrinter.ts:48 + +*** + +### items + +> **items**: `Dump`[] = `[]` + +Defined in: src/save/source/SourceFilePrinter.ts:49 + +*** + +### printer + +> `protected` **printer**: `ArkCodeBuffer` + +Defined in: src/save/Printer.ts:22 + +#### Inherited from + +[`Printer`](Printer.md).[`printer`](Printer.md#printer-1) + +## Methods + +### dump() + +> **dump**(): `string` + +Defined in: src/save/source/SourceFilePrinter.ts:56 + +ArkIR dump + +#### Returns + +`string` + +#### Overrides + +[`Printer`](Printer.md).[`dump`](Printer.md#dump) diff --git a/docs/api_docs/classes/SourceMethodPrinter.md b/docs/api_docs/classes/SourceMethodPrinter.md new file mode 100644 index 0000000000000000000000000000000000000000..a6ee5a04390fc005b6b3760be1369ee7b66fa4dc --- /dev/null +++ b/docs/api_docs/classes/SourceMethodPrinter.md @@ -0,0 +1,387 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / SourceMethodPrinter + +# Class: SourceMethodPrinter + +Defined in: src/save/source/SourceMethod.ts:31 + +## Extends + +- `SourceBase` + +## Constructors + +### new SourceMethodPrinter() + +> **new SourceMethodPrinter**(`method`, `indent`): [`SourceMethodPrinter`](SourceMethodPrinter.md) + +Defined in: src/save/source/SourceMethod.ts:35 + +#### Parameters + +##### method + +[`ArkMethod`](ArkMethod.md) + +##### indent + +`string` = `''` + +#### Returns + +[`SourceMethodPrinter`](SourceMethodPrinter.md) + +#### Overrides + +`SourceBase.constructor` + +## Properties + +### arkFile + +> `protected` **arkFile**: [`ArkFile`](ArkFile.md) + +Defined in: src/save/source/SourceBase.ts:37 + +#### Inherited from + +`SourceBase.arkFile` + +*** + +### inBuilder + +> `protected` **inBuilder**: `boolean` = `false` + +Defined in: src/save/source/SourceBase.ts:38 + +#### Inherited from + +`SourceBase.inBuilder` + +*** + +### printer + +> `protected` **printer**: `ArkCodeBuffer` + +Defined in: src/save/Printer.ts:22 + +#### Inherited from + +`SourceBase.printer` + +## Methods + +### dump() + +> **dump**(): `string` + +Defined in: src/save/source/SourceMethod.ts:50 + +ArkIR dump + +#### Returns + +`string` + +#### Overrides + +`SourceBase.dump` + +*** + +### dumpDefaultMethod() + +> **dumpDefaultMethod**(): `SourceStmt`[] + +Defined in: src/save/source/SourceMethod.ts:90 + +#### Returns + +`SourceStmt`[] + +*** + +### getArkFile() + +> **getArkFile**(): [`ArkFile`](ArkFile.md) + +Defined in: src/save/source/SourceBase.ts:49 + +#### Returns + +[`ArkFile`](ArkFile.md) + +#### Inherited from + +`SourceBase.getArkFile` + +*** + +### getClass() + +> **getClass**(`signature`): `null` \| [`ArkClass`](ArkClass.md) + +Defined in: src/save/source/SourceBase.ts:57 + +#### Parameters + +##### signature + +[`ClassSignature`](ClassSignature.md) + +#### Returns + +`null` \| [`ArkClass`](ArkClass.md) + +#### Inherited from + +`SourceBase.getClass` + +*** + +### getDeclaringArkNamespace() + +> **getDeclaringArkNamespace**(): `undefined` \| [`ArkNamespace`](ArkNamespace.md) + +Defined in: src/save/source/SourceMethod.ts:42 + +#### Returns + +`undefined` \| [`ArkNamespace`](ArkNamespace.md) + +#### Overrides + +`SourceBase.getDeclaringArkNamespace` + +*** + +### getLine() + +> **getLine**(): `number` + +Defined in: src/save/source/SourceMethod.ts:67 + +#### Returns + +`number` + +#### Overrides + +`SourceBase.getLine` + +*** + +### getMethod() + +> **getMethod**(`signature`): `null` \| [`ArkMethod`](ArkMethod.md) + +Defined in: src/save/source/SourceBase.ts:53 + +#### Parameters + +##### signature + +[`MethodSignature`](MethodSignature.md) + +#### Returns + +`null` \| [`ArkMethod`](ArkMethod.md) + +#### Inherited from + +`SourceBase.getMethod` + +*** + +### getPrinter() + +> **getPrinter**(): `ArkCodeBuffer` + +Defined in: src/save/source/SourceBase.ts:61 + +#### Returns + +`ArkCodeBuffer` + +#### Inherited from + +`SourceBase.getPrinter` + +*** + +### isInBuilderMethod() + +> **isInBuilderMethod**(): `boolean` + +Defined in: src/save/source/SourceBase.ts:69 + +#### Returns + +`boolean` + +#### Inherited from + +`SourceBase.isInBuilderMethod` + +*** + +### methodProtoToString() + +> `protected` **methodProtoToString**(`method`): `string` + +Defined in: src/save/source/SourceMethod.ts:122 + +#### Parameters + +##### method + +[`ArkMethod`](ArkMethod.md) + +#### Returns + +`string` + +*** + +### modifiersToString() + +> `protected` **modifiersToString**(`modifiers`): `string` + +Defined in: src/save/source/SourceBase.ts:81 + +#### Parameters + +##### modifiers + +`number` + +#### Returns + +`string` + +#### Inherited from + +`SourceBase.modifiersToString` + +*** + +### printDecorator() + +> `protected` **printDecorator**(`docorator`): `void` + +Defined in: src/save/source/SourceBase.ts:75 + +#### Parameters + +##### docorator + +[`Decorator`](Decorator.md)[] + +#### Returns + +`void` + +#### Inherited from + +`SourceBase.printDecorator` + +*** + +### resolveKeywordType() + +> `protected` **resolveKeywordType**(`keywordStr`): `string` + +Defined in: src/save/source/SourceBase.ts:86 + +#### Parameters + +##### keywordStr + +`string` + +#### Returns + +`string` + +#### Inherited from + +`SourceBase.resolveKeywordType` + +*** + +### resolveMethodName() + +> `protected` **resolveMethodName**(`name`): `string` + +Defined in: src/save/source/SourceBase.ts:105 + +#### Parameters + +##### name + +`string` + +#### Returns + +`string` + +#### Inherited from + +`SourceBase.resolveMethodName` + +*** + +### setInBuilder() + +> **setInBuilder**(`inBuilder`): `void` + +Defined in: src/save/source/SourceMethod.ts:46 + +#### Parameters + +##### inBuilder + +`boolean` + +#### Returns + +`void` + +*** + +### toArrowFunctionTypeString() + +> **toArrowFunctionTypeString**(): `string` + +Defined in: src/save/source/SourceMethod.ts:169 + +#### Returns + +`string` + +*** + +### transTemp2Code() + +> **transTemp2Code**(`temp`): `string` + +Defined in: src/save/source/SourceBase.ts:65 + +#### Parameters + +##### temp + +[`Local`](Local.md) + +#### Returns + +`string` + +#### Inherited from + +`SourceBase.transTemp2Code` diff --git a/docs/api_docs/classes/SourceNamespacePrinter.md b/docs/api_docs/classes/SourceNamespacePrinter.md new file mode 100644 index 0000000000000000000000000000000000000000..00713edce9e7273d6b56ea33df08cd41ef7fac94 --- /dev/null +++ b/docs/api_docs/classes/SourceNamespacePrinter.md @@ -0,0 +1,335 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / SourceNamespacePrinter + +# Class: SourceNamespacePrinter + +Defined in: src/save/source/SourceNamespace.ts:27 + +## Extends + +- `SourceBase` + +## Constructors + +### new SourceNamespacePrinter() + +> **new SourceNamespacePrinter**(`ns`, `indent`): [`SourceNamespacePrinter`](SourceNamespacePrinter.md) + +Defined in: src/save/source/SourceNamespace.ts:30 + +#### Parameters + +##### ns + +[`ArkNamespace`](ArkNamespace.md) + +##### indent + +`string` = `''` + +#### Returns + +[`SourceNamespacePrinter`](SourceNamespacePrinter.md) + +#### Overrides + +`SourceBase.constructor` + +## Properties + +### arkFile + +> `protected` **arkFile**: [`ArkFile`](ArkFile.md) + +Defined in: src/save/source/SourceBase.ts:37 + +#### Inherited from + +`SourceBase.arkFile` + +*** + +### inBuilder + +> `protected` **inBuilder**: `boolean` = `false` + +Defined in: src/save/source/SourceBase.ts:38 + +#### Inherited from + +`SourceBase.inBuilder` + +*** + +### ns + +> **ns**: [`ArkNamespace`](ArkNamespace.md) + +Defined in: src/save/source/SourceNamespace.ts:28 + +*** + +### printer + +> `protected` **printer**: `ArkCodeBuffer` + +Defined in: src/save/Printer.ts:22 + +#### Inherited from + +`SourceBase.printer` + +## Methods + +### dump() + +> **dump**(): `string` + +Defined in: src/save/source/SourceNamespace.ts:39 + +ArkIR dump + +#### Returns + +`string` + +#### Overrides + +`SourceBase.dump` + +*** + +### getArkFile() + +> **getArkFile**(): [`ArkFile`](ArkFile.md) + +Defined in: src/save/source/SourceBase.ts:49 + +#### Returns + +[`ArkFile`](ArkFile.md) + +#### Inherited from + +`SourceBase.getArkFile` + +*** + +### getClass() + +> **getClass**(`signature`): `null` \| [`ArkClass`](ArkClass.md) + +Defined in: src/save/source/SourceBase.ts:57 + +#### Parameters + +##### signature + +[`ClassSignature`](ClassSignature.md) + +#### Returns + +`null` \| [`ArkClass`](ArkClass.md) + +#### Inherited from + +`SourceBase.getClass` + +*** + +### getDeclaringArkNamespace() + +> **getDeclaringArkNamespace**(): `undefined` \| [`ArkNamespace`](ArkNamespace.md) + +Defined in: src/save/source/SourceBase.ts:45 + +#### Returns + +`undefined` \| [`ArkNamespace`](ArkNamespace.md) + +#### Inherited from + +`SourceBase.getDeclaringArkNamespace` + +*** + +### getLine() + +> **getLine**(): `number` + +Defined in: src/save/source/SourceNamespace.ts:35 + +#### Returns + +`number` + +#### Overrides + +`SourceBase.getLine` + +*** + +### getMethod() + +> **getMethod**(`signature`): `null` \| [`ArkMethod`](ArkMethod.md) + +Defined in: src/save/source/SourceBase.ts:53 + +#### Parameters + +##### signature + +[`MethodSignature`](MethodSignature.md) + +#### Returns + +`null` \| [`ArkMethod`](ArkMethod.md) + +#### Inherited from + +`SourceBase.getMethod` + +*** + +### getPrinter() + +> **getPrinter**(): `ArkCodeBuffer` + +Defined in: src/save/source/SourceBase.ts:61 + +#### Returns + +`ArkCodeBuffer` + +#### Inherited from + +`SourceBase.getPrinter` + +*** + +### isInBuilderMethod() + +> **isInBuilderMethod**(): `boolean` + +Defined in: src/save/source/SourceBase.ts:69 + +#### Returns + +`boolean` + +#### Inherited from + +`SourceBase.isInBuilderMethod` + +*** + +### modifiersToString() + +> `protected` **modifiersToString**(`modifiers`): `string` + +Defined in: src/save/source/SourceBase.ts:81 + +#### Parameters + +##### modifiers + +`number` + +#### Returns + +`string` + +#### Inherited from + +`SourceBase.modifiersToString` + +*** + +### printDecorator() + +> `protected` **printDecorator**(`docorator`): `void` + +Defined in: src/save/source/SourceBase.ts:75 + +#### Parameters + +##### docorator + +[`Decorator`](Decorator.md)[] + +#### Returns + +`void` + +#### Inherited from + +`SourceBase.printDecorator` + +*** + +### resolveKeywordType() + +> `protected` **resolveKeywordType**(`keywordStr`): `string` + +Defined in: src/save/source/SourceBase.ts:86 + +#### Parameters + +##### keywordStr + +`string` + +#### Returns + +`string` + +#### Inherited from + +`SourceBase.resolveKeywordType` + +*** + +### resolveMethodName() + +> `protected` **resolveMethodName**(`name`): `string` + +Defined in: src/save/source/SourceBase.ts:105 + +#### Parameters + +##### name + +`string` + +#### Returns + +`string` + +#### Inherited from + +`SourceBase.resolveMethodName` + +*** + +### transTemp2Code() + +> **transTemp2Code**(`temp`): `string` + +Defined in: src/save/source/SourceBase.ts:65 + +#### Parameters + +##### temp + +[`Local`](Local.md) + +#### Returns + +`string` + +#### Inherited from + +`SourceBase.transTemp2Code` diff --git a/docs/api_docs/classes/StaticSingleAssignmentFormer.md b/docs/api_docs/classes/StaticSingleAssignmentFormer.md new file mode 100644 index 0000000000000000000000000000000000000000..5ff6eb29e8ef08cba1c67c19a0c135e439f7cb53 --- /dev/null +++ b/docs/api_docs/classes/StaticSingleAssignmentFormer.md @@ -0,0 +1,37 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / StaticSingleAssignmentFormer + +# Class: StaticSingleAssignmentFormer + +Defined in: src/transformer/StaticSingleAssignmentFormer.ts:25 + +## Constructors + +### new StaticSingleAssignmentFormer() + +> **new StaticSingleAssignmentFormer**(): [`StaticSingleAssignmentFormer`](StaticSingleAssignmentFormer.md) + +#### Returns + +[`StaticSingleAssignmentFormer`](StaticSingleAssignmentFormer.md) + +## Methods + +### transformBody() + +> **transformBody**(`body`): `void` + +Defined in: src/transformer/StaticSingleAssignmentFormer.ts:26 + +#### Parameters + +##### body + +[`ArkBody`](ArkBody.md) + +#### Returns + +`void` diff --git a/docs/api_docs/classes/Stmt.md b/docs/api_docs/classes/Stmt.md new file mode 100644 index 0000000000000000000000000000000000000000..22359b9c37913dc7dac30db64553508d6fee2d49 --- /dev/null +++ b/docs/api_docs/classes/Stmt.md @@ -0,0 +1,566 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / Stmt + +# Class: `abstract` Stmt + +Defined in: src/core/base/Stmt.ts:31 + +## Extended by + +- [`ArkAssignStmt`](ArkAssignStmt.md) +- [`ArkInvokeStmt`](ArkInvokeStmt.md) +- [`ArkIfStmt`](ArkIfStmt.md) +- [`ArkReturnStmt`](ArkReturnStmt.md) +- [`ArkReturnVoidStmt`](ArkReturnVoidStmt.md) +- [`ArkThrowStmt`](ArkThrowStmt.md) +- [`ArkAliasTypeDefineStmt`](ArkAliasTypeDefineStmt.md) + +## Constructors + +### new Stmt() + +> **new Stmt**(): [`Stmt`](Stmt.md) + +#### Returns + +[`Stmt`](Stmt.md) + +## Properties + +### cfg + +> `protected` **cfg**: [`Cfg`](Cfg.md) + +Defined in: src/core/base/Stmt.ts:35 + +*** + +### metadata? + +> `optional` **metadata**: `ArkMetadata` + +Defined in: src/core/base/Stmt.ts:38 + +*** + +### operandOriginalPositions? + +> `protected` `optional` **operandOriginalPositions**: [`FullPosition`](FullPosition.md)[] + +Defined in: src/core/base/Stmt.ts:36 + +*** + +### originalPosition + +> `protected` **originalPosition**: [`LineColPosition`](LineColPosition.md) = `LineColPosition.DEFAULT` + +Defined in: src/core/base/Stmt.ts:34 + +*** + +### originalText? + +> `protected` `optional` **originalText**: `string` + +Defined in: src/core/base/Stmt.ts:33 + +*** + +### text? + +> `protected` `optional` **text**: `string` + +Defined in: src/core/base/Stmt.ts:32 + +## Methods + +### containsArrayRef() + +> **containsArrayRef**(): `boolean` + +Defined in: src/core/base/Stmt.ts:187 + +#### Returns + +`boolean` + +*** + +### containsFieldRef() + +> **containsFieldRef**(): `boolean` + +Defined in: src/core/base/Stmt.ts:213 + +#### Returns + +`boolean` + +*** + +### containsInvokeExpr() + +> **containsInvokeExpr**(): `boolean` + +Defined in: src/core/base/Stmt.ts:136 + +#### Returns + +`boolean` + +*** + +### getArrayRef() + +> **getArrayRef**(): `undefined` \| [`ArkArrayRef`](ArkArrayRef.md) + +Defined in: src/core/base/Stmt.ts:199 + +#### Returns + +`undefined` \| [`ArkArrayRef`](ArkArrayRef.md) + +*** + +### getCfg() + +> **getCfg**(): [`Cfg`](Cfg.md) + +Defined in: src/core/base/Stmt.ts:115 + +Get the CFG (i.e., control flow graph) of an [ArkBody](ArkBody.md) in which the statement is. +A CFG contains a set of basic blocks and statements corresponding to each basic block. +Note that, "source code" and "three-address" are two types of [Stmt](Stmt.md) in ArkAnalyzer. +Source code [Stmt](Stmt.md) represents the statement of ets/ts source code, while three-address code [Stmt](Stmt.md) +represents the statement after it has been converted into three-address code. Since the source code [Stmt](Stmt.md) does not save its CFG reference, it returns **null**, while the `getCfg()` of the third address code +[Stmt](Stmt.md) will return its CFG reference. + +#### Returns + +[`Cfg`](Cfg.md) + +The CFG (i.e., control flow graph) of an [ArkBody](ArkBody.md) in which the statement is. + +#### Example + +1. get the ArkFile based on stmt. +```typescript +const arkFile = stmt.getCfg()?.getDeclaringMethod().getDeclaringArkFile(); +``` +2. get the ArkMethod based on stmt. +```typescript +let sourceMethod: ArkMethod = stmt.getCfg()?.getDeclaringMethod(); +``` + +*** + +### getDef() + +> **getDef**(): `null` \| [`Value`](../interfaces/Value.md) + +Defined in: src/core/base/Stmt.ts:77 + +Return the definition which is uesd in this statement. Generally, the definition is the left value of `=` in +3AC. For example, the definition in 3AC of `value = parameter0: @project-1/sample-1.ets: AnonymousClass-0` is +`value`, and the definition in `$temp0 = staticinvoke <@_ProjectName/_FileName: xxx.create()>()` is `\$temp0`. + +#### Returns + +`null` \| [`Value`](../interfaces/Value.md) + +The definition in 3AC (may be a **null**). + +#### Example + +1. get the def in stmt. +```typescript +for (const block of this.blocks) { +for (const stmt of block.getStmts()) { + const defValue = stmt.getDef(); + ... + } +} +``` + +*** + +### getDefAndUses() + +> **getDefAndUses**(): [`Value`](../interfaces/Value.md)[] + +Defined in: src/core/base/Stmt.ts:86 + +#### Returns + +[`Value`](../interfaces/Value.md)[] + +*** + +### getExpectedSuccessorCount() + +> **getExpectedSuccessorCount**(): `number` + +Defined in: src/core/base/Stmt.ts:132 + +Return the number of statements which this statement may go to + +#### Returns + +`number` + +*** + +### getExprs() + +> **getExprs**(): [`AbstractExpr`](AbstractExpr.md)[] + +Defined in: src/core/base/Stmt.ts:177 + +Returns an array of expressions in the statement. + +#### Returns + +[`AbstractExpr`](AbstractExpr.md)[] + +An array of expressions in the statement. + +#### Example + +1. Traverse expression of statement. + +```typescript +for (const expr of stmt.getExprs()) { + ... +} +``` + +*** + +### getFieldRef() + +> **getFieldRef**(): `undefined` \| [`AbstractFieldRef`](AbstractFieldRef.md) + +Defined in: src/core/base/Stmt.ts:226 + +#### Returns + +`undefined` \| [`AbstractFieldRef`](AbstractFieldRef.md) + +*** + +### getInvokeExpr() + +> **getInvokeExpr**(): `undefined` \| [`AbstractInvokeExpr`](AbstractInvokeExpr.md) + +Defined in: src/core/base/Stmt.ts:156 + +Returns the method's invocation expression (including method signature and its arguments) +in the current statement. An **undefined** will be returned if there is no method used in this statement. + +#### Returns + +`undefined` \| [`AbstractInvokeExpr`](AbstractInvokeExpr.md) + +the method's invocation expression from the statement. An **undefined** will be returned if there is + no method can be found in this statement. + +#### Example + +1. get invoke expr based on stmt. +```typescript +let invoke = stmt.getInvokeExpr(); +``` + +*** + +### getMetadata() + +> **getMetadata**(`kind`): `undefined` \| `ArkMetadataType` + +Defined in: src/core/base/Stmt.ts:40 + +#### Parameters + +##### kind + +`ArkMetadataKind` + +#### Returns + +`undefined` \| `ArkMetadataType` + +*** + +### getOperandOriginalPosition() + +> **getOperandOriginalPosition**(`indexOrOperand`): `null` \| [`FullPosition`](FullPosition.md) + +Defined in: src/core/base/Stmt.ts:287 + +#### Parameters + +##### indexOrOperand + +`number` | [`Value`](../interfaces/Value.md) + +#### Returns + +`null` \| [`FullPosition`](FullPosition.md) + +*** + +### getOperandOriginalPositions() + +> **getOperandOriginalPositions**(): `undefined` \| [`FullPosition`](FullPosition.md)[] + +Defined in: src/core/base/Stmt.ts:283 + +#### Returns + +`undefined` \| [`FullPosition`](FullPosition.md)[] + +*** + +### getOriginalText() + +> **getOriginalText**(): `undefined` \| `string` + +Defined in: src/core/base/Stmt.ts:275 + +#### Returns + +`undefined` \| `string` + +*** + +### getOriginPositionInfo() + +> **getOriginPositionInfo**(): [`LineColPosition`](LineColPosition.md) + +Defined in: src/core/base/Stmt.ts:261 + +Returns the original position of the statement. +The position consists of two parts: line number and column number. +In the source file, the former (i.e., line number) indicates which line the statement is in, +and the latter (i.e., column number) indicates the position of the statement in the line. +The position is described as `LineColPosition(lineNo,colNum)` in ArkAnalyzer, +and its default value is LineColPosition(-1,-1). + +#### Returns + +[`LineColPosition`](LineColPosition.md) + +The original location of the statement. + +#### Example + +1. Get the stmt position info to make some condition judgements. +```typescript +for (const stmt of stmts) { + if (stmt.getOriginPositionInfo().getLineNo() === -1) { + stmt.setOriginPositionInfo(originalStmt.getOriginPositionInfo()); + this.stmtToOriginalStmt.set(stmt, originalStmt); + } +} +``` + +*** + +### getUses() + +> **getUses**(): [`Value`](../interfaces/Value.md)[] + +Defined in: src/core/base/Stmt.ts:52 + +Return a list of values which are uesd in this statement + +#### Returns + +[`Value`](../interfaces/Value.md)[] + +*** + +### isBranch() + +> **isBranch**(): `boolean` + +Defined in: src/core/base/Stmt.ts:127 + +Return true if the following statement may not execute after this statement. +The ArkIfStmt and ArkGotoStmt will return true. + +#### Returns + +`boolean` + +*** + +### replaceDef() + +> **replaceDef**(`oldDef`, `newDef`): `void` + +Defined in: src/core/base/Stmt.ts:81 + +#### Parameters + +##### oldDef + +[`Value`](../interfaces/Value.md) + +##### newDef + +[`Value`](../interfaces/Value.md) + +#### Returns + +`void` + +*** + +### replaceUse() + +> **replaceUse**(`oldUse`, `newUse`): `void` + +Defined in: src/core/base/Stmt.ts:56 + +#### Parameters + +##### oldUse + +[`Value`](../interfaces/Value.md) + +##### newUse + +[`Value`](../interfaces/Value.md) + +#### Returns + +`void` + +*** + +### setCfg() + +> **setCfg**(`cfg`): `void` + +Defined in: src/core/base/Stmt.ts:119 + +#### Parameters + +##### cfg + +[`Cfg`](Cfg.md) + +#### Returns + +`void` + +*** + +### setMetadata() + +> **setMetadata**(`kind`, `value`): `void` + +Defined in: src/core/base/Stmt.ts:44 + +#### Parameters + +##### kind + +`ArkMetadataKind` + +##### value + +`ArkMetadataType` + +#### Returns + +`void` + +*** + +### setOperandOriginalPositions() + +> **setOperandOriginalPositions**(`operandOriginalPositions`): `void` + +Defined in: src/core/base/Stmt.ts:279 + +#### Parameters + +##### operandOriginalPositions + +[`FullPosition`](FullPosition.md)[] + +#### Returns + +`void` + +*** + +### setOriginalText() + +> **setOriginalText**(`originalText`): `void` + +Defined in: src/core/base/Stmt.ts:271 + +#### Parameters + +##### originalText + +`string` + +#### Returns + +`void` + +*** + +### setOriginPositionInfo() + +> **setOriginPositionInfo**(`originPositionInfo`): `void` + +Defined in: src/core/base/Stmt.ts:238 + +#### Parameters + +##### originPositionInfo + +[`LineColPosition`](LineColPosition.md) + +#### Returns + +`void` + +*** + +### setText() + +> **setText**(`text`): `void` + +Defined in: src/core/base/Stmt.ts:267 + +#### Parameters + +##### text + +`string` + +#### Returns + +`void` + +*** + +### toString() + +> `abstract` **toString**(): `string` + +Defined in: src/core/base/Stmt.ts:265 + +#### Returns + +`string` diff --git a/docs/api_docs/classes/StmtUseReplacer.md b/docs/api_docs/classes/StmtUseReplacer.md new file mode 100644 index 0000000000000000000000000000000000000000..5dc8ae67bd1a28960de85244a7bec09be825b9a9 --- /dev/null +++ b/docs/api_docs/classes/StmtUseReplacer.md @@ -0,0 +1,51 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / StmtUseReplacer + +# Class: StmtUseReplacer + +Defined in: src/core/common/StmtUseReplacer.ts:27 + +Replace old use(Value) of a Stmt inplace + +## Constructors + +### new StmtUseReplacer() + +> **new StmtUseReplacer**(`oldUse`, `newUse`): [`StmtUseReplacer`](StmtUseReplacer.md) + +Defined in: src/core/common/StmtUseReplacer.ts:31 + +#### Parameters + +##### oldUse + +[`Value`](../interfaces/Value.md) + +##### newUse + +[`Value`](../interfaces/Value.md) + +#### Returns + +[`StmtUseReplacer`](StmtUseReplacer.md) + +## Methods + +### caseStmt() + +> **caseStmt**(`stmt`): `void` + +Defined in: src/core/common/StmtUseReplacer.ts:36 + +#### Parameters + +##### stmt + +[`Stmt`](Stmt.md) + +#### Returns + +`void` diff --git a/docs/api_docs/classes/StringType.md b/docs/api_docs/classes/StringType.md new file mode 100644 index 0000000000000000000000000000000000000000..f3ad67aa2268adf774187870562f7d2ea0b836b3 --- /dev/null +++ b/docs/api_docs/classes/StringType.md @@ -0,0 +1,75 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / StringType + +# Class: StringType + +Defined in: src/core/base/Type.ts:159 + +primitive type + +## Extends + +- [`PrimitiveType`](PrimitiveType.md) + +## Methods + +### getName() + +> **getName**(): `string` + +Defined in: src/core/base/Type.ts:126 + +#### Returns + +`string` + +#### Inherited from + +[`PrimitiveType`](PrimitiveType.md).[`getName`](PrimitiveType.md#getname) + +*** + +### getTypeString() + +> **getTypeString**(): `string` + +Defined in: src/core/base/Type.ts:130 + +#### Returns + +`string` + +#### Inherited from + +[`PrimitiveType`](PrimitiveType.md).[`getTypeString`](PrimitiveType.md#gettypestring) + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/base/Type.ts:36 + +#### Returns + +`string` + +#### Inherited from + +[`PrimitiveType`](PrimitiveType.md).[`toString`](PrimitiveType.md#tostring) + +*** + +### getInstance() + +> `static` **getInstance**(): [`StringType`](StringType.md) + +Defined in: src/core/base/Type.ts:166 + +#### Returns + +[`StringType`](StringType.md) diff --git a/docs/api_docs/classes/ThisPagEdge.md b/docs/api_docs/classes/ThisPagEdge.md new file mode 100644 index 0000000000000000000000000000000000000000..e9d2a9e064c6ef986e5f6879e4faa4faa7be50f6 --- /dev/null +++ b/docs/api_docs/classes/ThisPagEdge.md @@ -0,0 +1,197 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / ThisPagEdge + +# Class: ThisPagEdge + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:112 + +## Extends + +- [`PagEdge`](PagEdge.md) + +## Constructors + +### new ThisPagEdge() + +> **new ThisPagEdge**(`n`, `d`, `s`): [`ThisPagEdge`](ThisPagEdge.md) + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:113 + +#### Parameters + +##### n + +[`PagNode`](PagNode.md) + +##### d + +[`PagNode`](PagNode.md) + +##### s + +[`Stmt`](Stmt.md) + +#### Returns + +[`ThisPagEdge`](ThisPagEdge.md) + +#### Overrides + +[`PagEdge`](PagEdge.md).[`constructor`](PagEdge.md#constructors) + +## Properties + +### kind + +> `protected` **kind**: `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:27 + +#### Inherited from + +[`PagEdge`](PagEdge.md).[`kind`](PagEdge.md#kind) + +## Methods + +### getDotAttr() + +> **getDotAttr**(): `string` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:65 + +#### Returns + +`string` + +#### Inherited from + +[`PagEdge`](PagEdge.md).[`getDotAttr`](PagEdge.md#getdotattr) + +*** + +### getDstID() + +> **getDstID**(): `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:39 + +#### Returns + +`number` + +#### Inherited from + +[`PagEdge`](PagEdge.md).[`getDstID`](PagEdge.md#getdstid) + +*** + +### getDstNode() + +> **getDstNode**(): [`BaseNode`](BaseNode.md) + +Defined in: src/core/graph/BaseExplicitGraph.ts:47 + +#### Returns + +[`BaseNode`](BaseNode.md) + +#### Inherited from + +[`PagEdge`](PagEdge.md).[`getDstNode`](PagEdge.md#getdstnode) + +*** + +### getEndPoints() + +> **getEndPoints**(): `object` + +Defined in: src/core/graph/BaseExplicitGraph.ts:59 + +#### Returns + +`object` + +##### dst + +> **dst**: `number` + +##### src + +> **src**: `number` + +#### Inherited from + +[`PagEdge`](PagEdge.md).[`getEndPoints`](PagEdge.md#getendpoints) + +*** + +### getKind() + +> **getKind**(): `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:51 + +#### Returns + +`number` + +#### Inherited from + +[`PagEdge`](PagEdge.md).[`getKind`](PagEdge.md#getkind) + +*** + +### getSrcID() + +> **getSrcID**(): `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:35 + +#### Returns + +`number` + +#### Inherited from + +[`PagEdge`](PagEdge.md).[`getSrcID`](PagEdge.md#getsrcid) + +*** + +### getSrcNode() + +> **getSrcNode**(): [`BaseNode`](BaseNode.md) + +Defined in: src/core/graph/BaseExplicitGraph.ts:43 + +#### Returns + +[`BaseNode`](BaseNode.md) + +#### Inherited from + +[`PagEdge`](PagEdge.md).[`getSrcNode`](PagEdge.md#getsrcnode) + +*** + +### setKind() + +> **setKind**(`kind`): `void` + +Defined in: src/core/graph/BaseExplicitGraph.ts:55 + +#### Parameters + +##### kind + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`PagEdge`](PagEdge.md).[`setKind`](PagEdge.md#setkind) diff --git a/docs/api_docs/classes/TupleType.md b/docs/api_docs/classes/TupleType.md new file mode 100644 index 0000000000000000000000000000000000000000..63bb8ab174bf3567977410578abbcdaf63f02b51 --- /dev/null +++ b/docs/api_docs/classes/TupleType.md @@ -0,0 +1,79 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / TupleType + +# Class: TupleType + +Defined in: src/core/base/Type.ts:433 + +## Extends + +- [`Type`](Type.md) + +## Constructors + +### new TupleType() + +> **new TupleType**(`types`): [`TupleType`](TupleType.md) + +Defined in: src/core/base/Type.ts:436 + +#### Parameters + +##### types + +[`Type`](Type.md)[] + +#### Returns + +[`TupleType`](TupleType.md) + +#### Overrides + +[`Type`](Type.md).[`constructor`](Type.md#constructors) + +## Methods + +### getTypes() + +> **getTypes**(): [`Type`](Type.md)[] + +Defined in: src/core/base/Type.ts:441 + +#### Returns + +[`Type`](Type.md)[] + +*** + +### getTypeString() + +> **getTypeString**(): `string` + +Defined in: src/core/base/Type.ts:445 + +#### Returns + +`string` + +#### Overrides + +[`Type`](Type.md).[`getTypeString`](Type.md#gettypestring) + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/base/Type.ts:36 + +#### Returns + +`string` + +#### Inherited from + +[`Type`](Type.md).[`toString`](Type.md#tostring) diff --git a/docs/api_docs/classes/Type.md b/docs/api_docs/classes/Type.md new file mode 100644 index 0000000000000000000000000000000000000000..2cc6aedd8d6e001bb3aacc6fb1b2e832c41668d0 --- /dev/null +++ b/docs/api_docs/classes/Type.md @@ -0,0 +1,61 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / Type + +# Class: `abstract` Type + +Defined in: src/core/base/Type.ts:35 + +## Extended by + +- [`AnyType`](AnyType.md) +- [`UnknownType`](UnknownType.md) +- [`UnclearReferenceType`](UnclearReferenceType.md) +- [`PrimitiveType`](PrimitiveType.md) +- [`UnionType`](UnionType.md) +- [`VoidType`](VoidType.md) +- [`NeverType`](NeverType.md) +- [`FunctionType`](FunctionType.md) +- [`ClassType`](ClassType.md) +- [`ArrayType`](ArrayType.md) +- [`TupleType`](TupleType.md) +- [`AliasType`](AliasType.md) +- [`GenericType`](GenericType.md) +- [`AnnotationType`](AnnotationType.md) +- [`LexicalEnvType`](LexicalEnvType.md) + +## Constructors + +### new Type() + +> **new Type**(): [`Type`](Type.md) + +#### Returns + +[`Type`](Type.md) + +## Methods + +### getTypeString() + +> `abstract` **getTypeString**(): `string` + +Defined in: src/core/base/Type.ts:40 + +#### Returns + +`string` + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/base/Type.ts:36 + +#### Returns + +`string` diff --git a/docs/api_docs/classes/TypeInference.md b/docs/api_docs/classes/TypeInference.md new file mode 100644 index 0000000000000000000000000000000000000000..c61e930093122bae4972772fda7fd1b8de3338fc --- /dev/null +++ b/docs/api_docs/classes/TypeInference.md @@ -0,0 +1,487 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / TypeInference + +# Class: TypeInference + +Defined in: src/core/common/TypeInference.ts:68 + +## Constructors + +### new TypeInference() + +> **new TypeInference**(): [`TypeInference`](TypeInference.md) + +#### Returns + +[`TypeInference`](TypeInference.md) + +## Methods + +### buildTypeFromStr() + +> `static` **buildTypeFromStr**(`typeStr`): [`Type`](Type.md) + +Defined in: src/core/common/TypeInference.ts:351 + +#### Parameters + +##### typeStr + +`string` + +#### Returns + +[`Type`](Type.md) + +*** + +### inferBaseType() + +> `static` **inferBaseType**(`baseName`, `arkClass`): `null` \| [`Type`](Type.md) + +Defined in: src/core/common/TypeInference.ts:566 + +Find out the original object and type for a given base name. +It returns original type. +The original type is null if failed to infer the type. + +#### Parameters + +##### baseName + +`string` + +##### arkClass + +[`ArkClass`](ArkClass.md) + +#### Returns + +`null` \| [`Type`](Type.md) + +*** + +### inferDynamicImportType() + +> `static` **inferDynamicImportType**(`from`, `arkClass`): `null` \| [`Type`](Type.md) + +Defined in: src/core/common/TypeInference.ts:602 + +#### Parameters + +##### from + +`string` + +##### arkClass + +[`ArkClass`](ArkClass.md) + +#### Returns + +`null` \| [`Type`](Type.md) + +*** + +### inferFieldType() + +> `static` **inferFieldType**(`baseType`, `fieldName`, `declareClass`): `null` \| \[`any`, [`Type`](Type.md)\] + +Defined in: src/core/common/TypeInference.ts:510 + +Find out the original object and type for a given base type and the field name. +It returns an array with 2 items, original object and original type. +The original object is null if there is no object, or it failed to find the object. +The original type is null if it failed to infer the type. + +#### Parameters + +##### baseType + +[`Type`](Type.md) + +##### fieldName + +`string` + +##### declareClass + +[`ArkClass`](ArkClass.md) + +#### Returns + +`null` \| \[`any`, [`Type`](Type.md)\] + +*** + +### inferFunctionType() + +> `static` **inferFunctionType**(`argType`, `params`, `realTypes`): `void` + +Defined in: src/core/common/TypeInference.ts:653 + +#### Parameters + +##### argType + +[`FunctionType`](FunctionType.md) + +##### params + +`undefined` | `MethodParameter`[] + +##### realTypes + +`undefined` | [`Type`](Type.md)[] + +#### Returns + +`void` + +*** + +### inferGenericType() + +> `static` **inferGenericType**(`types`, `arkClass`): `void` + +Defined in: src/core/common/TypeInference.ts:418 + +#### Parameters + +##### types + +`undefined` | [`GenericType`](GenericType.md)[] + +##### arkClass + +[`ArkClass`](ArkClass.md) + +#### Returns + +`void` + +*** + +### inferRealGenericTypes() + +> `static` **inferRealGenericTypes**(`realTypes`, `arkClass`): `void` + +Defined in: src/core/common/TypeInference.ts:586 + +#### Parameters + +##### realTypes + +`undefined` | [`Type`](Type.md)[] + +##### arkClass + +[`ArkClass`](ArkClass.md) + +#### Returns + +`void` + +*** + +### inferSignatureReturnType() + +> `static` **inferSignatureReturnType**(`oldSignature`, `arkMethod`): `void` + +Defined in: src/core/common/TypeInference.ts:388 + +#### Parameters + +##### oldSignature + +[`MethodSignature`](MethodSignature.md) + +##### arkMethod + +[`ArkMethod`](ArkMethod.md) + +#### Returns + +`void` + +*** + +### inferSimpleTypeInMethod() + +> `static` **inferSimpleTypeInMethod**(`arkMethod`): `void` + +Defined in: src/core/common/TypeInference.ts:188 + +#### Parameters + +##### arkMethod + +[`ArkMethod`](ArkMethod.md) + +#### Returns + +`void` + +#### Deprecated + +*** + +### inferSimpleTypeInStmt() + +> `static` **inferSimpleTypeInStmt**(`stmt`): `void` + +Defined in: src/core/common/TypeInference.ts:337 + +#### Parameters + +##### stmt + +[`Stmt`](Stmt.md) + +#### Returns + +`void` + +*** + +### inferTypeInArkField() + +> `static` **inferTypeInArkField**(`arkField`): `void` + +Defined in: src/core/common/TypeInference.ts:70 + +#### Parameters + +##### arkField + +[`ArkField`](ArkField.md) + +#### Returns + +`void` + +*** + +### inferTypeInMethod() + +> `static` **inferTypeInMethod**(`arkMethod`): `void` + +Defined in: src/core/common/TypeInference.ts:152 + +#### Parameters + +##### arkMethod + +[`ArkMethod`](ArkMethod.md) + +#### Returns + +`void` + +*** + +### inferUnclearedType() + +> `static` **inferUnclearedType**(`leftOpType`, `declaringArkClass`, `rightType`?): `undefined` \| `null` \| [`Type`](Type.md) + +Defined in: src/core/common/TypeInference.ts:118 + +Infer type for a given unclear type. +It returns an array with 2 items, original object and original type. +The original object is null if there is no object, or it failed to find the object. +The original type is null if failed to infer the type. + +#### Parameters + +##### leftOpType + +[`Type`](Type.md) + +##### declaringArkClass + +[`ArkClass`](ArkClass.md) + +##### rightType? + +[`Type`](Type.md) + +#### Returns + +`undefined` \| `null` \| [`Type`](Type.md) + +*** + +### inferUnclearRefName() + +> `static` **inferUnclearRefName**(`refName`, `arkClass`): `null` \| [`Type`](Type.md) + +Defined in: src/core/common/TypeInference.ts:464 + +Find out the original object and type for a given unclear reference type name. +It returns original type. +The original type is null if it failed to infer the type. + +#### Parameters + +##### refName + +`string` + +##### arkClass + +[`ArkClass`](ArkClass.md) + +#### Returns + +`null` \| [`Type`](Type.md) + +*** + +### inferUnclearRefType() + +> `static` **inferUnclearRefType**(`urType`, `arkClass`): `null` \| [`Type`](Type.md) + +Defined in: src/core/common/TypeInference.ts:445 + +Infer type for a given [UnclearReferenceType](UnclearReferenceType.md) type. +It returns original type. +The original type is null if it failed to infer the type. + +#### Parameters + +##### urType + +[`UnclearReferenceType`](UnclearReferenceType.md) + +##### arkClass + +[`ArkClass`](ArkClass.md) + +#### Returns + +`null` \| [`Type`](Type.md) + +*** + +### inferValueType() + +> `static` **inferValueType**(`value`, `arkMethod`): `null` \| [`Type`](Type.md) + +Defined in: src/core/common/TypeInference.ts:378 + +#### Parameters + +##### value + +[`Value`](../interfaces/Value.md) + +##### arkMethod + +[`ArkMethod`](ArkMethod.md) + +#### Returns + +`null` \| [`Type`](Type.md) + +*** + +### isUnclearType() + +> `static` **isUnclearType**(`type`): `boolean` + +Defined in: src/core/common/TypeInference.ts:320 + +#### Parameters + +##### type + +`undefined` | `null` | [`Type`](Type.md) + +#### Returns + +`boolean` + +*** + +### parseArkExport2Type() + +> `static` **parseArkExport2Type**(`arkExport`): `null` \| [`Type`](Type.md) + +Defined in: src/core/common/TypeInference.ts:250 + +#### Parameters + +##### arkExport + +`undefined` | `null` | `ArkExport` + +#### Returns + +`null` \| [`Type`](Type.md) + +*** + +### replaceAliasType() + +> `static` **replaceAliasType**(`type`): [`Type`](Type.md) + +Defined in: src/core/common/TypeInference.ts:644 + +#### Parameters + +##### type + +[`Type`](Type.md) + +#### Returns + +[`Type`](Type.md) + +*** + +### replaceTypeWithReal() + +> `static` **replaceTypeWithReal**(`type`, `realTypes`?): [`Type`](Type.md) + +Defined in: src/core/common/TypeInference.ts:612 + +#### Parameters + +##### type + +[`Type`](Type.md) + +##### realTypes? + +[`Type`](Type.md)[] + +#### Returns + +[`Type`](Type.md) + +*** + +### resolveArkAssignStmt() + +> `static` **resolveArkAssignStmt**(`stmt`, `arkMethod`): `void` + +Defined in: src/core/common/TypeInference.ts:277 + +infer and pass type for ArkAssignStmt right and left + +#### Parameters + +##### stmt + +[`Stmt`](Stmt.md) + +##### arkMethod + +[`ArkMethod`](ArkMethod.md) + +#### Returns + +`void` diff --git a/docs/api_docs/classes/UnclearReferenceType.md b/docs/api_docs/classes/UnclearReferenceType.md new file mode 100644 index 0000000000000000000000000000000000000000..5303908115426033a94bd0db18c186e80080d00f --- /dev/null +++ b/docs/api_docs/classes/UnclearReferenceType.md @@ -0,0 +1,97 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / UnclearReferenceType + +# Class: UnclearReferenceType + +Defined in: src/core/base/Type.ts:87 + +unclear type + +## Extends + +- [`Type`](Type.md) + +## Constructors + +### new UnclearReferenceType() + +> **new UnclearReferenceType**(`name`, `genericTypes`): [`UnclearReferenceType`](UnclearReferenceType.md) + +Defined in: src/core/base/Type.ts:91 + +#### Parameters + +##### name + +`string` + +##### genericTypes + +[`Type`](Type.md)[] = `[]` + +#### Returns + +[`UnclearReferenceType`](UnclearReferenceType.md) + +#### Overrides + +[`Type`](Type.md).[`constructor`](Type.md#constructors) + +## Methods + +### getGenericTypes() + +> **getGenericTypes**(): [`Type`](Type.md)[] + +Defined in: src/core/base/Type.ts:101 + +#### Returns + +[`Type`](Type.md)[] + +*** + +### getName() + +> **getName**(): `string` + +Defined in: src/core/base/Type.ts:97 + +#### Returns + +`string` + +*** + +### getTypeString() + +> **getTypeString**(): `string` + +Defined in: src/core/base/Type.ts:105 + +#### Returns + +`string` + +#### Overrides + +[`Type`](Type.md).[`getTypeString`](Type.md#gettypestring) + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/base/Type.ts:36 + +#### Returns + +`string` + +#### Inherited from + +[`Type`](Type.md).[`toString`](Type.md#tostring) diff --git a/docs/api_docs/classes/UndefinedType.md b/docs/api_docs/classes/UndefinedType.md new file mode 100644 index 0000000000000000000000000000000000000000..b15dfc7aeabffe1e8e6cfc1721765de311be8b79 --- /dev/null +++ b/docs/api_docs/classes/UndefinedType.md @@ -0,0 +1,75 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / UndefinedType + +# Class: UndefinedType + +Defined in: src/core/base/Type.ts:191 + +undefined type + +## Extends + +- [`PrimitiveType`](PrimitiveType.md) + +## Methods + +### getName() + +> **getName**(): `string` + +Defined in: src/core/base/Type.ts:126 + +#### Returns + +`string` + +#### Inherited from + +[`PrimitiveType`](PrimitiveType.md).[`getName`](PrimitiveType.md#getname) + +*** + +### getTypeString() + +> **getTypeString**(): `string` + +Defined in: src/core/base/Type.ts:130 + +#### Returns + +`string` + +#### Inherited from + +[`PrimitiveType`](PrimitiveType.md).[`getTypeString`](PrimitiveType.md#gettypestring) + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/base/Type.ts:36 + +#### Returns + +`string` + +#### Inherited from + +[`PrimitiveType`](PrimitiveType.md).[`toString`](PrimitiveType.md#tostring) + +*** + +### getInstance() + +> `static` **getInstance**(): [`UndefinedType`](UndefinedType.md) + +Defined in: src/core/base/Type.ts:194 + +#### Returns + +[`UndefinedType`](UndefinedType.md) diff --git a/docs/api_docs/classes/UndefinedVariableChecker.md b/docs/api_docs/classes/UndefinedVariableChecker.md new file mode 100644 index 0000000000000000000000000000000000000000..1167dc16631c7bfa0ee89c93ef17d86cf4a80487 --- /dev/null +++ b/docs/api_docs/classes/UndefinedVariableChecker.md @@ -0,0 +1,409 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / UndefinedVariableChecker + +# Class: UndefinedVariableChecker + +Defined in: src/core/dataflow/UndefinedVariable.ts:36 + +## Extends + +- [`DataflowProblem`](DataflowProblem.md)\<[`Value`](../interfaces/Value.md)\> + +## Constructors + +### new UndefinedVariableChecker() + +> **new UndefinedVariableChecker**(`stmt`, `method`): [`UndefinedVariableChecker`](UndefinedVariableChecker.md) + +Defined in: src/core/dataflow/UndefinedVariable.ts:44 + +#### Parameters + +##### stmt + +[`Stmt`](Stmt.md) + +##### method + +[`ArkMethod`](ArkMethod.md) + +#### Returns + +[`UndefinedVariableChecker`](UndefinedVariableChecker.md) + +#### Overrides + +[`DataflowProblem`](DataflowProblem.md).[`constructor`](DataflowProblem.md#constructors) + +## Properties + +### classMap + +> **classMap**: `Map`\<[`NamespaceSignature`](NamespaceSignature.md) \| [`FileSignature`](FileSignature.md), [`ArkClass`](ArkClass.md)[]\> + +Defined in: src/core/dataflow/UndefinedVariable.ts:41 + +*** + +### entryMethod + +> **entryMethod**: [`ArkMethod`](ArkMethod.md) + +Defined in: src/core/dataflow/UndefinedVariable.ts:39 + +*** + +### entryPoint + +> **entryPoint**: [`Stmt`](Stmt.md) + +Defined in: src/core/dataflow/UndefinedVariable.ts:38 + +*** + +### globalVariableMap + +> **globalVariableMap**: `Map`\<[`NamespaceSignature`](NamespaceSignature.md) \| [`FileSignature`](FileSignature.md), [`Local`](Local.md)[]\> + +Defined in: src/core/dataflow/UndefinedVariable.ts:42 + +*** + +### outcomes + +> **outcomes**: `Outcome`[] = `[]` + +Defined in: src/core/dataflow/UndefinedVariable.ts:43 + +*** + +### scene + +> **scene**: [`Scene`](Scene.md) + +Defined in: src/core/dataflow/UndefinedVariable.ts:40 + +*** + +### zeroValue + +> **zeroValue**: [`Constant`](Constant.md) + +Defined in: src/core/dataflow/UndefinedVariable.ts:37 + +## Methods + +### addParameters() + +> **addParameters**(`srcStmt`, `dataFact`, `method`, `ret`): `void` + +Defined in: src/core/dataflow/UndefinedVariable.ts:174 + +#### Parameters + +##### srcStmt + +[`Stmt`](Stmt.md) + +##### dataFact + +[`Value`](../interfaces/Value.md) + +##### method + +[`ArkMethod`](ArkMethod.md) + +##### ret + +`Set`\<[`Value`](../interfaces/Value.md)\> + +#### Returns + +`void` + +*** + +### addUndefinedField() + +> **addUndefinedField**(`field`, `method`, `ret`): `void` + +Defined in: src/core/dataflow/UndefinedVariable.ts:159 + +#### Parameters + +##### field + +[`ArkField`](ArkField.md) + +##### method + +[`ArkMethod`](ArkMethod.md) + +##### ret + +`Set`\<[`Value`](../interfaces/Value.md)\> + +#### Returns + +`void` + +*** + +### createZeroValue() + +> **createZeroValue**(): [`Value`](../interfaces/Value.md) + +Defined in: src/core/dataflow/UndefinedVariable.ts:250 + +#### Returns + +[`Value`](../interfaces/Value.md) + +#### Overrides + +[`DataflowProblem`](DataflowProblem.md).[`createZeroValue`](DataflowProblem.md#createzerovalue) + +*** + +### factEqual() + +> **factEqual**(`d1`, `d2`): `boolean` + +Defined in: src/core/dataflow/UndefinedVariable.ts:258 + +#### Parameters + +##### d1 + +[`Value`](../interfaces/Value.md) + +##### d2 + +[`Value`](../interfaces/Value.md) + +#### Returns + +`boolean` + +#### Overrides + +[`DataflowProblem`](DataflowProblem.md).[`factEqual`](DataflowProblem.md#factequal) + +*** + +### getCallFlowFunction() + +> **getCallFlowFunction**(`srcStmt`, `method`): [`FlowFunction`](../interfaces/FlowFunction.md)\<[`Value`](../interfaces/Value.md)\> + +Defined in: src/core/dataflow/UndefinedVariable.ts:117 + +#### Parameters + +##### srcStmt + +[`Stmt`](Stmt.md) + +##### method + +[`ArkMethod`](ArkMethod.md) + +#### Returns + +[`FlowFunction`](../interfaces/FlowFunction.md)\<[`Value`](../interfaces/Value.md)\> + +#### Overrides + +[`DataflowProblem`](DataflowProblem.md).[`getCallFlowFunction`](DataflowProblem.md#getcallflowfunction) + +*** + +### getCallToReturnFlowFunction() + +> **getCallToReturnFlowFunction**(`srcStmt`, `tgtStmt`): [`FlowFunction`](../interfaces/FlowFunction.md)\<[`Value`](../interfaces/Value.md)\> + +Defined in: src/core/dataflow/UndefinedVariable.ts:232 + +#### Parameters + +##### srcStmt + +[`Stmt`](Stmt.md) + +##### tgtStmt + +[`Stmt`](Stmt.md) + +#### Returns + +[`FlowFunction`](../interfaces/FlowFunction.md)\<[`Value`](../interfaces/Value.md)\> + +#### Overrides + +[`DataflowProblem`](DataflowProblem.md).[`getCallToReturnFlowFunction`](DataflowProblem.md#getcalltoreturnflowfunction) + +*** + +### getEntryMethod() + +> **getEntryMethod**(): [`ArkMethod`](ArkMethod.md) + +Defined in: src/core/dataflow/UndefinedVariable.ts:57 + +#### Returns + +[`ArkMethod`](ArkMethod.md) + +#### Overrides + +[`DataflowProblem`](DataflowProblem.md).[`getEntryMethod`](DataflowProblem.md#getentrymethod) + +*** + +### getEntryPoint() + +> **getEntryPoint**(): [`Stmt`](Stmt.md) + +Defined in: src/core/dataflow/UndefinedVariable.ts:53 + +#### Returns + +[`Stmt`](Stmt.md) + +#### Overrides + +[`DataflowProblem`](DataflowProblem.md).[`getEntryPoint`](DataflowProblem.md#getentrypoint) + +*** + +### getExitToReturnFlowFunction() + +> **getExitToReturnFlowFunction**(`srcStmt`, `tgtStmt`, `callStmt`): [`FlowFunction`](../interfaces/FlowFunction.md)\<[`Value`](../interfaces/Value.md)\> + +Defined in: src/core/dataflow/UndefinedVariable.ts:193 + +#### Parameters + +##### srcStmt + +[`Stmt`](Stmt.md) + +##### tgtStmt + +[`Stmt`](Stmt.md) + +##### callStmt + +[`Stmt`](Stmt.md) + +#### Returns + +[`FlowFunction`](../interfaces/FlowFunction.md)\<[`Value`](../interfaces/Value.md)\> + +#### Overrides + +[`DataflowProblem`](DataflowProblem.md).[`getExitToReturnFlowFunction`](DataflowProblem.md#getexittoreturnflowfunction) + +*** + +### getNormalFlowFunction() + +> **getNormalFlowFunction**(`srcStmt`, `tgtStmt`): [`FlowFunction`](../interfaces/FlowFunction.md)\<[`Value`](../interfaces/Value.md)\> + +Defined in: src/core/dataflow/UndefinedVariable.ts:71 + +Transfer the outFact of srcStmt to the inFact of tgtStmt + +Return true if keeping progagation (i.e., tgtStmt will be added to the WorkList for further analysis) + +#### Parameters + +##### srcStmt + +[`Stmt`](Stmt.md) + +##### tgtStmt + +[`Stmt`](Stmt.md) + +#### Returns + +[`FlowFunction`](../interfaces/FlowFunction.md)\<[`Value`](../interfaces/Value.md)\> + +#### Overrides + +[`DataflowProblem`](DataflowProblem.md).[`getNormalFlowFunction`](DataflowProblem.md#getnormalflowfunction) + +*** + +### getOutcomes() + +> **getOutcomes**(): `Outcome`[] + +Defined in: src/core/dataflow/UndefinedVariable.ts:269 + +#### Returns + +`Outcome`[] + +*** + +### getZeroValue() + +> **getZeroValue**(): [`Value`](../interfaces/Value.md) + +Defined in: src/core/dataflow/UndefinedVariable.ts:254 + +#### Returns + +[`Value`](../interfaces/Value.md) + +*** + +### insideCallFlowFunction() + +> **insideCallFlowFunction**(`ret`, `method`): `void` + +Defined in: src/core/dataflow/UndefinedVariable.ts:140 + +#### Parameters + +##### ret + +`Set`\<[`Value`](../interfaces/Value.md)\> + +##### method + +[`ArkMethod`](ArkMethod.md) + +#### Returns + +`void` + +*** + +### insideNormalFlowFunction() + +> **insideNormalFlowFunction**(`ret`, `srcStmt`, `dataFact`): `void` + +Defined in: src/core/dataflow/UndefinedVariable.ts:88 + +#### Parameters + +##### ret + +`Set`\<[`Value`](../interfaces/Value.md)\> + +##### srcStmt + +[`ArkAssignStmt`](ArkAssignStmt.md) + +##### dataFact + +[`Value`](../interfaces/Value.md) + +#### Returns + +`void` diff --git a/docs/api_docs/classes/UndefinedVariableSolver.md b/docs/api_docs/classes/UndefinedVariableSolver.md new file mode 100644 index 0000000000000000000000000000000000000000..5ae1210ee88bfa8e0ed7c5a768892dc560449045 --- /dev/null +++ b/docs/api_docs/classes/UndefinedVariableSolver.md @@ -0,0 +1,591 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / UndefinedVariableSolver + +# Class: UndefinedVariableSolver + +Defined in: src/core/dataflow/UndefinedVariable.ts:274 + +## Extends + +- [`DataflowSolver`](DataflowSolver.md)\<[`Value`](../interfaces/Value.md)\> + +## Constructors + +### new UndefinedVariableSolver() + +> **new UndefinedVariableSolver**(`problem`, `scene`): [`UndefinedVariableSolver`](UndefinedVariableSolver.md) + +Defined in: src/core/dataflow/UndefinedVariable.ts:275 + +#### Parameters + +##### problem + +[`UndefinedVariableChecker`](UndefinedVariableChecker.md) + +##### scene + +[`Scene`](Scene.md) + +#### Returns + +[`UndefinedVariableSolver`](UndefinedVariableSolver.md) + +#### Overrides + +[`DataflowSolver`](DataflowSolver.md).[`constructor`](DataflowSolver.md#constructors) + +## Properties + +### CHA + +> `protected` **CHA**: [`ClassHierarchyAnalysis`](ClassHierarchyAnalysis.md) + +Defined in: src/core/dataflow/DataflowSolver.ts:49 + +#### Inherited from + +[`DataflowSolver`](DataflowSolver.md).[`CHA`](DataflowSolver.md#cha) + +*** + +### endSummary + +> `protected` **endSummary**: `Map`\<[`PathEdgePoint`](PathEdgePoint.md)\<[`Value`](../interfaces/Value.md)\>, `Set`\<[`PathEdgePoint`](PathEdgePoint.md)\<[`Value`](../interfaces/Value.md)\>\>\> + +Defined in: src/core/dataflow/DataflowSolver.ts:46 + +#### Inherited from + +[`DataflowSolver`](DataflowSolver.md).[`endSummary`](DataflowSolver.md#endsummary) + +*** + +### inComing + +> `protected` **inComing**: `Map`\<[`PathEdgePoint`](PathEdgePoint.md)\<[`Value`](../interfaces/Value.md)\>, `Set`\<[`PathEdgePoint`](PathEdgePoint.md)\<[`Value`](../interfaces/Value.md)\>\>\> + +Defined in: src/core/dataflow/DataflowSolver.ts:45 + +#### Inherited from + +[`DataflowSolver`](DataflowSolver.md).[`inComing`](DataflowSolver.md#incoming) + +*** + +### laterEdges + +> `protected` **laterEdges**: `Set`\<[`PathEdge`](PathEdge.md)\<[`Value`](../interfaces/Value.md)\>\> + +Defined in: src/core/dataflow/DataflowSolver.ts:51 + +#### Inherited from + +[`DataflowSolver`](DataflowSolver.md).[`laterEdges`](DataflowSolver.md#lateredges) + +*** + +### pathEdgeSet + +> `protected` **pathEdgeSet**: `Set`\<[`PathEdge`](PathEdge.md)\<[`Value`](../interfaces/Value.md)\>\> + +Defined in: src/core/dataflow/DataflowSolver.ts:43 + +#### Inherited from + +[`DataflowSolver`](DataflowSolver.md).[`pathEdgeSet`](DataflowSolver.md#pathedgeset) + +*** + +### problem + +> `protected` **problem**: [`DataflowProblem`](DataflowProblem.md)\<[`Value`](../interfaces/Value.md)\> + +Defined in: src/core/dataflow/DataflowSolver.ts:41 + +#### Inherited from + +[`DataflowSolver`](DataflowSolver.md).[`problem`](DataflowSolver.md#problem-1) + +*** + +### scene + +> `protected` **scene**: [`Scene`](Scene.md) + +Defined in: src/core/dataflow/DataflowSolver.ts:48 + +#### Inherited from + +[`DataflowSolver`](DataflowSolver.md).[`scene`](DataflowSolver.md#scene-1) + +*** + +### stmtNexts + +> `protected` **stmtNexts**: `Map`\<[`Stmt`](Stmt.md), `Set`\<[`Stmt`](Stmt.md)\>\> + +Defined in: src/core/dataflow/DataflowSolver.ts:50 + +#### Inherited from + +[`DataflowSolver`](DataflowSolver.md).[`stmtNexts`](DataflowSolver.md#stmtnexts) + +*** + +### summaryEdge + +> `protected` **summaryEdge**: `Set`\<`CallToReturnCacheEdge`\<[`Value`](../interfaces/Value.md)\>\> + +Defined in: src/core/dataflow/DataflowSolver.ts:47 + +#### Inherited from + +[`DataflowSolver`](DataflowSolver.md).[`summaryEdge`](DataflowSolver.md#summaryedge) + +*** + +### workList + +> `protected` **workList**: [`PathEdge`](PathEdge.md)\<[`Value`](../interfaces/Value.md)\>[] + +Defined in: src/core/dataflow/DataflowSolver.ts:42 + +#### Inherited from + +[`DataflowSolver`](DataflowSolver.md).[`workList`](DataflowSolver.md#worklist) + +*** + +### zeroFact + +> `protected` **zeroFact**: [`Value`](../interfaces/Value.md) + +Defined in: src/core/dataflow/DataflowSolver.ts:44 + +#### Inherited from + +[`DataflowSolver`](DataflowSolver.md).[`zeroFact`](DataflowSolver.md#zerofact) + +## Methods + +### buildStmtMapInBlock() + +> `protected` **buildStmtMapInBlock**(`block`): `void` + +Defined in: src/core/dataflow/DataflowSolver.ts:113 + +#### Parameters + +##### block + +[`BasicBlock`](BasicBlock.md) + +#### Returns + +`void` + +#### Inherited from + +[`DataflowSolver`](DataflowSolver.md).[`buildStmtMapInBlock`](DataflowSolver.md#buildstmtmapinblock) + +*** + +### buildStmtMapInClass() + +> `protected` **buildStmtMapInClass**(): `void` + +Defined in: src/core/dataflow/DataflowSolver.ts:98 + +#### Returns + +`void` + +#### Inherited from + +[`DataflowSolver`](DataflowSolver.md).[`buildStmtMapInClass`](DataflowSolver.md#buildstmtmapinclass) + +*** + +### callNodeFactPropagate() + +> `protected` **callNodeFactPropagate**(`edge`, `firstStmt`, `fact`, `returnSite`): `void` + +Defined in: src/core/dataflow/DataflowSolver.ts:277 + +#### Parameters + +##### edge + +[`PathEdge`](PathEdge.md)\<[`Value`](../interfaces/Value.md)\> + +##### firstStmt + +[`Stmt`](Stmt.md) + +##### fact + +[`Value`](../interfaces/Value.md) + +##### returnSite + +[`Stmt`](Stmt.md) + +#### Returns + +`void` + +#### Inherited from + +[`DataflowSolver`](DataflowSolver.md).[`callNodeFactPropagate`](DataflowSolver.md#callnodefactpropagate) + +*** + +### computeResult() + +> `protected` **computeResult**(`stmt`, `d`): `boolean` + +Defined in: src/core/dataflow/DataflowSolver.ts:71 + +#### Parameters + +##### stmt + +[`Stmt`](Stmt.md) + +##### d + +[`Value`](../interfaces/Value.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`DataflowSolver`](DataflowSolver.md).[`computeResult`](DataflowSolver.md#computeresult) + +*** + +### doSolve() + +> `protected` **doSolve**(): `void` + +Defined in: src/core/dataflow/DataflowSolver.ts:309 + +#### Returns + +`void` + +#### Inherited from + +[`DataflowSolver`](DataflowSolver.md).[`doSolve`](DataflowSolver.md#dosolve) + +*** + +### getAllCalleeMethods() + +> `protected` **getAllCalleeMethods**(`callNode`): `Set`\<[`ArkMethod`](ArkMethod.md)\> + +Defined in: src/core/dataflow/DataflowSolver.ts:137 + +#### Parameters + +##### callNode + +[`ArkInvokeStmt`](ArkInvokeStmt.md) + +#### Returns + +`Set`\<[`ArkMethod`](ArkMethod.md)\> + +#### Inherited from + +[`DataflowSolver`](DataflowSolver.md).[`getAllCalleeMethods`](DataflowSolver.md#getallcalleemethods) + +*** + +### getChildren() + +> `protected` **getChildren**(`stmt`): [`Stmt`](Stmt.md)[] + +Defined in: src/core/dataflow/DataflowSolver.ts:80 + +#### Parameters + +##### stmt + +[`Stmt`](Stmt.md) + +#### Returns + +[`Stmt`](Stmt.md)[] + +#### Inherited from + +[`DataflowSolver`](DataflowSolver.md).[`getChildren`](DataflowSolver.md#getchildren) + +*** + +### getPathEdgeSet() + +> **getPathEdgeSet**(): `Set`\<[`PathEdge`](PathEdge.md)\<[`Value`](../interfaces/Value.md)\>\> + +Defined in: src/core/dataflow/DataflowSolver.ts:344 + +#### Returns + +`Set`\<[`PathEdge`](PathEdge.md)\<[`Value`](../interfaces/Value.md)\>\> + +#### Inherited from + +[`DataflowSolver`](DataflowSolver.md).[`getPathEdgeSet`](DataflowSolver.md#getpathedgeset) + +*** + +### getReturnSiteOfCall() + +> `protected` **getReturnSiteOfCall**(`call`): [`Stmt`](Stmt.md) + +Defined in: src/core/dataflow/DataflowSolver.ts:150 + +#### Parameters + +##### call + +[`Stmt`](Stmt.md) + +#### Returns + +[`Stmt`](Stmt.md) + +#### Inherited from + +[`DataflowSolver`](DataflowSolver.md).[`getReturnSiteOfCall`](DataflowSolver.md#getreturnsiteofcall) + +*** + +### getStartOfCallerMethod() + +> `protected` **getStartOfCallerMethod**(`call`): [`Stmt`](Stmt.md) + +Defined in: src/core/dataflow/DataflowSolver.ts:154 + +#### Parameters + +##### call + +[`Stmt`](Stmt.md) + +#### Returns + +[`Stmt`](Stmt.md) + +#### Inherited from + +[`DataflowSolver`](DataflowSolver.md).[`getStartOfCallerMethod`](DataflowSolver.md#getstartofcallermethod) + +*** + +### init() + +> `protected` **init**(): `void` + +Defined in: src/core/dataflow/DataflowSolver.ts:84 + +#### Returns + +`void` + +#### Inherited from + +[`DataflowSolver`](DataflowSolver.md).[`init`](DataflowSolver.md#init) + +*** + +### isCallStatement() + +> `protected` **isCallStatement**(`stmt`): `boolean` + +Defined in: src/core/dataflow/DataflowSolver.ts:326 + +#### Parameters + +##### stmt + +[`Stmt`](Stmt.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`DataflowSolver`](DataflowSolver.md).[`isCallStatement`](DataflowSolver.md#iscallstatement) + +*** + +### isExitStatement() + +> `protected` **isExitStatement**(`stmt`): `boolean` + +Defined in: src/core/dataflow/DataflowSolver.ts:340 + +#### Parameters + +##### stmt + +[`Stmt`](Stmt.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`DataflowSolver`](DataflowSolver.md).[`isExitStatement`](DataflowSolver.md#isexitstatement) + +*** + +### pathEdgeSetHasEdge() + +> `protected` **pathEdgeSetHasEdge**(`edge`): `boolean` + +Defined in: src/core/dataflow/DataflowSolver.ts:160 + +#### Parameters + +##### edge + +[`PathEdge`](PathEdge.md)\<[`Value`](../interfaces/Value.md)\> + +#### Returns + +`boolean` + +#### Inherited from + +[`DataflowSolver`](DataflowSolver.md).[`pathEdgeSetHasEdge`](DataflowSolver.md#pathedgesethasedge) + +*** + +### processCallNode() + +> `protected` **processCallNode**(`edge`): `void` + +Defined in: src/core/dataflow/DataflowSolver.ts:243 + +#### Parameters + +##### edge + +[`PathEdge`](PathEdge.md)\<[`Value`](../interfaces/Value.md)\> + +#### Returns + +`void` + +#### Inherited from + +[`DataflowSolver`](DataflowSolver.md).[`processCallNode`](DataflowSolver.md#processcallnode) + +*** + +### processExitNode() + +> `protected` **processExitNode**(`edge`): `void` + +Defined in: src/core/dataflow/DataflowSolver.ts:185 + +#### Parameters + +##### edge + +[`PathEdge`](PathEdge.md)\<[`Value`](../interfaces/Value.md)\> + +#### Returns + +`void` + +#### Inherited from + +[`DataflowSolver`](DataflowSolver.md).[`processExitNode`](DataflowSolver.md#processexitnode) + +*** + +### processNormalNode() + +> `protected` **processNormalNode**(`edge`): `void` + +Defined in: src/core/dataflow/DataflowSolver.ts:227 + +#### Parameters + +##### edge + +[`PathEdge`](PathEdge.md)\<[`Value`](../interfaces/Value.md)\> + +#### Returns + +`void` + +#### Inherited from + +[`DataflowSolver`](DataflowSolver.md).[`processNormalNode`](DataflowSolver.md#processnormalnode) + +*** + +### propagate() + +> `protected` **propagate**(`edge`): `void` + +Defined in: src/core/dataflow/DataflowSolver.ts:171 + +#### Parameters + +##### edge + +[`PathEdge`](PathEdge.md)\<[`Value`](../interfaces/Value.md)\> + +#### Returns + +`void` + +#### Inherited from + +[`DataflowSolver`](DataflowSolver.md).[`propagate`](DataflowSolver.md#propagate) + +*** + +### setCfg4AllStmt() + +> `protected` **setCfg4AllStmt**(): `void` + +Defined in: src/core/dataflow/DataflowSolver.ts:129 + +#### Returns + +`void` + +#### Inherited from + +[`DataflowSolver`](DataflowSolver.md).[`setCfg4AllStmt`](DataflowSolver.md#setcfg4allstmt) + +*** + +### solve() + +> **solve**(): `void` + +Defined in: src/core/dataflow/DataflowSolver.ts:66 + +#### Returns + +`void` + +#### Inherited from + +[`DataflowSolver`](DataflowSolver.md).[`solve`](DataflowSolver.md#solve) diff --git a/docs/api_docs/classes/UnionType.md b/docs/api_docs/classes/UnionType.md new file mode 100644 index 0000000000000000000000000000000000000000..65741b26ec3bd17c7282eb73933e9ebb8df8c5cc --- /dev/null +++ b/docs/api_docs/classes/UnionType.md @@ -0,0 +1,127 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / UnionType + +# Class: UnionType + +Defined in: src/core/base/Type.ts:231 + +union type + +## Extends + +- [`Type`](Type.md) + +## Constructors + +### new UnionType() + +> **new UnionType**(`types`, `currType`): [`UnionType`](UnionType.md) + +Defined in: src/core/base/Type.ts:234 + +#### Parameters + +##### types + +[`Type`](Type.md)[] + +##### currType + +[`Type`](Type.md) = `...` + +#### Returns + +[`UnionType`](UnionType.md) + +#### Overrides + +[`Type`](Type.md).[`constructor`](Type.md#constructors) + +## Methods + +### flatType() + +> **flatType**(): [`Type`](Type.md)[] + +Defined in: src/core/base/Type.ts:256 + +#### Returns + +[`Type`](Type.md)[] + +*** + +### getCurrType() + +> **getCurrType**(): [`Type`](Type.md) + +Defined in: src/core/base/Type.ts:244 + +#### Returns + +[`Type`](Type.md) + +*** + +### getTypes() + +> **getTypes**(): [`Type`](Type.md)[] + +Defined in: src/core/base/Type.ts:240 + +#### Returns + +[`Type`](Type.md)[] + +*** + +### getTypeString() + +> **getTypeString**(): `string` + +Defined in: src/core/base/Type.ts:252 + +#### Returns + +`string` + +#### Overrides + +[`Type`](Type.md).[`getTypeString`](Type.md#gettypestring) + +*** + +### setCurrType() + +> **setCurrType**(`newType`): `void` + +Defined in: src/core/base/Type.ts:248 + +#### Parameters + +##### newType + +[`Type`](Type.md) + +#### Returns + +`void` + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/base/Type.ts:36 + +#### Returns + +`string` + +#### Inherited from + +[`Type`](Type.md).[`toString`](Type.md#tostring) diff --git a/docs/api_docs/classes/UnknownType.md b/docs/api_docs/classes/UnknownType.md new file mode 100644 index 0000000000000000000000000000000000000000..663b3c13495315abecc2018c090dbcf99f0104c2 --- /dev/null +++ b/docs/api_docs/classes/UnknownType.md @@ -0,0 +1,59 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / UnknownType + +# Class: UnknownType + +Defined in: src/core/base/Type.ts:67 + +unknown type + +## Extends + +- [`Type`](Type.md) + +## Methods + +### getTypeString() + +> **getTypeString**(): `string` + +Defined in: src/core/base/Type.ts:78 + +#### Returns + +`string` + +#### Overrides + +[`Type`](Type.md).[`getTypeString`](Type.md#gettypestring) + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/base/Type.ts:36 + +#### Returns + +`string` + +#### Inherited from + +[`Type`](Type.md).[`toString`](Type.md#tostring) + +*** + +### getInstance() + +> `static` **getInstance**(): [`UnknownType`](UnknownType.md) + +Defined in: src/core/base/Type.ts:70 + +#### Returns + +[`UnknownType`](UnknownType.md) diff --git a/docs/api_docs/classes/ValueUtil.md b/docs/api_docs/classes/ValueUtil.md new file mode 100644 index 0000000000000000000000000000000000000000..215094a57d3dbce28b67dacafd13f9ec849738d2 --- /dev/null +++ b/docs/api_docs/classes/ValueUtil.md @@ -0,0 +1,123 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / ValueUtil + +# Class: ValueUtil + +Defined in: src/core/common/ValueUtil.ts:27 + +## Constructors + +### new ValueUtil() + +> **new ValueUtil**(): [`ValueUtil`](ValueUtil.md) + +#### Returns + +[`ValueUtil`](ValueUtil.md) + +## Properties + +### EMPTY\_STRING\_CONSTANT + +> `readonly` `static` **EMPTY\_STRING\_CONSTANT**: `StringConstant` + +Defined in: src/core/common/ValueUtil.ts:29 + +## Methods + +### createConst() + +> `static` **createConst**(`str`): [`Constant`](Constant.md) + +Defined in: src/core/common/ValueUtil.ts:47 + +#### Parameters + +##### str + +`string` + +#### Returns + +[`Constant`](Constant.md) + +*** + +### createStringConst() + +> `static` **createStringConst**(`str`): [`Constant`](Constant.md) + +Defined in: src/core/common/ValueUtil.ts:40 + +#### Parameters + +##### str + +`string` + +#### Returns + +[`Constant`](Constant.md) + +*** + +### getBooleanConstant() + +> `static` **getBooleanConstant**(`value`): [`Constant`](Constant.md) + +Defined in: src/core/common/ValueUtil.ts:63 + +#### Parameters + +##### value + +`boolean` + +#### Returns + +[`Constant`](Constant.md) + +*** + +### getNullConstant() + +> `static` **getNullConstant**(): [`Constant`](Constant.md) + +Defined in: src/core/common/ValueUtil.ts:59 + +#### Returns + +[`Constant`](Constant.md) + +*** + +### getOrCreateNumberConst() + +> `static` **getOrCreateNumberConst**(`n`): [`Constant`](Constant.md) + +Defined in: src/core/common/ValueUtil.ts:31 + +#### Parameters + +##### n + +`number` + +#### Returns + +[`Constant`](Constant.md) + +*** + +### getUndefinedConst() + +> `static` **getUndefinedConst**(): [`Constant`](Constant.md) + +Defined in: src/core/common/ValueUtil.ts:55 + +#### Returns + +[`Constant`](Constant.md) diff --git a/docs/api_docs/classes/ViewTreePrinter.md b/docs/api_docs/classes/ViewTreePrinter.md new file mode 100644 index 0000000000000000000000000000000000000000..957e2c250df97769a8787c9b774925e58c008c6b --- /dev/null +++ b/docs/api_docs/classes/ViewTreePrinter.md @@ -0,0 +1,65 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / ViewTreePrinter + +# Class: ViewTreePrinter + +Defined in: src/save/ViewTreePrinter.ts:27 + +## Extends + +- [`Printer`](Printer.md) + +## Constructors + +### new ViewTreePrinter() + +> **new ViewTreePrinter**(`viewTree`): [`ViewTreePrinter`](ViewTreePrinter.md) + +Defined in: src/save/ViewTreePrinter.ts:31 + +#### Parameters + +##### viewTree + +[`ViewTree`](../interfaces/ViewTree.md) + +#### Returns + +[`ViewTreePrinter`](ViewTreePrinter.md) + +#### Overrides + +[`Printer`](Printer.md).[`constructor`](Printer.md#constructors) + +## Properties + +### printer + +> `protected` **printer**: `ArkCodeBuffer` + +Defined in: src/save/Printer.ts:22 + +#### Inherited from + +[`Printer`](Printer.md).[`printer`](Printer.md#printer-1) + +## Methods + +### dump() + +> **dump**(): `string` + +Defined in: src/save/ViewTreePrinter.ts:37 + +ArkIR dump + +#### Returns + +`string` + +#### Overrides + +[`Printer`](Printer.md).[`dump`](Printer.md#dump) diff --git a/docs/api_docs/classes/VisibleValue.md b/docs/api_docs/classes/VisibleValue.md new file mode 100644 index 0000000000000000000000000000000000000000..5bea44d7e5e184465e0fbbfe9a2bdd5c80628c5e --- /dev/null +++ b/docs/api_docs/classes/VisibleValue.md @@ -0,0 +1,81 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / VisibleValue + +# Class: VisibleValue + +Defined in: src/core/common/VisibleValue.ts:30 + +## Constructors + +### new VisibleValue() + +> **new VisibleValue**(): [`VisibleValue`](VisibleValue.md) + +Defined in: src/core/common/VisibleValue.ts:35 + +#### Returns + +[`VisibleValue`](VisibleValue.md) + +## Methods + +### getCurrVisibleValues() + +> **getCurrVisibleValues**(): [`Value`](../interfaces/Value.md)[] + +Defined in: src/core/common/VisibleValue.ts:43 + +get values that is visible in curr scope + +#### Returns + +[`Value`](../interfaces/Value.md)[] + +*** + +### getScopeChain() + +> **getScopeChain**(): [`Scope`](Scope.md)[] + +Defined in: src/core/common/VisibleValue.ts:47 + +#### Returns + +[`Scope`](Scope.md)[] + +*** + +### updateIntoScope() + +> **updateIntoScope**(`model`): `void` + +Defined in: src/core/common/VisibleValue.ts:52 + +udpate visible values after entered a scope, only support step by step + +#### Parameters + +##### model + +`ArkModel` + +#### Returns + +`void` + +*** + +### updateOutScope() + +> **updateOutScope**(): `void` + +Defined in: src/core/common/VisibleValue.ts:80 + +udpate visible values after left a scope, only support step by step + +#### Returns + +`void` diff --git a/docs/api_docs/classes/VoidType.md b/docs/api_docs/classes/VoidType.md new file mode 100644 index 0000000000000000000000000000000000000000..0f02b26b672692527e82d3a80faff5ddc353e80c --- /dev/null +++ b/docs/api_docs/classes/VoidType.md @@ -0,0 +1,59 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / VoidType + +# Class: VoidType + +Defined in: src/core/base/Type.ts:273 + +types for function void return type + +## Extends + +- [`Type`](Type.md) + +## Methods + +### getTypeString() + +> **getTypeString**(): `string` + +Defined in: src/core/base/Type.ts:284 + +#### Returns + +`string` + +#### Overrides + +[`Type`](Type.md).[`getTypeString`](Type.md#gettypestring) + +*** + +### toString() + +> **toString**(): `string` + +Defined in: src/core/base/Type.ts:36 + +#### Returns + +`string` + +#### Inherited from + +[`Type`](Type.md).[`toString`](Type.md#tostring) + +*** + +### getInstance() + +> `static` **getInstance**(): [`VoidType`](VoidType.md) + +Defined in: src/core/base/Type.ts:276 + +#### Returns + +[`VoidType`](VoidType.md) diff --git a/docs/api_docs/classes/WritePagEdge.md b/docs/api_docs/classes/WritePagEdge.md new file mode 100644 index 0000000000000000000000000000000000000000..a7a16ec1010b1226145357657e59119003507c45 --- /dev/null +++ b/docs/api_docs/classes/WritePagEdge.md @@ -0,0 +1,197 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / WritePagEdge + +# Class: WritePagEdge + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:106 + +## Extends + +- [`PagEdge`](PagEdge.md) + +## Constructors + +### new WritePagEdge() + +> **new WritePagEdge**(`n`, `d`, `s`): [`WritePagEdge`](WritePagEdge.md) + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:107 + +#### Parameters + +##### n + +[`PagNode`](PagNode.md) + +##### d + +[`PagNode`](PagNode.md) + +##### s + +[`Stmt`](Stmt.md) + +#### Returns + +[`WritePagEdge`](WritePagEdge.md) + +#### Overrides + +[`PagEdge`](PagEdge.md).[`constructor`](PagEdge.md#constructors) + +## Properties + +### kind + +> `protected` **kind**: `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:27 + +#### Inherited from + +[`PagEdge`](PagEdge.md).[`kind`](PagEdge.md#kind) + +## Methods + +### getDotAttr() + +> **getDotAttr**(): `string` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:65 + +#### Returns + +`string` + +#### Inherited from + +[`PagEdge`](PagEdge.md).[`getDotAttr`](PagEdge.md#getdotattr) + +*** + +### getDstID() + +> **getDstID**(): `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:39 + +#### Returns + +`number` + +#### Inherited from + +[`PagEdge`](PagEdge.md).[`getDstID`](PagEdge.md#getdstid) + +*** + +### getDstNode() + +> **getDstNode**(): [`BaseNode`](BaseNode.md) + +Defined in: src/core/graph/BaseExplicitGraph.ts:47 + +#### Returns + +[`BaseNode`](BaseNode.md) + +#### Inherited from + +[`PagEdge`](PagEdge.md).[`getDstNode`](PagEdge.md#getdstnode) + +*** + +### getEndPoints() + +> **getEndPoints**(): `object` + +Defined in: src/core/graph/BaseExplicitGraph.ts:59 + +#### Returns + +`object` + +##### dst + +> **dst**: `number` + +##### src + +> **src**: `number` + +#### Inherited from + +[`PagEdge`](PagEdge.md).[`getEndPoints`](PagEdge.md#getendpoints) + +*** + +### getKind() + +> **getKind**(): `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:51 + +#### Returns + +`number` + +#### Inherited from + +[`PagEdge`](PagEdge.md).[`getKind`](PagEdge.md#getkind) + +*** + +### getSrcID() + +> **getSrcID**(): `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:35 + +#### Returns + +`number` + +#### Inherited from + +[`PagEdge`](PagEdge.md).[`getSrcID`](PagEdge.md#getsrcid) + +*** + +### getSrcNode() + +> **getSrcNode**(): [`BaseNode`](BaseNode.md) + +Defined in: src/core/graph/BaseExplicitGraph.ts:43 + +#### Returns + +[`BaseNode`](BaseNode.md) + +#### Inherited from + +[`PagEdge`](PagEdge.md).[`getSrcNode`](PagEdge.md#getsrcnode) + +*** + +### setKind() + +> **setKind**(`kind`): `void` + +Defined in: src/core/graph/BaseExplicitGraph.ts:55 + +#### Parameters + +##### kind + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`PagEdge`](PagEdge.md).[`setKind`](PagEdge.md#setkind) diff --git a/docs/api_docs/enumerations/CallGraphNodeKind.md b/docs/api_docs/enumerations/CallGraphNodeKind.md new file mode 100644 index 0000000000000000000000000000000000000000..bc6a102046bdfa88f3eee26095c11abe0ff190eb --- /dev/null +++ b/docs/api_docs/enumerations/CallGraphNodeKind.md @@ -0,0 +1,41 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / CallGraphNodeKind + +# Enumeration: CallGraphNodeKind + +Defined in: src/callgraph/model/CallGraph.ts:33 + +## Enumeration Members + +### constructor + +> **constructor**: `3` + +Defined in: src/callgraph/model/CallGraph.ts:34 + +*** + +### intrinsic + +> **intrinsic**: `2` + +Defined in: src/callgraph/model/CallGraph.ts:34 + +*** + +### real + +> **real**: `0` + +Defined in: src/callgraph/model/CallGraph.ts:34 + +*** + +### vitual + +> **vitual**: `1` + +Defined in: src/callgraph/model/CallGraph.ts:34 diff --git a/docs/api_docs/enumerations/NormalBinaryOperator.md b/docs/api_docs/enumerations/NormalBinaryOperator.md new file mode 100644 index 0000000000000000000000000000000000000000..7c74d2d5c4ed40187899d6c2ea9dd2cfd21931e0 --- /dev/null +++ b/docs/api_docs/enumerations/NormalBinaryOperator.md @@ -0,0 +1,129 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / NormalBinaryOperator + +# Enumeration: NormalBinaryOperator + +Defined in: src/core/base/Expr.ts:500 + +## Enumeration Members + +### Addition + +> **Addition**: `"+"` + +Defined in: src/core/base/Expr.ts:507 + +*** + +### BitwiseAnd + +> **BitwiseAnd**: `"&"` + +Defined in: src/core/base/Expr.ts:518 + +*** + +### BitwiseOr + +> **BitwiseOr**: "\|" + +Defined in: src/core/base/Expr.ts:519 + +*** + +### BitwiseXor + +> **BitwiseXor**: `"^"` + +Defined in: src/core/base/Expr.ts:520 + +*** + +### Division + +> **Division**: `"/"` + +Defined in: src/core/base/Expr.ts:506 + +*** + +### Exponentiation + +> **Exponentiation**: `"**"` + +Defined in: src/core/base/Expr.ts:505 + +*** + +### LeftShift + +> **LeftShift**: `"<<"` + +Defined in: src/core/base/Expr.ts:513 + +*** + +### LogicalAnd + +> **LogicalAnd**: `"&&"` + +Defined in: src/core/base/Expr.ts:523 + +*** + +### LogicalOr + +> **LogicalOr**: "\|\|" + +Defined in: src/core/base/Expr.ts:524 + +*** + +### Multiplication + +> **Multiplication**: `"*"` + +Defined in: src/core/base/Expr.ts:509 + +*** + +### NullishCoalescing + +> **NullishCoalescing**: `"??"` + +Defined in: src/core/base/Expr.ts:502 + +*** + +### Remainder + +> **Remainder**: `"%"` + +Defined in: src/core/base/Expr.ts:510 + +*** + +### RightShift + +> **RightShift**: `">>"` + +Defined in: src/core/base/Expr.ts:514 + +*** + +### Subtraction + +> **Subtraction**: `"-"` + +Defined in: src/core/base/Expr.ts:508 + +*** + +### UnsignedRightShift + +> **UnsignedRightShift**: `">>>"` + +Defined in: src/core/base/Expr.ts:515 diff --git a/docs/api_docs/enumerations/PagEdgeKind.md b/docs/api_docs/enumerations/PagEdgeKind.md new file mode 100644 index 0000000000000000000000000000000000000000..7d3db697f51509aafae0a2de0e62f8981f408ee4 --- /dev/null +++ b/docs/api_docs/enumerations/PagEdgeKind.md @@ -0,0 +1,65 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / PagEdgeKind + +# Enumeration: PagEdgeKind + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:43 + +## Enumeration Members + +### Address + +> **Address**: `0` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:44 + +*** + +### Copy + +> **Copy**: `1` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:44 + +*** + +### InterProceduralCopy + +> **InterProceduralCopy**: `6` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:44 + +*** + +### Load + +> **Load**: `2` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:44 + +*** + +### This + +> **This**: `4` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:44 + +*** + +### Unknown + +> **Unknown**: `5` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:44 + +*** + +### Write + +> **Write**: `3` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:44 diff --git a/docs/api_docs/enumerations/PagNodeKind.md b/docs/api_docs/enumerations/PagNodeKind.md new file mode 100644 index 0000000000000000000000000000000000000000..aab66f88755b5075939f9526d7bc2de72202a709 --- /dev/null +++ b/docs/api_docs/enumerations/PagNodeKind.md @@ -0,0 +1,73 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / PagNodeKind + +# Enumeration: PagNodeKind + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:120 + +## Enumeration Members + +### ExportInfo + +> **ExportInfo**: `7` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:120 + +*** + +### Function + +> **Function**: `5` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:120 + +*** + +### GlobalThis + +> **GlobalThis**: `6` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:120 + +*** + +### HeapObj + +> **HeapObj**: `0` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:120 + +*** + +### LocalVar + +> **LocalVar**: `1` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:120 + +*** + +### Param + +> **Param**: `3` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:120 + +*** + +### RefVar + +> **RefVar**: `2` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:120 + +*** + +### ThisRef + +> **ThisRef**: `4` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:120 diff --git a/docs/api_docs/enumerations/RelationalBinaryOperator.md b/docs/api_docs/enumerations/RelationalBinaryOperator.md new file mode 100644 index 0000000000000000000000000000000000000000..339e1a697350b069ef38e05e0edf119ca80f86e6 --- /dev/null +++ b/docs/api_docs/enumerations/RelationalBinaryOperator.md @@ -0,0 +1,81 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / RelationalBinaryOperator + +# Enumeration: RelationalBinaryOperator + +Defined in: src/core/base/Expr.ts:527 + +## Enumeration Members + +### Equality + +> **Equality**: `"=="` + +Defined in: src/core/base/Expr.ts:532 + +*** + +### GreaterThan + +> **GreaterThan**: `">"` + +Defined in: src/core/base/Expr.ts:530 + +*** + +### GreaterThanOrEqual + +> **GreaterThanOrEqual**: `">="` + +Defined in: src/core/base/Expr.ts:531 + +*** + +### InEquality + +> **InEquality**: `"!="` + +Defined in: src/core/base/Expr.ts:533 + +*** + +### isPropertyOf + +> **isPropertyOf**: `"in"` + +Defined in: src/core/base/Expr.ts:536 + +*** + +### LessThan + +> **LessThan**: `"<"` + +Defined in: src/core/base/Expr.ts:528 + +*** + +### LessThanOrEqual + +> **LessThanOrEqual**: `"<="` + +Defined in: src/core/base/Expr.ts:529 + +*** + +### StrictEquality + +> **StrictEquality**: `"==="` + +Defined in: src/core/base/Expr.ts:534 + +*** + +### StrictInequality + +> **StrictInequality**: `"!=="` + +Defined in: src/core/base/Expr.ts:535 diff --git a/docs/api_docs/enumerations/StorageLinkEdgeType.md b/docs/api_docs/enumerations/StorageLinkEdgeType.md new file mode 100644 index 0000000000000000000000000000000000000000..41f3255edf076ca924008c5a01877653f3fc6eaa --- /dev/null +++ b/docs/api_docs/enumerations/StorageLinkEdgeType.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / StorageLinkEdgeType + +# Enumeration: StorageLinkEdgeType + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:51 + +## Enumeration Members + +### Local2Property + +> **Local2Property**: `1` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:53 + +*** + +### Property2Local + +> **Property2Local**: `0` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:52 + +*** + +### TwoWay + +> **TwoWay**: `2` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:54 diff --git a/docs/api_docs/enumerations/StorageType.md b/docs/api_docs/enumerations/StorageType.md new file mode 100644 index 0000000000000000000000000000000000000000..072e56d483f0d288ac33e5d3f1f64a9dace613a9 --- /dev/null +++ b/docs/api_docs/enumerations/StorageType.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / StorageType + +# Enumeration: StorageType + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:47 + +## Enumeration Members + +### APP\_STORAGE + +> **APP\_STORAGE**: `0` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:48 + +*** + +### LOCAL\_STORAGE + +> **LOCAL\_STORAGE**: `1` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:48 + +*** + +### Undefined + +> **Undefined**: `2` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:48 diff --git a/docs/api_docs/enumerations/UnaryOperator.md b/docs/api_docs/enumerations/UnaryOperator.md new file mode 100644 index 0000000000000000000000000000000000000000..5b6ecef70be5b1544fb2f7c46f6a9ff9d3d544de --- /dev/null +++ b/docs/api_docs/enumerations/UnaryOperator.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / UnaryOperator + +# Enumeration: UnaryOperator + +Defined in: src/core/base/Expr.ts:895 + +## Enumeration Members + +### BitwiseNot + +> **BitwiseNot**: `"~"` + +Defined in: src/core/base/Expr.ts:897 + +*** + +### LogicalNot + +> **LogicalNot**: `"!"` + +Defined in: src/core/base/Expr.ts:898 + +*** + +### Neg + +> **Neg**: `"-"` + +Defined in: src/core/base/Expr.ts:896 diff --git a/docs/api_docs/functions/addCfg2Stmt.md b/docs/api_docs/functions/addCfg2Stmt.md new file mode 100644 index 0000000000000000000000000000000000000000..eb5e2dd5e7fe58d04d5329b2c7d83d90466d2db1 --- /dev/null +++ b/docs/api_docs/functions/addCfg2Stmt.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / addCfg2Stmt + +# Function: addCfg2Stmt() + +> **addCfg2Stmt**(`method`): `void` + +Defined in: src/utils/entryMethodUtils.ts:110 + +## Parameters + +### method + +[`ArkMethod`](../classes/ArkMethod.md) + +## Returns + +`void` diff --git a/docs/api_docs/functions/classSignatureCompare.md b/docs/api_docs/functions/classSignatureCompare.md new file mode 100644 index 0000000000000000000000000000000000000000..442e2a58c96a7c65733520a8dc7bfe9724335588 --- /dev/null +++ b/docs/api_docs/functions/classSignatureCompare.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / classSignatureCompare + +# Function: classSignatureCompare() + +> **classSignatureCompare**(`leftSig`, `rightSig`): `boolean` + +Defined in: src/core/model/ArkSignature.ts:409 + +## Parameters + +### leftSig + +[`ClassSignature`](../classes/ClassSignature.md) + +### rightSig + +[`ClassSignature`](../classes/ClassSignature.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/functions/extractLastBracketContent.md b/docs/api_docs/functions/extractLastBracketContent.md new file mode 100644 index 0000000000000000000000000000000000000000..15d1e25622be84f9c6d91d56958915a805a26c9c --- /dev/null +++ b/docs/api_docs/functions/extractLastBracketContent.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / extractLastBracketContent + +# Function: extractLastBracketContent() + +> **extractLastBracketContent**(`input`): `string` + +Defined in: src/utils/callGraphUtils.ts:213 + +## Parameters + +### input + +`string` + +## Returns + +`string` diff --git a/docs/api_docs/functions/fetchDependenciesFromFile.md b/docs/api_docs/functions/fetchDependenciesFromFile.md new file mode 100644 index 0000000000000000000000000000000000000000..28ed0456cc161cdc6818a344784f737b7c1dd050 --- /dev/null +++ b/docs/api_docs/functions/fetchDependenciesFromFile.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / fetchDependenciesFromFile + +# Function: fetchDependenciesFromFile() + +> **fetchDependenciesFromFile**(`filePath`): `object` + +Defined in: src/utils/json5parser.ts:22 + +## Parameters + +### filePath + +`string` + +## Returns + +`object` diff --git a/docs/api_docs/functions/fieldSignatureCompare.md b/docs/api_docs/functions/fieldSignatureCompare.md new file mode 100644 index 0000000000000000000000000000000000000000..17e905c48a06bf30e80c8d853b1f1ec33f83a33b --- /dev/null +++ b/docs/api_docs/functions/fieldSignatureCompare.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / fieldSignatureCompare + +# Function: fieldSignatureCompare() + +> **fieldSignatureCompare**(`leftSig`, `rightSig`): `boolean` + +Defined in: src/core/model/ArkSignature.ts:385 + +## Parameters + +### leftSig + +[`FieldSignature`](../classes/FieldSignature.md) + +### rightSig + +[`FieldSignature`](../classes/FieldSignature.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/functions/fileSignatureCompare.md b/docs/api_docs/functions/fileSignatureCompare.md new file mode 100644 index 0000000000000000000000000000000000000000..35c400107c5cc3aa03718a4ec23dbe73079d2e88 --- /dev/null +++ b/docs/api_docs/functions/fileSignatureCompare.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / fileSignatureCompare + +# Function: fileSignatureCompare() + +> **fileSignatureCompare**(`leftSig`, `rightSig`): `boolean` + +Defined in: src/core/model/ArkSignature.ts:417 + +## Parameters + +### leftSig + +[`FileSignature`](../classes/FileSignature.md) + +### rightSig + +[`FileSignature`](../classes/FileSignature.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/functions/genSignature4ImportClause.md b/docs/api_docs/functions/genSignature4ImportClause.md new file mode 100644 index 0000000000000000000000000000000000000000..365b4f45f513622c8f1759757080dbd92bb9ca10 --- /dev/null +++ b/docs/api_docs/functions/genSignature4ImportClause.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / genSignature4ImportClause + +# Function: genSignature4ImportClause() + +> **genSignature4ImportClause**(`arkFileName`, `importClauseName`): `string` + +Defined in: src/core/model/ArkSignature.ts:436 + +## Parameters + +### arkFileName + +`string` + +### importClauseName + +`string` + +## Returns + +`string` diff --git a/docs/api_docs/functions/getAllFiles.md b/docs/api_docs/functions/getAllFiles.md new file mode 100644 index 0000000000000000000000000000000000000000..5e1ef27eca0371943e26aa8566f3c4227447eb4b --- /dev/null +++ b/docs/api_docs/functions/getAllFiles.md @@ -0,0 +1,47 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / getAllFiles + +# Function: getAllFiles() + +> **getAllFiles**(`srcPath`, `exts`, `ignore`, `filenameArr`, `visited`): `string`[] + +Defined in: src/utils/getAllFiles.ts:29 + +从指定目录中提取指定后缀名的所有文件 + +## Parameters + +### srcPath + +`string` + +string 要提取文件的项目入口,相对或绝对路径都可 + +### exts + +`string`[] + +string[] 要提取的文件扩展名数组,每个扩展名需以点开头 + +### ignore + +`string`[] = `[]` + +### filenameArr + +`string`[] = `[]` + +string[] 用来存放提取出的文件的原始路径的数组,可不传,默认为空数组 + +### visited + +`Set`\<`string`\> = `...` + +## Returns + +`string`[] + +string[] 提取出的文件的原始路径数组 diff --git a/docs/api_docs/functions/getCallbackMethodFromStmt.md b/docs/api_docs/functions/getCallbackMethodFromStmt.md new file mode 100644 index 0000000000000000000000000000000000000000..1ccab5aa24798450b2780d97baec0954cc96e275 --- /dev/null +++ b/docs/api_docs/functions/getCallbackMethodFromStmt.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / getCallbackMethodFromStmt + +# Function: getCallbackMethodFromStmt() + +> **getCallbackMethodFromStmt**(`stmt`, `scene`): `null` \| [`ArkMethod`](../classes/ArkMethod.md) + +Defined in: src/utils/entryMethodUtils.ts:94 + +## Parameters + +### stmt + +[`Stmt`](../classes/Stmt.md) + +### scene + +[`Scene`](../classes/Scene.md) + +## Returns + +`null` \| [`ArkMethod`](../classes/ArkMethod.md) diff --git a/docs/api_docs/functions/getFileRecursively.md b/docs/api_docs/functions/getFileRecursively.md new file mode 100644 index 0000000000000000000000000000000000000000..0ce72a45a436f0ddb98fb72271c23d6297f5f317 --- /dev/null +++ b/docs/api_docs/functions/getFileRecursively.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / getFileRecursively + +# Function: getFileRecursively() + +> **getFileRecursively**(`srcDir`, `fileName`, `visited`): `string` + +Defined in: src/utils/FileUtils.ts:92 + +## Parameters + +### srcDir + +`string` + +### fileName + +`string` + +### visited + +`Set`\<`string`\> = `...` + +## Returns + +`string` diff --git a/docs/api_docs/functions/isEtsAtomicComponent.md b/docs/api_docs/functions/isEtsAtomicComponent.md new file mode 100644 index 0000000000000000000000000000000000000000..af1b3dfa433980ec7b5295174e717ae4b4584461 --- /dev/null +++ b/docs/api_docs/functions/isEtsAtomicComponent.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / isEtsAtomicComponent + +# Function: isEtsAtomicComponent() + +> **isEtsAtomicComponent**(`name`): `boolean` + +Defined in: src/core/common/EtsConst.ts:994 + +## Parameters + +### name + +`string` + +## Returns + +`boolean` diff --git a/docs/api_docs/functions/isEtsContainerComponent.md b/docs/api_docs/functions/isEtsContainerComponent.md new file mode 100644 index 0000000000000000000000000000000000000000..c34df234c15cf115d06706f86fae8715200dc8e6 --- /dev/null +++ b/docs/api_docs/functions/isEtsContainerComponent.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / isEtsContainerComponent + +# Function: isEtsContainerComponent() + +> **isEtsContainerComponent**(`name`): `boolean` + +Defined in: src/core/common/EtsConst.ts:1002 + +## Parameters + +### name + +`string` + +## Returns + +`boolean` diff --git a/docs/api_docs/functions/isEtsSystemComponent.md b/docs/api_docs/functions/isEtsSystemComponent.md new file mode 100644 index 0000000000000000000000000000000000000000..0abad4396120e39dd9cac722dfc70ccb13ed6be5 --- /dev/null +++ b/docs/api_docs/functions/isEtsSystemComponent.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / isEtsSystemComponent + +# Function: isEtsSystemComponent() + +> **isEtsSystemComponent**(`name`): `boolean` + +Defined in: src/core/common/EtsConst.ts:998 + +## Parameters + +### name + +`string` + +## Returns + +`boolean` diff --git a/docs/api_docs/functions/isItemRegistered.md b/docs/api_docs/functions/isItemRegistered.md new file mode 100644 index 0000000000000000000000000000000000000000..1e0f3514aef7da57019b418f46b36b995ad5435e --- /dev/null +++ b/docs/api_docs/functions/isItemRegistered.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / isItemRegistered + +# Function: isItemRegistered() + +> **isItemRegistered**\<`T`\>(`item`, `array`, `compareFunc`): `boolean` + +Defined in: src/utils/callGraphUtils.ts:166 + +## Type Parameters + +• **T** + +## Parameters + +### item + +`T` + +### array + +`T`[] + +### compareFunc + +(`a`, `b`) => `boolean` + +## Returns + +`boolean` diff --git a/docs/api_docs/functions/methodSignatureCompare.md b/docs/api_docs/functions/methodSignatureCompare.md new file mode 100644 index 0000000000000000000000000000000000000000..9bb25652934d679533c09495da491e40b3ddf1eb --- /dev/null +++ b/docs/api_docs/functions/methodSignatureCompare.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / methodSignatureCompare + +# Function: methodSignatureCompare() + +> **methodSignatureCompare**(`leftSig`, `rightSig`): `boolean` + +Defined in: src/core/model/ArkSignature.ts:393 + +## Parameters + +### leftSig + +[`MethodSignature`](../classes/MethodSignature.md) + +### rightSig + +[`MethodSignature`](../classes/MethodSignature.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/functions/methodSubSignatureCompare.md b/docs/api_docs/functions/methodSubSignatureCompare.md new file mode 100644 index 0000000000000000000000000000000000000000..266befd9f598d149a5042603bc620e861a521585 --- /dev/null +++ b/docs/api_docs/functions/methodSubSignatureCompare.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / methodSubSignatureCompare + +# Function: methodSubSignatureCompare() + +> **methodSubSignatureCompare**(`leftSig`, `rightSig`): `boolean` + +Defined in: src/core/model/ArkSignature.ts:401 + +## Parameters + +### leftSig + +[`MethodSubSignature`](../classes/MethodSubSignature.md) + +### rightSig + +[`MethodSubSignature`](../classes/MethodSubSignature.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/functions/parseJsonText.md b/docs/api_docs/functions/parseJsonText.md new file mode 100644 index 0000000000000000000000000000000000000000..5944a5dd19f0cb2d081295db99d7cb4b8456c3ef --- /dev/null +++ b/docs/api_docs/functions/parseJsonText.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / parseJsonText + +# Function: parseJsonText() + +> **parseJsonText**(`text`): `object` + +Defined in: src/utils/json5parser.ts:37 + +## Parameters + +### text + +`string` + +## Returns + +`object` diff --git a/docs/api_docs/functions/printCallGraphDetails.md b/docs/api_docs/functions/printCallGraphDetails.md new file mode 100644 index 0000000000000000000000000000000000000000..773c959fd70171547133749769e9ffc01daaca7e --- /dev/null +++ b/docs/api_docs/functions/printCallGraphDetails.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / printCallGraphDetails + +# Function: printCallGraphDetails() + +> **printCallGraphDetails**(`methods`, `calls`, `rootDir`): `void` + +Defined in: src/utils/callGraphUtils.ts:189 + +## Parameters + +### methods + +`Set`\<[`MethodSignature`](../classes/MethodSignature.md)\> + +### calls + +`Map`\<[`MethodSignature`](../classes/MethodSignature.md), [`MethodSignature`](../classes/MethodSignature.md)[]\> + +### rootDir + +`string` + +## Returns + +`void` diff --git a/docs/api_docs/functions/splitStringWithRegex.md b/docs/api_docs/functions/splitStringWithRegex.md new file mode 100644 index 0000000000000000000000000000000000000000..2b6b585404cb5446cb55fd5af6b195c2a934a3bf --- /dev/null +++ b/docs/api_docs/functions/splitStringWithRegex.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / splitStringWithRegex + +# Function: splitStringWithRegex() + +> **splitStringWithRegex**(`input`): `string`[] + +Defined in: src/utils/callGraphUtils.ts:175 + +## Parameters + +### input + +`string` + +## Returns + +`string`[] diff --git a/docs/api_docs/functions/transfer2UnixPath.md b/docs/api_docs/functions/transfer2UnixPath.md new file mode 100644 index 0000000000000000000000000000000000000000..fe948cf9cf7c788caf823ab7958a36d039209a26 --- /dev/null +++ b/docs/api_docs/functions/transfer2UnixPath.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / transfer2UnixPath + +# Function: transfer2UnixPath() + +> **transfer2UnixPath**(`path2Do`): `string` + +Defined in: src/utils/pathTransfer.ts:18 + +## Parameters + +### path2Do + +`string` + +## Returns + +`string` diff --git a/docs/api_docs/globals.md b/docs/api_docs/globals.md new file mode 100644 index 0000000000000000000000000000000000000000..492d4abd3f8dee0a2291432f3e828182ec82c1b7 --- /dev/null +++ b/docs/api_docs/globals.md @@ -0,0 +1,333 @@ +[**ArkAnalyzer**](README.md) + +*** + +# ArkAnalyzer + +## core/base + +- [Constant](classes/Constant.md) +- [Decorator](classes/Decorator.md) +- [LineColPosition](classes/LineColPosition.md) +- [Local](classes/Local.md) +- [Value](interfaces/Value.md) + +## core/base/expr + +- [AbstractBinopExpr](classes/AbstractBinopExpr.md) +- [AbstractExpr](classes/AbstractExpr.md) +- [AbstractInvokeExpr](classes/AbstractInvokeExpr.md) +- [AliasTypeExpr](classes/AliasTypeExpr.md) +- [ArkAwaitExpr](classes/ArkAwaitExpr.md) +- [ArkCastExpr](classes/ArkCastExpr.md) +- [ArkConditionExpr](classes/ArkConditionExpr.md) +- [ArkDeleteExpr](classes/ArkDeleteExpr.md) +- [ArkInstanceInvokeExpr](classes/ArkInstanceInvokeExpr.md) +- [ArkInstanceOfExpr](classes/ArkInstanceOfExpr.md) +- [ArkNewArrayExpr](classes/ArkNewArrayExpr.md) +- [ArkNewExpr](classes/ArkNewExpr.md) +- [ArkNormalBinopExpr](classes/ArkNormalBinopExpr.md) +- [ArkPhiExpr](classes/ArkPhiExpr.md) +- [ArkPtrInvokeExpr](classes/ArkPtrInvokeExpr.md) +- [ArkStaticInvokeExpr](classes/ArkStaticInvokeExpr.md) +- [ArkTypeOfExpr](classes/ArkTypeOfExpr.md) +- [ArkUnopExpr](classes/ArkUnopExpr.md) +- [ArkYieldExpr](classes/ArkYieldExpr.md) + +## core/base/stmt + +- [ArkAliasTypeDefineStmt](classes/ArkAliasTypeDefineStmt.md) +- [ArkAssignStmt](classes/ArkAssignStmt.md) +- [ArkIfStmt](classes/ArkIfStmt.md) +- [ArkInvokeStmt](classes/ArkInvokeStmt.md) +- [ArkReturnStmt](classes/ArkReturnStmt.md) +- [ArkReturnVoidStmt](classes/ArkReturnVoidStmt.md) +- [ArkThrowStmt](classes/ArkThrowStmt.md) +- [Stmt](classes/Stmt.md) + +## core/base/type + +- [AliasType](classes/AliasType.md) +- [AnnotationNamespaceType](classes/AnnotationNamespaceType.md) +- [AnnotationType](classes/AnnotationType.md) +- [AnnotationTypeQueryType](classes/AnnotationTypeQueryType.md) +- [AnyType](classes/AnyType.md) +- [ArrayType](classes/ArrayType.md) +- [BooleanType](classes/BooleanType.md) +- [ClassType](classes/ClassType.md) +- [ClosureType](classes/ClosureType.md) +- [FunctionType](classes/FunctionType.md) +- [GenericType](classes/GenericType.md) +- [LexicalEnvType](classes/LexicalEnvType.md) +- [LiteralType](classes/LiteralType.md) +- [NeverType](classes/NeverType.md) +- [NullType](classes/NullType.md) +- [NumberType](classes/NumberType.md) +- [PrimitiveType](classes/PrimitiveType.md) +- [StringType](classes/StringType.md) +- [TupleType](classes/TupleType.md) +- [Type](classes/Type.md) +- [UnclearReferenceType](classes/UnclearReferenceType.md) +- [UndefinedType](classes/UndefinedType.md) +- [UnionType](classes/UnionType.md) +- [UnknownType](classes/UnknownType.md) +- [VoidType](classes/VoidType.md) + +## core/base/ref + +- [AbstractFieldRef](classes/AbstractFieldRef.md) +- [AbstractRef](classes/AbstractRef.md) +- [ArkArrayRef](classes/ArkArrayRef.md) +- [ArkCaughtExceptionRef](classes/ArkCaughtExceptionRef.md) +- [ArkInstanceFieldRef](classes/ArkInstanceFieldRef.md) +- [ArkParameterRef](classes/ArkParameterRef.md) +- [ArkStaticFieldRef](classes/ArkStaticFieldRef.md) +- [ArkThisRef](classes/ArkThisRef.md) +- [ClosureFieldRef](classes/ClosureFieldRef.md) +- [GlobalRef](classes/GlobalRef.md) + +## core/model + +- [ArkClass](classes/ArkClass.md) +- [ArkField](classes/ArkField.md) +- [ArkFile](classes/ArkFile.md) +- [ArkMethod](classes/ArkMethod.md) +- [ArkNamespace](classes/ArkNamespace.md) +- [ExportInfo](classes/ExportInfo.md) +- [FileSignature](classes/FileSignature.md) +- [ImportInfo](classes/ImportInfo.md) +- [MethodSignature](classes/MethodSignature.md) + +## core/graph + +- [Cfg](classes/Cfg.md) +- [ViewTree](interfaces/ViewTree.md) +- [ViewTreeNode](interfaces/ViewTreeNode.md) + +## Other + +- [ts](namespaces/ts/README.md) +- [CallGraphNodeKind](enumerations/CallGraphNodeKind.md) +- [NormalBinaryOperator](enumerations/NormalBinaryOperator.md) +- [PagEdgeKind](enumerations/PagEdgeKind.md) +- [PagNodeKind](enumerations/PagNodeKind.md) +- [RelationalBinaryOperator](enumerations/RelationalBinaryOperator.md) +- [StorageLinkEdgeType](enumerations/StorageLinkEdgeType.md) +- [StorageType](enumerations/StorageType.md) +- [UnaryOperator](enumerations/UnaryOperator.md) +- [AbstractAnalysis](classes/AbstractAnalysis.md) +- [AddrPagEdge](classes/AddrPagEdge.md) +- [AliasClassSignature](classes/AliasClassSignature.md) +- [ArkBody](classes/ArkBody.md) +- [ArkSignatureBuilder](classes/ArkSignatureBuilder.md) +- [AstTreeUtils](classes/AstTreeUtils.md) +- [BaseEdge](classes/BaseEdge.md) +- [BaseExplicitGraph](classes/BaseExplicitGraph.md) +- [BaseNode](classes/BaseNode.md) +- [CallGraph](classes/CallGraph.md) +- [CallGraphBuilder](classes/CallGraphBuilder.md) +- [CallGraphEdge](classes/CallGraphEdge.md) +- [CallGraphNode](classes/CallGraphNode.md) +- [CallSite](classes/CallSite.md) +- [CGStat](classes/CGStat.md) +- [ClassHierarchyAnalysis](classes/ClassHierarchyAnalysis.md) +- [ClassSignature](classes/ClassSignature.md) +- [CopyPagEdge](classes/CopyPagEdge.md) +- [CSCallSite](classes/CSCallSite.md) +- [CSFuncID](classes/CSFuncID.md) +- [DataflowProblem](classes/DataflowProblem.md) +- [DataflowResult](classes/DataflowResult.md) +- [DataflowSolver](classes/DataflowSolver.md) +- [DefUseChain](classes/DefUseChain.md) +- [DiffPTData](classes/DiffPTData.md) +- [DominanceFinder](classes/DominanceFinder.md) +- [DominanceTree](classes/DominanceTree.md) +- [DummyCallCreator](classes/DummyCallCreator.md) +- [DummyMainCreater](classes/DummyMainCreater.md) +- [DynCallSite](classes/DynCallSite.md) +- [ExprUseReplacer](classes/ExprUseReplacer.md) +- [Fact](classes/Fact.md) +- [FieldSignature](classes/FieldSignature.md) +- [FileUtils](classes/FileUtils.md) +- [FullPosition](classes/FullPosition.md) +- [FuncPag](classes/FuncPag.md) +- [InterFuncPag](classes/InterFuncPag.md) +- [IRUtils](classes/IRUtils.md) +- [KLimitedContextSensitive](classes/KLimitedContextSensitive.md) +- [LoadPagEdge](classes/LoadPagEdge.md) +- [LocalSignature](classes/LocalSignature.md) +- [MethodSignatureManager](classes/MethodSignatureManager.md) +- [MethodSubSignature](classes/MethodSubSignature.md) +- [ModelUtils](classes/ModelUtils.md) +- [ModulePath](classes/ModulePath.md) +- [NamespaceSignature](classes/NamespaceSignature.md) +- [Pag](classes/Pag.md) +- [PagArrayNode](classes/PagArrayNode.md) +- [PagBuilder](classes/PagBuilder.md) +- [PagEdge](classes/PagEdge.md) +- [PagFuncNode](classes/PagFuncNode.md) +- [PagGlobalThisNode](classes/PagGlobalThisNode.md) +- [PagInstanceFieldNode](classes/PagInstanceFieldNode.md) +- [PagLocalNode](classes/PagLocalNode.md) +- [PagNewContainerExprNode](classes/PagNewContainerExprNode.md) +- [PagNewExprNode](classes/PagNewExprNode.md) +- [PagNode](classes/PagNode.md) +- [PagParamNode](classes/PagParamNode.md) +- [PAGStat](classes/PAGStat.md) +- [PagStaticFieldNode](classes/PagStaticFieldNode.md) +- [PagThisRefNode](classes/PagThisRefNode.md) +- [PathEdge](classes/PathEdge.md) +- [PathEdgePoint](classes/PathEdgePoint.md) +- [PointerAnalysis](classes/PointerAnalysis.md) +- [PointerAnalysisConfig](classes/PointerAnalysisConfig.md) +- [PTAStat](classes/PTAStat.md) +- [PtsSet](classes/PtsSet.md) +- [RapidTypeAnalysis](classes/RapidTypeAnalysis.md) +- [RefUseReplacer](classes/RefUseReplacer.md) +- [SCCDetection](classes/SCCDetection.md) +- [Scene](classes/Scene.md) +- [SceneConfig](classes/SceneConfig.md) +- [SceneManager](classes/SceneManager.md) +- [Scope](classes/Scope.md) +- [StaticSingleAssignmentFormer](classes/StaticSingleAssignmentFormer.md) +- [StmtUseReplacer](classes/StmtUseReplacer.md) +- [ThisPagEdge](classes/ThisPagEdge.md) +- [TypeInference](classes/TypeInference.md) +- [UndefinedVariableChecker](classes/UndefinedVariableChecker.md) +- [UndefinedVariableSolver](classes/UndefinedVariableSolver.md) +- [ValueUtil](classes/ValueUtil.md) +- [VisibleValue](classes/VisibleValue.md) +- [WritePagEdge](classes/WritePagEdge.md) +- [AbilityMessage](interfaces/AbilityMessage.md) +- [ArkSignature](interfaces/ArkSignature.md) +- [FlowFunction](interfaces/FlowFunction.md) +- [GraphTraits](interfaces/GraphTraits.md) +- [AliasTypeOriginalModel](type-aliases/AliasTypeOriginalModel.md) +- [BaseSignature](type-aliases/BaseSignature.md) +- [BinaryOperator](type-aliases/BinaryOperator.md) +- [CallSiteID](type-aliases/CallSiteID.md) +- [FuncID](type-aliases/FuncID.md) +- [InterProceduralEdge](type-aliases/InterProceduralEdge.md) +- [InterProceduralSrcType](type-aliases/InterProceduralSrcType.md) +- [IntraProceduralEdge](type-aliases/IntraProceduralEdge.md) +- [Kind](type-aliases/Kind.md) +- [Method](type-aliases/Method.md) +- [NodeID](type-aliases/NodeID.md) +- [PagNodeType](type-aliases/PagNodeType.md) +- [Signature](type-aliases/Signature.md) +- [ALL](variables/ALL.md) +- [ANONYMOUS\_CLASS\_DELIMITER](variables/ANONYMOUS_CLASS_DELIMITER.md) +- [ANONYMOUS\_CLASS\_PREFIX](variables/ANONYMOUS_CLASS_PREFIX.md) +- [ANONYMOUS\_METHOD\_PREFIX](variables/ANONYMOUS_METHOD_PREFIX.md) +- [ANY\_KEYWORD](variables/ANY_KEYWORD.md) +- [API\_COMMON](variables/API_COMMON.md) +- [API\_INTERNAL](variables/API_INTERNAL.md) +- [BOOLEAN\_KEYWORD](variables/BOOLEAN_KEYWORD.md) +- [BUILD\_PROFILE\_JSON5](variables/BUILD_PROFILE_JSON5.md) +- [BUILDER\_DECORATOR](variables/BUILDER_DECORATOR.md) +- [BUILDER\_PARAM\_DECORATOR](variables/BUILDER_PARAM_DECORATOR.md) +- [BUILDIN\_ATOMIC\_COMPONENT](variables/BUILDIN_ATOMIC_COMPONENT.md) +- [BUILDIN\_SYSTEM\_COMPONENT](variables/BUILDIN_SYSTEM_COMPONENT.md) +- [CALL\_BACK](variables/CALL_BACK.md) +- [CALL\_SIGNATURE\_NAME](variables/CALL_SIGNATURE_NAME.md) +- [CALLBACK\_METHOD\_NAME](variables/CALLBACK_METHOD_NAME.md) +- [COMPONENT\_ATTRIBUTE](variables/COMPONENT_ATTRIBUTE.md) +- [COMPONENT\_BRANCH\_FUNCTION](variables/COMPONENT_BRANCH_FUNCTION.md) +- [COMPONENT\_BUILD\_FUNCTION](variables/COMPONENT_BUILD_FUNCTION.md) +- [COMPONENT\_COMMON](variables/COMPONENT_COMMON.md) +- [COMPONENT\_CREATE\_FUNCTION](variables/COMPONENT_CREATE_FUNCTION.md) +- [COMPONENT\_CUSTOMVIEW](variables/COMPONENT_CUSTOMVIEW.md) +- [COMPONENT\_DECORATOR](variables/COMPONENT_DECORATOR.md) +- [COMPONENT\_FOR\_EACH](variables/COMPONENT_FOR_EACH.md) +- [COMPONENT\_IF](variables/COMPONENT_IF.md) +- [COMPONENT\_IF\_BRANCH](variables/COMPONENT_IF_BRANCH.md) +- [COMPONENT\_INSTANCE](variables/COMPONENT_INSTANCE.md) +- [COMPONENT\_LAZY\_FOR\_EACH](variables/COMPONENT_LAZY_FOR_EACH.md) +- [COMPONENT\_LIFECYCLE\_METHOD\_NAME](variables/COMPONENT_LIFECYCLE_METHOD_NAME.md) +- [COMPONENT\_PATH](variables/COMPONENT_PATH.md) +- [COMPONENT\_POP\_FUNCTION](variables/COMPONENT_POP_FUNCTION.md) +- [COMPONENT\_REPEAT](variables/COMPONENT_REPEAT.md) +- [CONSTRUCTOR\_NAME](variables/CONSTRUCTOR_NAME.md) +- [DECLARE\_KEYWORD](variables/DECLARE_KEYWORD.md) +- [DEFAULT](variables/DEFAULT.md) +- [DEFAULT\_ARK\_CLASS\_NAME](variables/DEFAULT_ARK_CLASS_NAME.md) +- [DEFAULT\_ARK\_METHOD\_NAME](variables/DEFAULT_ARK_METHOD_NAME.md) +- [DEFAULT\_NAME](variables/DEFAULT_NAME.md) +- [ENTRY\_DECORATOR](variables/ENTRY_DECORATOR.md) +- [ETS\_COMPILER\_OPTIONS](variables/ETS_COMPILER_OPTIONS.md) +- [GLOBAL\_THIS\_NAME](variables/GLOBAL_THIS_NAME.md) +- [IMPORT](variables/IMPORT.md) +- [INSTANCE\_INIT\_METHOD\_NAME](variables/INSTANCE_INIT_METHOD_NAME.md) +- [LEXICAL\_ENV\_NAME\_PREFIX](variables/LEXICAL_ENV_NAME_PREFIX.md) +- [LIFECYCLE\_METHOD\_NAME](variables/LIFECYCLE_METHOD_NAME.md) +- [NAME\_DELIMITER](variables/NAME_DELIMITER.md) +- [NAME\_PREFIX](variables/NAME_PREFIX.md) +- [NEVER\_KEYWORD](variables/NEVER_KEYWORD.md) +- [NULL\_KEYWORD](variables/NULL_KEYWORD.md) +- [NUMBER\_KEYWORD](variables/NUMBER_KEYWORD.md) +- [OH\_PACKAGE\_JSON5](variables/OH_PACKAGE_JSON5.md) +- [ON\_OFF](variables/ON_OFF.md) +- [SPECIAL\_CONTAINER\_COMPONENT](variables/SPECIAL_CONTAINER_COMPONENT.md) +- [STATIC\_INIT\_METHOD\_NAME](variables/STATIC_INIT_METHOD_NAME.md) +- [STRING\_KEYWORD](variables/STRING_KEYWORD.md) +- [SUPER\_NAME](variables/SUPER_NAME.md) +- [TEMP\_LOCAL\_PREFIX](variables/TEMP_LOCAL_PREFIX.md) +- [THIS\_NAME](variables/THIS_NAME.md) +- [TSCONFIG\_JSON](variables/TSCONFIG_JSON.md) +- [UNDEFINED\_KEYWORD](variables/UNDEFINED_KEYWORD.md) +- [UNKNOWN\_CLASS\_NAME](variables/UNKNOWN_CLASS_NAME.md) +- [UNKNOWN\_FIELD\_NAME](variables/UNKNOWN_FIELD_NAME.md) +- [UNKNOWN\_FILE\_NAME](variables/UNKNOWN_FILE_NAME.md) +- [UNKNOWN\_KEYWORD](variables/UNKNOWN_KEYWORD.md) +- [UNKNOWN\_METHOD\_NAME](variables/UNKNOWN_METHOD_NAME.md) +- [UNKNOWN\_NAME](variables/UNKNOWN_NAME.md) +- [UNKNOWN\_NAMESPACE\_NAME](variables/UNKNOWN_NAMESPACE_NAME.md) +- [UNKNOWN\_PROJECT\_NAME](variables/UNKNOWN_PROJECT_NAME.md) +- [VOID\_KEYWORD](variables/VOID_KEYWORD.md) +- [addCfg2Stmt](functions/addCfg2Stmt.md) +- [classSignatureCompare](functions/classSignatureCompare.md) +- [extractLastBracketContent](functions/extractLastBracketContent.md) +- [fetchDependenciesFromFile](functions/fetchDependenciesFromFile.md) +- [fieldSignatureCompare](functions/fieldSignatureCompare.md) +- [fileSignatureCompare](functions/fileSignatureCompare.md) +- [genSignature4ImportClause](functions/genSignature4ImportClause.md) +- [getAllFiles](functions/getAllFiles.md) +- [getCallbackMethodFromStmt](functions/getCallbackMethodFromStmt.md) +- [getFileRecursively](functions/getFileRecursively.md) +- [isEtsAtomicComponent](functions/isEtsAtomicComponent.md) +- [isEtsContainerComponent](functions/isEtsContainerComponent.md) +- [isEtsSystemComponent](functions/isEtsSystemComponent.md) +- [isItemRegistered](functions/isItemRegistered.md) +- [methodSignatureCompare](functions/methodSignatureCompare.md) +- [methodSubSignatureCompare](functions/methodSubSignatureCompare.md) +- [parseJsonText](functions/parseJsonText.md) +- [printCallGraphDetails](functions/printCallGraphDetails.md) +- [splitStringWithRegex](functions/splitStringWithRegex.md) +- [transfer2UnixPath](functions/transfer2UnixPath.md) + +## core/graph +A `BasicBlock` is composed of: +- ID: a **number** that uniquely identify the basic block, initialized as -1. +- Statements: an **array** of statements in the basic block. +- Predecessors: an **array** of basic blocks in front of the current basic block. More accurately, these basic + blocks can reach the current block through edges. +- Successors: an **array** of basic blocks after the current basic block. More accurately, the current block can + reach these basic blocks through edges. + +- [BasicBlock](classes/BasicBlock.md) + +## save + +- [DotClassPrinter](classes/DotClassPrinter.md) +- [DotFilePrinter](classes/DotFilePrinter.md) +- [DotMethodPrinter](classes/DotMethodPrinter.md) +- [DotNamespacePrinter](classes/DotNamespacePrinter.md) +- [GraphPrinter](classes/GraphPrinter.md) +- [JsonPrinter](classes/JsonPrinter.md) +- [Printer](classes/Printer.md) +- [PrinterBuilder](classes/PrinterBuilder.md) +- [SourceClassPrinter](classes/SourceClassPrinter.md) +- [SourceFilePrinter](classes/SourceFilePrinter.md) +- [SourceMethodPrinter](classes/SourceMethodPrinter.md) +- [SourceNamespacePrinter](classes/SourceNamespacePrinter.md) +- [ViewTreePrinter](classes/ViewTreePrinter.md) diff --git a/docs/api_docs/interfaces/AbilityMessage.md b/docs/api_docs/interfaces/AbilityMessage.md new file mode 100644 index 0000000000000000000000000000000000000000..b5b65bff416782596580ee62e3c4cf6a39f64efe --- /dev/null +++ b/docs/api_docs/interfaces/AbilityMessage.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / AbilityMessage + +# Interface: AbilityMessage + +Defined in: src/utils/entryMethodUtils.ts:88 + +## Properties + +### name + +> **name**: `string` + +Defined in: src/utils/entryMethodUtils.ts:90 + +*** + +### srcEntrance + +> **srcEntrance**: `string` + +Defined in: src/utils/entryMethodUtils.ts:91 + +*** + +### srcEntry + +> **srcEntry**: `string` + +Defined in: src/utils/entryMethodUtils.ts:89 diff --git a/docs/api_docs/interfaces/ArkSignature.md b/docs/api_docs/interfaces/ArkSignature.md new file mode 100644 index 0000000000000000000000000000000000000000..b0db7c6b47f982b66e6b63615683c06671cfe7c8 --- /dev/null +++ b/docs/api_docs/interfaces/ArkSignature.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / ArkSignature + +# Interface: ArkSignature + +Defined in: src/core/model/ArkSignature.ts:31 + +## Methods + +### getSignature() + +> **getSignature**(): [`Signature`](../type-aliases/Signature.md) + +Defined in: src/core/model/ArkSignature.ts:32 + +#### Returns + +[`Signature`](../type-aliases/Signature.md) diff --git a/docs/api_docs/interfaces/FlowFunction.md b/docs/api_docs/interfaces/FlowFunction.md new file mode 100644 index 0000000000000000000000000000000000000000..5942f8c685a1f0220dbe8631ae01069a341aa981 --- /dev/null +++ b/docs/api_docs/interfaces/FlowFunction.md @@ -0,0 +1,31 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / FlowFunction + +# Interface: FlowFunction\ + +Defined in: src/core/dataflow/DataflowProblem.ts:53 + +## Type Parameters + +• **D** + +## Methods + +### getDataFacts() + +> **getDataFacts**(`d`): `Set`\<`D`\> + +Defined in: src/core/dataflow/DataflowProblem.ts:54 + +#### Parameters + +##### d + +`D` + +#### Returns + +`Set`\<`D`\> diff --git a/docs/api_docs/interfaces/GraphTraits.md b/docs/api_docs/interfaces/GraphTraits.md new file mode 100644 index 0000000000000000000000000000000000000000..31db86290b9a878eebf25a9a93cd96b072b6b1e1 --- /dev/null +++ b/docs/api_docs/interfaces/GraphTraits.md @@ -0,0 +1,51 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / GraphTraits + +# Interface: GraphTraits + +Defined in: src/core/graph/BaseExplicitGraph.ts:19 + +## Methods + +### getGraphName() + +> **getGraphName**(): `string` + +Defined in: src/core/graph/BaseExplicitGraph.ts:21 + +#### Returns + +`string` + +*** + +### getNode() + +> **getNode**(`id`): `undefined` \| [`BaseNode`](../classes/BaseNode.md) + +Defined in: src/core/graph/BaseExplicitGraph.ts:22 + +#### Parameters + +##### id + +`number` + +#### Returns + +`undefined` \| [`BaseNode`](../classes/BaseNode.md) + +*** + +### nodesItor() + +> **nodesItor**(): `IterableIterator`\<[`BaseNode`](../classes/BaseNode.md)\> + +Defined in: src/core/graph/BaseExplicitGraph.ts:20 + +#### Returns + +`IterableIterator`\<[`BaseNode`](../classes/BaseNode.md)\> diff --git a/docs/api_docs/interfaces/Value.md b/docs/api_docs/interfaces/Value.md new file mode 100644 index 0000000000000000000000000000000000000000..460acc575986ea67a0aad49f6a9e701d843cb388 --- /dev/null +++ b/docs/api_docs/interfaces/Value.md @@ -0,0 +1,59 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / Value + +# Interface: Value + +Defined in: src/core/base/Value.ts:21 + +## Methods + +### getType() + +> **getType**(): [`Type`](../classes/Type.md) + +Defined in: src/core/base/Value.ts:48 + +Return the type of this value. The interface is encapsulated in [Value](Value.md). +The `Type` is defined in type.ts, such as **Any**, **Unknown**, **TypeParameter**, +**UnclearReference**, **Primitive**, **Number**, **String**, etc. + +#### Returns + +[`Type`](../classes/Type.md) + +The type of this value. + +#### Example + +1. In the declaration statement, determine the left-value type and right-value type. + +```typescript +let leftValue:Value; +let rightValue:Value; +... +if (leftValue.getType() instanceof UnknownType && + !(rightValue.getType() instanceof UnknownType) && + !(rightValue.getType() instanceof UndefinedType)) { + ... +} +``` + +*** + +### getUses() + +> **getUses**(): [`Value`](Value.md)[] + +Defined in: src/core/base/Value.ts:27 + +Return a list of values which are contained in this [Value](Value.md). +Value is a core interface in ArkAnalyzer, which may represent any value or expression. + +#### Returns + +[`Value`](Value.md)[] + +An **array** of values used by this value. diff --git a/docs/api_docs/interfaces/ViewTree.md b/docs/api_docs/interfaces/ViewTree.md new file mode 100644 index 0000000000000000000000000000000000000000..2c657cc6d89977b5014b7f31930a6932099c0f7b --- /dev/null +++ b/docs/api_docs/interfaces/ViewTree.md @@ -0,0 +1,119 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / ViewTree + +# Interface: ViewTree + +Defined in: src/core/graph/ViewTree.ts:118 + +ArkUI Component Tree + +## Example + +```ts +// Component Class get ViewTree +let arkClas: ArkClass = ...; +let viewtree = arkClas.getViewTree(); + +// get viewtree root node +let root: ViewTreeNode = viewtree.getRoot(); + +// get viewtree stateValues Map +let stateValues: Map> = viewtree.getStateValues(); + +// walk all nodes +root.walk((node) => { + // check node is builder + if (node.isBuilder()) { + xx + } + + // check node is sub CustomComponent + if (node.isCustomComponent()) { + xx + } + + if (xxx) { + // Skip the remaining nodes and end the traversal + return true; + } + + return false; +}) +``` + +## Methods + +### ~~getClassFieldType()~~ + +> **getClassFieldType**(`name`): `undefined` \| [`Decorator`](../classes/Decorator.md) \| [`Type`](../classes/Type.md) + +Defined in: src/core/graph/ViewTree.ts:127 + +#### Parameters + +##### name + +`string` + +#### Returns + +`undefined` \| [`Decorator`](../classes/Decorator.md) \| [`Type`](../classes/Type.md) + +#### Deprecated + +Use [getStateValues](ViewTree.md#getstatevalues) instead. + +*** + +### getRoot() + +> **getRoot**(): `null` \| [`ViewTreeNode`](ViewTreeNode.md) + +Defined in: src/core/graph/ViewTree.ts:139 + +ViewTree root node. + +#### Returns + +`null` \| [`ViewTreeNode`](ViewTreeNode.md) + +root node + +*** + +### getStateValues() + +> **getStateValues**(): `Map`\<[`ArkField`](../classes/ArkField.md), `Set`\<[`ViewTreeNode`](ViewTreeNode.md)\>\> + +Defined in: src/core/graph/ViewTree.ts:133 + +Map of the component controlled by the state variable + +#### Returns + +`Map`\<[`ArkField`](../classes/ArkField.md), `Set`\<[`ViewTreeNode`](ViewTreeNode.md)\>\> + +*** + +### ~~isClassField()~~ + +> **isClassField**(`name`): `boolean` + +Defined in: src/core/graph/ViewTree.ts:122 + +#### Parameters + +##### name + +`string` + +#### Returns + +`boolean` + +#### Deprecated + +Use [getStateValues](ViewTree.md#getstatevalues) instead. diff --git a/docs/api_docs/interfaces/ViewTreeNode.md b/docs/api_docs/interfaces/ViewTreeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..d520d582e63467d8e6810ce4da6ef061492e1ead --- /dev/null +++ b/docs/api_docs/interfaces/ViewTreeNode.md @@ -0,0 +1,184 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / ViewTreeNode + +# Interface: ViewTreeNode + +Defined in: src/core/graph/ViewTree.ts:28 + +## Properties + +### attributes + +> **attributes**: `Map`\<`string`, \[[`Stmt`](../classes/Stmt.md), ([`Constant`](../classes/Constant.md) \| [`MethodSignature`](../classes/MethodSignature.md) \| [`ArkInstanceFieldRef`](../classes/ArkInstanceFieldRef.md))[]\]\> + +Defined in: src/core/graph/ViewTree.ts:34 + +Component attribute stmts, key is attribute name, value is [Stmt, [Uses Values]]. + +*** + +### builder? + +> `optional` **builder**: [`MethodSignature`](../classes/MethodSignature.md) + +Defined in: src/core/graph/ViewTree.ts:59 + +builderParam bind builder method signature. + +*** + +### builderParam? + +> `optional` **builderParam**: [`ArkField`](../classes/ArkField.md) + +Defined in: src/core/graph/ViewTree.ts:56 + +BuilderParam placeholders ArkField. + +*** + +### children + +> **children**: [`ViewTreeNode`](ViewTreeNode.md)[] + +Defined in: src/core/graph/ViewTree.ts:40 + +Node's children. + +*** + +### ~~classSignature?~~ + +> `optional` **classSignature**: [`MethodSignature`](../classes/MethodSignature.md) \| [`ClassSignature`](../classes/ClassSignature.md) + +Defined in: src/core/graph/ViewTree.ts:42 + +#### Deprecated + +Use [signature](ViewTreeNode.md#signature) instead. + +*** + +### name + +> **name**: `string` + +Defined in: src/core/graph/ViewTree.ts:30 + +Component node name + +*** + +### parent + +> **parent**: `null` \| [`ViewTreeNode`](ViewTreeNode.md) + +Defined in: src/core/graph/ViewTree.ts:38 + +Node's parent, CustomComponent and root node no parent. + +*** + +### signature? + +> `optional` **signature**: [`MethodSignature`](../classes/MethodSignature.md) \| [`ClassSignature`](../classes/ClassSignature.md) + +Defined in: src/core/graph/ViewTree.ts:44 + +CustomComponent class signature or Builder method signature. + +*** + +### stateValues + +> **stateValues**: `Set`\<[`ArkField`](../classes/ArkField.md)\> + +Defined in: src/core/graph/ViewTree.ts:36 + +Used state values. + +*** + +### stateValuesTransfer? + +> `optional` **stateValuesTransfer**: `Map`\<[`ArkField`](../classes/ArkField.md), [`ArkField`](../classes/ArkField.md) \| [`ArkMethod`](../classes/ArkMethod.md)\> + +Defined in: src/core/graph/ViewTree.ts:53 + +Custom component value transfer +- key: ArkField, child custom component class stateValue field. +- value: ArkField | ArkMethod, parent component transfer value. + key is BuilderParam, the value is Builder ArkMethod. + Others, the value is parent class stateValue field. + +*** + +### ~~stmts~~ + +> **stmts**: `Map`\<`string`, \[[`Stmt`](../classes/Stmt.md), ([`Constant`](../classes/Constant.md) \| [`MethodSignature`](../classes/MethodSignature.md) \| [`ArkInstanceFieldRef`](../classes/ArkInstanceFieldRef.md))[]\]\> + +Defined in: src/core/graph/ViewTree.ts:32 + +#### Deprecated + +Use [attributes](ViewTreeNode.md#attributes) instead. + +## Methods + +### isBuilder() + +> **isBuilder**(): `boolean` + +Defined in: src/core/graph/ViewTree.ts:74 + +Whether the node type is Builder. + +#### Returns + +`boolean` + +true: node is Builder, false others. + +*** + +### isCustomComponent() + +> **isCustomComponent**(): `boolean` + +Defined in: src/core/graph/ViewTree.ts:80 + +Whether the node type is custom component. + +#### Returns + +`boolean` + +true: node is custom component, false others. + +*** + +### walk() + +> **walk**(`selector`): `boolean` + +Defined in: src/core/graph/ViewTree.ts:68 + +walk node and node's children + +#### Parameters + +##### selector + +(`item`) => `boolean` + +Node selector function, return true skipping the follow-up nodes. + +#### Returns + +`boolean` + +- true: There are nodes that meet the selector. + - false: does not exist. diff --git a/docs/api_docs/namespaces/ts/README.md b/docs/api_docs/namespaces/ts/README.md new file mode 100644 index 0000000000000000000000000000000000000000..a2bf9d9a9f1f2553da35d7ece95ce737e9ac2b02 --- /dev/null +++ b/docs/api_docs/namespaces/ts/README.md @@ -0,0 +1,1655 @@ +[**ArkAnalyzer**](../../README.md) + +*** + +[ArkAnalyzer](../../globals.md) / ts + +# ts + +## Namespaces + +- [ArkTSLinter\_1\_0](namespaces/ArkTSLinter_1_0/README.md) +- [ArkTSLinter\_1\_1](namespaces/ArkTSLinter_1_1/README.md) +- [ScriptSnapshot](namespaces/ScriptSnapshot/README.md) +- [server](namespaces/server/README.md) + +## Enumerations + +- [ClassificationType](enumerations/ClassificationType.md) +- [ClassificationTypeNames](enumerations/ClassificationTypeNames.md) +- [CompletionInfoFlags](enumerations/CompletionInfoFlags.md) +- [CompletionTriggerKind](enumerations/CompletionTriggerKind.md) +- [DiagnosticCategory](enumerations/DiagnosticCategory.md) +- [ElementFlags](enumerations/ElementFlags.md) +- [EmitFlags](enumerations/EmitFlags.md) +- [EmitHint](enumerations/EmitHint.md) +- [EndOfLineState](enumerations/EndOfLineState.md) +- [EtsFlags](enumerations/EtsFlags.md) +- [ExitStatus](enumerations/ExitStatus.md) +- [Extension](enumerations/Extension.md) +- [FileWatcherEventKind](enumerations/FileWatcherEventKind.md) +- [FlowFlags](enumerations/FlowFlags.md) +- [GeneratedIdentifierFlags](enumerations/GeneratedIdentifierFlags.md) +- [HighlightSpanKind](enumerations/HighlightSpanKind.md) +- [ImportsNotUsedAsValues](enumerations/ImportsNotUsedAsValues.md) +- [IndentStyle](enumerations/IndentStyle.md) +- [IndexKind](enumerations/IndexKind.md) +- [InferencePriority](enumerations/InferencePriority.md) +- [InlayHintKind](enumerations/InlayHintKind.md) +- [InternalSymbolName](enumerations/InternalSymbolName.md) +- [InvalidatedProjectKind](enumerations/InvalidatedProjectKind.md) +- [JsxEmit](enumerations/JsxEmit.md) +- [JsxFlags](enumerations/JsxFlags.md) +- [LanguageServiceMode](enumerations/LanguageServiceMode.md) +- [LanguageVariant](enumerations/LanguageVariant.md) +- [ListFormat](enumerations/ListFormat.md) +- [ModifierFlags](enumerations/ModifierFlags.md) +- [ModuleDetectionKind](enumerations/ModuleDetectionKind.md) +- [ModuleKind](enumerations/ModuleKind.md) +- [ModuleResolutionKind](enumerations/ModuleResolutionKind.md) +- [NewLineKind](enumerations/NewLineKind.md) +- [NodeBuilderFlags](enumerations/NodeBuilderFlags.md) +- [NodeFlags](enumerations/NodeFlags.md) +- [ObjectFlags](enumerations/ObjectFlags.md) +- [OrganizeImportsMode](enumerations/OrganizeImportsMode.md) +- [OuterExpressionKinds](enumerations/OuterExpressionKinds.md) +- [OutliningSpanKind](enumerations/OutliningSpanKind.md) +- [OutputFileType](enumerations/OutputFileType.md) +- [PollingWatchKind](enumerations/PollingWatchKind.md) +- [ScriptElementKind](enumerations/ScriptElementKind.md) +- [ScriptElementKindModifier](enumerations/ScriptElementKindModifier.md) +- [ScriptKind](enumerations/ScriptKind.md) +- [ScriptTarget](enumerations/ScriptTarget.md) +- [SemanticClassificationFormat](enumerations/SemanticClassificationFormat.md) +- [SemicolonPreference](enumerations/SemicolonPreference.md) +- [SignatureKind](enumerations/SignatureKind.md) +- [SymbolDisplayPartKind](enumerations/SymbolDisplayPartKind.md) +- [SymbolFlags](enumerations/SymbolFlags.md) +- [SymbolFormatFlags](enumerations/SymbolFormatFlags.md) +- [SyntaxKind](enumerations/SyntaxKind.md) +- [TimePhase](enumerations/TimePhase.md) +- [TokenClass](enumerations/TokenClass.md) +- [TokenFlags](enumerations/TokenFlags.md) +- [TypeFlags](enumerations/TypeFlags.md) +- [TypeFormatFlags](enumerations/TypeFormatFlags.md) +- [TypePredicateKind](enumerations/TypePredicateKind.md) +- [WatchDirectoryFlags](enumerations/WatchDirectoryFlags.md) +- [WatchDirectoryKind](enumerations/WatchDirectoryKind.md) +- [WatchFileKind](enumerations/WatchFileKind.md) + +## Classes + +- [ArkTSLinterTimePrinter](classes/ArkTSLinterTimePrinter.md) +- [OperationCanceledException](classes/OperationCanceledException.md) + +## Interfaces + +- [AmdDependency](interfaces/AmdDependency.md) +- [ApplicableRefactorInfo](interfaces/ApplicableRefactorInfo.md) +- [ApplyCodeActionCommandResult](interfaces/ApplyCodeActionCommandResult.md) +- [ArrayBindingPattern](interfaces/ArrayBindingPattern.md) +- [ArrayDestructuringAssignment](interfaces/ArrayDestructuringAssignment.md) +- [ArrayLiteralExpression](interfaces/ArrayLiteralExpression.md) +- [ArrayTypeNode](interfaces/ArrayTypeNode.md) +- [ArrowFunction](interfaces/ArrowFunction.md) +- [AsExpression](interfaces/AsExpression.md) +- [AssertClause](interfaces/AssertClause.md) +- [AssertEntry](interfaces/AssertEntry.md) +- [AssertsIdentifierTypePredicate](interfaces/AssertsIdentifierTypePredicate.md) +- [AssertsThisTypePredicate](interfaces/AssertsThisTypePredicate.md) +- [AssignmentExpression](interfaces/AssignmentExpression.md) +- [AutoAccessorPropertyDeclaration](interfaces/AutoAccessorPropertyDeclaration.md) +- [AwaitExpression](interfaces/AwaitExpression.md) +- [BigIntLiteral](interfaces/BigIntLiteral.md) +- [BigIntLiteralType](interfaces/BigIntLiteralType.md) +- [BinaryExpression](interfaces/BinaryExpression.md) +- [BindingElement](interfaces/BindingElement.md) +- [Block](interfaces/Block.md) +- [BreakStatement](interfaces/BreakStatement.md) +- [BuilderProgram](interfaces/BuilderProgram.md) +- [BuilderProgramHost](interfaces/BuilderProgramHost.md) +- [BuildInvalidedProject](interfaces/BuildInvalidedProject.md) +- [BuildOptions](interfaces/BuildOptions.md) +- [Bundle](interfaces/Bundle.md) +- [CallChain](interfaces/CallChain.md) +- [CallExpression](interfaces/CallExpression.md) +- [CallHierarchyIncomingCall](interfaces/CallHierarchyIncomingCall.md) +- [CallHierarchyItem](interfaces/CallHierarchyItem.md) +- [CallHierarchyOutgoingCall](interfaces/CallHierarchyOutgoingCall.md) +- [CallSignatureDeclaration](interfaces/CallSignatureDeclaration.md) +- [CancellationToken](interfaces/CancellationToken.md) +- [CaseBlock](interfaces/CaseBlock.md) +- [CaseClause](interfaces/CaseClause.md) +- [CatchClause](interfaces/CatchClause.md) +- [CheckJsDirective](interfaces/CheckJsDirective.md) +- [ClassDeclaration](interfaces/ClassDeclaration.md) +- [ClassElement](interfaces/ClassElement.md) +- [ClassExpression](interfaces/ClassExpression.md) +- [ClassificationInfo](interfaces/ClassificationInfo.md) +- [ClassificationResult](interfaces/ClassificationResult.md) +- [Classifications](interfaces/Classifications.md) +- [ClassifiedSpan](interfaces/ClassifiedSpan.md) +- [ClassifiedSpan2020](interfaces/ClassifiedSpan2020.md) +- [Classifier](interfaces/Classifier.md) +- [ClassLikeDeclarationBase](interfaces/ClassLikeDeclarationBase.md) +- [ClassStaticBlockDeclaration](interfaces/ClassStaticBlockDeclaration.md) +- [CodeAction](interfaces/CodeAction.md) +- [CodeFixAction](interfaces/CodeFixAction.md) +- [Collection](interfaces/Collection.md) +- [CombinedCodeActions](interfaces/CombinedCodeActions.md) +- [CombinedCodeFixScope](interfaces/CombinedCodeFixScope.md) +- [CommaListExpression](interfaces/CommaListExpression.md) +- [CommentRange](interfaces/CommentRange.md) +- [CompilerHost](interfaces/CompilerHost.md) +- [CompilerOptions](interfaces/CompilerOptions.md) +- [CompletionEntry](interfaces/CompletionEntry.md) +- [CompletionEntryDataAutoImport](interfaces/CompletionEntryDataAutoImport.md) +- [CompletionEntryDataResolved](interfaces/CompletionEntryDataResolved.md) +- [CompletionEntryDataUnresolved](interfaces/CompletionEntryDataUnresolved.md) +- [CompletionEntryDetails](interfaces/CompletionEntryDetails.md) +- [CompletionEntryLabelDetails](interfaces/CompletionEntryLabelDetails.md) +- [CompletionInfo](interfaces/CompletionInfo.md) +- [ComputedPropertyName](interfaces/ComputedPropertyName.md) +- [ConditionalExpression](interfaces/ConditionalExpression.md) +- [ConditionalRoot](interfaces/ConditionalRoot.md) +- [ConditionalType](interfaces/ConditionalType.md) +- [ConditionalTypeNode](interfaces/ConditionalTypeNode.md) +- [ConditionCheckResult](interfaces/ConditionCheckResult.md) +- [ConfigFileDiagnosticsReporter](interfaces/ConfigFileDiagnosticsReporter.md) +- [ConstructorDeclaration](interfaces/ConstructorDeclaration.md) +- [ConstructorTypeNode](interfaces/ConstructorTypeNode.md) +- [ConstructSignatureDeclaration](interfaces/ConstructSignatureDeclaration.md) +- [ContinueStatement](interfaces/ContinueStatement.md) +- [CoreTransformationContext](interfaces/CoreTransformationContext.md) +- [CreateProgramOptions](interfaces/CreateProgramOptions.md) +- [CreateSourceFileOptions](interfaces/CreateSourceFileOptions.md) +- [CustomTransformer](interfaces/CustomTransformer.md) +- [CustomTransformers](interfaces/CustomTransformers.md) +- [DebuggerStatement](interfaces/DebuggerStatement.md) +- [Declaration](interfaces/Declaration.md) +- [DeclarationStatement](interfaces/DeclarationStatement.md) +- [Decorator](interfaces/Decorator.md) +- [DefaultClause](interfaces/DefaultClause.md) +- [DeferredTypeReference](interfaces/DeferredTypeReference.md) +- [DefinitionInfo](interfaces/DefinitionInfo.md) +- [DefinitionInfoAndBoundSpan](interfaces/DefinitionInfoAndBoundSpan.md) +- [DeleteExpression](interfaces/DeleteExpression.md) +- [Diagnostic](interfaces/Diagnostic.md) +- [DiagnosticMessage](interfaces/DiagnosticMessage.md) +- [DiagnosticMessageChain](interfaces/DiagnosticMessageChain.md) +- [DiagnosticRelatedInformation](interfaces/DiagnosticRelatedInformation.md) +- [DiagnosticWithLocation](interfaces/DiagnosticWithLocation.md) +- [DocCommentTemplateOptions](interfaces/DocCommentTemplateOptions.md) +- [DocumentHighlights](interfaces/DocumentHighlights.md) +- [DocumentRegistry](interfaces/DocumentRegistry.md) +- [DocumentSpan](interfaces/DocumentSpan.md) +- [DoStatement](interfaces/DoStatement.md) +- [~~EditorOptions~~](interfaces/EditorOptions.md) +- [EditorSettings](interfaces/EditorSettings.md) +- [ElementAccessChain](interfaces/ElementAccessChain.md) +- [ElementAccessExpression](interfaces/ElementAccessExpression.md) +- [EmitAndSemanticDiagnosticsBuilderProgram](interfaces/EmitAndSemanticDiagnosticsBuilderProgram.md) +- [EmitHelperBase](interfaces/EmitHelperBase.md) +- [EmitHost](interfaces/EmitHost.md) +- [EmitOutput](interfaces/EmitOutput.md) +- [EmitResult](interfaces/EmitResult.md) +- [EmitTextWriter](interfaces/EmitTextWriter.md) +- [EmptyStatement](interfaces/EmptyStatement.md) +- [EnumDeclaration](interfaces/EnumDeclaration.md) +- [EnumMember](interfaces/EnumMember.md) +- [EnumType](interfaces/EnumType.md) +- [ESMap](interfaces/ESMap.md) +- [EtsComponentExpression](interfaces/EtsComponentExpression.md) +- [EtsOptions](interfaces/EtsOptions.md) +- [EvolvingArrayType](interfaces/EvolvingArrayType.md) +- [ExportAssignment](interfaces/ExportAssignment.md) +- [ExportDeclaration](interfaces/ExportDeclaration.md) +- [ExportSpecifier](interfaces/ExportSpecifier.md) +- [Expression](interfaces/Expression.md) +- [ExpressionStatement](interfaces/ExpressionStatement.md) +- [ExpressionWithTypeArguments](interfaces/ExpressionWithTypeArguments.md) +- [ExtendedConfigCacheEntry](interfaces/ExtendedConfigCacheEntry.md) +- [ExternalModuleReference](interfaces/ExternalModuleReference.md) +- [FalseLiteral](interfaces/FalseLiteral.md) +- [FileCheckModuleInfo](interfaces/FileCheckModuleInfo.md) +- [FileExtensionInfo](interfaces/FileExtensionInfo.md) +- [FileReference](interfaces/FileReference.md) +- [FileTextChanges](interfaces/FileTextChanges.md) +- [FileWatcher](interfaces/FileWatcher.md) +- [FlowArrayMutation](interfaces/FlowArrayMutation.md) +- [FlowAssignment](interfaces/FlowAssignment.md) +- [FlowCall](interfaces/FlowCall.md) +- [FlowCondition](interfaces/FlowCondition.md) +- [FlowLabel](interfaces/FlowLabel.md) +- [FlowNodeBase](interfaces/FlowNodeBase.md) +- [FlowReduceLabel](interfaces/FlowReduceLabel.md) +- [FlowStart](interfaces/FlowStart.md) +- [FlowSwitchClause](interfaces/FlowSwitchClause.md) +- [ForInStatement](interfaces/ForInStatement.md) +- [~~FormatCodeOptions~~](interfaces/FormatCodeOptions.md) +- [FormatCodeSettings](interfaces/FormatCodeSettings.md) +- [FormatDiagnosticsHost](interfaces/FormatDiagnosticsHost.md) +- [ForOfStatement](interfaces/ForOfStatement.md) +- [ForStatement](interfaces/ForStatement.md) +- [FunctionDeclaration](interfaces/FunctionDeclaration.md) +- [FunctionExpression](interfaces/FunctionExpression.md) +- [FunctionLikeDeclarationBase](interfaces/FunctionLikeDeclarationBase.md) +- [FunctionOrConstructorTypeNodeBase](interfaces/FunctionOrConstructorTypeNodeBase.md) +- [FunctionTypeNode](interfaces/FunctionTypeNode.md) +- [GenericType](interfaces/GenericType.md) +- [GetAccessorDeclaration](interfaces/GetAccessorDeclaration.md) +- [GetCompletionsAtPositionOptions](interfaces/GetCompletionsAtPositionOptions.md) +- [GetEffectiveTypeRootsHost](interfaces/GetEffectiveTypeRootsHost.md) +- [HeritageClause](interfaces/HeritageClause.md) +- [HighlightSpan](interfaces/HighlightSpan.md) +- [HostCancellationToken](interfaces/HostCancellationToken.md) +- [Identifier](interfaces/Identifier.md) +- [IdentifierTypePredicate](interfaces/IdentifierTypePredicate.md) +- [IfStatement](interfaces/IfStatement.md) +- [ImplementationLocation](interfaces/ImplementationLocation.md) +- [ImportCall](interfaces/ImportCall.md) +- [ImportClause](interfaces/ImportClause.md) +- [ImportDeclaration](interfaces/ImportDeclaration.md) +- [ImportEqualsDeclaration](interfaces/ImportEqualsDeclaration.md) +- [ImportExpression](interfaces/ImportExpression.md) +- [ImportSpecifier](interfaces/ImportSpecifier.md) +- [ImportTypeAssertionContainer](interfaces/ImportTypeAssertionContainer.md) +- [ImportTypeNode](interfaces/ImportTypeNode.md) +- [IncompleteCompletionsCache](interfaces/IncompleteCompletionsCache.md) +- [IncompleteType](interfaces/IncompleteType.md) +- [IncrementalProgramOptions](interfaces/IncrementalProgramOptions.md) +- [IndexedAccessType](interfaces/IndexedAccessType.md) +- [IndexedAccessTypeNode](interfaces/IndexedAccessTypeNode.md) +- [IndexInfo](interfaces/IndexInfo.md) +- [IndexSignatureDeclaration](interfaces/IndexSignatureDeclaration.md) +- [IndexType](interfaces/IndexType.md) +- [InferTypeNode](interfaces/InferTypeNode.md) +- [InlayHint](interfaces/InlayHint.md) +- [InlayHintsContext](interfaces/InlayHintsContext.md) +- [InputFiles](interfaces/InputFiles.md) +- [InstallPackageAction](interfaces/InstallPackageAction.md) +- [InstallPackageOptions](interfaces/InstallPackageOptions.md) +- [InstantiableType](interfaces/InstantiableType.md) +- [InterfaceDeclaration](interfaces/InterfaceDeclaration.md) +- [InterfaceType](interfaces/InterfaceType.md) +- [InterfaceTypeWithDeclaredMembers](interfaces/InterfaceTypeWithDeclaredMembers.md) +- [IntersectionType](interfaces/IntersectionType.md) +- [IntersectionTypeNode](interfaces/IntersectionTypeNode.md) +- [InvalidatedProjectBase](interfaces/InvalidatedProjectBase.md) +- [IScriptSnapshot](interfaces/IScriptSnapshot.md) +- [IterationStatement](interfaces/IterationStatement.md) +- [Iterator](interfaces/Iterator.md) +- [JSDoc](interfaces/JSDoc.md) +- [JSDocAllType](interfaces/JSDocAllType.md) +- [JSDocAugmentsTag](interfaces/JSDocAugmentsTag.md) +- [JSDocAuthorTag](interfaces/JSDocAuthorTag.md) +- [JSDocCallbackTag](interfaces/JSDocCallbackTag.md) +- [JSDocClassTag](interfaces/JSDocClassTag.md) +- [JSDocContainer](interfaces/JSDocContainer.md) +- [JSDocDeprecatedTag](interfaces/JSDocDeprecatedTag.md) +- [JSDocEnumTag](interfaces/JSDocEnumTag.md) +- [JSDocFunctionType](interfaces/JSDocFunctionType.md) +- [JSDocImplementsTag](interfaces/JSDocImplementsTag.md) +- [JSDocLink](interfaces/JSDocLink.md) +- [JSDocLinkCode](interfaces/JSDocLinkCode.md) +- [JSDocLinkDisplayPart](interfaces/JSDocLinkDisplayPart.md) +- [JSDocLinkPlain](interfaces/JSDocLinkPlain.md) +- [JSDocMemberName](interfaces/JSDocMemberName.md) +- [JSDocNamepathType](interfaces/JSDocNamepathType.md) +- [JSDocNameReference](interfaces/JSDocNameReference.md) +- [JSDocNamespaceDeclaration](interfaces/JSDocNamespaceDeclaration.md) +- [JsDocNodeCheckConfig](interfaces/JsDocNodeCheckConfig.md) +- [JsDocNodeCheckConfigItem](interfaces/JsDocNodeCheckConfigItem.md) +- [JSDocNonNullableType](interfaces/JSDocNonNullableType.md) +- [JSDocNullableType](interfaces/JSDocNullableType.md) +- [JSDocOptionalType](interfaces/JSDocOptionalType.md) +- [JSDocOverrideTag](interfaces/JSDocOverrideTag.md) +- [JSDocParameterTag](interfaces/JSDocParameterTag.md) +- [JSDocPrivateTag](interfaces/JSDocPrivateTag.md) +- [JSDocPropertyLikeTag](interfaces/JSDocPropertyLikeTag.md) +- [JSDocPropertyTag](interfaces/JSDocPropertyTag.md) +- [JSDocProtectedTag](interfaces/JSDocProtectedTag.md) +- [JSDocPublicTag](interfaces/JSDocPublicTag.md) +- [JSDocReadonlyTag](interfaces/JSDocReadonlyTag.md) +- [JSDocReturnTag](interfaces/JSDocReturnTag.md) +- [JSDocSeeTag](interfaces/JSDocSeeTag.md) +- [JSDocSignature](interfaces/JSDocSignature.md) +- [JSDocTag](interfaces/JSDocTag.md) +- [JsDocTagInfo](interfaces/JsDocTagInfo.md) +- [JSDocTagInfo](interfaces/JSDocTagInfo-1.md) +- [JSDocTemplateTag](interfaces/JSDocTemplateTag.md) +- [JSDocText](interfaces/JSDocText.md) +- [JSDocThisTag](interfaces/JSDocThisTag.md) +- [JSDocType](interfaces/JSDocType.md) +- [JSDocTypedefTag](interfaces/JSDocTypedefTag.md) +- [JSDocTypeExpression](interfaces/JSDocTypeExpression.md) +- [JSDocTypeLiteral](interfaces/JSDocTypeLiteral.md) +- [JSDocTypeTag](interfaces/JSDocTypeTag.md) +- [JSDocUnknownTag](interfaces/JSDocUnknownTag.md) +- [JSDocUnknownType](interfaces/JSDocUnknownType.md) +- [JSDocVariadicType](interfaces/JSDocVariadicType.md) +- [JsonMinusNumericLiteral](interfaces/JsonMinusNumericLiteral.md) +- [JsonObjectExpressionStatement](interfaces/JsonObjectExpressionStatement.md) +- [JsonSourceFile](interfaces/JsonSourceFile.md) +- [JsxAttribute](interfaces/JsxAttribute.md) +- [JsxAttributes](interfaces/JsxAttributes.md) +- [JsxClosingElement](interfaces/JsxClosingElement.md) +- [JsxClosingFragment](interfaces/JsxClosingFragment.md) +- [JsxClosingTagInfo](interfaces/JsxClosingTagInfo.md) +- [JsxElement](interfaces/JsxElement.md) +- [JsxExpression](interfaces/JsxExpression.md) +- [JsxFragment](interfaces/JsxFragment.md) +- [JsxOpeningElement](interfaces/JsxOpeningElement.md) +- [JsxOpeningFragment](interfaces/JsxOpeningFragment.md) +- [JsxSelfClosingElement](interfaces/JsxSelfClosingElement.md) +- [JsxSpreadAttribute](interfaces/JsxSpreadAttribute.md) +- [JsxTagNamePropertyAccess](interfaces/JsxTagNamePropertyAccess.md) +- [JsxText](interfaces/JsxText.md) +- [KeywordToken](interfaces/KeywordToken.md) +- [KeywordTypeNode](interfaces/KeywordTypeNode.md) +- [LabeledStatement](interfaces/LabeledStatement.md) +- [LanguageService](interfaces/LanguageService.md) +- [LanguageServiceHost](interfaces/LanguageServiceHost.md) +- [LeftHandSideExpression](interfaces/LeftHandSideExpression.md) +- [LineAndCharacter](interfaces/LineAndCharacter.md) +- [LiteralExpression](interfaces/LiteralExpression.md) +- [LiteralLikeNode](interfaces/LiteralLikeNode.md) +- [LiteralType](interfaces/LiteralType.md) +- [LiteralTypeNode](interfaces/LiteralTypeNode.md) +- [Map](interfaces/Map.md) +- [MapLike](interfaces/MapLike.md) +- [MappedTypeNode](interfaces/MappedTypeNode.md) +- [MemberExpression](interfaces/MemberExpression.md) +- [MetaProperty](interfaces/MetaProperty.md) +- [MethodDeclaration](interfaces/MethodDeclaration.md) +- [MethodSignature](interfaces/MethodSignature.md) +- [MinimalResolutionCacheHost](interfaces/MinimalResolutionCacheHost.md) +- [MissingDeclaration](interfaces/MissingDeclaration.md) +- [ModeAwareCache](interfaces/ModeAwareCache.md) +- [ModifierToken](interfaces/ModifierToken.md) +- [ModuleBlock](interfaces/ModuleBlock.md) +- [ModuleDeclaration](interfaces/ModuleDeclaration.md) +- [ModulePath](interfaces/ModulePath.md) +- [ModuleResolutionCache](interfaces/ModuleResolutionCache.md) +- [ModuleResolutionHost](interfaces/ModuleResolutionHost.md) +- [ModuleSpecifierCache](interfaces/ModuleSpecifierCache.md) +- [ModuleSpecifierOptions](interfaces/ModuleSpecifierOptions.md) +- [ModuleSpecifierResolutionHost](interfaces/ModuleSpecifierResolutionHost.md) +- [NamedDeclaration](interfaces/NamedDeclaration.md) +- [NamedExports](interfaces/NamedExports.md) +- [NamedImports](interfaces/NamedImports.md) +- [NamedTupleMember](interfaces/NamedTupleMember.md) +- [NamespaceDeclaration](interfaces/NamespaceDeclaration.md) +- [NamespaceExport](interfaces/NamespaceExport.md) +- [NamespaceExportDeclaration](interfaces/NamespaceExportDeclaration.md) +- [NamespaceImport](interfaces/NamespaceImport.md) +- [NavigateToItem](interfaces/NavigateToItem.md) +- [NavigationBarItem](interfaces/NavigationBarItem.md) +- [NavigationTree](interfaces/NavigationTree.md) +- [NewExpression](interfaces/NewExpression.md) +- [Node](interfaces/Node.md) +- [NodeArray](interfaces/NodeArray.md) +- [NodeFactory](interfaces/NodeFactory.md) +- [NodesVisitor](interfaces/NodesVisitor.md) +- [NodeVisitor](interfaces/NodeVisitor.md) +- [NodeWithTypeArguments](interfaces/NodeWithTypeArguments.md) +- [NonNullChain](interfaces/NonNullChain.md) +- [NonNullExpression](interfaces/NonNullExpression.md) +- [NonRelativeModuleNameResolutionCache](interfaces/NonRelativeModuleNameResolutionCache.md) +- [NoSubstitutionTemplateLiteral](interfaces/NoSubstitutionTemplateLiteral.md) +- [NotEmittedStatement](interfaces/NotEmittedStatement.md) +- [NullLiteral](interfaces/NullLiteral.md) +- [NumberLiteralType](interfaces/NumberLiteralType.md) +- [NumericLiteral](interfaces/NumericLiteral.md) +- [ObjectBindingPattern](interfaces/ObjectBindingPattern.md) +- [ObjectDestructuringAssignment](interfaces/ObjectDestructuringAssignment.md) +- [ObjectLiteralElement](interfaces/ObjectLiteralElement.md) +- [ObjectLiteralExpression](interfaces/ObjectLiteralExpression.md) +- [ObjectLiteralExpressionBase](interfaces/ObjectLiteralExpressionBase.md) +- [ObjectType](interfaces/ObjectType.md) +- [OmittedExpression](interfaces/OmittedExpression.md) +- [OptionalTypeNode](interfaces/OptionalTypeNode.md) +- [OrganizeImportsArgs](interfaces/OrganizeImportsArgs.md) +- [OutliningSpan](interfaces/OutliningSpan.md) +- [OutputFile](interfaces/OutputFile.md) +- [PackageId](interfaces/PackageId.md) +- [PackageJsonInfoCache](interfaces/PackageJsonInfoCache.md) +- [ParameterDeclaration](interfaces/ParameterDeclaration.md) +- [ParenthesizedExpression](interfaces/ParenthesizedExpression.md) +- [ParenthesizedTypeNode](interfaces/ParenthesizedTypeNode.md) +- [ParseConfigFileHost](interfaces/ParseConfigFileHost.md) +- [ParseConfigHost](interfaces/ParseConfigHost.md) +- [ParsedCommandLine](interfaces/ParsedCommandLine.md) +- [ParsedTsconfig](interfaces/ParsedTsconfig.md) +- [PartiallyEmittedExpression](interfaces/PartiallyEmittedExpression.md) +- [PerDirectoryResolutionCache](interfaces/PerDirectoryResolutionCache.md) +- [PerformanceEvent](interfaces/PerformanceEvent.md) +- [PerModuleNameCache](interfaces/PerModuleNameCache.md) +- [PluginImport](interfaces/PluginImport.md) +- [PostfixUnaryExpression](interfaces/PostfixUnaryExpression.md) +- [PrefixUnaryExpression](interfaces/PrefixUnaryExpression.md) +- [PreProcessedFileInfo](interfaces/PreProcessedFileInfo.md) +- [PrimaryExpression](interfaces/PrimaryExpression.md) +- [Printer](interfaces/Printer.md) +- [PrinterOptions](interfaces/PrinterOptions.md) +- [PrintHandlers](interfaces/PrintHandlers.md) +- [PrivateIdentifier](interfaces/PrivateIdentifier.md) +- [Program](interfaces/Program.md) +- [ProgramHost](interfaces/ProgramHost.md) +- [ProjectReference](interfaces/ProjectReference.md) +- [PropertyAccessChain](interfaces/PropertyAccessChain.md) +- [PropertyAccessEntityNameExpression](interfaces/PropertyAccessEntityNameExpression.md) +- [PropertyAccessExpression](interfaces/PropertyAccessExpression.md) +- [PropertyAssignment](interfaces/PropertyAssignment.md) +- [PropertyDeclaration](interfaces/PropertyDeclaration.md) +- [PropertyLikeDeclaration](interfaces/PropertyLikeDeclaration.md) +- [PropertySignature](interfaces/PropertySignature.md) +- [PseudoBigInt](interfaces/PseudoBigInt.md) +- [PunctuationToken](interfaces/PunctuationToken.md) +- [Push](interfaces/Push.md) +- [QualifiedName](interfaces/QualifiedName.md) +- [QuickInfo](interfaces/QuickInfo.md) +- [RawSourceMap](interfaces/RawSourceMap.md) +- [ReadBuildProgramHost](interfaces/ReadBuildProgramHost.md) +- [ReadonlyCollection](interfaces/ReadonlyCollection.md) +- [ReadonlyESMap](interfaces/ReadonlyESMap.md) +- [ReadonlyMap](interfaces/ReadonlyMap.md) +- [ReadonlySet](interfaces/ReadonlySet.md) +- [ReadonlyTextRange](interfaces/ReadonlyTextRange.md) +- [ReadonlyUnderscoreEscapedMap](interfaces/ReadonlyUnderscoreEscapedMap.md) +- [RefactorActionInfo](interfaces/RefactorActionInfo.md) +- [RefactorEditInfo](interfaces/RefactorEditInfo.md) +- [ReferencedSymbol](interfaces/ReferencedSymbol.md) +- [ReferencedSymbolDefinitionInfo](interfaces/ReferencedSymbolDefinitionInfo.md) +- [ReferencedSymbolEntry](interfaces/ReferencedSymbolEntry.md) +- [ReferenceEntry](interfaces/ReferenceEntry.md) +- [RegularExpressionLiteral](interfaces/RegularExpressionLiteral.md) +- [RenameInfoFailure](interfaces/RenameInfoFailure.md) +- [~~RenameInfoOptions~~](interfaces/RenameInfoOptions.md) +- [RenameInfoSuccess](interfaces/RenameInfoSuccess.md) +- [RenameLocation](interfaces/RenameLocation.md) +- [ReportFileInError](interfaces/ReportFileInError.md) +- [ResolvedModule](interfaces/ResolvedModule.md) +- [ResolvedModuleFull](interfaces/ResolvedModuleFull.md) +- [ResolvedModuleSpecifierInfo](interfaces/ResolvedModuleSpecifierInfo.md) +- [ResolvedModuleWithFailedLookupLocations](interfaces/ResolvedModuleWithFailedLookupLocations.md) +- [ResolvedProjectReference](interfaces/ResolvedProjectReference.md) +- [ResolvedTypeReferenceDirective](interfaces/ResolvedTypeReferenceDirective.md) +- [ResolvedTypeReferenceDirectiveWithFailedLookupLocations](interfaces/ResolvedTypeReferenceDirectiveWithFailedLookupLocations.md) +- [~~ResolveProjectReferencePathHost~~](interfaces/ResolveProjectReferencePathHost.md) +- [RestTypeNode](interfaces/RestTypeNode.md) +- [ReturnStatement](interfaces/ReturnStatement.md) +- [SatisfiesExpression](interfaces/SatisfiesExpression.md) +- [Scanner](interfaces/Scanner.md) +- [ScopedEmitHelper](interfaces/ScopedEmitHelper.md) +- [ScriptReferenceHost](interfaces/ScriptReferenceHost.md) +- [SelectionRange](interfaces/SelectionRange.md) +- [SemanticDiagnosticsBuilderProgram](interfaces/SemanticDiagnosticsBuilderProgram.md) +- [SemicolonClassElement](interfaces/SemicolonClassElement.md) +- [Set](interfaces/Set.md) +- [SetAccessorDeclaration](interfaces/SetAccessorDeclaration.md) +- [ShorthandPropertyAssignment](interfaces/ShorthandPropertyAssignment.md) +- [Signature](interfaces/Signature.md) +- [SignatureDeclarationBase](interfaces/SignatureDeclarationBase.md) +- [SignatureHelpCharacterTypedReason](interfaces/SignatureHelpCharacterTypedReason.md) +- [SignatureHelpInvokedReason](interfaces/SignatureHelpInvokedReason.md) +- [SignatureHelpItem](interfaces/SignatureHelpItem.md) +- [SignatureHelpItems](interfaces/SignatureHelpItems.md) +- [SignatureHelpItemsOptions](interfaces/SignatureHelpItemsOptions.md) +- [SignatureHelpParameter](interfaces/SignatureHelpParameter.md) +- [SignatureHelpRetriggeredReason](interfaces/SignatureHelpRetriggeredReason.md) +- [SolutionBuilder](interfaces/SolutionBuilder.md) +- [SolutionBuilderHost](interfaces/SolutionBuilderHost.md) +- [SolutionBuilderHostBase](interfaces/SolutionBuilderHostBase.md) +- [SolutionBuilderWithWatchHost](interfaces/SolutionBuilderWithWatchHost.md) +- [SortedArray](interfaces/SortedArray.md) +- [SortedReadonlyArray](interfaces/SortedReadonlyArray.md) +- [SourceFile](interfaces/SourceFile.md) +- [SourceFileLike](interfaces/SourceFileLike.md) +- [SourceFileMayBeEmittedHost](interfaces/SourceFileMayBeEmittedHost.md) +- [SourceMapGenerator](interfaces/SourceMapGenerator.md) +- [SourceMapGeneratorOptions](interfaces/SourceMapGeneratorOptions.md) +- [SourceMapRange](interfaces/SourceMapRange.md) +- [SourceMapSource](interfaces/SourceMapSource.md) +- [SourceMapSpan](interfaces/SourceMapSpan.md) +- [SpreadAssignment](interfaces/SpreadAssignment.md) +- [SpreadElement](interfaces/SpreadElement.md) +- [Statement](interfaces/Statement.md) +- [StringLiteral](interfaces/StringLiteral.md) +- [StringLiteralType](interfaces/StringLiteralType.md) +- [StringMappingType](interfaces/StringMappingType.md) +- [StructDeclaration](interfaces/StructDeclaration.md) +- [SubstitutionType](interfaces/SubstitutionType.md) +- [SuperCall](interfaces/SuperCall.md) +- [SuperElementAccessExpression](interfaces/SuperElementAccessExpression.md) +- [SuperExpression](interfaces/SuperExpression.md) +- [SuperPropertyAccessExpression](interfaces/SuperPropertyAccessExpression.md) +- [SwitchStatement](interfaces/SwitchStatement.md) +- [Symbol](interfaces/Symbol.md) +- [SymbolDisplayPart](interfaces/SymbolDisplayPart.md) +- [SymbolTracker](interfaces/SymbolTracker.md) +- [SyntaxList](interfaces/SyntaxList.md) +- [SynthesizedComment](interfaces/SynthesizedComment.md) +- [SyntheticExpression](interfaces/SyntheticExpression.md) +- [System](interfaces/System.md) +- [TagCheckConfig](interfaces/TagCheckConfig.md) +- [TagCheckParam](interfaces/TagCheckParam.md) +- [TaggedTemplateExpression](interfaces/TaggedTemplateExpression.md) +- [TemplateExpression](interfaces/TemplateExpression.md) +- [TemplateHead](interfaces/TemplateHead.md) +- [TemplateLiteralLikeNode](interfaces/TemplateLiteralLikeNode.md) +- [TemplateLiteralType](interfaces/TemplateLiteralType.md) +- [TemplateLiteralTypeNode](interfaces/TemplateLiteralTypeNode.md) +- [TemplateLiteralTypeSpan](interfaces/TemplateLiteralTypeSpan.md) +- [TemplateMiddle](interfaces/TemplateMiddle.md) +- [TemplateSpan](interfaces/TemplateSpan.md) +- [TemplateTail](interfaces/TemplateTail.md) +- [TextChange](interfaces/TextChange.md) +- [TextChangeRange](interfaces/TextChangeRange.md) +- [TextInsertion](interfaces/TextInsertion.md) +- [TextRange](interfaces/TextRange.md) +- [TextSpan](interfaces/TextSpan.md) +- [ThisExpression](interfaces/ThisExpression.md) +- [ThisTypeNode](interfaces/ThisTypeNode.md) +- [ThisTypePredicate](interfaces/ThisTypePredicate.md) +- [ThrowStatement](interfaces/ThrowStatement.md) +- [TodoComment](interfaces/TodoComment.md) +- [TodoCommentDescriptor](interfaces/TodoCommentDescriptor.md) +- [Token](interfaces/Token.md) +- [TransformationContext](interfaces/TransformationContext.md) +- [TransformationResult](interfaces/TransformationResult.md) +- [TransientIdentifier](interfaces/TransientIdentifier.md) +- [TranspileOptions](interfaces/TranspileOptions.md) +- [TranspileOutput](interfaces/TranspileOutput.md) +- [TrueLiteral](interfaces/TrueLiteral.md) +- [TryStatement](interfaces/TryStatement.md) +- [TsConfigSourceFile](interfaces/TsConfigSourceFile.md) +- [TupleType](interfaces/TupleType.md) +- [TupleTypeNode](interfaces/TupleTypeNode.md) +- [TupleTypeReference](interfaces/TupleTypeReference.md) +- [Type](interfaces/Type.md) +- [TypeAcquisition](interfaces/TypeAcquisition.md) +- [TypeAliasDeclaration](interfaces/TypeAliasDeclaration.md) +- [TypeAssertion](interfaces/TypeAssertion.md) +- [TypeChecker](interfaces/TypeChecker.md) +- [TypeElement](interfaces/TypeElement.md) +- [TypeLiteralNode](interfaces/TypeLiteralNode.md) +- [TypeNode](interfaces/TypeNode.md) +- [TypeOfExpression](interfaces/TypeOfExpression.md) +- [TypeOperatorNode](interfaces/TypeOperatorNode.md) +- [TypeParameter](interfaces/TypeParameter.md) +- [TypeParameterDeclaration](interfaces/TypeParameterDeclaration.md) +- [TypePredicateBase](interfaces/TypePredicateBase.md) +- [TypePredicateNode](interfaces/TypePredicateNode.md) +- [TypeQueryNode](interfaces/TypeQueryNode.md) +- [TypeReference](interfaces/TypeReference.md) +- [TypeReferenceDirectiveResolutionCache](interfaces/TypeReferenceDirectiveResolutionCache.md) +- [TypeReferenceNode](interfaces/TypeReferenceNode.md) +- [UnaryExpression](interfaces/UnaryExpression.md) +- [UnderscoreEscapedMap](interfaces/UnderscoreEscapedMap.md) +- [UnionOrIntersectionType](interfaces/UnionOrIntersectionType.md) +- [UnionType](interfaces/UnionType.md) +- [UnionTypeNode](interfaces/UnionTypeNode.md) +- [UniqueESSymbolType](interfaces/UniqueESSymbolType.md) +- [UnparsedPrepend](interfaces/UnparsedPrepend.md) +- [UnparsedPrologue](interfaces/UnparsedPrologue.md) +- [UnparsedSection](interfaces/UnparsedSection.md) +- [UnparsedSource](interfaces/UnparsedSource.md) +- [UnparsedSyntheticReference](interfaces/UnparsedSyntheticReference.md) +- [UnparsedTextLike](interfaces/UnparsedTextLike.md) +- [UnscopedEmitHelper](interfaces/UnscopedEmitHelper.md) +- [UpdateBundleProject](interfaces/UpdateBundleProject.md) +- [UpdateExpression](interfaces/UpdateExpression.md) +- [UpdateOutputFileStampsProject](interfaces/UpdateOutputFileStampsProject.md) +- [UserPreferences](interfaces/UserPreferences.md) +- [VariableDeclaration](interfaces/VariableDeclaration.md) +- [VariableDeclarationList](interfaces/VariableDeclarationList.md) +- [VariableStatement](interfaces/VariableStatement.md) +- [VoidExpression](interfaces/VoidExpression.md) +- [Watch](interfaces/Watch.md) +- [WatchCompilerHost](interfaces/WatchCompilerHost.md) +- [WatchCompilerHostOfConfigFile](interfaces/WatchCompilerHostOfConfigFile.md) +- [WatchCompilerHostOfFilesAndCompilerOptions](interfaces/WatchCompilerHostOfFilesAndCompilerOptions.md) +- [WatchHost](interfaces/WatchHost.md) +- [WatchOfConfigFile](interfaces/WatchOfConfigFile.md) +- [WatchOfFilesAndCompilerOptions](interfaces/WatchOfFilesAndCompilerOptions.md) +- [WatchOptions](interfaces/WatchOptions.md) +- [WhileStatement](interfaces/WhileStatement.md) +- [WithStatement](interfaces/WithStatement.md) +- [WriteFileCallbackData](interfaces/WriteFileCallbackData.md) +- [YieldExpression](interfaces/YieldExpression.md) + +## Type Aliases + +- [\_\_String](type-aliases/String.md) +- [AbstractKeyword](type-aliases/AbstractKeyword.md) +- [AccessExpression](type-aliases/AccessExpression.md) +- [AccessibilityModifier](type-aliases/AccessibilityModifier.md) +- [AccessorDeclaration](type-aliases/AccessorDeclaration.md) +- [AccessorKeyword](type-aliases/AccessorKeyword.md) +- [AdditiveOperator](type-aliases/AdditiveOperator.md) +- [AdditiveOperatorOrHigher](type-aliases/AdditiveOperatorOrHigher.md) +- [AffectedFileResult](type-aliases/AffectedFileResult.md) +- [ArrayBindingElement](type-aliases/ArrayBindingElement.md) +- [ArrayBindingOrAssignmentElement](type-aliases/ArrayBindingOrAssignmentElement.md) +- [ArrayBindingOrAssignmentPattern](type-aliases/ArrayBindingOrAssignmentPattern.md) +- [AssertionExpression](type-aliases/AssertionExpression.md) +- [AssertionKey](type-aliases/AssertionKey.md) +- [AssertKeyword](type-aliases/AssertKeyword.md) +- [AssertsKeyword](type-aliases/AssertsKeyword.md) +- [~~AssertsToken~~](type-aliases/AssertsToken.md) +- [AssignmentOperator](type-aliases/AssignmentOperator.md) +- [AssignmentOperatorOrHigher](type-aliases/AssignmentOperatorOrHigher.md) +- [AssignmentOperatorToken](type-aliases/AssignmentOperatorToken.md) +- [AssignmentPattern](type-aliases/AssignmentPattern.md) +- [AsteriskToken](type-aliases/AsteriskToken.md) +- [AsyncKeyword](type-aliases/AsyncKeyword.md) +- [AwaitKeyword](type-aliases/AwaitKeyword.md) +- [~~AwaitKeywordToken~~](type-aliases/AwaitKeywordToken.md) +- [BaseType](type-aliases/BaseType.md) +- [BinaryOperator](type-aliases/BinaryOperator.md) +- [BinaryOperatorToken](type-aliases/BinaryOperatorToken.md) +- [BindingName](type-aliases/BindingName.md) +- [BindingOrAssignmentElement](type-aliases/BindingOrAssignmentElement.md) +- [BindingOrAssignmentElementRestIndicator](type-aliases/BindingOrAssignmentElementRestIndicator.md) +- [BindingOrAssignmentElementTarget](type-aliases/BindingOrAssignmentElementTarget.md) +- [BindingOrAssignmentPattern](type-aliases/BindingOrAssignmentPattern.md) +- [BindingPattern](type-aliases/BindingPattern.md) +- [BitwiseOperator](type-aliases/BitwiseOperator.md) +- [BitwiseOperatorOrHigher](type-aliases/BitwiseOperatorOrHigher.md) +- [BlockLike](type-aliases/BlockLike.md) +- [BooleanLiteral](type-aliases/BooleanLiteral.md) +- [BreakOrContinueStatement](type-aliases/BreakOrContinueStatement.md) +- [CallLikeExpression](type-aliases/CallLikeExpression.md) +- [CaseOrDefaultClause](type-aliases/CaseOrDefaultClause.md) +- [ClassLikeDeclaration](type-aliases/ClassLikeDeclaration.md) +- [ClassMemberModifier](type-aliases/ClassMemberModifier.md) +- [CodeActionCommand](type-aliases/CodeActionCommand.md) +- [ColonToken](type-aliases/ColonToken.md) +- [CommentKind](type-aliases/CommentKind.md) +- [CompilerOptionsValue](type-aliases/CompilerOptionsValue.md) +- [CompletionEntryData](type-aliases/CompletionEntryData.md) +- [CompletionsTriggerCharacter](type-aliases/CompletionsTriggerCharacter.md) +- [CompoundAssignmentOperator](type-aliases/CompoundAssignmentOperator.md) +- [ConciseBody](type-aliases/ConciseBody.md) +- [ConstKeyword](type-aliases/ConstKeyword.md) +- [CreateProgram](type-aliases/CreateProgram.md) +- [CustomTransformerFactory](type-aliases/CustomTransformerFactory.md) +- [DeclarationName](type-aliases/DeclarationName.md) +- [DeclarationWithTypeParameterChildren](type-aliases/DeclarationWithTypeParameterChildren.md) +- [DeclarationWithTypeParameters](type-aliases/DeclarationWithTypeParameters.md) +- [DeclareKeyword](type-aliases/DeclareKeyword.md) +- [DefaultKeyword](type-aliases/DefaultKeyword.md) +- [DestructuringAssignment](type-aliases/DestructuringAssignment.md) +- [DestructuringPattern](type-aliases/DestructuringPattern.md) +- [DiagnosticReporter](type-aliases/DiagnosticReporter.md) +- [DirectoryWatcherCallback](type-aliases/DirectoryWatcherCallback.md) +- [DocumentRegistryBucketKey](type-aliases/DocumentRegistryBucketKey.md) +- [DotDotDotToken](type-aliases/DotDotDotToken.md) +- [DotToken](type-aliases/DotToken.md) +- [EmitHelper](type-aliases/EmitHelper.md) +- [EmitHelperUniqueNameCallback](type-aliases/EmitHelperUniqueNameCallback.md) +- [EndOfFileToken](type-aliases/EndOfFileToken.md) +- [EntityName](type-aliases/EntityName.md) +- [EntityNameExpression](type-aliases/EntityNameExpression.md) +- [EntityNameOrEntityNameExpression](type-aliases/EntityNameOrEntityNameExpression.md) +- [EqualityOperator](type-aliases/EqualityOperator.md) +- [EqualityOperatorOrHigher](type-aliases/EqualityOperatorOrHigher.md) +- [EqualsGreaterThanToken](type-aliases/EqualsGreaterThanToken.md) +- [EqualsToken](type-aliases/EqualsToken.md) +- [ErrorCallback](type-aliases/ErrorCallback.md) +- [ExclamationToken](type-aliases/ExclamationToken.md) +- [ExponentiationOperator](type-aliases/ExponentiationOperator.md) +- [ExportKeyword](type-aliases/ExportKeyword.md) +- [FileWatcherCallback](type-aliases/FileWatcherCallback.md) +- [FlowNode](type-aliases/FlowNode.md) +- [FlowType](type-aliases/FlowType.md) +- [ForInitializer](type-aliases/ForInitializer.md) +- [ForInOrOfStatement](type-aliases/ForInOrOfStatement.md) +- [FunctionBody](type-aliases/FunctionBody.md) +- [~~FunctionLike~~](type-aliases/FunctionLike.md) +- [FunctionLikeDeclaration](type-aliases/FunctionLikeDeclaration.md) +- [FunctionOrConstructorTypeNode](type-aliases/FunctionOrConstructorTypeNode.md) +- [HasDecorators](type-aliases/HasDecorators.md) +- [HasExpressionInitializer](type-aliases/HasExpressionInitializer.md) +- [HasIllegalDecorators](type-aliases/HasIllegalDecorators.md) +- [HasInitializer](type-aliases/HasInitializer.md) +- [HasJSDoc](type-aliases/HasJSDoc.md) +- [HasModifiers](type-aliases/HasModifiers.md) +- [HasType](type-aliases/HasType.md) +- [HasTypeArguments](type-aliases/HasTypeArguments.md) +- [ImportOrExportSpecifier](type-aliases/ImportOrExportSpecifier.md) +- [IncrementExpression](type-aliases/IncrementExpression.md) +- [InKeyword](type-aliases/InKeyword.md) +- [InvalidatedProject](type-aliases/InvalidatedProject.md) +- [JSDocComment](type-aliases/JSDocComment.md) +- [JSDocNamespaceBody](type-aliases/JSDocNamespaceBody.md) +- [JSDocSyntaxKind](type-aliases/JSDocSyntaxKind.md) +- [JSDocTypeReferencingNode](type-aliases/JSDocTypeReferencingNode.md) +- [~~JsFileExtensionInfo~~](type-aliases/JsFileExtensionInfo.md) +- [JsonObjectExpression](type-aliases/JsonObjectExpression.md) +- [JsxAttributeLike](type-aliases/JsxAttributeLike.md) +- [JsxAttributeValue](type-aliases/JsxAttributeValue.md) +- [JsxChild](type-aliases/JsxChild.md) +- [JsxOpeningLikeElement](type-aliases/JsxOpeningLikeElement.md) +- [JsxTagNameExpression](type-aliases/JsxTagNameExpression.md) +- [JsxTokenSyntaxKind](type-aliases/JsxTokenSyntaxKind.md) +- [KeywordSyntaxKind](type-aliases/KeywordSyntaxKind.md) +- [KeywordTypeSyntaxKind](type-aliases/KeywordTypeSyntaxKind.md) +- [LiteralSyntaxKind](type-aliases/LiteralSyntaxKind.md) +- [LiteralToken](type-aliases/LiteralToken.md) +- [LogicalOperator](type-aliases/LogicalOperator.md) +- [LogicalOperatorOrHigher](type-aliases/LogicalOperatorOrHigher.md) +- [LogicalOrCoalescingAssignmentOperator](type-aliases/LogicalOrCoalescingAssignmentOperator.md) +- [MemberName](type-aliases/MemberName.md) +- [MinusToken](type-aliases/MinusToken.md) +- [Modifier](type-aliases/Modifier.md) +- [ModifierLike](type-aliases/ModifierLike.md) +- [ModifiersArray](type-aliases/ModifiersArray.md) +- [ModifierSyntaxKind](type-aliases/ModifierSyntaxKind.md) +- [ModuleBody](type-aliases/ModuleBody.md) +- [ModuleName](type-aliases/ModuleName.md) +- [ModuleReference](type-aliases/ModuleReference.md) +- [MultiplicativeOperator](type-aliases/MultiplicativeOperator.md) +- [MultiplicativeOperatorOrHigher](type-aliases/MultiplicativeOperatorOrHigher.md) +- [NamedExportBindings](type-aliases/NamedExportBindings.md) +- [NamedImportBindings](type-aliases/NamedImportBindings.md) +- [NamedImportsOrExports](type-aliases/NamedImportsOrExports.md) +- [NamespaceBody](type-aliases/NamespaceBody.md) +- [ObjectBindingOrAssignmentElement](type-aliases/ObjectBindingOrAssignmentElement.md) +- [ObjectBindingOrAssignmentPattern](type-aliases/ObjectBindingOrAssignmentPattern.md) +- [ObjectLiteralElementLike](type-aliases/ObjectLiteralElementLike.md) +- [ObjectTypeDeclaration](type-aliases/ObjectTypeDeclaration.md) +- [OptionalChain](type-aliases/OptionalChain.md) +- [OutKeyword](type-aliases/OutKeyword.md) +- [OverrideKeyword](type-aliases/OverrideKeyword.md) +- [ParameterPropertyDeclaration](type-aliases/ParameterPropertyDeclaration.md) +- [ParameterPropertyModifier](type-aliases/ParameterPropertyModifier.md) +- [Path](type-aliases/Path.md) +- [PlusToken](type-aliases/PlusToken.md) +- [PostfixUnaryOperator](type-aliases/PostfixUnaryOperator.md) +- [PrefixUnaryOperator](type-aliases/PrefixUnaryOperator.md) +- [PrivateKeyword](type-aliases/PrivateKeyword.md) +- [PropertyName](type-aliases/PropertyName.md) +- [PropertyNameLiteral](type-aliases/PropertyNameLiteral.md) +- [ProtectedKeyword](type-aliases/ProtectedKeyword.md) +- [PseudoLiteralSyntaxKind](type-aliases/PseudoLiteralSyntaxKind.md) +- [PseudoLiteralToken](type-aliases/PseudoLiteralToken.md) +- [PublicKeyword](type-aliases/PublicKeyword.md) +- [PunctuationSyntaxKind](type-aliases/PunctuationSyntaxKind.md) +- [QuestionDotToken](type-aliases/QuestionDotToken.md) +- [QuestionToken](type-aliases/QuestionToken.md) +- [ReadonlyKeyword](type-aliases/ReadonlyKeyword.md) +- [~~ReadonlyToken~~](type-aliases/ReadonlyToken.md) +- [RedirectTargetsMap](type-aliases/RedirectTargetsMap.md) +- [RefactorTriggerReason](type-aliases/RefactorTriggerReason.md) +- [RelationalOperator](type-aliases/RelationalOperator.md) +- [RelationalOperatorOrHigher](type-aliases/RelationalOperatorOrHigher.md) +- [RenameInfo](type-aliases/RenameInfo.md) +- [ReportEmitErrorSummary](type-aliases/ReportEmitErrorSummary.md) +- [ResolvedConfigFileName](type-aliases/ResolvedConfigFileName.md) +- [ShiftOperator](type-aliases/ShiftOperator.md) +- [ShiftOperatorOrHigher](type-aliases/ShiftOperatorOrHigher.md) +- [SignatureDeclaration](type-aliases/SignatureDeclaration.md) +- [SignatureHelpRetriggerCharacter](type-aliases/SignatureHelpRetriggerCharacter.md) +- [SignatureHelpTriggerCharacter](type-aliases/SignatureHelpTriggerCharacter.md) +- [SignatureHelpTriggerReason](type-aliases/SignatureHelpTriggerReason.md) +- [StaticKeyword](type-aliases/StaticKeyword.md) +- [StringLiteralLike](type-aliases/StringLiteralLike.md) +- [StructuredType](type-aliases/StructuredType.md) +- [SuperProperty](type-aliases/SuperProperty.md) +- [SymbolTable](type-aliases/SymbolTable.md) +- [TemplateLiteral](type-aliases/TemplateLiteral.md) +- [TemplateLiteralToken](type-aliases/TemplateLiteralToken.md) +- [TokenSyntaxKind](type-aliases/TokenSyntaxKind.md) +- [Transformer](type-aliases/Transformer.md) +- [TransformerFactory](type-aliases/TransformerFactory.md) +- [TriviaSyntaxKind](type-aliases/TriviaSyntaxKind.md) +- [TypeOfTag](type-aliases/TypeOfTag.md) +- [TypeOnlyAliasDeclaration](type-aliases/TypeOnlyAliasDeclaration.md) +- [TypeOnlyCompatibleAliasDeclaration](type-aliases/TypeOnlyCompatibleAliasDeclaration.md) +- [TypePredicate](type-aliases/TypePredicate.md) +- [TypeReferenceType](type-aliases/TypeReferenceType.md) +- [TypeVariable](type-aliases/TypeVariable.md) +- [UnionOrIntersectionTypeNode](type-aliases/UnionOrIntersectionTypeNode.md) +- [UnparsedNode](type-aliases/UnparsedNode.md) +- [UnparsedSourceText](type-aliases/UnparsedSourceText.md) +- [VariableLikeDeclaration](type-aliases/VariableLikeDeclaration.md) +- [Visitor](type-aliases/Visitor.md) +- [VisitResult](type-aliases/VisitResult.md) +- [WatchStatusReporter](type-aliases/WatchStatusReporter.md) +- [WithMetadata](type-aliases/WithMetadata.md) +- [WriteFileCallback](type-aliases/WriteFileCallback.md) + +## Variables + +- [factory](variables/factory.md) +- [ohModulesPathPart](variables/ohModulesPathPart.md) +- [servicesVersion](variables/servicesVersion.md) +- [sys](variables/sys.md) +- [unchangedTextChangeRange](variables/unchangedTextChangeRange.md) +- [version](variables/version.md) +- [versionMajorMinor](variables/versionMajorMinor.md) + +## Functions + +- [addEmitHelper](functions/addEmitHelper.md) +- [addEmitHelpers](functions/addEmitHelpers.md) +- [addSyntheticLeadingComment](functions/addSyntheticLeadingComment.md) +- [addSyntheticTrailingComment](functions/addSyntheticTrailingComment.md) +- [canHaveDecorators](functions/canHaveDecorators.md) +- [canHaveModifiers](functions/canHaveModifiers.md) +- [choosePathContainsModules](functions/choosePathContainsModules.md) +- [classicNameResolver](functions/classicNameResolver.md) +- [collapseTextChangeRangesAcrossMultipleVersions](functions/collapseTextChangeRangesAcrossMultipleVersions.md) +- [concatenateDecoratorsAndModifiers](functions/concatenateDecoratorsAndModifiers.md) +- [convertCompilerOptionsFromJson](functions/convertCompilerOptionsFromJson.md) +- [convertToObject](functions/convertToObject.md) +- [convertTypeAcquisitionFromJson](functions/convertTypeAcquisitionFromJson.md) +- [couldStartTrivia](functions/couldStartTrivia.md) +- [createAbstractBuilder](functions/createAbstractBuilder.md) +- [~~createAdd~~](functions/createAdd.md) +- [~~createArrayBindingPattern~~](functions/createArrayBindingPattern.md) +- [~~createArrayLiteral~~](functions/createArrayLiteral.md) +- [~~createArrayTypeNode~~](functions/createArrayTypeNode.md) +- [~~createArrowFunction~~](functions/createArrowFunction.md) +- [~~createAsExpression~~](functions/createAsExpression.md) +- [~~createAssignment~~](functions/createAssignment.md) +- [~~createAwait~~](functions/createAwait.md) +- [~~createBigIntLiteral~~](functions/createBigIntLiteral.md) +- [~~createBinary~~](functions/createBinary.md) +- [~~createBindingElement~~](functions/createBindingElement.md) +- [~~createBlock~~](functions/createBlock.md) +- [~~createBreak~~](functions/createBreak.md) +- [createBuilderStatusReporter](functions/createBuilderStatusReporter.md) +- [~~createBundle~~](functions/createBundle.md) +- [~~createCall~~](functions/createCall.md) +- [~~createCallChain~~](functions/createCallChain.md) +- [~~createCallSignature~~](functions/createCallSignature.md) +- [~~createCaseBlock~~](functions/createCaseBlock.md) +- [~~createCaseClause~~](functions/createCaseClause.md) +- [~~createCatchClause~~](functions/createCatchClause.md) +- [~~createClassDeclaration~~](functions/createClassDeclaration.md) +- [~~createClassExpression~~](functions/createClassExpression.md) +- [createClassifier](functions/createClassifier.md) +- [~~createComma~~](functions/createComma.md) +- [~~createCommaList~~](functions/createCommaList.md) +- [createCompilerHost](functions/createCompilerHost.md) +- [~~createComputedPropertyName~~](functions/createComputedPropertyName.md) +- [~~createConditional~~](functions/createConditional.md) +- [~~createConditionalTypeNode~~](functions/createConditionalTypeNode.md) +- [~~createConstructor~~](functions/createConstructor.md) +- [~~createConstructorTypeNode~~](functions/createConstructorTypeNode.md) +- [~~createConstructSignature~~](functions/createConstructSignature.md) +- [~~createContinue~~](functions/createContinue.md) +- [~~createDebuggerStatement~~](functions/createDebuggerStatement.md) +- [~~createDecorator~~](functions/createDecorator.md) +- [~~createDefaultClause~~](functions/createDefaultClause.md) +- [~~createDelete~~](functions/createDelete.md) +- [~~createDo~~](functions/createDo.md) +- [createDocumentRegistry](functions/createDocumentRegistry.md) +- [~~createElementAccess~~](functions/createElementAccess.md) +- [~~createElementAccessChain~~](functions/createElementAccessChain.md) +- [createEmitAndSemanticDiagnosticsBuilderProgram](functions/createEmitAndSemanticDiagnosticsBuilderProgram.md) +- [createEmitAndSemanticDiagnosticsBuilderProgramForArkTs](functions/createEmitAndSemanticDiagnosticsBuilderProgramForArkTs.md) +- [~~createEmptyStatement~~](functions/createEmptyStatement.md) +- [~~createEnumDeclaration~~](functions/createEnumDeclaration.md) +- [~~createEnumMember~~](functions/createEnumMember.md) +- [~~createExportAssignment~~](functions/createExportAssignment.md) +- [~~createExportDeclaration~~](functions/createExportDeclaration.md) +- [~~createExportDefault~~](functions/createExportDefault.md) +- [~~createExportSpecifier~~](functions/createExportSpecifier.md) +- [~~createExpressionStatement~~](functions/createExpressionStatement.md) +- [~~createExpressionWithTypeArguments~~](functions/createExpressionWithTypeArguments.md) +- [~~createExternalModuleExport~~](functions/createExternalModuleExport.md) +- [~~createExternalModuleReference~~](functions/createExternalModuleReference.md) +- [~~createFalse~~](functions/createFalse.md) +- [~~createFileLevelUniqueName~~](functions/createFileLevelUniqueName.md) +- [~~createFor~~](functions/createFor.md) +- [~~createForIn~~](functions/createForIn.md) +- [~~createForOf~~](functions/createForOf.md) +- [~~createFunctionDeclaration~~](functions/createFunctionDeclaration.md) +- [~~createFunctionExpression~~](functions/createFunctionExpression.md) +- [~~createFunctionTypeNode~~](functions/createFunctionTypeNode.md) +- [~~createGetAccessor~~](functions/createGetAccessor.md) +- [~~createHeritageClause~~](functions/createHeritageClause.md) +- [~~createIdentifier~~](functions/createIdentifier.md) +- [~~createIf~~](functions/createIf.md) +- [~~createImmediatelyInvokedArrowFunction~~](functions/createImmediatelyInvokedArrowFunction.md) +- [~~createImmediatelyInvokedFunctionExpression~~](functions/createImmediatelyInvokedFunctionExpression.md) +- [~~createImportClause~~](functions/createImportClause.md) +- [~~createImportDeclaration~~](functions/createImportDeclaration.md) +- [~~createImportEqualsDeclaration~~](functions/createImportEqualsDeclaration.md) +- [~~createImportSpecifier~~](functions/createImportSpecifier.md) +- [~~createImportTypeNode~~](functions/createImportTypeNode.md) +- [createIncrementalCompilerHost](functions/createIncrementalCompilerHost.md) +- [createIncrementalProgram](functions/createIncrementalProgram.md) +- [createIncrementalProgramForArkTs](functions/createIncrementalProgramForArkTs.md) +- [~~createIndexedAccessTypeNode~~](functions/createIndexedAccessTypeNode.md) +- [~~createIndexSignature~~](functions/createIndexSignature.md) +- [~~createInferTypeNode~~](functions/createInferTypeNode.md) +- [createInputFiles](functions/createInputFiles.md) +- [~~createInterfaceDeclaration~~](functions/createInterfaceDeclaration.md) +- [~~createIntersectionTypeNode~~](functions/createIntersectionTypeNode.md) +- [~~createJSDocAugmentsTag~~](functions/createJSDocAugmentsTag.md) +- [~~createJSDocAuthorTag~~](functions/createJSDocAuthorTag.md) +- [~~createJSDocCallbackTag~~](functions/createJSDocCallbackTag.md) +- [~~createJSDocClassTag~~](functions/createJSDocClassTag.md) +- [~~createJSDocComment~~](functions/createJSDocComment.md) +- [~~createJSDocEnumTag~~](functions/createJSDocEnumTag.md) +- [~~createJSDocImplementsTag~~](functions/createJSDocImplementsTag.md) +- [~~createJSDocParameterTag~~](functions/createJSDocParameterTag.md) +- [~~createJSDocParamTag~~](functions/createJSDocParamTag.md) +- [~~createJSDocPrivateTag~~](functions/createJSDocPrivateTag.md) +- [~~createJSDocPropertyTag~~](functions/createJSDocPropertyTag.md) +- [~~createJSDocProtectedTag~~](functions/createJSDocProtectedTag.md) +- [~~createJSDocPublicTag~~](functions/createJSDocPublicTag.md) +- [~~createJSDocReadonlyTag~~](functions/createJSDocReadonlyTag.md) +- [~~createJSDocReturnTag~~](functions/createJSDocReturnTag.md) +- [~~createJSDocSignature~~](functions/createJSDocSignature.md) +- [~~createJSDocTag~~](functions/createJSDocTag.md) +- [~~createJSDocTemplateTag~~](functions/createJSDocTemplateTag.md) +- [~~createJSDocThisTag~~](functions/createJSDocThisTag.md) +- [~~createJSDocTypedefTag~~](functions/createJSDocTypedefTag.md) +- [~~createJSDocTypeExpression~~](functions/createJSDocTypeExpression.md) +- [~~createJSDocTypeLiteral~~](functions/createJSDocTypeLiteral.md) +- [~~createJSDocTypeTag~~](functions/createJSDocTypeTag.md) +- [~~createJsxAttribute~~](functions/createJsxAttribute.md) +- [~~createJsxAttributes~~](functions/createJsxAttributes.md) +- [~~createJsxClosingElement~~](functions/createJsxClosingElement.md) +- [~~createJsxElement~~](functions/createJsxElement.md) +- [~~createJsxExpression~~](functions/createJsxExpression.md) +- [~~createJsxFragment~~](functions/createJsxFragment.md) +- [~~createJsxJsxClosingFragment~~](functions/createJsxJsxClosingFragment.md) +- [~~createJsxOpeningElement~~](functions/createJsxOpeningElement.md) +- [~~createJsxOpeningFragment~~](functions/createJsxOpeningFragment.md) +- [~~createJsxSelfClosingElement~~](functions/createJsxSelfClosingElement.md) +- [~~createJsxSpreadAttribute~~](functions/createJsxSpreadAttribute.md) +- [~~createJsxText~~](functions/createJsxText.md) +- [~~createKeywordTypeNode~~](functions/createKeywordTypeNode.md) +- [~~createLabel~~](functions/createLabel.md) +- [createLanguageService](functions/createLanguageService.md) +- [createLanguageServiceSourceFile](functions/createLanguageServiceSourceFile.md) +- [~~createLessThan~~](functions/createLessThan.md) +- [~~createLiteral~~](functions/createLiteral.md) +- [~~createLiteralTypeNode~~](functions/createLiteralTypeNode.md) +- [~~createLogicalAnd~~](functions/createLogicalAnd.md) +- [~~createLogicalNot~~](functions/createLogicalNot.md) +- [~~createLogicalOr~~](functions/createLogicalOr.md) +- [~~createLoopVariable~~](functions/createLoopVariable.md) +- [~~createMappedTypeNode~~](functions/createMappedTypeNode.md) +- [~~createMetaProperty~~](functions/createMetaProperty.md) +- [~~createMethod~~](functions/createMethod.md) +- [~~createMethodSignature~~](functions/createMethodSignature.md) +- [~~createModifier~~](functions/createModifier.md) +- [~~createModifiersFromModifierFlags~~](functions/createModifiersFromModifierFlags.md) +- [~~createModuleBlock~~](functions/createModuleBlock.md) +- [~~createModuleDeclaration~~](functions/createModuleDeclaration.md) +- [createModuleResolutionCache](functions/createModuleResolutionCache.md) +- [~~createNamedExports~~](functions/createNamedExports.md) +- [~~createNamedImports~~](functions/createNamedImports.md) +- [~~createNamespaceExport~~](functions/createNamespaceExport.md) +- [~~createNamespaceExportDeclaration~~](functions/createNamespaceExportDeclaration.md) +- [~~createNamespaceImport~~](functions/createNamespaceImport.md) +- [~~createNew~~](functions/createNew.md) +- [~~createNode~~](functions/createNode.md) +- [~~createNodeArray~~](functions/createNodeArray.md) +- [~~createNonNullChain~~](functions/createNonNullChain.md) +- [~~createNonNullExpression~~](functions/createNonNullExpression.md) +- [~~createNoSubstitutionTemplateLiteral~~](functions/createNoSubstitutionTemplateLiteral.md) +- [~~createNotEmittedStatement~~](functions/createNotEmittedStatement.md) +- [~~createNull~~](functions/createNull.md) +- [~~createNumericLiteral~~](functions/createNumericLiteral.md) +- [createObfTextSingleLineWriter](functions/createObfTextSingleLineWriter.md) +- [~~createObjectBindingPattern~~](functions/createObjectBindingPattern.md) +- [~~createObjectLiteral~~](functions/createObjectLiteral.md) +- [~~createOmittedExpression~~](functions/createOmittedExpression.md) +- [~~createOptimisticUniqueName~~](functions/createOptimisticUniqueName.md) +- [~~createOptionalTypeNode~~](functions/createOptionalTypeNode.md) +- [~~createParameter~~](functions/createParameter.md) +- [~~createParen~~](functions/createParen.md) +- [~~createParenthesizedType~~](functions/createParenthesizedType.md) +- [~~createPartiallyEmittedExpression~~](functions/createPartiallyEmittedExpression.md) +- [~~createPostfix~~](functions/createPostfix.md) +- [~~createPostfixIncrement~~](functions/createPostfixIncrement.md) +- [~~createPrefix~~](functions/createPrefix.md) +- [createPrinter](functions/createPrinter.md) +- [~~createPrivateIdentifier~~](functions/createPrivateIdentifier.md) +- [createProgram](functions/createProgram.md) +- [~~createProperty~~](functions/createProperty.md) +- [~~createPropertyAccess~~](functions/createPropertyAccess.md) +- [~~createPropertyAccessChain~~](functions/createPropertyAccessChain.md) +- [~~createPropertyAssignment~~](functions/createPropertyAssignment.md) +- [~~createPropertySignature~~](functions/createPropertySignature.md) +- [~~createQualifiedName~~](functions/createQualifiedName.md) +- [~~createRegularExpressionLiteral~~](functions/createRegularExpressionLiteral.md) +- [~~createRestTypeNode~~](functions/createRestTypeNode.md) +- [~~createReturn~~](functions/createReturn.md) +- [createScanner](functions/createScanner.md) +- [createSemanticDiagnosticsBuilderProgram](functions/createSemanticDiagnosticsBuilderProgram.md) +- [~~createSemicolonClassElement~~](functions/createSemicolonClassElement.md) +- [~~createSetAccessor~~](functions/createSetAccessor.md) +- [~~createShorthandPropertyAssignment~~](functions/createShorthandPropertyAssignment.md) +- [createSolutionBuilder](functions/createSolutionBuilder.md) +- [createSolutionBuilderHost](functions/createSolutionBuilderHost.md) +- [createSolutionBuilderWithWatch](functions/createSolutionBuilderWithWatch.md) +- [createSolutionBuilderWithWatchHost](functions/createSolutionBuilderWithWatchHost.md) +- [createSourceFile](functions/createSourceFile.md) +- [createSourceMapGenerator](functions/createSourceMapGenerator.md) +- [createSourceMapSource](functions/createSourceMapSource.md) +- [~~createSpread~~](functions/createSpread.md) +- [~~createSpreadAssignment~~](functions/createSpreadAssignment.md) +- [~~createStatement~~](functions/createStatement.md) +- [~~createStrictEquality~~](functions/createStrictEquality.md) +- [~~createStrictInequality~~](functions/createStrictInequality.md) +- [~~createStringLiteral~~](functions/createStringLiteral.md) +- [~~createStringLiteralFromNode~~](functions/createStringLiteralFromNode.md) +- [~~createSubtract~~](functions/createSubtract.md) +- [~~createSuper~~](functions/createSuper.md) +- [~~createSwitch~~](functions/createSwitch.md) +- [~~createTaggedTemplate~~](functions/createTaggedTemplate.md) +- [~~createTemplateExpression~~](functions/createTemplateExpression.md) +- [~~createTemplateHead~~](functions/createTemplateHead.md) +- [~~createTemplateMiddle~~](functions/createTemplateMiddle.md) +- [~~createTemplateSpan~~](functions/createTemplateSpan.md) +- [~~createTemplateTail~~](functions/createTemplateTail.md) +- [~~createTempVariable~~](functions/createTempVariable.md) +- [createTextChangeRange](functions/createTextChangeRange.md) +- [createTextSpan](functions/createTextSpan.md) +- [createTextSpanFromBounds](functions/createTextSpanFromBounds.md) +- [createTextWriter](functions/createTextWriter.md) +- [~~createThis~~](functions/createThis.md) +- [~~createThisTypeNode~~](functions/createThisTypeNode.md) +- [~~createThrow~~](functions/createThrow.md) +- [~~createToken~~](functions/createToken.md) +- [~~createTrue~~](functions/createTrue.md) +- [~~createTry~~](functions/createTry.md) +- [~~createTupleTypeNode~~](functions/createTupleTypeNode.md) +- [~~createTypeAliasDeclaration~~](functions/createTypeAliasDeclaration.md) +- [~~createTypeAssertion~~](functions/createTypeAssertion.md) +- [~~createTypeLiteralNode~~](functions/createTypeLiteralNode.md) +- [~~createTypeOf~~](functions/createTypeOf.md) +- [~~createTypeOperatorNode~~](functions/createTypeOperatorNode.md) +- [~~createTypeParameterDeclaration~~](functions/createTypeParameterDeclaration.md) +- [~~createTypePredicateNode~~](functions/createTypePredicateNode.md) +- [~~createTypePredicateNodeWithModifier~~](functions/createTypePredicateNodeWithModifier.md) +- [~~createTypeQueryNode~~](functions/createTypeQueryNode.md) +- [createTypeReferenceDirectiveResolutionCache](functions/createTypeReferenceDirectiveResolutionCache.md) +- [~~createTypeReferenceNode~~](functions/createTypeReferenceNode.md) +- [~~createUnionTypeNode~~](functions/createUnionTypeNode.md) +- [~~createUniqueName~~](functions/createUniqueName.md) +- [createUnparsedSourceFile](functions/createUnparsedSourceFile.md) +- [~~createVariableDeclaration~~](functions/createVariableDeclaration.md) +- [~~createVariableDeclarationList~~](functions/createVariableDeclarationList.md) +- [~~createVariableStatement~~](functions/createVariableStatement.md) +- [~~createVoid~~](functions/createVoid.md) +- [~~createVoidZero~~](functions/createVoidZero.md) +- [createWatchCompilerHost](functions/createWatchCompilerHost.md) +- [createWatchProgram](functions/createWatchProgram.md) +- [~~createWhile~~](functions/createWhile.md) +- [~~createWith~~](functions/createWith.md) +- [~~createYield~~](functions/createYield.md) +- [decodedTextSpanIntersectsWith](functions/decodedTextSpanIntersectsWith.md) +- [displayPartsToString](functions/displayPartsToString.md) +- [disposeEmitNodes](functions/disposeEmitNodes.md) +- [escapeLeadingUnderscores](functions/escapeLeadingUnderscores.md) +- [findAncestor](functions/findAncestor.md) +- [findConfigFile](functions/findConfigFile.md) +- [flattenDiagnosticMessageText](functions/flattenDiagnosticMessageText.md) +- [forEachChild](functions/forEachChild.md) +- [forEachLeadingCommentRange](functions/forEachLeadingCommentRange.md) +- [forEachTrailingCommentRange](functions/forEachTrailingCommentRange.md) +- [formatDiagnostic](functions/formatDiagnostic.md) +- [formatDiagnostics](functions/formatDiagnostics.md) +- [formatDiagnosticsWithColorAndContext](functions/formatDiagnosticsWithColorAndContext.md) +- [getAllDecorators](functions/getAllDecorators.md) +- [getAllJSDocTags](functions/getAllJSDocTags.md) +- [getAllJSDocTagsOfKind](functions/getAllJSDocTagsOfKind.md) +- [getAutomaticTypeDirectiveNames](functions/getAutomaticTypeDirectiveNames.md) +- [getCombinedModifierFlags](functions/getCombinedModifierFlags.md) +- [getCombinedNodeFlags](functions/getCombinedNodeFlags.md) +- [getCommentRange](functions/getCommentRange.md) +- [getConfigFileParsingDiagnostics](functions/getConfigFileParsingDiagnostics.md) +- [getConstantValue](functions/getConstantValue.md) +- [getDecorators](functions/getDecorators.md) +- [getDefaultCompilerOptions](functions/getDefaultCompilerOptions.md) +- [getDefaultFormatCodeSettings](functions/getDefaultFormatCodeSettings.md) +- [getDefaultLibFileName](functions/getDefaultLibFileName.md) +- [getDefaultLibFilePath](functions/getDefaultLibFilePath.md) +- [getEffectiveConstraintOfTypeParameter](functions/getEffectiveConstraintOfTypeParameter.md) +- [getEffectiveTypeParameterDeclarations](functions/getEffectiveTypeParameterDeclarations.md) +- [getEffectiveTypeRoots](functions/getEffectiveTypeRoots.md) +- [getEmitHelpers](functions/getEmitHelpers.md) +- [~~getGeneratedNameForNode~~](functions/getGeneratedNameForNode.md) +- [getIllegalDecorators](functions/getIllegalDecorators.md) +- [getImpliedNodeFormatForFile](functions/getImpliedNodeFormatForFile.md) +- [getJSDocAugmentsTag](functions/getJSDocAugmentsTag.md) +- [getJSDocClassTag](functions/getJSDocClassTag.md) +- [getJSDocDeprecatedTag](functions/getJSDocDeprecatedTag.md) +- [getJSDocEnumTag](functions/getJSDocEnumTag.md) +- [getJSDocImplementsTags](functions/getJSDocImplementsTags.md) +- [getJSDocOverrideTagNoCache](functions/getJSDocOverrideTagNoCache.md) +- [getJSDocParameterTags](functions/getJSDocParameterTags.md) +- [getJSDocPrivateTag](functions/getJSDocPrivateTag.md) +- [getJSDocProtectedTag](functions/getJSDocProtectedTag.md) +- [getJSDocPublicTag](functions/getJSDocPublicTag.md) +- [getJSDocReadonlyTag](functions/getJSDocReadonlyTag.md) +- [getJSDocReturnTag](functions/getJSDocReturnTag.md) +- [getJSDocReturnType](functions/getJSDocReturnType.md) +- [getJSDocTags](functions/getJSDocTags.md) +- [getJSDocTemplateTag](functions/getJSDocTemplateTag.md) +- [getJSDocThisTag](functions/getJSDocThisTag.md) +- [getJSDocType](functions/getJSDocType.md) +- [getJSDocTypeParameterTags](functions/getJSDocTypeParameterTags.md) +- [getJSDocTypeTag](functions/getJSDocTypeTag.md) +- [getLeadingCommentRanges](functions/getLeadingCommentRanges.md) +- [getLeadingCommentRangesOfNode](functions/getLeadingCommentRangesOfNode.md) +- [getLineAndCharacterOfPosition](functions/getLineAndCharacterOfPosition.md) +- [getModeForFileReference](functions/getModeForFileReference.md) +- [getModeForResolutionAtIndex](functions/getModeForResolutionAtIndex.md) +- [getModeForUsageLocation](functions/getModeForUsageLocation.md) +- [getModifiers](functions/getModifiers.md) +- [getModuleByPMType](functions/getModuleByPMType.md) +- [getModulePathPartByPMType](functions/getModulePathPartByPMType.md) +- [~~getMutableClone~~](functions/getMutableClone.md) +- [getNameOfDeclaration](functions/getNameOfDeclaration.md) +- [getNameOfJSDocTypedef](functions/getNameOfJSDocTypedef.md) +- [getNodeMajorVersion](functions/getNodeMajorVersion.md) +- [getOriginalNode](functions/getOriginalNode.md) +- [getOutputFileNames](functions/getOutputFileNames.md) +- [getPackageJsonByPMType](functions/getPackageJsonByPMType.md) +- [getParsedCommandLineOfConfigFile](functions/getParsedCommandLineOfConfigFile.md) +- [getParseTreeNode](functions/getParseTreeNode.md) +- [getPositionOfLineAndCharacter](functions/getPositionOfLineAndCharacter.md) +- [getPreEmitDiagnostics](functions/getPreEmitDiagnostics.md) +- [getShebang](functions/getShebang.md) +- [getSourceMapRange](functions/getSourceMapRange.md) +- [getSupportedCodeFixes](functions/getSupportedCodeFixes.md) +- [getSyntheticLeadingComments](functions/getSyntheticLeadingComments.md) +- [getSyntheticTrailingComments](functions/getSyntheticTrailingComments.md) +- [getTextOfJSDocComment](functions/getTextOfJSDocComment.md) +- [getTokenSourceMapRange](functions/getTokenSourceMapRange.md) +- [getTrailingCommentRanges](functions/getTrailingCommentRanges.md) +- [getTsBuildInfoEmitOutputFilePath](functions/getTsBuildInfoEmitOutputFilePath.md) +- [getTsBuildInfoEmitOutputFilePathForLinter](functions/getTsBuildInfoEmitOutputFilePathForLinter.md) +- [getTypeExportImportAndConstEnumTransformer](functions/getTypeExportImportAndConstEnumTransformer.md) +- [getTypeParameterOwner](functions/getTypeParameterOwner.md) +- [hasJSDocParameterTags](functions/hasJSDocParameterTags.md) +- [hasOnlyExpressionInitializer](functions/hasOnlyExpressionInitializer.md) +- [hasRestParameter](functions/hasRestParameter.md) +- [hasTsNoCheckOrTsIgnoreFlag](functions/hasTsNoCheckOrTsIgnoreFlag.md) +- [idText](functions/idText.md) +- [isAccessor](functions/isAccessor.md) +- [isArrayBindingPattern](functions/isArrayBindingPattern.md) +- [isArrayLiteralExpression](functions/isArrayLiteralExpression.md) +- [isArrayTypeNode](functions/isArrayTypeNode.md) +- [isArrowFunction](functions/isArrowFunction.md) +- [isAsExpression](functions/isAsExpression.md) +- [isAssertClause](functions/isAssertClause.md) +- [isAssertEntry](functions/isAssertEntry.md) +- [isAssertionExpression](functions/isAssertionExpression.md) +- [isAssertionKey](functions/isAssertionKey.md) +- [isAsteriskToken](functions/isAsteriskToken.md) +- [isAutoAccessorPropertyDeclaration](functions/isAutoAccessorPropertyDeclaration.md) +- [isAwaitExpression](functions/isAwaitExpression.md) +- [isBigIntLiteral](functions/isBigIntLiteral.md) +- [isBinaryExpression](functions/isBinaryExpression.md) +- [isBindingElement](functions/isBindingElement.md) +- [isBindingName](functions/isBindingName.md) +- [isBlock](functions/isBlock.md) +- [isBreakOrContinueStatement](functions/isBreakOrContinueStatement.md) +- [isBreakStatement](functions/isBreakStatement.md) +- [isBundle](functions/isBundle.md) +- [isCallChain](functions/isCallChain.md) +- [isCallExpression](functions/isCallExpression.md) +- [isCallLikeExpression](functions/isCallLikeExpression.md) +- [isCallOrNewExpression](functions/isCallOrNewExpression.md) +- [isCallSignatureDeclaration](functions/isCallSignatureDeclaration.md) +- [isCaseBlock](functions/isCaseBlock.md) +- [isCaseClause](functions/isCaseClause.md) +- [isCaseOrDefaultClause](functions/isCaseOrDefaultClause.md) +- [isCatchClause](functions/isCatchClause.md) +- [isClassDeclaration](functions/isClassDeclaration.md) +- [isClassElement](functions/isClassElement.md) +- [isClassExpression](functions/isClassExpression.md) +- [isClassLike](functions/isClassLike.md) +- [isClassOrTypeElement](functions/isClassOrTypeElement.md) +- [isClassStaticBlockDeclaration](functions/isClassStaticBlockDeclaration.md) +- [isCommaListExpression](functions/isCommaListExpression.md) +- [isComputedPropertyName](functions/isComputedPropertyName.md) +- [isConditionalExpression](functions/isConditionalExpression.md) +- [isConditionalTypeNode](functions/isConditionalTypeNode.md) +- [isConstructorDeclaration](functions/isConstructorDeclaration.md) +- [isConstructorTypeNode](functions/isConstructorTypeNode.md) +- [isConstructSignatureDeclaration](functions/isConstructSignatureDeclaration.md) +- [isConstTypeReference](functions/isConstTypeReference.md) +- [isContinueStatement](functions/isContinueStatement.md) +- [isDebuggerStatement](functions/isDebuggerStatement.md) +- [isDecorator](functions/isDecorator.md) +- [isDefaultClause](functions/isDefaultClause.md) +- [isDeleteExpression](functions/isDeleteExpression.md) +- [isDoStatement](functions/isDoStatement.md) +- [isDotDotDotToken](functions/isDotDotDotToken.md) +- [isElementAccessChain](functions/isElementAccessChain.md) +- [isElementAccessExpression](functions/isElementAccessExpression.md) +- [isEmptyBindingElement](functions/isEmptyBindingElement.md) +- [isEmptyBindingPattern](functions/isEmptyBindingPattern.md) +- [isEmptyStatement](functions/isEmptyStatement.md) +- [isEntityName](functions/isEntityName.md) +- [isEnumDeclaration](functions/isEnumDeclaration.md) +- [isEnumMember](functions/isEnumMember.md) +- [isEtsComponentExpression](functions/isEtsComponentExpression.md) +- [isEtsFunctionDecorators](functions/isEtsFunctionDecorators.md) +- [isExportAssignment](functions/isExportAssignment.md) +- [isExportDeclaration](functions/isExportDeclaration.md) +- [isExportSpecifier](functions/isExportSpecifier.md) +- [isExpressionStatement](functions/isExpressionStatement.md) +- [isExpressionWithTypeArguments](functions/isExpressionWithTypeArguments.md) +- [isExternalModule](functions/isExternalModule.md) +- [isExternalModuleNameRelative](functions/isExternalModuleNameRelative.md) +- [isExternalModuleReference](functions/isExternalModuleReference.md) +- [isForInStatement](functions/isForInStatement.md) +- [isForOfStatement](functions/isForOfStatement.md) +- [isForStatement](functions/isForStatement.md) +- [isFunctionDeclaration](functions/isFunctionDeclaration.md) +- [isFunctionExpression](functions/isFunctionExpression.md) +- [isFunctionLike](functions/isFunctionLike.md) +- [isFunctionOrConstructorTypeNode](functions/isFunctionOrConstructorTypeNode.md) +- [isFunctionTypeNode](functions/isFunctionTypeNode.md) +- [isGetAccessor](functions/isGetAccessor.md) +- [isGetAccessorDeclaration](functions/isGetAccessorDeclaration.md) +- [isHeritageClause](functions/isHeritageClause.md) +- [isIdentifier](functions/isIdentifier.md) +- [~~isIdentifierOrPrivateIdentifier~~](functions/isIdentifierOrPrivateIdentifier.md) +- [isIdentifierPart](functions/isIdentifierPart.md) +- [isIdentifierStart](functions/isIdentifierStart.md) +- [isIfStatement](functions/isIfStatement.md) +- [isImportClause](functions/isImportClause.md) +- [isImportDeclaration](functions/isImportDeclaration.md) +- [isImportEqualsDeclaration](functions/isImportEqualsDeclaration.md) +- [isImportOrExportSpecifier](functions/isImportOrExportSpecifier.md) +- [isImportSpecifier](functions/isImportSpecifier.md) +- [isImportTypeAssertionContainer](functions/isImportTypeAssertionContainer.md) +- [isImportTypeNode](functions/isImportTypeNode.md) +- [isIndexedAccessTypeNode](functions/isIndexedAccessTypeNode.md) +- [isIndexSignatureDeclaration](functions/isIndexSignatureDeclaration.md) +- [isInferTypeNode](functions/isInferTypeNode.md) +- [isInterfaceDeclaration](functions/isInterfaceDeclaration.md) +- [isIntersectionTypeNode](functions/isIntersectionTypeNode.md) +- [isIterationStatement](functions/isIterationStatement.md) +- [isJSDoc](functions/isJSDoc.md) +- [isJSDocAllType](functions/isJSDocAllType.md) +- [isJSDocAugmentsTag](functions/isJSDocAugmentsTag.md) +- [isJSDocAuthorTag](functions/isJSDocAuthorTag.md) +- [isJSDocCallbackTag](functions/isJSDocCallbackTag.md) +- [isJSDocClassTag](functions/isJSDocClassTag.md) +- [isJSDocCommentContainingNode](functions/isJSDocCommentContainingNode.md) +- [isJSDocDeprecatedTag](functions/isJSDocDeprecatedTag.md) +- [isJSDocEnumTag](functions/isJSDocEnumTag.md) +- [isJSDocFunctionType](functions/isJSDocFunctionType.md) +- [isJSDocImplementsTag](functions/isJSDocImplementsTag.md) +- [isJSDocLink](functions/isJSDocLink.md) +- [isJSDocLinkCode](functions/isJSDocLinkCode.md) +- [isJSDocLinkLike](functions/isJSDocLinkLike.md) +- [isJSDocLinkPlain](functions/isJSDocLinkPlain.md) +- [isJSDocMemberName](functions/isJSDocMemberName.md) +- [isJSDocNamepathType](functions/isJSDocNamepathType.md) +- [isJSDocNameReference](functions/isJSDocNameReference.md) +- [isJSDocNonNullableType](functions/isJSDocNonNullableType.md) +- [isJSDocNullableType](functions/isJSDocNullableType.md) +- [isJSDocOptionalType](functions/isJSDocOptionalType.md) +- [isJSDocOverrideTag](functions/isJSDocOverrideTag.md) +- [isJSDocParameterTag](functions/isJSDocParameterTag.md) +- [isJSDocPrivateTag](functions/isJSDocPrivateTag.md) +- [isJSDocPropertyLikeTag](functions/isJSDocPropertyLikeTag.md) +- [isJSDocPropertyTag](functions/isJSDocPropertyTag.md) +- [isJSDocProtectedTag](functions/isJSDocProtectedTag.md) +- [isJSDocPublicTag](functions/isJSDocPublicTag.md) +- [isJSDocReadonlyTag](functions/isJSDocReadonlyTag.md) +- [isJSDocReturnTag](functions/isJSDocReturnTag.md) +- [isJSDocSeeTag](functions/isJSDocSeeTag.md) +- [isJSDocSignature](functions/isJSDocSignature.md) +- [isJSDocTemplateTag](functions/isJSDocTemplateTag.md) +- [isJSDocThisTag](functions/isJSDocThisTag.md) +- [isJSDocTypedefTag](functions/isJSDocTypedefTag.md) +- [isJSDocTypeExpression](functions/isJSDocTypeExpression.md) +- [isJSDocTypeLiteral](functions/isJSDocTypeLiteral.md) +- [isJSDocTypeTag](functions/isJSDocTypeTag.md) +- [isJSDocUnknownTag](functions/isJSDocUnknownTag.md) +- [isJSDocUnknownType](functions/isJSDocUnknownType.md) +- [isJSDocVariadicType](functions/isJSDocVariadicType.md) +- [isJsxAttribute](functions/isJsxAttribute.md) +- [isJsxAttributes](functions/isJsxAttributes.md) +- [isJsxClosingElement](functions/isJsxClosingElement.md) +- [isJsxClosingFragment](functions/isJsxClosingFragment.md) +- [isJsxElement](functions/isJsxElement.md) +- [isJsxExpression](functions/isJsxExpression.md) +- [isJsxFragment](functions/isJsxFragment.md) +- [isJsxOpeningElement](functions/isJsxOpeningElement.md) +- [isJsxOpeningFragment](functions/isJsxOpeningFragment.md) +- [isJsxOpeningLikeElement](functions/isJsxOpeningLikeElement.md) +- [isJsxSelfClosingElement](functions/isJsxSelfClosingElement.md) +- [isJsxSpreadAttribute](functions/isJsxSpreadAttribute.md) +- [isJsxText](functions/isJsxText.md) +- [isLabeledStatement](functions/isLabeledStatement.md) +- [isLineBreak](functions/isLineBreak.md) +- [isLiteralExpression](functions/isLiteralExpression.md) +- [isLiteralTypeNode](functions/isLiteralTypeNode.md) +- [isMappedTypeNode](functions/isMappedTypeNode.md) +- [isMemberName](functions/isMemberName.md) +- [isMetaProperty](functions/isMetaProperty.md) +- [isMethodDeclaration](functions/isMethodDeclaration.md) +- [isMethodSignature](functions/isMethodSignature.md) +- [isMinusToken](functions/isMinusToken.md) +- [isMissingDeclaration](functions/isMissingDeclaration.md) +- [isModifier](functions/isModifier.md) +- [isModifierLike](functions/isModifierLike.md) +- [isModuleBlock](functions/isModuleBlock.md) +- [isModuleDeclaration](functions/isModuleDeclaration.md) +- [isNamedExportBindings](functions/isNamedExportBindings.md) +- [isNamedExports](functions/isNamedExports.md) +- [isNamedImports](functions/isNamedImports.md) +- [isNamedTupleMember](functions/isNamedTupleMember.md) +- [isNamespaceExport](functions/isNamespaceExport.md) +- [isNamespaceExportDeclaration](functions/isNamespaceExportDeclaration.md) +- [isNamespaceImport](functions/isNamespaceImport.md) +- [isNewExpression](functions/isNewExpression.md) +- [isNonNullChain](functions/isNonNullChain.md) +- [isNonNullExpression](functions/isNonNullExpression.md) +- [isNoSubstitutionTemplateLiteral](functions/isNoSubstitutionTemplateLiteral.md) +- [isNotEmittedStatement](functions/isNotEmittedStatement.md) +- [isNullishCoalesce](functions/isNullishCoalesce.md) +- [isNumericLiteral](functions/isNumericLiteral.md) +- [isObjectBindingPattern](functions/isObjectBindingPattern.md) +- [isObjectLiteralElement](functions/isObjectLiteralElement.md) +- [isObjectLiteralElementLike](functions/isObjectLiteralElementLike.md) +- [isObjectLiteralExpression](functions/isObjectLiteralExpression.md) +- [isOHModules](functions/isOHModules.md) +- [isOHModulesDirectory](functions/isOHModulesDirectory.md) +- [isOhpm](functions/isOhpm.md) +- [isOhpmAndOhModules](functions/isOhpmAndOhModules.md) +- [isOmittedExpression](functions/isOmittedExpression.md) +- [isOptionalChain](functions/isOptionalChain.md) +- [isOptionalTypeNode](functions/isOptionalTypeNode.md) +- [isParameter](functions/isParameter.md) +- [isParameterPropertyDeclaration](functions/isParameterPropertyDeclaration.md) +- [isParenthesizedExpression](functions/isParenthesizedExpression.md) +- [isParenthesizedTypeNode](functions/isParenthesizedTypeNode.md) +- [isParseTreeNode](functions/isParseTreeNode.md) +- [isPartiallyEmittedExpression](functions/isPartiallyEmittedExpression.md) +- [isPlusToken](functions/isPlusToken.md) +- [isPostfixUnaryExpression](functions/isPostfixUnaryExpression.md) +- [isPrefixUnaryExpression](functions/isPrefixUnaryExpression.md) +- [isPrivateIdentifier](functions/isPrivateIdentifier.md) +- [isPropertyAccessChain](functions/isPropertyAccessChain.md) +- [isPropertyAccessExpression](functions/isPropertyAccessExpression.md) +- [isPropertyAccessOrQualifiedName](functions/isPropertyAccessOrQualifiedName.md) +- [isPropertyAssignment](functions/isPropertyAssignment.md) +- [isPropertyDeclaration](functions/isPropertyDeclaration.md) +- [isPropertyName](functions/isPropertyName.md) +- [isPropertySignature](functions/isPropertySignature.md) +- [isQualifiedName](functions/isQualifiedName.md) +- [isRegularExpressionLiteral](functions/isRegularExpressionLiteral.md) +- [isRestParameter](functions/isRestParameter.md) +- [isRestTypeNode](functions/isRestTypeNode.md) +- [isReturnStatement](functions/isReturnStatement.md) +- [isSatisfiesExpression](functions/isSatisfiesExpression.md) +- [isSemicolonClassElement](functions/isSemicolonClassElement.md) +- [isSetAccessor](functions/isSetAccessor.md) +- [isSetAccessorDeclaration](functions/isSetAccessorDeclaration.md) +- [isShorthandPropertyAssignment](functions/isShorthandPropertyAssignment.md) +- [isSourceFile](functions/isSourceFile.md) +- [isSpreadAssignment](functions/isSpreadAssignment.md) +- [isSpreadElement](functions/isSpreadElement.md) +- [isStringLiteral](functions/isStringLiteral.md) +- [isStringLiteralLike](functions/isStringLiteralLike.md) +- [isStringTextContainingNode](functions/isStringTextContainingNode.md) +- [isStruct](functions/isStruct.md) +- [isStructDeclaration](functions/isStructDeclaration.md) +- [isSwitchStatement](functions/isSwitchStatement.md) +- [isSyntheticExpression](functions/isSyntheticExpression.md) +- [isTaggedTemplateExpression](functions/isTaggedTemplateExpression.md) +- [isTargetModulesDerectory](functions/isTargetModulesDerectory.md) +- [isTemplateExpression](functions/isTemplateExpression.md) +- [isTemplateHead](functions/isTemplateHead.md) +- [isTemplateLiteral](functions/isTemplateLiteral.md) +- [isTemplateLiteralToken](functions/isTemplateLiteralToken.md) +- [isTemplateLiteralTypeNode](functions/isTemplateLiteralTypeNode.md) +- [isTemplateLiteralTypeSpan](functions/isTemplateLiteralTypeSpan.md) +- [isTemplateMiddle](functions/isTemplateMiddle.md) +- [isTemplateMiddleOrTemplateTail](functions/isTemplateMiddleOrTemplateTail.md) +- [isTemplateSpan](functions/isTemplateSpan.md) +- [isTemplateTail](functions/isTemplateTail.md) +- [isThisTypeNode](functions/isThisTypeNode.md) +- [isThrowStatement](functions/isThrowStatement.md) +- [isToken](functions/isToken.md) +- [isTokenKind](functions/isTokenKind.md) +- [isTryStatement](functions/isTryStatement.md) +- [isTupleTypeNode](functions/isTupleTypeNode.md) +- [isTypeAliasDeclaration](functions/isTypeAliasDeclaration.md) +- [~~isTypeAssertion~~](functions/isTypeAssertion.md) +- [isTypeAssertionExpression](functions/isTypeAssertionExpression.md) +- [isTypeElement](functions/isTypeElement.md) +- [isTypeLiteralNode](functions/isTypeLiteralNode.md) +- [isTypeNode](functions/isTypeNode.md) +- [isTypeOfExpression](functions/isTypeOfExpression.md) +- [isTypeOnlyImportOrExportDeclaration](functions/isTypeOnlyImportOrExportDeclaration.md) +- [isTypeOperatorNode](functions/isTypeOperatorNode.md) +- [isTypeParameterDeclaration](functions/isTypeParameterDeclaration.md) +- [isTypePredicateNode](functions/isTypePredicateNode.md) +- [isTypeQueryNode](functions/isTypeQueryNode.md) +- [isTypeReferenceNode](functions/isTypeReferenceNode.md) +- [isUnionTypeNode](functions/isUnionTypeNode.md) +- [isUnparsedNode](functions/isUnparsedNode.md) +- [isUnparsedPrepend](functions/isUnparsedPrepend.md) +- [isUnparsedSource](functions/isUnparsedSource.md) +- [isUnparsedTextLike](functions/isUnparsedTextLike.md) +- [isVariableDeclaration](functions/isVariableDeclaration.md) +- [isVariableDeclarationList](functions/isVariableDeclarationList.md) +- [isVariableStatement](functions/isVariableStatement.md) +- [isVoidExpression](functions/isVoidExpression.md) +- [isWhileStatement](functions/isWhileStatement.md) +- [isWhiteSpaceLike](functions/isWhiteSpaceLike.md) +- [isWhiteSpaceSingleLine](functions/isWhiteSpaceSingleLine.md) +- [isWithStatement](functions/isWithStatement.md) +- [isYieldExpression](functions/isYieldExpression.md) +- [moveEmitHelpers](functions/moveEmitHelpers.md) +- [moveSyntheticComments](functions/moveSyntheticComments.md) +- [nodeModuleNameResolver](functions/nodeModuleNameResolver.md) +- [parseCommandLine](functions/parseCommandLine.md) +- [parseConfigFileTextToJson](functions/parseConfigFileTextToJson.md) +- [parseIsolatedEntityName](functions/parseIsolatedEntityName.md) +- [parseJsonConfigFileContent](functions/parseJsonConfigFileContent.md) +- [parseJsonSourceFileConfigFileContent](functions/parseJsonSourceFileConfigFileContent.md) +- [parseJsonText](functions/parseJsonText.md) +- [parseModuleFromPath](functions/parseModuleFromPath.md) +- [pathContainsOHModules](functions/pathContainsOHModules.md) +- [preProcessFile](functions/preProcessFile.md) +- [readBuilderProgram](functions/readBuilderProgram.md) +- [readConfigFile](functions/readConfigFile.md) +- [readJsonConfigFile](functions/readJsonConfigFile.md) +- [reduceEachLeadingCommentRange](functions/reduceEachLeadingCommentRange.md) +- [reduceEachTrailingCommentRange](functions/reduceEachTrailingCommentRange.md) +- [removeEmitHelper](functions/removeEmitHelper.md) +- [resolveModuleName](functions/resolveModuleName.md) +- [resolveModuleNameFromCache](functions/resolveModuleNameFromCache.md) +- [resolveProjectReferencePath](functions/resolveProjectReferencePath.md) +- [resolveTripleslashReference](functions/resolveTripleslashReference.md) +- [resolveTypeReferenceDirective](functions/resolveTypeReferenceDirective.md) +- [setCommentRange](functions/setCommentRange.md) +- [setConstantValue](functions/setConstantValue.md) +- [setEmitFlags](functions/setEmitFlags.md) +- [setOriginalNode](functions/setOriginalNode.md) +- [setParentRecursive](functions/setParentRecursive.md) +- [setSourceMapRange](functions/setSourceMapRange.md) +- [setSyntheticLeadingComments](functions/setSyntheticLeadingComments.md) +- [setSyntheticTrailingComments](functions/setSyntheticTrailingComments.md) +- [setTextRange](functions/setTextRange.md) +- [setTokenSourceMapRange](functions/setTokenSourceMapRange.md) +- [skipPartiallyEmittedExpressions](functions/skipPartiallyEmittedExpressions.md) +- [sortAndDeduplicateDiagnostics](functions/sortAndDeduplicateDiagnostics.md) +- [symbolName](functions/symbolName.md) +- [textChangeRangeIsUnchanged](functions/textChangeRangeIsUnchanged.md) +- [textChangeRangeNewSpan](functions/textChangeRangeNewSpan.md) +- [textSpanContainsPosition](functions/textSpanContainsPosition.md) +- [textSpanContainsTextSpan](functions/textSpanContainsTextSpan.md) +- [textSpanEnd](functions/textSpanEnd.md) +- [textSpanIntersection](functions/textSpanIntersection.md) +- [textSpanIntersectsWith](functions/textSpanIntersectsWith.md) +- [textSpanIntersectsWithPosition](functions/textSpanIntersectsWithPosition.md) +- [textSpanIntersectsWithTextSpan](functions/textSpanIntersectsWithTextSpan.md) +- [textSpanIsEmpty](functions/textSpanIsEmpty.md) +- [textSpanOverlap](functions/textSpanOverlap.md) +- [textSpanOverlapsWith](functions/textSpanOverlapsWith.md) +- [toEditorSettings](functions/toEditorSettings.md) +- [tokenToString](functions/tokenToString.md) +- [transform](functions/transform.md) +- [transformTypeExportImportAndConstEnumInTypeScript](functions/transformTypeExportImportAndConstEnumInTypeScript.md) +- [transpile](functions/transpile.md) +- [transpileModule](functions/transpileModule.md) +- [unescapeLeadingUnderscores](functions/unescapeLeadingUnderscores.md) +- [~~updateArrayBindingPattern~~](functions/updateArrayBindingPattern.md) +- [~~updateArrayLiteral~~](functions/updateArrayLiteral.md) +- [~~updateArrayTypeNode~~](functions/updateArrayTypeNode.md) +- [~~updateArrowFunction~~](functions/updateArrowFunction.md) +- [~~updateAsExpression~~](functions/updateAsExpression.md) +- [~~updateAwait~~](functions/updateAwait.md) +- [~~updateBinary~~](functions/updateBinary.md) +- [~~updateBindingElement~~](functions/updateBindingElement.md) +- [~~updateBlock~~](functions/updateBlock.md) +- [~~updateBreak~~](functions/updateBreak.md) +- [~~updateBundle~~](functions/updateBundle.md) +- [~~updateCall~~](functions/updateCall.md) +- [~~updateCallChain~~](functions/updateCallChain.md) +- [~~updateCallSignature~~](functions/updateCallSignature.md) +- [~~updateCaseBlock~~](functions/updateCaseBlock.md) +- [~~updateCaseClause~~](functions/updateCaseClause.md) +- [~~updateCatchClause~~](functions/updateCatchClause.md) +- [~~updateClassDeclaration~~](functions/updateClassDeclaration.md) +- [~~updateClassExpression~~](functions/updateClassExpression.md) +- [~~updateCommaList~~](functions/updateCommaList.md) +- [~~updateComputedPropertyName~~](functions/updateComputedPropertyName.md) +- [~~updateConditional~~](functions/updateConditional.md) +- [~~updateConditionalTypeNode~~](functions/updateConditionalTypeNode.md) +- [~~updateConstructor~~](functions/updateConstructor.md) +- [~~updateConstructorTypeNode~~](functions/updateConstructorTypeNode.md) +- [~~updateConstructSignature~~](functions/updateConstructSignature.md) +- [~~updateContinue~~](functions/updateContinue.md) +- [~~updateDecorator~~](functions/updateDecorator.md) +- [~~updateDefaultClause~~](functions/updateDefaultClause.md) +- [~~updateDelete~~](functions/updateDelete.md) +- [~~updateDo~~](functions/updateDo.md) +- [~~updateElementAccess~~](functions/updateElementAccess.md) +- [~~updateElementAccessChain~~](functions/updateElementAccessChain.md) +- [~~updateEnumDeclaration~~](functions/updateEnumDeclaration.md) +- [~~updateEnumMember~~](functions/updateEnumMember.md) +- [~~updateExportAssignment~~](functions/updateExportAssignment.md) +- [~~updateExportDeclaration~~](functions/updateExportDeclaration.md) +- [~~updateExportSpecifier~~](functions/updateExportSpecifier.md) +- [~~updateExpressionStatement~~](functions/updateExpressionStatement.md) +- [~~updateExpressionWithTypeArguments~~](functions/updateExpressionWithTypeArguments.md) +- [~~updateExternalModuleReference~~](functions/updateExternalModuleReference.md) +- [~~updateFor~~](functions/updateFor.md) +- [~~updateForIn~~](functions/updateForIn.md) +- [~~updateForOf~~](functions/updateForOf.md) +- [~~updateFunctionDeclaration~~](functions/updateFunctionDeclaration.md) +- [~~updateFunctionExpression~~](functions/updateFunctionExpression.md) +- [~~updateFunctionTypeNode~~](functions/updateFunctionTypeNode.md) +- [~~updateGetAccessor~~](functions/updateGetAccessor.md) +- [~~updateHeritageClause~~](functions/updateHeritageClause.md) +- [~~updateIf~~](functions/updateIf.md) +- [~~updateImportClause~~](functions/updateImportClause.md) +- [~~updateImportDeclaration~~](functions/updateImportDeclaration.md) +- [~~updateImportEqualsDeclaration~~](functions/updateImportEqualsDeclaration.md) +- [~~updateImportSpecifier~~](functions/updateImportSpecifier.md) +- [~~updateImportTypeNode~~](functions/updateImportTypeNode.md) +- [~~updateIndexedAccessTypeNode~~](functions/updateIndexedAccessTypeNode.md) +- [~~updateIndexSignature~~](functions/updateIndexSignature.md) +- [~~updateInferTypeNode~~](functions/updateInferTypeNode.md) +- [~~updateInterfaceDeclaration~~](functions/updateInterfaceDeclaration.md) +- [~~updateIntersectionTypeNode~~](functions/updateIntersectionTypeNode.md) +- [~~updateJsxAttribute~~](functions/updateJsxAttribute.md) +- [~~updateJsxAttributes~~](functions/updateJsxAttributes.md) +- [~~updateJsxClosingElement~~](functions/updateJsxClosingElement.md) +- [~~updateJsxElement~~](functions/updateJsxElement.md) +- [~~updateJsxExpression~~](functions/updateJsxExpression.md) +- [~~updateJsxFragment~~](functions/updateJsxFragment.md) +- [~~updateJsxOpeningElement~~](functions/updateJsxOpeningElement.md) +- [~~updateJsxSelfClosingElement~~](functions/updateJsxSelfClosingElement.md) +- [~~updateJsxSpreadAttribute~~](functions/updateJsxSpreadAttribute.md) +- [~~updateJsxText~~](functions/updateJsxText.md) +- [~~updateLabel~~](functions/updateLabel.md) +- [updateLanguageServiceSourceFile](functions/updateLanguageServiceSourceFile.md) +- [~~updateLiteralTypeNode~~](functions/updateLiteralTypeNode.md) +- [~~updateMappedTypeNode~~](functions/updateMappedTypeNode.md) +- [~~updateMetaProperty~~](functions/updateMetaProperty.md) +- [~~updateMethod~~](functions/updateMethod.md) +- [~~updateMethodSignature~~](functions/updateMethodSignature.md) +- [~~updateModuleBlock~~](functions/updateModuleBlock.md) +- [~~updateModuleDeclaration~~](functions/updateModuleDeclaration.md) +- [~~updateNamedExports~~](functions/updateNamedExports.md) +- [~~updateNamedImports~~](functions/updateNamedImports.md) +- [~~updateNamespaceExport~~](functions/updateNamespaceExport.md) +- [~~updateNamespaceExportDeclaration~~](functions/updateNamespaceExportDeclaration.md) +- [~~updateNamespaceImport~~](functions/updateNamespaceImport.md) +- [~~updateNew~~](functions/updateNew.md) +- [~~updateNonNullChain~~](functions/updateNonNullChain.md) +- [~~updateNonNullExpression~~](functions/updateNonNullExpression.md) +- [~~updateObjectBindingPattern~~](functions/updateObjectBindingPattern.md) +- [~~updateObjectLiteral~~](functions/updateObjectLiteral.md) +- [~~updateOptionalTypeNode~~](functions/updateOptionalTypeNode.md) +- [~~updateParameter~~](functions/updateParameter.md) +- [~~updateParen~~](functions/updateParen.md) +- [~~updateParenthesizedType~~](functions/updateParenthesizedType.md) +- [~~updatePartiallyEmittedExpression~~](functions/updatePartiallyEmittedExpression.md) +- [~~updatePostfix~~](functions/updatePostfix.md) +- [~~updatePrefix~~](functions/updatePrefix.md) +- [~~updateProperty~~](functions/updateProperty.md) +- [~~updatePropertyAccess~~](functions/updatePropertyAccess.md) +- [~~updatePropertyAccessChain~~](functions/updatePropertyAccessChain.md) +- [~~updatePropertyAssignment~~](functions/updatePropertyAssignment.md) +- [~~updatePropertySignature~~](functions/updatePropertySignature.md) +- [~~updateQualifiedName~~](functions/updateQualifiedName.md) +- [~~updateRestTypeNode~~](functions/updateRestTypeNode.md) +- [~~updateReturn~~](functions/updateReturn.md) +- [~~updateSetAccessor~~](functions/updateSetAccessor.md) +- [~~updateShorthandPropertyAssignment~~](functions/updateShorthandPropertyAssignment.md) +- [updateSourceFile](functions/updateSourceFile.md) +- [~~updateSourceFileNode~~](functions/updateSourceFileNode.md) +- [~~updateSpread~~](functions/updateSpread.md) +- [~~updateSpreadAssignment~~](functions/updateSpreadAssignment.md) +- [~~updateStatement~~](functions/updateStatement.md) +- [~~updateSwitch~~](functions/updateSwitch.md) +- [~~updateTaggedTemplate~~](functions/updateTaggedTemplate.md) +- [~~updateTemplateExpression~~](functions/updateTemplateExpression.md) +- [~~updateTemplateSpan~~](functions/updateTemplateSpan.md) +- [~~updateThrow~~](functions/updateThrow.md) +- [~~updateTry~~](functions/updateTry.md) +- [~~updateTupleTypeNode~~](functions/updateTupleTypeNode.md) +- [~~updateTypeAliasDeclaration~~](functions/updateTypeAliasDeclaration.md) +- [~~updateTypeAssertion~~](functions/updateTypeAssertion.md) +- [~~updateTypeLiteralNode~~](functions/updateTypeLiteralNode.md) +- [~~updateTypeOf~~](functions/updateTypeOf.md) +- [~~updateTypeOperatorNode~~](functions/updateTypeOperatorNode.md) +- [~~updateTypeParameterDeclaration~~](functions/updateTypeParameterDeclaration.md) +- [~~updateTypePredicateNode~~](functions/updateTypePredicateNode.md) +- [~~updateTypePredicateNodeWithModifier~~](functions/updateTypePredicateNodeWithModifier.md) +- [~~updateTypeQueryNode~~](functions/updateTypeQueryNode.md) +- [~~updateTypeReferenceNode~~](functions/updateTypeReferenceNode.md) +- [~~updateUnionTypeNode~~](functions/updateUnionTypeNode.md) +- [~~updateVariableDeclaration~~](functions/updateVariableDeclaration.md) +- [~~updateVariableDeclarationList~~](functions/updateVariableDeclarationList.md) +- [~~updateVariableStatement~~](functions/updateVariableStatement.md) +- [~~updateVoid~~](functions/updateVoid.md) +- [~~updateWhile~~](functions/updateWhile.md) +- [~~updateWith~~](functions/updateWith.md) +- [~~updateYield~~](functions/updateYield.md) +- [validateLocaleAndSetLanguage](functions/validateLocaleAndSetLanguage.md) +- [visitEachChild](functions/visitEachChild.md) +- [visitFunctionBody](functions/visitFunctionBody.md) +- [visitIterationBody](functions/visitIterationBody.md) +- [visitLexicalEnvironment](functions/visitLexicalEnvironment.md) +- [visitNode](functions/visitNode.md) +- [visitNodes](functions/visitNodes.md) +- [visitParameterList](functions/visitParameterList.md) +- [walkUpBindingElementsAndPatterns](functions/walkUpBindingElementsAndPatterns.md) diff --git a/docs/api_docs/namespaces/ts/classes/ArkTSLinterTimePrinter.md b/docs/api_docs/namespaces/ts/classes/ArkTSLinterTimePrinter.md new file mode 100644 index 0000000000000000000000000000000000000000..65ed7acc0880d4b893be289f9e69f36cdd83dffe --- /dev/null +++ b/docs/api_docs/namespaces/ts/classes/ArkTSLinterTimePrinter.md @@ -0,0 +1,81 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ArkTSLinterTimePrinter + +# Class: ArkTSLinterTimePrinter + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9784 + +## Methods + +### appendTime() + +> **appendTime**(`key`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9792 + +#### Parameters + +##### key + +`string` + +#### Returns + +`void` + +*** + +### printTimes() + +> **printTimes**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9794 + +#### Returns + +`void` + +*** + +### setArkTSTimePrintSwitch() + +> **setArkTSTimePrintSwitch**(`arkTSTimePrintSwitch`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9791 + +#### Parameters + +##### arkTSTimePrintSwitch + +`boolean` + +#### Returns + +`void` + +*** + +### destroyInstance() + +> `static` **destroyInstance**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9790 + +#### Returns + +`void` + +*** + +### getInstance() + +> `static` **getInstance**(): [`ArkTSLinterTimePrinter`](ArkTSLinterTimePrinter.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9789 + +#### Returns + +[`ArkTSLinterTimePrinter`](ArkTSLinterTimePrinter.md) diff --git a/docs/api_docs/namespaces/ts/classes/OperationCanceledException.md b/docs/api_docs/namespaces/ts/classes/OperationCanceledException.md new file mode 100644 index 0000000000000000000000000000000000000000..09bb70f4c75af9eca1f0b44af4f4b4ebbb0a1883 --- /dev/null +++ b/docs/api_docs/namespaces/ts/classes/OperationCanceledException.md @@ -0,0 +1,19 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / OperationCanceledException + +# Class: OperationCanceledException + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2258 + +## Constructors + +### new OperationCanceledException() + +> **new OperationCanceledException**(): [`OperationCanceledException`](OperationCanceledException.md) + +#### Returns + +[`OperationCanceledException`](OperationCanceledException.md) diff --git a/docs/api_docs/namespaces/ts/enumerations/ClassificationType.md b/docs/api_docs/namespaces/ts/enumerations/ClassificationType.md new file mode 100644 index 0000000000000000000000000000000000000000..37d510804c4a8e6c637b490c1076a18e3f7af2ba --- /dev/null +++ b/docs/api_docs/namespaces/ts/enumerations/ClassificationType.md @@ -0,0 +1,209 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ClassificationType + +# Enumeration: ClassificationType + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7275 + +## Enumeration Members + +### bigintLiteral + +> **bigintLiteral**: `25` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7300 + +*** + +### className + +> **className**: `11` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7286 + +*** + +### comment + +> **comment**: `1` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7276 + +*** + +### docCommentTagName + +> **docCommentTagName**: `18` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7293 + +*** + +### enumName + +> **enumName**: `12` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7287 + +*** + +### identifier + +> **identifier**: `2` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7277 + +*** + +### interfaceName + +> **interfaceName**: `13` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7288 + +*** + +### jsxAttribute + +> **jsxAttribute**: `22` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7297 + +*** + +### jsxAttributeStringLiteralValue + +> **jsxAttributeStringLiteralValue**: `24` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7299 + +*** + +### jsxCloseTagName + +> **jsxCloseTagName**: `20` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7295 + +*** + +### jsxOpenTagName + +> **jsxOpenTagName**: `19` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7294 + +*** + +### jsxSelfClosingTagName + +> **jsxSelfClosingTagName**: `21` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7296 + +*** + +### jsxText + +> **jsxText**: `23` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7298 + +*** + +### keyword + +> **keyword**: `3` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7278 + +*** + +### moduleName + +> **moduleName**: `14` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7289 + +*** + +### numericLiteral + +> **numericLiteral**: `4` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7279 + +*** + +### operator + +> **operator**: `5` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7280 + +*** + +### parameterName + +> **parameterName**: `17` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7292 + +*** + +### punctuation + +> **punctuation**: `10` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7285 + +*** + +### regularExpressionLiteral + +> **regularExpressionLiteral**: `7` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7282 + +*** + +### stringLiteral + +> **stringLiteral**: `6` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7281 + +*** + +### text + +> **text**: `9` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7284 + +*** + +### typeAliasName + +> **typeAliasName**: `16` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7291 + +*** + +### typeParameterName + +> **typeParameterName**: `15` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7290 + +*** + +### whiteSpace + +> **whiteSpace**: `8` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7283 diff --git a/docs/api_docs/namespaces/ts/enumerations/ClassificationTypeNames.md b/docs/api_docs/namespaces/ts/enumerations/ClassificationTypeNames.md new file mode 100644 index 0000000000000000000000000000000000000000..fe561dd0bd823d3b75da127bd396cbaca6c21e4e --- /dev/null +++ b/docs/api_docs/namespaces/ts/enumerations/ClassificationTypeNames.md @@ -0,0 +1,201 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ClassificationTypeNames + +# Enumeration: ClassificationTypeNames + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7249 + +## Enumeration Members + +### bigintLiteral + +> **bigintLiteral**: `"bigint"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7254 + +*** + +### className + +> **className**: `"class name"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7260 + +*** + +### comment + +> **comment**: `"comment"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7250 + +*** + +### docCommentTagName + +> **docCommentTagName**: `"doc comment tag name"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7267 + +*** + +### enumName + +> **enumName**: `"enum name"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7261 + +*** + +### identifier + +> **identifier**: `"identifier"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7251 + +*** + +### interfaceName + +> **interfaceName**: `"interface name"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7262 + +*** + +### jsxAttribute + +> **jsxAttribute**: `"jsx attribute"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7271 + +*** + +### jsxAttributeStringLiteralValue + +> **jsxAttributeStringLiteralValue**: `"jsx attribute string literal value"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7273 + +*** + +### jsxCloseTagName + +> **jsxCloseTagName**: `"jsx close tag name"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7269 + +*** + +### jsxOpenTagName + +> **jsxOpenTagName**: `"jsx open tag name"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7268 + +*** + +### jsxSelfClosingTagName + +> **jsxSelfClosingTagName**: `"jsx self closing tag name"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7270 + +*** + +### jsxText + +> **jsxText**: `"jsx text"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7272 + +*** + +### keyword + +> **keyword**: `"keyword"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7252 + +*** + +### moduleName + +> **moduleName**: `"module name"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7263 + +*** + +### numericLiteral + +> **numericLiteral**: `"number"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7253 + +*** + +### operator + +> **operator**: `"operator"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7255 + +*** + +### parameterName + +> **parameterName**: `"parameter name"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7266 + +*** + +### punctuation + +> **punctuation**: `"punctuation"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7259 + +*** + +### stringLiteral + +> **stringLiteral**: `"string"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7256 + +*** + +### text + +> **text**: `"text"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7258 + +*** + +### typeAliasName + +> **typeAliasName**: `"type alias name"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7265 + +*** + +### typeParameterName + +> **typeParameterName**: `"type parameter name"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7264 + +*** + +### whiteSpace + +> **whiteSpace**: `"whitespace"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7257 diff --git a/docs/api_docs/namespaces/ts/enumerations/CompletionInfoFlags.md b/docs/api_docs/namespaces/ts/enumerations/CompletionInfoFlags.md new file mode 100644 index 0000000000000000000000000000000000000000..a9d09fa74c1ec981c8561f13599c852b6de508fa --- /dev/null +++ b/docs/api_docs/namespaces/ts/enumerations/CompletionInfoFlags.md @@ -0,0 +1,65 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / CompletionInfoFlags + +# Enumeration: CompletionInfoFlags + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6953 + +## Enumeration Members + +### IsContinuation + +> **IsContinuation**: `4` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6957 + +*** + +### IsImportStatementCompletion + +> **IsImportStatementCompletion**: `2` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6956 + +*** + +### MayIncludeAutoImports + +> **MayIncludeAutoImports**: `1` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6955 + +*** + +### MayIncludeMethodSnippets + +> **MayIncludeMethodSnippets**: `32` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6960 + +*** + +### None + +> **None**: `0` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6954 + +*** + +### ResolvedModuleSpecifiers + +> **ResolvedModuleSpecifiers**: `8` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6958 + +*** + +### ResolvedModuleSpecifiersBeyondLimit + +> **ResolvedModuleSpecifiersBeyondLimit**: `16` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6959 diff --git a/docs/api_docs/namespaces/ts/enumerations/CompletionTriggerKind.md b/docs/api_docs/namespaces/ts/enumerations/CompletionTriggerKind.md new file mode 100644 index 0000000000000000000000000000000000000000..9e42a4a3eb93b77d88f0278f666b04c9578035af --- /dev/null +++ b/docs/api_docs/namespaces/ts/enumerations/CompletionTriggerKind.md @@ -0,0 +1,39 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / CompletionTriggerKind + +# Enumeration: CompletionTriggerKind + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6453 + +## Enumeration Members + +### Invoked + +> **Invoked**: `1` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6455 + +Completion was triggered by typing an identifier, manual invocation (e.g Ctrl+Space) or via API. + +*** + +### TriggerCharacter + +> **TriggerCharacter**: `2` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6457 + +Completion was triggered by a trigger character. + +*** + +### TriggerForIncompleteCompletions + +> **TriggerForIncompleteCompletions**: `3` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6459 + +Completion was re-triggered as the current completion list is incomplete. diff --git a/docs/api_docs/namespaces/ts/enumerations/DiagnosticCategory.md b/docs/api_docs/namespaces/ts/enumerations/DiagnosticCategory.md new file mode 100644 index 0000000000000000000000000000000000000000..4a7e7b7c36fa98d7b6891eb9c2556f25ad4b670b --- /dev/null +++ b/docs/api_docs/namespaces/ts/enumerations/DiagnosticCategory.md @@ -0,0 +1,41 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / DiagnosticCategory + +# Enumeration: DiagnosticCategory + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3014 + +## Enumeration Members + +### Error + +> **Error**: `1` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3016 + +*** + +### Message + +> **Message**: `3` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3018 + +*** + +### Suggestion + +> **Suggestion**: `2` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3017 + +*** + +### Warning + +> **Warning**: `0` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3015 diff --git a/docs/api_docs/namespaces/ts/enumerations/ElementFlags.md b/docs/api_docs/namespaces/ts/enumerations/ElementFlags.md new file mode 100644 index 0000000000000000000000000000000000000000..1f12ca6285095c77856ecf61d399034585811081 --- /dev/null +++ b/docs/api_docs/namespaces/ts/enumerations/ElementFlags.md @@ -0,0 +1,73 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ElementFlags + +# Enumeration: ElementFlags + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2852 + +## Enumeration Members + +### Fixed + +> **Fixed**: `3` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2857 + +*** + +### NonRequired + +> **NonRequired**: `14` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2859 + +*** + +### NonRest + +> **NonRest**: `11` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2860 + +*** + +### Optional + +> **Optional**: `2` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2854 + +*** + +### Required + +> **Required**: `1` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2853 + +*** + +### Rest + +> **Rest**: `4` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2855 + +*** + +### Variable + +> **Variable**: `12` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2858 + +*** + +### Variadic + +> **Variadic**: `8` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2856 diff --git a/docs/api_docs/namespaces/ts/enumerations/EmitFlags.md b/docs/api_docs/namespaces/ts/enumerations/EmitFlags.md new file mode 100644 index 0000000000000000000000000000000000000000..e4ffb2a99c37ef17b03bb4b8c0b319d78dfcb65a --- /dev/null +++ b/docs/api_docs/namespaces/ts/enumerations/EmitFlags.md @@ -0,0 +1,241 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / EmitFlags + +# Enumeration: EmitFlags + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3522 + +## Enumeration Members + +### AdviseOnEmitNode + +> **AdviseOnEmitNode**: `2` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3525 + +*** + +### AsyncFunctionBody + +> **AsyncFunctionBody**: `262144` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3545 + +*** + +### CapturesThis + +> **CapturesThis**: `8` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3527 + +*** + +### CustomPrologue + +> **CustomPrologue**: `1048576` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3547 + +*** + +### ExportName + +> **ExportName**: `8192` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3540 + +*** + +### HasEndOfDeclarationMarker + +> **HasEndOfDeclarationMarker**: `4194304` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3549 + +*** + +### HelperName + +> **HelperName**: `4096` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3539 + +*** + +### Indented + +> **Indented**: `65536` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3543 + +*** + +### InternalName + +> **InternalName**: `32768` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3542 + +*** + +### Iterator + +> **Iterator**: `8388608` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3550 + +*** + +### LocalName + +> **LocalName**: `16384` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3541 + +*** + +### NoAsciiEscaping + +> **NoAsciiEscaping**: `16777216` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3551 + +*** + +### NoComments + +> **NoComments**: `1536` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3537 + +*** + +### NoHoisting + +> **NoHoisting**: `2097152` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3548 + +*** + +### NoIndentation + +> **NoIndentation**: `131072` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3544 + +*** + +### NoLeadingComments + +> **NoLeadingComments**: `512` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3535 + +*** + +### NoLeadingSourceMap + +> **NoLeadingSourceMap**: `16` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3528 + +*** + +### None + +> **None**: `0` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3523 + +*** + +### NoNestedComments + +> **NoNestedComments**: `2048` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3538 + +*** + +### NoNestedSourceMaps + +> **NoNestedSourceMaps**: `64` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3531 + +*** + +### NoSourceMap + +> **NoSourceMap**: `48` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3530 + +*** + +### NoSubstitution + +> **NoSubstitution**: `4` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3526 + +*** + +### NoTokenLeadingSourceMaps + +> **NoTokenLeadingSourceMaps**: `128` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3532 + +*** + +### NoTokenSourceMaps + +> **NoTokenSourceMaps**: `384` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3534 + +*** + +### NoTokenTrailingSourceMaps + +> **NoTokenTrailingSourceMaps**: `256` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3533 + +*** + +### NoTrailingComments + +> **NoTrailingComments**: `1024` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3536 + +*** + +### NoTrailingSourceMap + +> **NoTrailingSourceMap**: `32` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3529 + +*** + +### ReuseTempVariableScope + +> **ReuseTempVariableScope**: `524288` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3546 + +*** + +### SingleLine + +> **SingleLine**: `1` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3524 diff --git a/docs/api_docs/namespaces/ts/enumerations/EmitHint.md b/docs/api_docs/namespaces/ts/enumerations/EmitHint.md new file mode 100644 index 0000000000000000000000000000000000000000..f84a01d1246fdc21f7e505e6e531a25c6549d4b1 --- /dev/null +++ b/docs/api_docs/namespaces/ts/enumerations/EmitHint.md @@ -0,0 +1,65 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / EmitHint + +# Enumeration: EmitHint + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3569 + +## Enumeration Members + +### EmbeddedStatement + +> **EmbeddedStatement**: `5` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3575 + +*** + +### Expression + +> **Expression**: `1` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3571 + +*** + +### IdentifierName + +> **IdentifierName**: `2` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3572 + +*** + +### JsxAttributeValue + +> **JsxAttributeValue**: `6` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3576 + +*** + +### MappedTypeParameter + +> **MappedTypeParameter**: `3` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3573 + +*** + +### SourceFile + +> **SourceFile**: `0` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3570 + +*** + +### Unspecified + +> **Unspecified**: `4` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3574 diff --git a/docs/api_docs/namespaces/ts/enumerations/EndOfLineState.md b/docs/api_docs/namespaces/ts/enumerations/EndOfLineState.md new file mode 100644 index 0000000000000000000000000000000000000000..6627d902e5578612e397ed3464e5614188d69f79 --- /dev/null +++ b/docs/api_docs/namespaces/ts/enumerations/EndOfLineState.md @@ -0,0 +1,65 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / EndOfLineState + +# Enumeration: EndOfLineState + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7087 + +## Enumeration Members + +### InDoubleQuoteStringLiteral + +> **InDoubleQuoteStringLiteral**: `3` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7091 + +*** + +### InMultiLineCommentTrivia + +> **InMultiLineCommentTrivia**: `1` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7089 + +*** + +### InSingleQuoteStringLiteral + +> **InSingleQuoteStringLiteral**: `2` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7090 + +*** + +### InTemplateHeadOrNoSubstitutionTemplate + +> **InTemplateHeadOrNoSubstitutionTemplate**: `4` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7092 + +*** + +### InTemplateMiddleOrTail + +> **InTemplateMiddleOrTail**: `5` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7093 + +*** + +### InTemplateSubstitutionPosition + +> **InTemplateSubstitutionPosition**: `6` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7094 + +*** + +### None + +> **None**: `0` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7088 diff --git a/docs/api_docs/namespaces/ts/enumerations/EtsFlags.md b/docs/api_docs/namespaces/ts/enumerations/EtsFlags.md new file mode 100644 index 0000000000000000000000000000000000000000..9dc9986ef2e879b2013fb8ae1503c9985937fb34 --- /dev/null +++ b/docs/api_docs/namespaces/ts/enumerations/EtsFlags.md @@ -0,0 +1,97 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / EtsFlags + +# Enumeration: EtsFlags + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:547 + +## Enumeration Members + +### EtsBuildContext + +> **EtsBuildContext**: `16` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:552 + +*** + +### EtsBuilderContext + +> **EtsBuilderContext**: `32` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:553 + +*** + +### EtsComponentsContext + +> **EtsComponentsContext**: `128` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:555 + +*** + +### EtsExtendComponentsContext + +> **EtsExtendComponentsContext**: `4` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:550 + +*** + +### EtsNewExpressionContext + +> **EtsNewExpressionContext**: `256` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:556 + +*** + +### EtsStateStylesContext + +> **EtsStateStylesContext**: `64` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:554 + +*** + +### EtsStylesComponentsContext + +> **EtsStylesComponentsContext**: `8` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:551 + +*** + +### None + +> **None**: `0` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:548 + +*** + +### StructContext + +> **StructContext**: `2` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:549 + +*** + +### SyntaxComponentContext + +> **SyntaxComponentContext**: `1024` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:558 + +*** + +### UICallbackContext + +> **UICallbackContext**: `512` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:557 diff --git a/docs/api_docs/namespaces/ts/enumerations/ExitStatus.md b/docs/api_docs/namespaces/ts/enumerations/ExitStatus.md new file mode 100644 index 0000000000000000000000000000000000000000..5a528826ebe964b1bf05e6cd66c321bbad49ad6d --- /dev/null +++ b/docs/api_docs/namespaces/ts/enumerations/ExitStatus.md @@ -0,0 +1,63 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ExitStatus + +# Enumeration: ExitStatus + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2369 + +Return code used by getEmitOutput function to indicate status of the function + +## Enumeration Members + +### DiagnosticsPresent\_OutputsGenerated + +> **DiagnosticsPresent\_OutputsGenerated**: `2` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2372 + +*** + +### DiagnosticsPresent\_OutputsSkipped + +> **DiagnosticsPresent\_OutputsSkipped**: `1` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2371 + +*** + +### InvalidProject\_OutputsSkipped + +> **InvalidProject\_OutputsSkipped**: `3` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2373 + +*** + +### ProjectReferenceCycle\_OutputsSkipped + +> **ProjectReferenceCycle\_OutputsSkipped**: `4` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2374 + +*** + +### ~~ProjectReferenceCycle\_OutputsSkupped~~ + +> **ProjectReferenceCycle\_OutputsSkupped**: `4` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2376 + +#### Deprecated + +Use ProjectReferenceCycle_OutputsSkipped instead. + +*** + +### Success + +> **Success**: `0` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2370 diff --git a/docs/api_docs/namespaces/ts/enumerations/Extension.md b/docs/api_docs/namespaces/ts/enumerations/Extension.md new file mode 100644 index 0000000000000000000000000000000000000000..2a280306eff41ab485a836cffad5185edaf7032e --- /dev/null +++ b/docs/api_docs/namespaces/ts/enumerations/Extension.md @@ -0,0 +1,129 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / Extension + +# Enumeration: Extension + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3408 + +## Enumeration Members + +### Cjs + +> **Cjs**: `".cjs"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3419 + +*** + +### Cts + +> **Cts**: `".cts"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3420 + +*** + +### Dcts + +> **Dcts**: `".d.cts"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3421 + +*** + +### Dets + +> **Dets**: `".d.ets"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3423 + +*** + +### Dmts + +> **Dmts**: `".d.mts"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3418 + +*** + +### Dts + +> **Dts**: `".d.ts"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3411 + +*** + +### Ets + +> **Ets**: `".ets"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3422 + +*** + +### Js + +> **Js**: `".js"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3412 + +*** + +### Json + +> **Json**: `".json"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3414 + +*** + +### Jsx + +> **Jsx**: `".jsx"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3413 + +*** + +### Mjs + +> **Mjs**: `".mjs"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3416 + +*** + +### Mts + +> **Mts**: `".mts"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3417 + +*** + +### Ts + +> **Ts**: `".ts"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3409 + +*** + +### TsBuildInfo + +> **TsBuildInfo**: `".tsbuildinfo"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3415 + +*** + +### Tsx + +> **Tsx**: `".tsx"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3410 diff --git a/docs/api_docs/namespaces/ts/enumerations/FileWatcherEventKind.md b/docs/api_docs/namespaces/ts/enumerations/FileWatcherEventKind.md new file mode 100644 index 0000000000000000000000000000000000000000..c4af2da50902275ab9fa50d7238f01efce3a502a --- /dev/null +++ b/docs/api_docs/namespaces/ts/enumerations/FileWatcherEventKind.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / FileWatcherEventKind + +# Enumeration: FileWatcherEventKind + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4516 + +## Enumeration Members + +### Changed + +> **Changed**: `1` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4518 + +*** + +### Created + +> **Created**: `0` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4517 + +*** + +### Deleted + +> **Deleted**: `2` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4519 diff --git a/docs/api_docs/namespaces/ts/enumerations/FlowFlags.md b/docs/api_docs/namespaces/ts/enumerations/FlowFlags.md new file mode 100644 index 0000000000000000000000000000000000000000..6c0d6ba39ad03101de8b9f8a75660a5f1826dc19 --- /dev/null +++ b/docs/api_docs/namespaces/ts/enumerations/FlowFlags.md @@ -0,0 +1,129 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / FlowFlags + +# Enumeration: FlowFlags + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2045 + +## Enumeration Members + +### ArrayMutation + +> **ArrayMutation**: `256` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2054 + +*** + +### Assignment + +> **Assignment**: `16` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2050 + +*** + +### BranchLabel + +> **BranchLabel**: `4` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2048 + +*** + +### Call + +> **Call**: `512` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2055 + +*** + +### Condition + +> **Condition**: `96` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2060 + +*** + +### FalseCondition + +> **FalseCondition**: `64` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2052 + +*** + +### Label + +> **Label**: `12` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2059 + +*** + +### LoopLabel + +> **LoopLabel**: `8` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2049 + +*** + +### ReduceLabel + +> **ReduceLabel**: `1024` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2056 + +*** + +### Referenced + +> **Referenced**: `2048` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2057 + +*** + +### Shared + +> **Shared**: `4096` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2058 + +*** + +### Start + +> **Start**: `2` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2047 + +*** + +### SwitchClause + +> **SwitchClause**: `128` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2053 + +*** + +### TrueCondition + +> **TrueCondition**: `32` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2051 + +*** + +### Unreachable + +> **Unreachable**: `1` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2046 diff --git a/docs/api_docs/namespaces/ts/enumerations/GeneratedIdentifierFlags.md b/docs/api_docs/namespaces/ts/enumerations/GeneratedIdentifierFlags.md new file mode 100644 index 0000000000000000000000000000000000000000..1dc4de6b885c305aacbe0e360cc9fc7dd26cad29 --- /dev/null +++ b/docs/api_docs/namespaces/ts/enumerations/GeneratedIdentifierFlags.md @@ -0,0 +1,49 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / GeneratedIdentifierFlags + +# Enumeration: GeneratedIdentifierFlags + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:669 + +## Enumeration Members + +### AllowNameSubstitution + +> **AllowNameSubstitution**: `64` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:674 + +*** + +### FileLevel + +> **FileLevel**: `32` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:673 + +*** + +### None + +> **None**: `0` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:670 + +*** + +### Optimistic + +> **Optimistic**: `16` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:672 + +*** + +### ReservedInNestedScopes + +> **ReservedInNestedScopes**: `8` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:671 diff --git a/docs/api_docs/namespaces/ts/enumerations/HighlightSpanKind.md b/docs/api_docs/namespaces/ts/enumerations/HighlightSpanKind.md new file mode 100644 index 0000000000000000000000000000000000000000..ed50f48181d364f6ded7eac5fe9b1f3f1622883f --- /dev/null +++ b/docs/api_docs/namespaces/ts/enumerations/HighlightSpanKind.md @@ -0,0 +1,41 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / HighlightSpanKind + +# Enumeration: HighlightSpanKind + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6728 + +## Enumeration Members + +### definition + +> **definition**: `"definition"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6730 + +*** + +### none + +> **none**: `"none"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6729 + +*** + +### reference + +> **reference**: `"reference"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6731 + +*** + +### writtenReference + +> **writtenReference**: `"writtenReference"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6732 diff --git a/docs/api_docs/namespaces/ts/enumerations/ImportsNotUsedAsValues.md b/docs/api_docs/namespaces/ts/enumerations/ImportsNotUsedAsValues.md new file mode 100644 index 0000000000000000000000000000000000000000..5f03b7702c25b8a2526612e426d88d28f101d6cc --- /dev/null +++ b/docs/api_docs/namespaces/ts/enumerations/ImportsNotUsedAsValues.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ImportsNotUsedAsValues + +# Enumeration: ImportsNotUsedAsValues + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3267 + +## Enumeration Members + +### Error + +> **Error**: `2` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3270 + +*** + +### Preserve + +> **Preserve**: `1` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3269 + +*** + +### Remove + +> **Remove**: `0` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3268 diff --git a/docs/api_docs/namespaces/ts/enumerations/IndentStyle.md b/docs/api_docs/namespaces/ts/enumerations/IndentStyle.md new file mode 100644 index 0000000000000000000000000000000000000000..4b9c35daa5526e77e64a3cb8c6bb2141bd26d9f0 --- /dev/null +++ b/docs/api_docs/namespaces/ts/enumerations/IndentStyle.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / IndentStyle + +# Enumeration: IndentStyle + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6752 + +## Enumeration Members + +### Block + +> **Block**: `1` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6754 + +*** + +### None + +> **None**: `0` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6753 + +*** + +### Smart + +> **Smart**: `2` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6755 diff --git a/docs/api_docs/namespaces/ts/enumerations/IndexKind.md b/docs/api_docs/namespaces/ts/enumerations/IndexKind.md new file mode 100644 index 0000000000000000000000000000000000000000..5ec5fbcb304d50cb7daad9c74c8726550a8f04eb --- /dev/null +++ b/docs/api_docs/namespaces/ts/enumerations/IndexKind.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / IndexKind + +# Enumeration: IndexKind + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2941 + +## Enumeration Members + +### Number + +> **Number**: `1` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2943 + +*** + +### String + +> **String**: `0` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2942 diff --git a/docs/api_docs/namespaces/ts/enumerations/InferencePriority.md b/docs/api_docs/namespaces/ts/enumerations/InferencePriority.md new file mode 100644 index 0000000000000000000000000000000000000000..b17d17fa39e34c0fec6f15920523ba5a39c7b889 --- /dev/null +++ b/docs/api_docs/namespaces/ts/enumerations/InferencePriority.md @@ -0,0 +1,121 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / InferencePriority + +# Enumeration: InferencePriority + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2951 + +## Enumeration Members + +### AlwaysStrict + +> **AlwaysStrict**: `1024` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2962 + +*** + +### Circularity + +> **Circularity**: `-1` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2965 + +*** + +### ContravariantConditional + +> **ContravariantConditional**: `64` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2958 + +*** + +### HomomorphicMappedType + +> **HomomorphicMappedType**: `8` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2955 + +*** + +### LiteralKeyof + +> **LiteralKeyof**: `256` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2960 + +*** + +### MappedTypeConstraint + +> **MappedTypeConstraint**: `32` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2957 + +*** + +### MaxValue + +> **MaxValue**: `2048` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2963 + +*** + +### NakedTypeVariable + +> **NakedTypeVariable**: `1` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2952 + +*** + +### NoConstraints + +> **NoConstraints**: `512` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2961 + +*** + +### PartialHomomorphicMappedType + +> **PartialHomomorphicMappedType**: `16` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2956 + +*** + +### PriorityImpliesCombination + +> **PriorityImpliesCombination**: `416` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2964 + +*** + +### ReturnType + +> **ReturnType**: `128` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2959 + +*** + +### SpeculativeTuple + +> **SpeculativeTuple**: `2` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2953 + +*** + +### SubstituteSource + +> **SubstituteSource**: `4` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2954 diff --git a/docs/api_docs/namespaces/ts/enumerations/InlayHintKind.md b/docs/api_docs/namespaces/ts/enumerations/InlayHintKind.md new file mode 100644 index 0000000000000000000000000000000000000000..64901ce0a00299d297c1ab2bd775251f276a1aff --- /dev/null +++ b/docs/api_docs/namespaces/ts/enumerations/InlayHintKind.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / InlayHintKind + +# Enumeration: InlayHintKind + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6578 + +## Enumeration Members + +### Enum + +> **Enum**: `"Enum"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6581 + +*** + +### Parameter + +> **Parameter**: `"Parameter"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6580 + +*** + +### Type + +> **Type**: `"Type"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6579 diff --git a/docs/api_docs/namespaces/ts/enumerations/InternalSymbolName.md b/docs/api_docs/namespaces/ts/enumerations/InternalSymbolName.md new file mode 100644 index 0000000000000000000000000000000000000000..2057196d0ab3a0cb8c86f2f641275e08ae53e765 --- /dev/null +++ b/docs/api_docs/namespaces/ts/enumerations/InternalSymbolName.md @@ -0,0 +1,145 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / InternalSymbolName + +# Enumeration: InternalSymbolName + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2678 + +## Enumeration Members + +### Call + +> **Call**: `"__call"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2679 + +*** + +### Class + +> **Class**: `"__class"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2689 + +*** + +### Computed + +> **Computed**: `"__computed"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2691 + +*** + +### Constructor + +> **Constructor**: `"__constructor"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2680 + +*** + +### Default + +> **Default**: `"default"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2694 + +*** + +### ExportEquals + +> **ExportEquals**: `"export="` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2693 + +*** + +### ExportStar + +> **ExportStar**: `"__export"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2683 + +*** + +### Function + +> **Function**: `"__function"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2690 + +*** + +### Global + +> **Global**: `"__global"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2684 + +*** + +### Index + +> **Index**: `"__index"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2682 + +*** + +### JSXAttributes + +> **JSXAttributes**: `"__jsxAttributes"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2688 + +*** + +### Missing + +> **Missing**: `"__missing"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2685 + +*** + +### New + +> **New**: `"__new"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2681 + +*** + +### Object + +> **Object**: `"__object"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2687 + +*** + +### Resolving + +> **Resolving**: `"__resolving__"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2692 + +*** + +### This + +> **This**: `"this"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2695 + +*** + +### Type + +> **Type**: `"__type"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2686 diff --git a/docs/api_docs/namespaces/ts/enumerations/InvalidatedProjectKind.md b/docs/api_docs/namespaces/ts/enumerations/InvalidatedProjectKind.md new file mode 100644 index 0000000000000000000000000000000000000000..f91684a84a31b4a836d81cef6ebe34dc9f45e459 --- /dev/null +++ b/docs/api_docs/namespaces/ts/enumerations/InvalidatedProjectKind.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / InvalidatedProjectKind + +# Enumeration: InvalidatedProjectKind + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5971 + +## Enumeration Members + +### Build + +> **Build**: `0` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5972 + +*** + +### UpdateBundle + +> **UpdateBundle**: `1` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5973 + +*** + +### UpdateOutputFileStamps + +> **UpdateOutputFileStamps**: `2` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5974 diff --git a/docs/api_docs/namespaces/ts/enumerations/JsxEmit.md b/docs/api_docs/namespaces/ts/enumerations/JsxEmit.md new file mode 100644 index 0000000000000000000000000000000000000000..ce5c2f89176bd5157fd48b242c04aab584d72aa1 --- /dev/null +++ b/docs/api_docs/namespaces/ts/enumerations/JsxEmit.md @@ -0,0 +1,57 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JsxEmit + +# Enumeration: JsxEmit + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3259 + +## Enumeration Members + +### None + +> **None**: `0` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3260 + +*** + +### Preserve + +> **Preserve**: `1` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3261 + +*** + +### React + +> **React**: `2` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3262 + +*** + +### ReactJSX + +> **ReactJSX**: `4` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3264 + +*** + +### ReactJSXDev + +> **ReactJSXDev**: `5` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3265 + +*** + +### ReactNative + +> **ReactNative**: `3` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3263 diff --git a/docs/api_docs/namespaces/ts/enumerations/JsxFlags.md b/docs/api_docs/namespaces/ts/enumerations/JsxFlags.md new file mode 100644 index 0000000000000000000000000000000000000000..fecef0b0b169c8533cac3d3a9a874e2aae7acde3 --- /dev/null +++ b/docs/api_docs/namespaces/ts/enumerations/JsxFlags.md @@ -0,0 +1,45 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JsxFlags + +# Enumeration: JsxFlags + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:589 + +## Enumeration Members + +### IntrinsicElement + +> **IntrinsicElement**: `3` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:595 + +*** + +### IntrinsicIndexedElement + +> **IntrinsicIndexedElement**: `2` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:594 + +An element inferred from the string index signature of the JSX.IntrinsicElements interface + +*** + +### IntrinsicNamedElement + +> **IntrinsicNamedElement**: `1` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:592 + +An element from a named property of the JSX.IntrinsicElements interface + +*** + +### None + +> **None**: `0` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:590 diff --git a/docs/api_docs/namespaces/ts/enumerations/LanguageServiceMode.md b/docs/api_docs/namespaces/ts/enumerations/LanguageServiceMode.md new file mode 100644 index 0000000000000000000000000000000000000000..02cd5f3ad849703b09fccb793b4687b9ef1dd6e5 --- /dev/null +++ b/docs/api_docs/namespaces/ts/enumerations/LanguageServiceMode.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / LanguageServiceMode + +# Enumeration: LanguageServiceMode + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6212 + +## Enumeration Members + +### PartialSemantic + +> **PartialSemantic**: `1` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6214 + +*** + +### Semantic + +> **Semantic**: `0` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6213 + +*** + +### Syntactic + +> **Syntactic**: `2` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6215 diff --git a/docs/api_docs/namespaces/ts/enumerations/LanguageVariant.md b/docs/api_docs/namespaces/ts/enumerations/LanguageVariant.md new file mode 100644 index 0000000000000000000000000000000000000000..01b9cb80d4e4b3f98a1bb24bd01159f27a69c135 --- /dev/null +++ b/docs/api_docs/namespaces/ts/enumerations/LanguageVariant.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / LanguageVariant + +# Enumeration: LanguageVariant + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3311 + +## Enumeration Members + +### JSX + +> **JSX**: `1` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3313 + +*** + +### Standard + +> **Standard**: `0` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3312 diff --git a/docs/api_docs/namespaces/ts/enumerations/ListFormat.md b/docs/api_docs/namespaces/ts/enumerations/ListFormat.md new file mode 100644 index 0000000000000000000000000000000000000000..4a3455f53f177d6aa5e3732e8f2c9eb353763595 --- /dev/null +++ b/docs/api_docs/namespaces/ts/enumerations/ListFormat.md @@ -0,0 +1,553 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ListFormat + +# Enumeration: ListFormat + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4405 + +## Enumeration Members + +### AllowTrailingComma + +> **AllowTrailingComma**: `64` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4417 + +*** + +### AmpersandDelimited + +> **AmpersandDelimited**: `8` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4413 + +*** + +### AngleBrackets + +> **AngleBrackets**: `4096` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4423 + +*** + +### ArrayBindingPatternElements + +> **ArrayBindingPatternElements**: `524880` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4444 + +*** + +### ArrayLiteralExpressionElements + +> **ArrayLiteralExpressionElements**: `8914` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4447 + +*** + +### AsteriskDelimited + +> **AsteriskDelimited**: `32` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4415 + +*** + +### BarDelimited + +> **BarDelimited**: `4` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4412 + +*** + +### Braces + +> **Braces**: `1024` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4421 + +*** + +### BracketsMask + +> **BracketsMask**: `15360` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4425 + +*** + +### CallExpressionArguments + +> **CallExpressionArguments**: `2576` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4449 + +*** + +### CaseBlockClauses + +> **CaseBlockClauses**: `129` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4461 + +*** + +### CaseOrDefaultClauseStatements + +> **CaseOrDefaultClauseStatements**: `163969` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4465 + +*** + +### ClassHeritageClauses + +> **ClassHeritageClauses**: `0` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4457 + +*** + +### ClassMembers + +> **ClassMembers**: `129` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4458 + +*** + +### CommaDelimited + +> **CommaDelimited**: `16` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4414 + +*** + +### CommaListElements + +> **CommaListElements**: `528` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4448 + +*** + +### Decorators + +> **Decorators**: `2146305` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4468 + +*** + +### DelimitersMask + +> **DelimitersMask**: `60` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4416 + +*** + +### EnumMembers + +> **EnumMembers**: `145` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4460 + +*** + +### HeritageClauses + +> **HeritageClauses**: `512` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4436 + +*** + +### HeritageClauseTypes + +> **HeritageClauseTypes**: `528` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4466 + +*** + +### ImportClauseEntries + +> **ImportClauseEntries**: `526226` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4446 + +*** + +### Indented + +> **Indented**: `128` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4418 + +*** + +### IndexSignatureParameters + +> **IndexSignatureParameters**: `8848` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4472 + +*** + +### InterfaceMembers + +> **InterfaceMembers**: `129` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4459 + +*** + +### IntersectionTypeConstituents + +> **IntersectionTypeConstituents**: `520` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4442 + +*** + +### JSDocComment + +> **JSDocComment**: `33` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4473 + +*** + +### JsxElementAttributes + +> **JsxElementAttributes**: `262656` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4464 + +*** + +### JsxElementOrFragmentChildren + +> **JsxElementOrFragmentChildren**: `262144` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4463 + +*** + +### LinesMask + +> **LinesMask**: `3` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4410 + +*** + +### Modifiers + +> **Modifiers**: `2359808` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4435 + +*** + +### MultiLine + +> **MultiLine**: `1` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4408 + +*** + +### MultiLineBlockStatements + +> **MultiLineBlockStatements**: `129` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4453 + +*** + +### MultiLineFunctionBodyStatements + +> **MultiLineFunctionBodyStatements**: `1` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4456 + +*** + +### MultiLineTupleTypeElements + +> **MultiLineTupleTypeElements**: `657` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4440 + +*** + +### MultiLineTypeLiteralMembers + +> **MultiLineTypeLiteralMembers**: `32897` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4438 + +*** + +### NamedImportsOrExportsElements + +> **NamedImportsOrExportsElements**: `525136` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4462 + +*** + +### NewExpressionArguments + +> **NewExpressionArguments**: `18960` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4450 + +*** + +### NoInterveningComments + +> **NoInterveningComments**: `262144` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4431 + +*** + +### None + +> **None**: `0` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4406 + +*** + +### NoSpaceIfEmpty + +> **NoSpaceIfEmpty**: `524288` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4432 + +*** + +### NotDelimited + +> **NotDelimited**: `0` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4411 + +*** + +### NoTrailingNewLine + +> **NoTrailingNewLine**: `131072` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4430 + +*** + +### ObjectBindingPatternElements + +> **ObjectBindingPatternElements**: `525136` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4443 + +*** + +### ObjectLiteralExpressionProperties + +> **ObjectLiteralExpressionProperties**: `526226` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4445 + +*** + +### Optional + +> **Optional**: `49152` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4428 + +*** + +### OptionalIfEmpty + +> **OptionalIfEmpty**: `32768` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4427 + +*** + +### OptionalIfUndefined + +> **OptionalIfUndefined**: `16384` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4426 + +*** + +### Parameters + +> **Parameters**: `2576` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4471 + +*** + +### Parenthesis + +> **Parenthesis**: `2048` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4422 + +*** + +### PreferNewLine + +> **PreferNewLine**: `65536` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4429 + +*** + +### PreserveLines + +> **PreserveLines**: `2` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4409 + +*** + +### SingleElement + +> **SingleElement**: `1048576` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4433 + +*** + +### SingleLine + +> **SingleLine**: `0` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4407 + +*** + +### SingleLineBlockStatements + +> **SingleLineBlockStatements**: `768` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4452 + +*** + +### SingleLineFunctionBodyStatements + +> **SingleLineFunctionBodyStatements**: `768` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4455 + +*** + +### SingleLineTupleTypeElements + +> **SingleLineTupleTypeElements**: `528` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4439 + +*** + +### SingleLineTypeLiteralMembers + +> **SingleLineTypeLiteralMembers**: `768` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4437 + +*** + +### SourceFileStatements + +> **SourceFileStatements**: `131073` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4467 + +*** + +### SpaceAfterList + +> **SpaceAfterList**: `2097152` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4434 + +*** + +### SpaceBetweenBraces + +> **SpaceBetweenBraces**: `256` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4419 + +*** + +### SpaceBetweenSiblings + +> **SpaceBetweenSiblings**: `512` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4420 + +*** + +### SquareBrackets + +> **SquareBrackets**: `8192` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4424 + +*** + +### TemplateExpressionSpans + +> **TemplateExpressionSpans**: `262144` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4451 + +*** + +### TypeArguments + +> **TypeArguments**: `53776` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4469 + +*** + +### TypeParameters + +> **TypeParameters**: `53776` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4470 + +*** + +### UnionTypeConstituents + +> **UnionTypeConstituents**: `516` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4441 + +*** + +### VariableDeclarationList + +> **VariableDeclarationList**: `528` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4454 diff --git a/docs/api_docs/namespaces/ts/enumerations/ModifierFlags.md b/docs/api_docs/namespaces/ts/enumerations/ModifierFlags.md new file mode 100644 index 0000000000000000000000000000000000000000..9a2c9938f1f6066382fa94706fcda8c4bc7eef52 --- /dev/null +++ b/docs/api_docs/namespaces/ts/enumerations/ModifierFlags.md @@ -0,0 +1,225 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ModifierFlags + +# Enumeration: ModifierFlags + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:560 + +## Enumeration Members + +### Abstract + +> **Abstract**: `256` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:570 + +*** + +### AccessibilityModifier + +> **AccessibilityModifier**: `28` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:581 + +*** + +### Accessor + +> **Accessor**: `128` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:569 + +*** + +### All + +> **All**: `258047` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:586 + +*** + +### Ambient + +> **Ambient**: `2` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:563 + +*** + +### Async + +> **Async**: `512` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:571 + +*** + +### Const + +> **Const**: `2048` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:573 + +*** + +### Decorator + +> **Decorator**: `131072` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:579 + +*** + +### Default + +> **Default**: `1024` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:572 + +*** + +### Deprecated + +> **Deprecated**: `8192` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:575 + +*** + +### Export + +> **Export**: `1` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:562 + +*** + +### ExportDefault + +> **ExportDefault**: `1025` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:585 + +*** + +### HasComputedFlags + +> **HasComputedFlags**: `536870912` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:580 + +*** + +### HasComputedJSDocModifiers + +> **HasComputedJSDocModifiers**: `4096` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:574 + +*** + +### In + +> **In**: `32768` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:577 + +*** + +### Modifier + +> **Modifier**: `126975` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:587 + +*** + +### None + +> **None**: `0` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:561 + +*** + +### NonPublicAccessibilityModifier + +> **NonPublicAccessibilityModifier**: `24` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:583 + +*** + +### Out + +> **Out**: `65536` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:578 + +*** + +### Override + +> **Override**: `16384` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:576 + +*** + +### ParameterPropertyModifier + +> **ParameterPropertyModifier**: `16476` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:582 + +*** + +### Private + +> **Private**: `8` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:565 + +*** + +### Protected + +> **Protected**: `16` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:566 + +*** + +### Public + +> **Public**: `4` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:564 + +*** + +### Readonly + +> **Readonly**: `64` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:568 + +*** + +### Static + +> **Static**: `32` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:567 + +*** + +### TypeScriptModifier + +> **TypeScriptModifier**: `117086` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:584 diff --git a/docs/api_docs/namespaces/ts/enumerations/ModuleDetectionKind.md b/docs/api_docs/namespaces/ts/enumerations/ModuleDetectionKind.md new file mode 100644 index 0000000000000000000000000000000000000000..74d9b8d37f2536f1ee8317f2bc0ed2cd9d417719 --- /dev/null +++ b/docs/api_docs/namespaces/ts/enumerations/ModuleDetectionKind.md @@ -0,0 +1,39 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ModuleDetectionKind + +# Enumeration: ModuleDetectionKind + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3026 + +## Enumeration Members + +### Auto + +> **Auto**: `2` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3034 + +Legacy, but also files with jsx under react-jsx or react-jsxdev and esm mode files under moduleResolution: node16+ + +*** + +### Force + +> **Force**: `3` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3038 + +Consider all non-declaration files modules, regardless of present syntax + +*** + +### Legacy + +> **Legacy**: `1` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3030 + +Files with imports, exports and/or import.meta are considered modules diff --git a/docs/api_docs/namespaces/ts/enumerations/ModuleKind.md b/docs/api_docs/namespaces/ts/enumerations/ModuleKind.md new file mode 100644 index 0000000000000000000000000000000000000000..3d95ee194e9d9162dc44f259192d09b436e3d51a --- /dev/null +++ b/docs/api_docs/namespaces/ts/enumerations/ModuleKind.md @@ -0,0 +1,97 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ModuleKind + +# Enumeration: ModuleKind + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3246 + +## Enumeration Members + +### AMD + +> **AMD**: `2` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3249 + +*** + +### CommonJS + +> **CommonJS**: `1` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3248 + +*** + +### ES2015 + +> **ES2015**: `5` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3252 + +*** + +### ES2020 + +> **ES2020**: `6` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3253 + +*** + +### ES2022 + +> **ES2022**: `7` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3254 + +*** + +### ESNext + +> **ESNext**: `99` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3255 + +*** + +### Node16 + +> **Node16**: `100` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3256 + +*** + +### NodeNext + +> **NodeNext**: `199` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3257 + +*** + +### None + +> **None**: `0` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3247 + +*** + +### System + +> **System**: `4` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3251 + +*** + +### UMD + +> **UMD**: `3` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3250 diff --git a/docs/api_docs/namespaces/ts/enumerations/ModuleResolutionKind.md b/docs/api_docs/namespaces/ts/enumerations/ModuleResolutionKind.md new file mode 100644 index 0000000000000000000000000000000000000000..6d6aeed6d1f74d73cd1f054f85a6d2e40ab13adb --- /dev/null +++ b/docs/api_docs/namespaces/ts/enumerations/ModuleResolutionKind.md @@ -0,0 +1,41 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ModuleResolutionKind + +# Enumeration: ModuleResolutionKind + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3020 + +## Enumeration Members + +### Classic + +> **Classic**: `1` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3021 + +*** + +### Node16 + +> **Node16**: `3` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3023 + +*** + +### NodeJs + +> **NodeJs**: `2` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3022 + +*** + +### NodeNext + +> **NodeNext**: `99` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3024 diff --git a/docs/api_docs/namespaces/ts/enumerations/NewLineKind.md b/docs/api_docs/namespaces/ts/enumerations/NewLineKind.md new file mode 100644 index 0000000000000000000000000000000000000000..85f754c184746b7377d61312bd8a7750d9e6821d --- /dev/null +++ b/docs/api_docs/namespaces/ts/enumerations/NewLineKind.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / NewLineKind + +# Enumeration: NewLineKind + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3272 + +## Enumeration Members + +### CarriageReturnLineFeed + +> **CarriageReturnLineFeed**: `0` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3273 + +*** + +### LineFeed + +> **LineFeed**: `1` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3274 diff --git a/docs/api_docs/namespaces/ts/enumerations/NodeBuilderFlags.md b/docs/api_docs/namespaces/ts/enumerations/NodeBuilderFlags.md new file mode 100644 index 0000000000000000000000000000000000000000..b2693793acc9af886570420f169d26192e2b46d1 --- /dev/null +++ b/docs/api_docs/namespaces/ts/enumerations/NodeBuilderFlags.md @@ -0,0 +1,269 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / NodeBuilderFlags + +# Enumeration: NodeBuilderFlags + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2489 + +## Enumeration Members + +### AllowAnonymousIdentifier + +> **AllowAnonymousIdentifier**: `131072` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2513 + +*** + +### AllowEmptyIndexInfoType + +> **AllowEmptyIndexInfoType**: `2097152` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2517 + +*** + +### AllowEmptyTuple + +> **AllowEmptyTuple**: `524288` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2515 + +*** + +### AllowEmptyUnionOrIntersection + +> **AllowEmptyUnionOrIntersection**: `262144` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2514 + +*** + +### AllowNodeModulesRelativePaths + +> **AllowNodeModulesRelativePaths**: `67108864` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2518 + +*** + +### ~~AllowQualifedNameInPlaceOfIdentifier~~ + +> **AllowQualifedNameInPlaceOfIdentifier**: `65536` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2512 + +#### Deprecated + +AllowQualifedNameInPlaceOfIdentifier. Use AllowQualifiedNameInPlaceOfIdentifier instead. + +*** + +### AllowQualifiedNameInPlaceOfIdentifier + +> **AllowQualifiedNameInPlaceOfIdentifier**: `65536` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2510 + +*** + +### AllowThisInObjectLiteral + +> **AllowThisInObjectLiteral**: `32768` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2509 + +*** + +### AllowUniqueESSymbolType + +> **AllowUniqueESSymbolType**: `1048576` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2516 + +*** + +### ForbidIndexedAccessSymbolReferences + +> **ForbidIndexedAccessSymbolReferences**: `16` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2495 + +*** + +### GenerateNamesForShadowedTypeParams + +> **GenerateNamesForShadowedTypeParams**: `4` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2493 + +*** + +### IgnoreErrors + +> **IgnoreErrors**: `70221824` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2519 + +*** + +### InInitialEntityName + +> **InInitialEntityName**: `16777216` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2522 + +*** + +### InObjectTypeLiteral + +> **InObjectTypeLiteral**: `4194304` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2520 + +*** + +### InTypeAlias + +> **InTypeAlias**: `8388608` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2521 + +*** + +### MultilineObjectLiterals + +> **MultilineObjectLiterals**: `1024` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2501 + +*** + +### None + +> **None**: `0` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2490 + +*** + +### NoTruncation + +> **NoTruncation**: `1` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2491 + +*** + +### NoTypeReduction + +> **NoTypeReduction**: `536870912` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2507 + +*** + +### OmitParameterModifiers + +> **OmitParameterModifiers**: `8192` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2504 + +*** + +### OmitThisParameter + +> **OmitThisParameter**: `33554432` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2508 + +*** + +### SuppressAnyReturnType + +> **SuppressAnyReturnType**: `256` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2499 + +*** + +### UseAliasDefinedOutsideCurrentScope + +> **UseAliasDefinedOutsideCurrentScope**: `16384` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2505 + +*** + +### UseFullyQualifiedType + +> **UseFullyQualifiedType**: `64` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2497 + +*** + +### UseOnlyExternalAliasing + +> **UseOnlyExternalAliasing**: `128` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2498 + +*** + +### UseSingleQuotesForStringLiteralType + +> **UseSingleQuotesForStringLiteralType**: `268435456` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2506 + +*** + +### UseStructuralFallback + +> **UseStructuralFallback**: `8` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2494 + +*** + +### UseTypeOfFunction + +> **UseTypeOfFunction**: `4096` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2503 + +*** + +### WriteArrayAsGenericType + +> **WriteArrayAsGenericType**: `2` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2492 + +*** + +### WriteClassExpressionAsTypeLiteral + +> **WriteClassExpressionAsTypeLiteral**: `2048` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2502 + +*** + +### WriteTypeArgumentsOfSignature + +> **WriteTypeArgumentsOfSignature**: `32` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2496 + +*** + +### WriteTypeParametersInQualifiedName + +> **WriteTypeParametersInQualifiedName**: `512` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2500 diff --git a/docs/api_docs/namespaces/ts/enumerations/NodeFlags.md b/docs/api_docs/namespaces/ts/enumerations/NodeFlags.md new file mode 100644 index 0000000000000000000000000000000000000000..a4bf133bb7d83fe66f13a9ff692552777a07e8f5 --- /dev/null +++ b/docs/api_docs/namespaces/ts/enumerations/NodeFlags.md @@ -0,0 +1,249 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / NodeFlags + +# Enumeration: NodeFlags + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:515 + +## Enumeration Members + +### AwaitContext + +> **AwaitContext**: `32768` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:532 + +*** + +### BlockScoped + +> **BlockScoped**: `3` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:541 + +*** + +### Const + +> **Const**: `2` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:518 + +*** + +### ContainsThis + +> **ContainsThis**: `128` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:524 + +*** + +### ContextFlags + +> **ContextFlags**: `1124462592` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:544 + +*** + +### DecoratorContext + +> **DecoratorContext**: `16384` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:531 + +*** + +### DisallowConditionalTypesContext + +> **DisallowConditionalTypesContext**: `65536` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:533 + +*** + +### DisallowInContext + +> **DisallowInContext**: `4096` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:529 + +*** + +### EtsContext + +> **EtsContext**: `1073741824` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:540 + +*** + +### ExportContext + +> **ExportContext**: `64` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:523 + +*** + +### GlobalAugmentation + +> **GlobalAugmentation**: `1024` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:527 + +*** + +### HasAggregatedChildData + +> **HasAggregatedChildData**: `1048576` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:537 + +*** + +### HasAsyncFunctions + +> **HasAsyncFunctions**: `2048` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:528 + +*** + +### HasExplicitReturn + +> **HasExplicitReturn**: `512` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:526 + +*** + +### HasImplicitReturn + +> **HasImplicitReturn**: `256` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:525 + +*** + +### JavaScriptFile + +> **JavaScriptFile**: `262144` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:535 + +*** + +### JSDoc + +> **JSDoc**: `8388608` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:538 + +*** + +### JsonFile + +> **JsonFile**: `67108864` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:539 + +*** + +### Let + +> **Let**: `1` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:517 + +*** + +### Namespace + +> **Namespace**: `16` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:521 + +*** + +### NestedNamespace + +> **NestedNamespace**: `4` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:519 + +*** + +### None + +> **None**: `0` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:516 + +*** + +### OptionalChain + +> **OptionalChain**: `32` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:522 + +*** + +### ReachabilityAndEmitFlags + +> **ReachabilityAndEmitFlags**: `2816` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:543 + +*** + +### ReachabilityCheckFlags + +> **ReachabilityCheckFlags**: `768` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:542 + +*** + +### Synthesized + +> **Synthesized**: `8` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:520 + +*** + +### ThisNodeHasError + +> **ThisNodeHasError**: `131072` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:534 + +*** + +### ThisNodeOrAnySubNodesHasError + +> **ThisNodeOrAnySubNodesHasError**: `524288` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:536 + +*** + +### TypeExcludesFlags + +> **TypeExcludesFlags**: `40960` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:545 + +*** + +### YieldContext + +> **YieldContext**: `8192` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:530 diff --git a/docs/api_docs/namespaces/ts/enumerations/ObjectFlags.md b/docs/api_docs/namespaces/ts/enumerations/ObjectFlags.md new file mode 100644 index 0000000000000000000000000000000000000000..e555aeb6a15f9d5fddaae877b416895cf1bf5b39 --- /dev/null +++ b/docs/api_docs/namespaces/ts/enumerations/ObjectFlags.md @@ -0,0 +1,161 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ObjectFlags + +# Enumeration: ObjectFlags + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2796 + +## Enumeration Members + +### Anonymous + +> **Anonymous**: `16` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2801 + +*** + +### ArrayLiteral + +> **ArrayLiteral**: `16384` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2811 + +*** + +### Class + +> **Class**: `1` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2797 + +*** + +### ClassOrInterface + +> **ClassOrInterface**: `3` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2812 + +*** + +### ContainsSpread + +> **ContainsSpread**: `2097152` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2813 + +*** + +### EvolvingArray + +> **EvolvingArray**: `256` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2805 + +*** + +### FreshLiteral + +> **FreshLiteral**: `8192` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2810 + +*** + +### Instantiated + +> **Instantiated**: `64` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2803 + +*** + +### InstantiationExpressionType + +> **InstantiationExpressionType**: `8388608` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2815 + +*** + +### Interface + +> **Interface**: `2` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2798 + +*** + +### JSLiteral + +> **JSLiteral**: `4096` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2809 + +*** + +### JsxAttributes + +> **JsxAttributes**: `2048` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2808 + +*** + +### Mapped + +> **Mapped**: `32` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2802 + +*** + +### ObjectLiteral + +> **ObjectLiteral**: `128` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2804 + +*** + +### ObjectLiteralPatternWithComputedProperties + +> **ObjectLiteralPatternWithComputedProperties**: `512` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2806 + +*** + +### ObjectRestType + +> **ObjectRestType**: `4194304` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2814 + +*** + +### Reference + +> **Reference**: `4` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2799 + +*** + +### ReverseMapped + +> **ReverseMapped**: `1024` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2807 + +*** + +### Tuple + +> **Tuple**: `8` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2800 diff --git a/docs/api_docs/namespaces/ts/enumerations/OrganizeImportsMode.md b/docs/api_docs/namespaces/ts/enumerations/OrganizeImportsMode.md new file mode 100644 index 0000000000000000000000000000000000000000..a2277ab24cf176b693400dcb13cce390a5915eb4 --- /dev/null +++ b/docs/api_docs/namespaces/ts/enumerations/OrganizeImportsMode.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / OrganizeImportsMode + +# Enumeration: OrganizeImportsMode + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6442 + +## Enumeration Members + +### All + +> **All**: `"All"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6443 + +*** + +### RemoveUnused + +> **RemoveUnused**: `"RemoveUnused"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6445 + +*** + +### SortAndCombine + +> **SortAndCombine**: `"SortAndCombine"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6444 diff --git a/docs/api_docs/namespaces/ts/enumerations/OuterExpressionKinds.md b/docs/api_docs/namespaces/ts/enumerations/OuterExpressionKinds.md new file mode 100644 index 0000000000000000000000000000000000000000..0224ae221012d66d5fb6285338f5136912121425 --- /dev/null +++ b/docs/api_docs/namespaces/ts/enumerations/OuterExpressionKinds.md @@ -0,0 +1,65 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / OuterExpressionKinds + +# Enumeration: OuterExpressionKinds + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3599 + +## Enumeration Members + +### All + +> **All**: `15` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3605 + +*** + +### Assertions + +> **Assertions**: `6` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3604 + +*** + +### ExcludeJSDocTypeAssertion + +> **ExcludeJSDocTypeAssertion**: `16` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3606 + +*** + +### NonNullAssertions + +> **NonNullAssertions**: `4` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3602 + +*** + +### Parentheses + +> **Parentheses**: `1` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3600 + +*** + +### PartiallyEmittedExpressions + +> **PartiallyEmittedExpressions**: `8` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3603 + +*** + +### TypeAssertions + +> **TypeAssertions**: `2` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3601 diff --git a/docs/api_docs/namespaces/ts/enumerations/OutliningSpanKind.md b/docs/api_docs/namespaces/ts/enumerations/OutliningSpanKind.md new file mode 100644 index 0000000000000000000000000000000000000000..467339f317b26b619757c8abd1cdbb0905be7c27 --- /dev/null +++ b/docs/api_docs/namespaces/ts/enumerations/OutliningSpanKind.md @@ -0,0 +1,49 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / OutliningSpanKind + +# Enumeration: OutliningSpanKind + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7072 + +## Enumeration Members + +### Code + +> **Code**: `"code"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7078 + +Declarations and expressions + +*** + +### Comment + +> **Comment**: `"comment"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7074 + +Single or multi-line comments + +*** + +### Imports + +> **Imports**: `"imports"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7080 + +Contiguous blocks of import declarations + +*** + +### Region + +> **Region**: `"region"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7076 + +Sections marked by '// #region' and '// #endregion' comments diff --git a/docs/api_docs/namespaces/ts/enumerations/OutputFileType.md b/docs/api_docs/namespaces/ts/enumerations/OutputFileType.md new file mode 100644 index 0000000000000000000000000000000000000000..65bbf578e83442db111cf8de207c07b87ce36a9d --- /dev/null +++ b/docs/api_docs/namespaces/ts/enumerations/OutputFileType.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / OutputFileType + +# Enumeration: OutputFileType + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7082 + +## Enumeration Members + +### Declaration + +> **Declaration**: `2` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7085 + +*** + +### JavaScript + +> **JavaScript**: `0` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7083 + +*** + +### SourceMap + +> **SourceMap**: `1` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7084 diff --git a/docs/api_docs/namespaces/ts/enumerations/PollingWatchKind.md b/docs/api_docs/namespaces/ts/enumerations/PollingWatchKind.md new file mode 100644 index 0000000000000000000000000000000000000000..166d9eb31979b3822bd5150226200bfbbcd8fc00 --- /dev/null +++ b/docs/api_docs/namespaces/ts/enumerations/PollingWatchKind.md @@ -0,0 +1,41 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / PollingWatchKind + +# Enumeration: PollingWatchKind + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3067 + +## Enumeration Members + +### DynamicPriority + +> **DynamicPriority**: `2` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3070 + +*** + +### FixedChunkSize + +> **FixedChunkSize**: `3` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3071 + +*** + +### FixedInterval + +> **FixedInterval**: `0` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3068 + +*** + +### PriorityInterval + +> **PriorityInterval**: `1` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3069 diff --git a/docs/api_docs/namespaces/ts/enumerations/ScriptElementKind.md b/docs/api_docs/namespaces/ts/enumerations/ScriptElementKind.md new file mode 100644 index 0000000000000000000000000000000000000000..7bb3b81dcdb720dfdcbad95963fa6f0a134d41b8 --- /dev/null +++ b/docs/api_docs/namespaces/ts/enumerations/ScriptElementKind.md @@ -0,0 +1,381 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ScriptElementKind + +# Enumeration: ScriptElementKind + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7140 + +## Enumeration Members + +### alias + +> **alias**: `"alias"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7204 + +*** + +### callSignatureElement + +> **callSignatureElement**: `"call"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7194 + +interface Y { ():number; } + +*** + +### classElement + +> **classElement**: `"class"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7150 + +class X {} + +*** + +### constElement + +> **constElement**: `"const"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7205 + +*** + +### constructorImplementationElement + +> **constructorImplementationElement**: `"constructor"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7192 + +class X { constructor() { } } +class X { static { } } + +*** + +### constructSignatureElement + +> **constructSignatureElement**: `"construct"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7198 + +interface Y { new():Y; } + +*** + +### directory + +> **directory**: `"directory"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7207 + +*** + +### enumElement + +> **enumElement**: `"enum"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7160 + +enum E + +*** + +### enumMemberElement + +> **enumMemberElement**: `"enum member"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7161 + +*** + +### externalModuleName + +> **externalModuleName**: `"external module name"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7208 + +*** + +### functionElement + +> **functionElement**: `"function"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7173 + +Inside module and script only +function f() { } + +*** + +### indexSignatureElement + +> **indexSignatureElement**: `"index"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7196 + +interface Y { []:number; } + +*** + +### interfaceElement + +> **interfaceElement**: `"interface"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7156 + +interface Y {} + +*** + +### ~~jsxAttribute~~ + +> **jsxAttribute**: `"JSX attribute"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7213 + + + +#### Deprecated + +*** + +### keyword + +> **keyword**: `"keyword"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7144 + +predefined type (void) or keyword (class) + +*** + +### label + +> **label**: `"label"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7203 + +*** + +### letElement + +> **letElement**: `"let"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7206 + +*** + +### link + +> **link**: `"link"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7217 + +Jsdoc @link: in `{@link C link text}`, the before and after text "" and "" + +*** + +### linkName + +> **linkName**: `"link name"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7219 + +Jsdoc @link: in `{@link C link text}`, the entity name "C" + +*** + +### linkText + +> **linkText**: `"link text"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7221 + +Jsdoc @link: in `{@link C link text}`, the link text "link text" + +*** + +### localClassElement + +> **localClassElement**: `"local class"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7152 + +var x = class X {} + +*** + +### localFunctionElement + +> **localFunctionElement**: `"local function"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7175 + +Inside function + +*** + +### localVariableElement + +> **localVariableElement**: `"local var"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7168 + +Inside function + +*** + +### memberAccessorVariableElement + +> **memberAccessorVariableElement**: `"accessor"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7187 + +class X { [public|private]* accessor foo: number; } + +*** + +### memberFunctionElement + +> **memberFunctionElement**: `"method"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7177 + +class X { [public|private]* foo() {} } + +*** + +### memberGetAccessorElement + +> **memberGetAccessorElement**: `"getter"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7179 + +class X { [public|private]* [get|set] foo:number; } + +*** + +### memberSetAccessorElement + +> **memberSetAccessorElement**: `"setter"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7180 + +*** + +### memberVariableElement + +> **memberVariableElement**: `"property"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7185 + +class X { [public|private]* foo:number; } +interface Y { foo:number; } + +*** + +### moduleElement + +> **moduleElement**: `"module"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7148 + +module foo {} + +*** + +### parameterElement + +> **parameterElement**: `"parameter"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7200 + +function foo(*Y*: string) + +*** + +### primitiveType + +> **primitiveType**: `"primitive type"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7202 + +*** + +### scriptElement + +> **scriptElement**: `"script"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7146 + +top level script node + +*** + +### string + +> **string**: `"string"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7215 + +String literal + +*** + +### structElement + +> **structElement**: `"struct"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7154 + +struct X {} + +*** + +### typeElement + +> **typeElement**: `"type"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7158 + +type T = ... + +*** + +### typeParameterElement + +> **typeParameterElement**: `"type parameter"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7201 + +*** + +### unknown + +> **unknown**: `""` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7141 + +*** + +### variableElement + +> **variableElement**: `"var"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7166 + +Inside module and script only +const v = .. + +*** + +### warning + +> **warning**: `"warning"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7142 diff --git a/docs/api_docs/namespaces/ts/enumerations/ScriptElementKindModifier.md b/docs/api_docs/namespaces/ts/enumerations/ScriptElementKindModifier.md new file mode 100644 index 0000000000000000000000000000000000000000..7848d7fa8123e00deb2d4fe8b05550a644c7a46b --- /dev/null +++ b/docs/api_docs/namespaces/ts/enumerations/ScriptElementKindModifier.md @@ -0,0 +1,201 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ScriptElementKindModifier + +# Enumeration: ScriptElementKindModifier + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7223 + +## Enumeration Members + +### abstractModifier + +> **abstractModifier**: `"abstract"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7231 + +*** + +### ambientModifier + +> **ambientModifier**: `"declare"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7229 + +*** + +### cjsModifier + +> **cjsModifier**: `".cjs"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7245 + +*** + +### ctsModifier + +> **ctsModifier**: `".cts"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7244 + +*** + +### dctsModifier + +> **dctsModifier**: `".d.cts"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7243 + +*** + +### deprecatedModifier + +> **deprecatedModifier**: `"deprecated"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7233 + +*** + +### detsModifier + +> **detsModifier**: `".d.ets"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7247 + +*** + +### dmtsModifier + +> **dmtsModifier**: `".d.mts"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7240 + +*** + +### dtsModifier + +> **dtsModifier**: `".d.ts"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7234 + +*** + +### etsModifier + +> **etsModifier**: `".ets"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7246 + +*** + +### exportedModifier + +> **exportedModifier**: `"export"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7228 + +*** + +### jsModifier + +> **jsModifier**: `".js"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7237 + +*** + +### jsonModifier + +> **jsonModifier**: `".json"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7239 + +*** + +### jsxModifier + +> **jsxModifier**: `".jsx"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7238 + +*** + +### mjsModifier + +> **mjsModifier**: `".mjs"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7242 + +*** + +### mtsModifier + +> **mtsModifier**: `".mts"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7241 + +*** + +### none + +> **none**: `""` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7224 + +*** + +### optionalModifier + +> **optionalModifier**: `"optional"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7232 + +*** + +### privateMemberModifier + +> **privateMemberModifier**: `"private"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7226 + +*** + +### protectedMemberModifier + +> **protectedMemberModifier**: `"protected"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7227 + +*** + +### publicMemberModifier + +> **publicMemberModifier**: `"public"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7225 + +*** + +### staticModifier + +> **staticModifier**: `"static"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7230 + +*** + +### tsModifier + +> **tsModifier**: `".ts"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7235 + +*** + +### tsxModifier + +> **tsxModifier**: `".tsx"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7236 diff --git a/docs/api_docs/namespaces/ts/enumerations/ScriptKind.md b/docs/api_docs/namespaces/ts/enumerations/ScriptKind.md new file mode 100644 index 0000000000000000000000000000000000000000..d2fb7b0f75f208c3e3ce2ab1ddfe1e306f945ce8 --- /dev/null +++ b/docs/api_docs/namespaces/ts/enumerations/ScriptKind.md @@ -0,0 +1,84 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ScriptKind + +# Enumeration: ScriptKind + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3281 + +## Enumeration Members + +### Deferred + +> **Deferred**: `7` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3293 + +Used on extensions that doesn't define the ScriptKind but the content defines it. +Deferred extensions are going to be included in all project contexts. + +*** + +### ETS + +> **ETS**: `8` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3294 + +*** + +### External + +> **External**: `5` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3287 + +*** + +### JS + +> **JS**: `1` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3283 + +*** + +### JSON + +> **JSON**: `6` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3288 + +*** + +### JSX + +> **JSX**: `2` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3284 + +*** + +### TS + +> **TS**: `3` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3285 + +*** + +### TSX + +> **TSX**: `4` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3286 + +*** + +### Unknown + +> **Unknown**: `0` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3282 diff --git a/docs/api_docs/namespaces/ts/enumerations/ScriptTarget.md b/docs/api_docs/namespaces/ts/enumerations/ScriptTarget.md new file mode 100644 index 0000000000000000000000000000000000000000..c0a37dfce8a1017901ca60abdf68351d4ef321f0 --- /dev/null +++ b/docs/api_docs/namespaces/ts/enumerations/ScriptTarget.md @@ -0,0 +1,113 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ScriptTarget + +# Enumeration: ScriptTarget + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3296 + +## Enumeration Members + +### ES2015 + +> **ES2015**: `2` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3299 + +*** + +### ES2016 + +> **ES2016**: `3` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3300 + +*** + +### ES2017 + +> **ES2017**: `4` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3301 + +*** + +### ES2018 + +> **ES2018**: `5` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3302 + +*** + +### ES2019 + +> **ES2019**: `6` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3303 + +*** + +### ES2020 + +> **ES2020**: `7` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3304 + +*** + +### ES2021 + +> **ES2021**: `8` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3305 + +*** + +### ES2022 + +> **ES2022**: `9` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3306 + +*** + +### ES3 + +> **ES3**: `0` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3297 + +*** + +### ES5 + +> **ES5**: `1` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3298 + +*** + +### ESNext + +> **ESNext**: `99` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3307 + +*** + +### JSON + +> **JSON**: `100` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3308 + +*** + +### Latest + +> **Latest**: `99` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3309 diff --git a/docs/api_docs/namespaces/ts/enumerations/SemanticClassificationFormat.md b/docs/api_docs/namespaces/ts/enumerations/SemanticClassificationFormat.md new file mode 100644 index 0000000000000000000000000000000000000000..28903b0210ce0a3b143a46491c372fdf1f6f6bbd --- /dev/null +++ b/docs/api_docs/namespaces/ts/enumerations/SemanticClassificationFormat.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / SemanticClassificationFormat + +# Enumeration: SemanticClassificationFormat + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6266 + +## Enumeration Members + +### Original + +> **Original**: `"original"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6267 + +*** + +### TwentyTwenty + +> **TwentyTwenty**: `"2020"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6268 diff --git a/docs/api_docs/namespaces/ts/enumerations/SemicolonPreference.md b/docs/api_docs/namespaces/ts/enumerations/SemicolonPreference.md new file mode 100644 index 0000000000000000000000000000000000000000..a4565cd47c70e1e2b58e4fd6ac773cdd7831e6cd --- /dev/null +++ b/docs/api_docs/namespaces/ts/enumerations/SemicolonPreference.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / SemicolonPreference + +# Enumeration: SemicolonPreference + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6757 + +## Enumeration Members + +### Ignore + +> **Ignore**: `"ignore"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6758 + +*** + +### Insert + +> **Insert**: `"insert"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6759 + +*** + +### Remove + +> **Remove**: `"remove"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6760 diff --git a/docs/api_docs/namespaces/ts/enumerations/SignatureKind.md b/docs/api_docs/namespaces/ts/enumerations/SignatureKind.md new file mode 100644 index 0000000000000000000000000000000000000000..89d611e864a5cc48123b0efc63f7d7daafed9bd8 --- /dev/null +++ b/docs/api_docs/namespaces/ts/enumerations/SignatureKind.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / SignatureKind + +# Enumeration: SignatureKind + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2932 + +## Enumeration Members + +### Call + +> **Call**: `0` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2933 + +*** + +### Construct + +> **Construct**: `1` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2934 diff --git a/docs/api_docs/namespaces/ts/enumerations/SymbolDisplayPartKind.md b/docs/api_docs/namespaces/ts/enumerations/SymbolDisplayPartKind.md new file mode 100644 index 0000000000000000000000000000000000000000..7fa37cc2af2c96141a9cfdd1f0ba93489dcad315 --- /dev/null +++ b/docs/api_docs/namespaces/ts/enumerations/SymbolDisplayPartKind.md @@ -0,0 +1,209 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / SymbolDisplayPartKind + +# Enumeration: SymbolDisplayPartKind + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6842 + +## Enumeration Members + +### aliasName + +> **aliasName**: `0` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6843 + +*** + +### className + +> **className**: `1` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6844 + +*** + +### enumMemberName + +> **enumMemberName**: `19` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6862 + +*** + +### enumName + +> **enumName**: `2` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6845 + +*** + +### fieldName + +> **fieldName**: `3` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6846 + +*** + +### functionName + +> **functionName**: `20` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6863 + +*** + +### interfaceName + +> **interfaceName**: `4` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6847 + +*** + +### keyword + +> **keyword**: `5` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6848 + +*** + +### lineBreak + +> **lineBreak**: `6` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6849 + +*** + +### link + +> **link**: `22` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6865 + +*** + +### linkName + +> **linkName**: `23` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6866 + +*** + +### linkText + +> **linkText**: `24` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6867 + +*** + +### localName + +> **localName**: `9` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6852 + +*** + +### methodName + +> **methodName**: `10` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6853 + +*** + +### moduleName + +> **moduleName**: `11` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6854 + +*** + +### numericLiteral + +> **numericLiteral**: `7` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6850 + +*** + +### operator + +> **operator**: `12` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6855 + +*** + +### parameterName + +> **parameterName**: `13` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6856 + +*** + +### propertyName + +> **propertyName**: `14` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6857 + +*** + +### punctuation + +> **punctuation**: `15` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6858 + +*** + +### regularExpressionLiteral + +> **regularExpressionLiteral**: `21` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6864 + +*** + +### space + +> **space**: `16` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6859 + +*** + +### stringLiteral + +> **stringLiteral**: `8` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6851 + +*** + +### text + +> **text**: `17` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6860 + +*** + +### typeParameterName + +> **typeParameterName**: `18` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6861 diff --git a/docs/api_docs/namespaces/ts/enumerations/SymbolFlags.md b/docs/api_docs/namespaces/ts/enumerations/SymbolFlags.md new file mode 100644 index 0000000000000000000000000000000000000000..a04bc20f18ce534bb294005ad10ddca58d944120 --- /dev/null +++ b/docs/api_docs/namespaces/ts/enumerations/SymbolFlags.md @@ -0,0 +1,489 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / SymbolFlags + +# Enumeration: SymbolFlags + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2606 + +## Enumeration Members + +### Accessor + +> **Accessor**: `98304` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2642 + +*** + +### AccessorExcludes + +> **AccessorExcludes**: `13247` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2658 + +*** + +### Alias + +> **Alias**: `2097152` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2629 + +*** + +### AliasExcludes + +> **AliasExcludes**: `2097152` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2661 + +*** + +### Assignment + +> **Assignment**: `67108864` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2634 + +*** + +### BlockScoped + +> **BlockScoped**: `418` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2664 + +*** + +### BlockScopedVariable + +> **BlockScopedVariable**: `2` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2609 + +*** + +### BlockScopedVariableExcludes + +> **BlockScopedVariableExcludes**: `111551` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2644 + +*** + +### Class + +> **Class**: `32` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2613 + +*** + +### ClassExcludes + +> **ClassExcludes**: `899503` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2649 + +*** + +### ClassMember + +> **ClassMember**: `106500` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2666 + +*** + +### ConstEnum + +> **ConstEnum**: `128` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2615 + +*** + +### ConstEnumExcludes + +> **ConstEnumExcludes**: `899967` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2652 + +*** + +### Constructor + +> **Constructor**: `16384` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2622 + +*** + +### Enum + +> **Enum**: `384` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2636 + +*** + +### EnumMember + +> **EnumMember**: `8` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2611 + +*** + +### EnumMemberExcludes + +> **EnumMemberExcludes**: `900095` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2647 + +*** + +### ExportHasLocal + +> **ExportHasLocal**: `944` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2663 + +*** + +### ExportStar + +> **ExportStar**: `8388608` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2631 + +*** + +### ExportValue + +> **ExportValue**: `1048576` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2628 + +*** + +### Function + +> **Function**: `16` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2612 + +*** + +### FunctionExcludes + +> **FunctionExcludes**: `110991` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2648 + +*** + +### FunctionScopedVariable + +> **FunctionScopedVariable**: `1` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2608 + +*** + +### FunctionScopedVariableExcludes + +> **FunctionScopedVariableExcludes**: `111550` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2643 + +*** + +### GetAccessor + +> **GetAccessor**: `32768` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2623 + +*** + +### GetAccessorExcludes + +> **GetAccessorExcludes**: `46015` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2656 + +*** + +### Interface + +> **Interface**: `64` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2614 + +*** + +### InterfaceExcludes + +> **InterfaceExcludes**: `788872` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2650 + +*** + +### Method + +> **Method**: `8192` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2621 + +*** + +### MethodExcludes + +> **MethodExcludes**: `103359` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2655 + +*** + +### Module + +> **Module**: `1536` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2641 + +*** + +### ModuleExports + +> **ModuleExports**: `134217728` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2635 + +*** + +### ModuleMember + +> **ModuleMember**: `2623475` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2662 + +*** + +### Namespace + +> **Namespace**: `1920` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2640 + +*** + +### NamespaceModule + +> **NamespaceModule**: `1024` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2618 + +*** + +### NamespaceModuleExcludes + +> **NamespaceModuleExcludes**: `0` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2654 + +*** + +### None + +> **None**: `0` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2607 + +*** + +### ObjectLiteral + +> **ObjectLiteral**: `4096` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2620 + +*** + +### Optional + +> **Optional**: `16777216` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2632 + +*** + +### ParameterExcludes + +> **ParameterExcludes**: `111551` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2645 + +*** + +### Property + +> **Property**: `4` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2610 + +*** + +### PropertyExcludes + +> **PropertyExcludes**: `0` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2646 + +*** + +### PropertyOrAccessor + +> **PropertyOrAccessor**: `98308` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2665 + +*** + +### Prototype + +> **Prototype**: `4194304` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2630 + +*** + +### RegularEnum + +> **RegularEnum**: `256` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2616 + +*** + +### RegularEnumExcludes + +> **RegularEnumExcludes**: `899327` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2651 + +*** + +### SetAccessor + +> **SetAccessor**: `65536` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2624 + +*** + +### SetAccessorExcludes + +> **SetAccessorExcludes**: `78783` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2657 + +*** + +### Signature + +> **Signature**: `131072` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2625 + +*** + +### Transient + +> **Transient**: `33554432` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2633 + +*** + +### Type + +> **Type**: `788968` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2639 + +*** + +### TypeAlias + +> **TypeAlias**: `524288` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2627 + +*** + +### TypeAliasExcludes + +> **TypeAliasExcludes**: `788968` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2660 + +*** + +### TypeLiteral + +> **TypeLiteral**: `2048` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2619 + +*** + +### TypeParameter + +> **TypeParameter**: `262144` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2626 + +*** + +### TypeParameterExcludes + +> **TypeParameterExcludes**: `526824` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2659 + +*** + +### Value + +> **Value**: `111551` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2638 + +*** + +### ValueModule + +> **ValueModule**: `512` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2617 + +*** + +### ValueModuleExcludes + +> **ValueModuleExcludes**: `110735` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2653 + +*** + +### Variable + +> **Variable**: `3` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2637 diff --git a/docs/api_docs/namespaces/ts/enumerations/SymbolFormatFlags.md b/docs/api_docs/namespaces/ts/enumerations/SymbolFormatFlags.md new file mode 100644 index 0000000000000000000000000000000000000000..6504642a5605c3efe844540016fe6ceee4327d68 --- /dev/null +++ b/docs/api_docs/namespaces/ts/enumerations/SymbolFormatFlags.md @@ -0,0 +1,49 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / SymbolFormatFlags + +# Enumeration: SymbolFormatFlags + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2550 + +## Enumeration Members + +### AllowAnyNodeKind + +> **AllowAnyNodeKind**: `4` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2554 + +*** + +### None + +> **None**: `0` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2551 + +*** + +### UseAliasDefinedOutsideCurrentScope + +> **UseAliasDefinedOutsideCurrentScope**: `8` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2555 + +*** + +### UseOnlyExternalAliasing + +> **UseOnlyExternalAliasing**: `2` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2553 + +*** + +### WriteTypeParametersOrArguments + +> **WriteTypeParametersOrArguments**: `1` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2552 diff --git a/docs/api_docs/namespaces/ts/enumerations/SyntaxKind.md b/docs/api_docs/namespaces/ts/enumerations/SyntaxKind.md new file mode 100644 index 0000000000000000000000000000000000000000..cf768a64fb9d19dbb7fb6df635d68516558820d0 --- /dev/null +++ b/docs/api_docs/namespaces/ts/enumerations/SyntaxKind.md @@ -0,0 +1,3177 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / SyntaxKind + +# Enumeration: SyntaxKind + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:105 + +## Enumeration Members + +### AbstractKeyword + +> **AbstractKeyword**: `127` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:235 + +*** + +### AccessorKeyword + +> **AccessorKeyword**: `128` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:236 + +*** + +### AmpersandAmpersandEqualsToken + +> **AmpersandAmpersandEqualsToken**: `76` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:184 + +*** + +### AmpersandAmpersandToken + +> **AmpersandAmpersandToken**: `55` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:161 + +*** + +### AmpersandEqualsToken + +> **AmpersandEqualsToken**: `73` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:181 + +*** + +### AmpersandToken + +> **AmpersandToken**: `50` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:156 + +*** + +### AnyKeyword + +> **AnyKeyword**: `132` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:240 + +*** + +### ArrayBindingPattern + +> **ArrayBindingPattern**: `206` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:314 + +*** + +### ArrayLiteralExpression + +> **ArrayLiteralExpression**: `208` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:316 + +*** + +### ArrayType + +> **ArrayType**: `187` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:295 + +*** + +### ArrowFunction + +> **ArrowFunction**: `218` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:326 + +*** + +### AsExpression + +> **AsExpression**: `234` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:342 + +*** + +### AsKeyword + +> **AsKeyword**: `129` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:237 + +*** + +### AssertClause + +> **AssertClause**: `300` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:408 + +*** + +### AssertEntry + +> **AssertEntry**: `301` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:409 + +*** + +### AssertKeyword + +> **AssertKeyword**: `131` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:239 + +*** + +### AssertsKeyword + +> **AssertsKeyword**: `130` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:238 + +*** + +### AsteriskAsteriskEqualsToken + +> **AsteriskAsteriskEqualsToken**: `67` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:175 + +*** + +### AsteriskAsteriskToken + +> **AsteriskAsteriskToken**: `42` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:148 + +*** + +### AsteriskEqualsToken + +> **AsteriskEqualsToken**: `66` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:174 + +*** + +### AsteriskToken + +> **AsteriskToken**: `41` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:147 + +*** + +### AsyncKeyword + +> **AsyncKeyword**: `133` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:241 + +*** + +### AtToken + +> **AtToken**: `59` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:165 + +*** + +### AwaitExpression + +> **AwaitExpression**: `223` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:331 + +*** + +### AwaitKeyword + +> **AwaitKeyword**: `134` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:242 + +*** + +### BacktickToken + +> **BacktickToken**: `61` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:168 + +Only the JSDoc scanner produces BacktickToken. The normal scanner produces NoSubstitutionTemplateLiteral and related kinds. + +*** + +### BarBarEqualsToken + +> **BarBarEqualsToken**: `75` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:183 + +*** + +### BarBarToken + +> **BarBarToken**: `56` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:162 + +*** + +### BarEqualsToken + +> **BarEqualsToken**: `74` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:182 + +*** + +### BarToken + +> **BarToken**: `51` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:157 + +*** + +### BigIntKeyword + +> **BigIntKeyword**: `162` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:270 + +*** + +### BigIntLiteral + +> **BigIntLiteral**: `9` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:115 + +*** + +### BinaryExpression + +> **BinaryExpression**: `226` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:334 + +*** + +### BindingElement + +> **BindingElement**: `207` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:315 + +*** + +### Block + +> **Block**: `241` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:349 + +*** + +### BooleanKeyword + +> **BooleanKeyword**: `135` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:243 + +*** + +### BreakKeyword + +> **BreakKeyword**: `81` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:189 + +*** + +### BreakStatement + +> **BreakStatement**: `252` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:360 + +*** + +### Bundle + +> **Bundle**: `313` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:421 + +*** + +### CallExpression + +> **CallExpression**: `212` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:320 + +*** + +### CallSignature + +> **CallSignature**: `178` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:286 + +*** + +### CaretEqualsToken + +> **CaretEqualsToken**: `78` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:186 + +*** + +### CaretToken + +> **CaretToken**: `52` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:158 + +*** + +### CaseBlock + +> **CaseBlock**: `270` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:378 + +*** + +### CaseClause + +> **CaseClause**: `296` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:404 + +*** + +### CaseKeyword + +> **CaseKeyword**: `82` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:190 + +*** + +### CatchClause + +> **CatchClause**: `299` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:407 + +*** + +### CatchKeyword + +> **CatchKeyword**: `83` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:191 + +*** + +### ClassDeclaration + +> **ClassDeclaration**: `263` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:371 + +*** + +### ClassExpression + +> **ClassExpression**: `231` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:339 + +*** + +### ClassKeyword + +> **ClassKeyword**: `84` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:192 + +*** + +### ClassStaticBlockDeclaration + +> **ClassStaticBlockDeclaration**: `174` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:282 + +*** + +### CloseBraceToken + +> **CloseBraceToken**: `19` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:125 + +*** + +### CloseBracketToken + +> **CloseBracketToken**: `23` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:129 + +*** + +### CloseParenToken + +> **CloseParenToken**: `21` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:127 + +*** + +### ColonToken + +> **ColonToken**: `58` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:164 + +*** + +### CommaListExpression + +> **CommaListExpression**: `358` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:468 + +*** + +### CommaToken + +> **CommaToken**: `27` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:133 + +*** + +### ComputedPropertyName + +> **ComputedPropertyName**: `166` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:274 + +*** + +### ConditionalExpression + +> **ConditionalExpression**: `227` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:335 + +*** + +### ConditionalType + +> **ConditionalType**: `193` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:301 + +*** + +### ConflictMarkerTrivia + +> **ConflictMarkerTrivia**: `7` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:113 + +*** + +### ConstKeyword + +> **ConstKeyword**: `86` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:194 + +*** + +### Constructor + +> **Constructor**: `175` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:283 + +*** + +### ConstructorKeyword + +> **ConstructorKeyword**: `136` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:244 + +*** + +### ConstructorType + +> **ConstructorType**: `184` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:292 + +*** + +### ConstructSignature + +> **ConstructSignature**: `179` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:287 + +*** + +### ContinueKeyword + +> **ContinueKeyword**: `87` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:195 + +*** + +### ContinueStatement + +> **ContinueStatement**: `251` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:359 + +*** + +### Count + +> **Count**: `362` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:472 + +*** + +### DebuggerKeyword + +> **DebuggerKeyword**: `88` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:196 + +*** + +### DebuggerStatement + +> **DebuggerStatement**: `259` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:367 + +*** + +### DeclareKeyword + +> **DeclareKeyword**: `137` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:245 + +*** + +### Decorator + +> **Decorator**: `169` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:277 + +*** + +### DefaultClause + +> **DefaultClause**: `297` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:405 + +*** + +### DefaultKeyword + +> **DefaultKeyword**: `89` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:197 + +*** + +### DeleteExpression + +> **DeleteExpression**: `220` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:328 + +*** + +### DeleteKeyword + +> **DeleteKeyword**: `90` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:198 + +*** + +### DoKeyword + +> **DoKeyword**: `91` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:199 + +*** + +### DoStatement + +> **DoStatement**: `246` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:354 + +*** + +### DotDotDotToken + +> **DotDotDotToken**: `25` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:131 + +*** + +### DotToken + +> **DotToken**: `24` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:130 + +*** + +### ElementAccessExpression + +> **ElementAccessExpression**: `211` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:319 + +*** + +### ElseKeyword + +> **ElseKeyword**: `92` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:200 + +*** + +### EmptyStatement + +> **EmptyStatement**: `242` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:350 + +*** + +### EndOfDeclarationMarker + +> **EndOfDeclarationMarker**: `360` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:470 + +*** + +### EndOfFileToken + +> **EndOfFileToken**: `1` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:107 + +*** + +### EnumDeclaration + +> **EnumDeclaration**: `267` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:375 + +*** + +### EnumKeyword + +> **EnumKeyword**: `93` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:201 + +*** + +### EnumMember + +> **EnumMember**: `306` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:414 + +*** + +### EqualsEqualsEqualsToken + +> **EqualsEqualsEqualsToken**: `36` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:142 + +*** + +### EqualsEqualsToken + +> **EqualsEqualsToken**: `34` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:140 + +*** + +### EqualsGreaterThanToken + +> **EqualsGreaterThanToken**: `38` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:144 + +*** + +### EqualsToken + +> **EqualsToken**: `63` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:171 + +*** + +### EtsComponentExpression + +> **EtsComponentExpression**: `219` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:327 + +*** + +### ExclamationEqualsEqualsToken + +> **ExclamationEqualsEqualsToken**: `37` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:143 + +*** + +### ExclamationEqualsToken + +> **ExclamationEqualsToken**: `35` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:141 + +*** + +### ExclamationToken + +> **ExclamationToken**: `53` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:159 + +*** + +### ExportAssignment + +> **ExportAssignment**: `278` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:386 + +*** + +### ExportDeclaration + +> **ExportDeclaration**: `279` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:387 + +*** + +### ExportKeyword + +> **ExportKeyword**: `94` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:202 + +*** + +### ExportSpecifier + +> **ExportSpecifier**: `282` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:390 + +*** + +### ExpressionStatement + +> **ExpressionStatement**: `244` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:352 + +*** + +### ExpressionWithTypeArguments + +> **ExpressionWithTypeArguments**: `233` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:341 + +*** + +### ExtendsKeyword + +> **ExtendsKeyword**: `95` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:203 + +*** + +### ExternalModuleReference + +> **ExternalModuleReference**: `284` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:392 + +*** + +### FalseKeyword + +> **FalseKeyword**: `96` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:204 + +*** + +### FinallyKeyword + +> **FinallyKeyword**: `97` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:205 + +*** + +### FirstAssignment + +> **FirstAssignment**: `63` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:473 + +*** + +### FirstBinaryOperator + +> **FirstBinaryOperator**: `29` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:495 + +*** + +### FirstCompoundAssignment + +> **FirstCompoundAssignment**: `64` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:475 + +*** + +### FirstFutureReservedWord + +> **FirstFutureReservedWord**: `118` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:481 + +*** + +### FirstJSDocNode + +> **FirstJSDocNode**: `316` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:500 + +*** + +### FirstJSDocTagNode + +> **FirstJSDocTagNode**: `334` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:502 + +*** + +### FirstKeyword + +> **FirstKeyword**: `81` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:479 + +*** + +### FirstLiteralToken + +> **FirstLiteralToken**: `8` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:491 + +*** + +### FirstNode + +> **FirstNode**: `165` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:499 + +*** + +### FirstPunctuation + +> **FirstPunctuation**: `18` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:485 + +*** + +### FirstReservedWord + +> **FirstReservedWord**: `81` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:477 + +*** + +### FirstStatement + +> **FirstStatement**: `243` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:497 + +*** + +### FirstTemplateToken + +> **FirstTemplateToken**: `14` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:493 + +*** + +### FirstToken + +> **FirstToken**: `0` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:487 + +*** + +### FirstTriviaToken + +> **FirstTriviaToken**: `2` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:489 + +*** + +### FirstTypeNode + +> **FirstTypeNode**: `181` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:483 + +*** + +### ForInStatement + +> **ForInStatement**: `249` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:357 + +*** + +### ForKeyword + +> **ForKeyword**: `98` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:206 + +*** + +### ForOfStatement + +> **ForOfStatement**: `250` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:358 + +*** + +### ForStatement + +> **ForStatement**: `248` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:356 + +*** + +### FromKeyword + +> **FromKeyword**: `160` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:268 + +*** + +### FunctionDeclaration + +> **FunctionDeclaration**: `262` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:370 + +*** + +### FunctionExpression + +> **FunctionExpression**: `217` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:325 + +*** + +### FunctionKeyword + +> **FunctionKeyword**: `99` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:207 + +*** + +### FunctionType + +> **FunctionType**: `183` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:291 + +*** + +### GetAccessor + +> **GetAccessor**: `176` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:284 + +*** + +### GetKeyword + +> **GetKeyword**: `138` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:246 + +*** + +### GlobalKeyword + +> **GlobalKeyword**: `161` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:269 + +*** + +### GreaterThanEqualsToken + +> **GreaterThanEqualsToken**: `33` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:139 + +*** + +### GreaterThanGreaterThanEqualsToken + +> **GreaterThanGreaterThanEqualsToken**: `71` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:179 + +*** + +### GreaterThanGreaterThanGreaterThanEqualsToken + +> **GreaterThanGreaterThanGreaterThanEqualsToken**: `72` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:180 + +*** + +### GreaterThanGreaterThanGreaterThanToken + +> **GreaterThanGreaterThanGreaterThanToken**: `49` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:155 + +*** + +### GreaterThanGreaterThanToken + +> **GreaterThanGreaterThanToken**: `48` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:154 + +*** + +### GreaterThanToken + +> **GreaterThanToken**: `31` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:137 + +*** + +### HashToken + +> **HashToken**: `62` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:170 + +Only the JSDoc scanner produces HashToken. The normal scanner produces PrivateIdentifier. + +*** + +### HeritageClause + +> **HeritageClause**: `298` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:406 + +*** + +### Identifier + +> **Identifier**: `79` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:187 + +*** + +### IfKeyword + +> **IfKeyword**: `100` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:208 + +*** + +### IfStatement + +> **IfStatement**: `245` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:353 + +*** + +### ImplementsKeyword + +> **ImplementsKeyword**: `118` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:226 + +*** + +### ImportClause + +> **ImportClause**: `274` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:382 + +*** + +### ImportDeclaration + +> **ImportDeclaration**: `273` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:381 + +*** + +### ImportEqualsDeclaration + +> **ImportEqualsDeclaration**: `272` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:380 + +*** + +### ImportKeyword + +> **ImportKeyword**: `101` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:209 + +*** + +### ImportSpecifier + +> **ImportSpecifier**: `277` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:385 + +*** + +### ImportType + +> **ImportType**: `204` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:312 + +*** + +### ImportTypeAssertionContainer + +> **ImportTypeAssertionContainer**: `302` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:410 + +*** + +### IndexedAccessType + +> **IndexedAccessType**: `198` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:306 + +*** + +### IndexSignature + +> **IndexSignature**: `180` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:288 + +*** + +### InferKeyword + +> **InferKeyword**: `139` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:247 + +*** + +### InferType + +> **InferType**: `194` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:302 + +*** + +### InKeyword + +> **InKeyword**: `102` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:210 + +*** + +### InputFiles + +> **InputFiles**: `315` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:423 + +*** + +### InstanceOfKeyword + +> **InstanceOfKeyword**: `103` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:211 + +*** + +### InterfaceDeclaration + +> **InterfaceDeclaration**: `265` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:373 + +*** + +### InterfaceKeyword + +> **InterfaceKeyword**: `119` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:227 + +*** + +### IntersectionType + +> **IntersectionType**: `192` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:300 + +*** + +### IntrinsicKeyword + +> **IntrinsicKeyword**: `140` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:248 + +*** + +### IsKeyword + +> **IsKeyword**: `141` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:249 + +*** + +### JSDoc + +> **JSDoc**: `327` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:435 + +*** + +### JSDocAllType + +> **JSDocAllType**: `319` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:427 + +*** + +### JSDocAugmentsTag + +> **JSDocAugmentsTag**: `335` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:445 + +*** + +### JSDocAuthorTag + +> **JSDocAuthorTag**: `337` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:447 + +*** + +### JSDocCallbackTag + +> **JSDocCallbackTag**: `345` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:455 + +*** + +### JSDocClassTag + +> **JSDocClassTag**: `339` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:449 + +*** + +### ~~JSDocComment~~ + +> **JSDocComment**: `327` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:437 + +#### Deprecated + +Use SyntaxKind.JSDoc + +*** + +### JSDocDeprecatedTag + +> **JSDocDeprecatedTag**: `338` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:448 + +*** + +### JSDocEnumTag + +> **JSDocEnumTag**: `346` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:456 + +*** + +### JSDocFunctionType + +> **JSDocFunctionType**: `324` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:432 + +*** + +### JSDocImplementsTag + +> **JSDocImplementsTag**: `336` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:446 + +*** + +### JSDocLink + +> **JSDocLink**: `331` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:441 + +*** + +### JSDocLinkCode + +> **JSDocLinkCode**: `332` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:442 + +*** + +### JSDocLinkPlain + +> **JSDocLinkPlain**: `333` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:443 + +*** + +### JSDocMemberName + +> **JSDocMemberName**: `318` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:426 + +*** + +### JSDocNamepathType + +> **JSDocNamepathType**: `326` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:434 + +*** + +### JSDocNameReference + +> **JSDocNameReference**: `317` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:425 + +*** + +### JSDocNonNullableType + +> **JSDocNonNullableType**: `322` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:430 + +*** + +### JSDocNullableType + +> **JSDocNullableType**: `321` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:429 + +*** + +### JSDocOptionalType + +> **JSDocOptionalType**: `323` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:431 + +*** + +### JSDocOverrideTag + +> **JSDocOverrideTag**: `344` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:454 + +*** + +### JSDocParameterTag + +> **JSDocParameterTag**: `347` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:457 + +*** + +### JSDocPrivateTag + +> **JSDocPrivateTag**: `341` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:451 + +*** + +### JSDocPropertyTag + +> **JSDocPropertyTag**: `354` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:464 + +*** + +### JSDocProtectedTag + +> **JSDocProtectedTag**: `342` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:452 + +*** + +### JSDocPublicTag + +> **JSDocPublicTag**: `340` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:450 + +*** + +### JSDocReadonlyTag + +> **JSDocReadonlyTag**: `343` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:453 + +*** + +### JSDocReturnTag + +> **JSDocReturnTag**: `348` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:458 + +*** + +### JSDocSeeTag + +> **JSDocSeeTag**: `353` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:463 + +*** + +### JSDocSignature + +> **JSDocSignature**: `330` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:440 + +*** + +### JSDocTag + +> **JSDocTag**: `334` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:444 + +*** + +### JSDocTemplateTag + +> **JSDocTemplateTag**: `351` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:461 + +*** + +### JSDocText + +> **JSDocText**: `328` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:438 + +*** + +### JSDocThisTag + +> **JSDocThisTag**: `349` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:459 + +*** + +### JSDocTypedefTag + +> **JSDocTypedefTag**: `352` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:462 + +*** + +### JSDocTypeExpression + +> **JSDocTypeExpression**: `316` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:424 + +*** + +### JSDocTypeLiteral + +> **JSDocTypeLiteral**: `329` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:439 + +*** + +### JSDocTypeTag + +> **JSDocTypeTag**: `350` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:460 + +*** + +### JSDocUnknownType + +> **JSDocUnknownType**: `320` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:428 + +*** + +### JSDocVariadicType + +> **JSDocVariadicType**: `325` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:433 + +*** + +### JsxAttribute + +> **JsxAttribute**: `292` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:400 + +*** + +### JsxAttributes + +> **JsxAttributes**: `293` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:401 + +*** + +### JsxClosingElement + +> **JsxClosingElement**: `288` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:396 + +*** + +### JsxClosingFragment + +> **JsxClosingFragment**: `291` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:399 + +*** + +### JsxElement + +> **JsxElement**: `285` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:393 + +*** + +### JsxExpression + +> **JsxExpression**: `295` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:403 + +*** + +### JsxFragment + +> **JsxFragment**: `289` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:397 + +*** + +### JsxOpeningElement + +> **JsxOpeningElement**: `287` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:395 + +*** + +### JsxOpeningFragment + +> **JsxOpeningFragment**: `290` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:398 + +*** + +### JsxSelfClosingElement + +> **JsxSelfClosingElement**: `286` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:394 + +*** + +### JsxSpreadAttribute + +> **JsxSpreadAttribute**: `294` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:402 + +*** + +### JsxText + +> **JsxText**: `11` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:117 + +*** + +### JsxTextAllWhiteSpaces + +> **JsxTextAllWhiteSpaces**: `12` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:118 + +*** + +### KeyOfKeyword + +> **KeyOfKeyword**: `142` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:250 + +*** + +### LabeledStatement + +> **LabeledStatement**: `256` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:364 + +*** + +### LastAssignment + +> **LastAssignment**: `78` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:474 + +*** + +### LastBinaryOperator + +> **LastBinaryOperator**: `78` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:496 + +*** + +### LastCompoundAssignment + +> **LastCompoundAssignment**: `78` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:476 + +*** + +### LastFutureReservedWord + +> **LastFutureReservedWord**: `126` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:482 + +*** + +### LastJSDocNode + +> **LastJSDocNode**: `354` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:501 + +*** + +### LastJSDocTagNode + +> **LastJSDocTagNode**: `354` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:503 + +*** + +### LastKeyword + +> **LastKeyword**: `164` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:480 + +*** + +### LastLiteralToken + +> **LastLiteralToken**: `14` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:492 + +*** + +### LastPunctuation + +> **LastPunctuation**: `78` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:486 + +*** + +### LastReservedWord + +> **LastReservedWord**: `117` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:478 + +*** + +### LastStatement + +> **LastStatement**: `259` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:498 + +*** + +### LastTemplateToken + +> **LastTemplateToken**: `17` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:494 + +*** + +### LastToken + +> **LastToken**: `164` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:488 + +*** + +### LastTriviaToken + +> **LastTriviaToken**: `7` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:490 + +*** + +### LastTypeNode + +> **LastTypeNode**: `204` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:484 + +*** + +### LazyKeyword + +> **LazyKeyword**: `156` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:264 + +*** + +### LessThanEqualsToken + +> **LessThanEqualsToken**: `32` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:138 + +*** + +### LessThanLessThanEqualsToken + +> **LessThanLessThanEqualsToken**: `70` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:178 + +*** + +### LessThanLessThanToken + +> **LessThanLessThanToken**: `47` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:153 + +*** + +### LessThanSlashToken + +> **LessThanSlashToken**: `30` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:136 + +*** + +### LessThanToken + +> **LessThanToken**: `29` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:135 + +*** + +### LetKeyword + +> **LetKeyword**: `120` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:228 + +*** + +### LiteralType + +> **LiteralType**: `200` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:308 + +*** + +### MappedType + +> **MappedType**: `199` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:307 + +*** + +### MergeDeclarationMarker + +> **MergeDeclarationMarker**: `359` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:469 + +*** + +### MetaProperty + +> **MetaProperty**: `236` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:344 + +*** + +### MethodDeclaration + +> **MethodDeclaration**: `173` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:281 + +*** + +### MethodSignature + +> **MethodSignature**: `172` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:280 + +*** + +### MinusEqualsToken + +> **MinusEqualsToken**: `65` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:173 + +*** + +### MinusMinusToken + +> **MinusMinusToken**: `46` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:152 + +*** + +### MinusToken + +> **MinusToken**: `40` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:146 + +*** + +### MissingDeclaration + +> **MissingDeclaration**: `283` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:391 + +*** + +### ModuleBlock + +> **ModuleBlock**: `269` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:377 + +*** + +### ModuleDeclaration + +> **ModuleDeclaration**: `268` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:376 + +*** + +### ModuleKeyword + +> **ModuleKeyword**: `143` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:251 + +*** + +### MultiLineCommentTrivia + +> **MultiLineCommentTrivia**: `3` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:109 + +*** + +### NamedExports + +> **NamedExports**: `280` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:388 + +*** + +### NamedImports + +> **NamedImports**: `276` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:384 + +*** + +### NamedTupleMember + +> **NamedTupleMember**: `201` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:309 + +*** + +### NamespaceExport + +> **NamespaceExport**: `281` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:389 + +*** + +### NamespaceExportDeclaration + +> **NamespaceExportDeclaration**: `271` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:379 + +*** + +### NamespaceImport + +> **NamespaceImport**: `275` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:383 + +*** + +### NamespaceKeyword + +> **NamespaceKeyword**: `144` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:252 + +*** + +### NeverKeyword + +> **NeverKeyword**: `145` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:253 + +*** + +### NewExpression + +> **NewExpression**: `213` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:321 + +*** + +### NewKeyword + +> **NewKeyword**: `104` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:212 + +*** + +### NewLineTrivia + +> **NewLineTrivia**: `4` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:110 + +*** + +### NonNullExpression + +> **NonNullExpression**: `235` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:343 + +*** + +### NoSubstitutionTemplateLiteral + +> **NoSubstitutionTemplateLiteral**: `14` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:120 + +*** + +### NotEmittedStatement + +> **NotEmittedStatement**: `356` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:466 + +*** + +### NullKeyword + +> **NullKeyword**: `105` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:213 + +*** + +### NumberKeyword + +> **NumberKeyword**: `149` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:257 + +*** + +### NumericLiteral + +> **NumericLiteral**: `8` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:114 + +*** + +### ObjectBindingPattern + +> **ObjectBindingPattern**: `205` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:313 + +*** + +### ObjectKeyword + +> **ObjectKeyword**: `150` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:258 + +*** + +### ObjectLiteralExpression + +> **ObjectLiteralExpression**: `209` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:317 + +*** + +### OfKeyword + +> **OfKeyword**: `164` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:272 + +*** + +### OmittedExpression + +> **OmittedExpression**: `232` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:340 + +*** + +### OpenBraceToken + +> **OpenBraceToken**: `18` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:124 + +*** + +### OpenBracketToken + +> **OpenBracketToken**: `22` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:128 + +*** + +### OpenParenToken + +> **OpenParenToken**: `20` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:126 + +*** + +### OptionalType + +> **OptionalType**: `189` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:297 + +*** + +### OutKeyword + +> **OutKeyword**: `146` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:254 + +*** + +### OverrideKeyword + +> **OverrideKeyword**: `163` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:271 + +*** + +### PackageKeyword + +> **PackageKeyword**: `121` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:229 + +*** + +### Parameter + +> **Parameter**: `168` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:276 + +*** + +### ParenthesizedExpression + +> **ParenthesizedExpression**: `216` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:324 + +*** + +### ParenthesizedType + +> **ParenthesizedType**: `195` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:303 + +*** + +### PartiallyEmittedExpression + +> **PartiallyEmittedExpression**: `357` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:467 + +*** + +### PercentEqualsToken + +> **PercentEqualsToken**: `69` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:177 + +*** + +### PercentToken + +> **PercentToken**: `44` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:150 + +*** + +### PlusEqualsToken + +> **PlusEqualsToken**: `64` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:172 + +*** + +### PlusPlusToken + +> **PlusPlusToken**: `45` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:151 + +*** + +### PlusToken + +> **PlusToken**: `39` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:145 + +*** + +### PostfixUnaryExpression + +> **PostfixUnaryExpression**: `225` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:333 + +*** + +### PrefixUnaryExpression + +> **PrefixUnaryExpression**: `224` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:332 + +*** + +### PrivateIdentifier + +> **PrivateIdentifier**: `80` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:188 + +*** + +### PrivateKeyword + +> **PrivateKeyword**: `122` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:230 + +*** + +### PropertyAccessExpression + +> **PropertyAccessExpression**: `210` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:318 + +*** + +### PropertyAssignment + +> **PropertyAssignment**: `303` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:411 + +*** + +### PropertyDeclaration + +> **PropertyDeclaration**: `171` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:279 + +*** + +### PropertySignature + +> **PropertySignature**: `170` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:278 + +*** + +### ProtectedKeyword + +> **ProtectedKeyword**: `123` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:231 + +*** + +### PublicKeyword + +> **PublicKeyword**: `124` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:232 + +*** + +### QualifiedName + +> **QualifiedName**: `165` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:273 + +*** + +### QuestionDotToken + +> **QuestionDotToken**: `28` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:134 + +*** + +### QuestionQuestionEqualsToken + +> **QuestionQuestionEqualsToken**: `77` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:185 + +*** + +### QuestionQuestionToken + +> **QuestionQuestionToken**: `60` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:166 + +*** + +### QuestionToken + +> **QuestionToken**: `57` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:163 + +*** + +### ReadonlyKeyword + +> **ReadonlyKeyword**: `147` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:255 + +*** + +### RegularExpressionLiteral + +> **RegularExpressionLiteral**: `13` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:119 + +*** + +### RequireKeyword + +> **RequireKeyword**: `148` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:256 + +*** + +### RestType + +> **RestType**: `190` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:298 + +*** + +### ReturnKeyword + +> **ReturnKeyword**: `106` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:214 + +*** + +### ReturnStatement + +> **ReturnStatement**: `253` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:361 + +*** + +### SatisfiesExpression + +> **SatisfiesExpression**: `238` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:346 + +*** + +### SatisfiesKeyword + +> **SatisfiesKeyword**: `151` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:259 + +*** + +### SemicolonClassElement + +> **SemicolonClassElement**: `240` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:348 + +*** + +### SemicolonToken + +> **SemicolonToken**: `26` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:132 + +*** + +### SetAccessor + +> **SetAccessor**: `177` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:285 + +*** + +### SetKeyword + +> **SetKeyword**: `152` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:260 + +*** + +### ShebangTrivia + +> **ShebangTrivia**: `6` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:112 + +*** + +### ShorthandPropertyAssignment + +> **ShorthandPropertyAssignment**: `304` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:412 + +*** + +### SingleLineCommentTrivia + +> **SingleLineCommentTrivia**: `2` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:108 + +*** + +### SlashEqualsToken + +> **SlashEqualsToken**: `68` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:176 + +*** + +### SlashToken + +> **SlashToken**: `43` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:149 + +*** + +### SourceFile + +> **SourceFile**: `312` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:420 + +*** + +### SpreadAssignment + +> **SpreadAssignment**: `305` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:413 + +*** + +### SpreadElement + +> **SpreadElement**: `230` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:338 + +*** + +### StaticKeyword + +> **StaticKeyword**: `125` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:233 + +*** + +### StringKeyword + +> **StringKeyword**: `153` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:261 + +*** + +### StringLiteral + +> **StringLiteral**: `10` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:116 + +*** + +### StructDeclaration + +> **StructDeclaration**: `264` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:372 + +*** + +### StructKeyword + +> **StructKeyword**: `85` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:193 + +*** + +### SuperKeyword + +> **SuperKeyword**: `107` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:215 + +*** + +### SwitchKeyword + +> **SwitchKeyword**: `108` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:216 + +*** + +### SwitchStatement + +> **SwitchStatement**: `255` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:363 + +*** + +### SymbolKeyword + +> **SymbolKeyword**: `154` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:262 + +*** + +### SyntaxList + +> **SyntaxList**: `355` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:465 + +*** + +### SyntheticExpression + +> **SyntheticExpression**: `237` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:345 + +*** + +### SyntheticReferenceExpression + +> **SyntheticReferenceExpression**: `361` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:471 + +*** + +### TaggedTemplateExpression + +> **TaggedTemplateExpression**: `214` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:322 + +*** + +### TemplateExpression + +> **TemplateExpression**: `228` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:336 + +*** + +### TemplateHead + +> **TemplateHead**: `15` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:121 + +*** + +### TemplateLiteralType + +> **TemplateLiteralType**: `202` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:310 + +*** + +### TemplateLiteralTypeSpan + +> **TemplateLiteralTypeSpan**: `203` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:311 + +*** + +### TemplateMiddle + +> **TemplateMiddle**: `16` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:122 + +*** + +### TemplateSpan + +> **TemplateSpan**: `239` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:347 + +*** + +### TemplateTail + +> **TemplateTail**: `17` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:123 + +*** + +### ThisKeyword + +> **ThisKeyword**: `109` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:217 + +*** + +### ThisType + +> **ThisType**: `196` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:304 + +*** + +### ThrowKeyword + +> **ThrowKeyword**: `110` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:218 + +*** + +### ThrowStatement + +> **ThrowStatement**: `257` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:365 + +*** + +### TildeToken + +> **TildeToken**: `54` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:160 + +*** + +### TrueKeyword + +> **TrueKeyword**: `111` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:219 + +*** + +### TryKeyword + +> **TryKeyword**: `112` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:220 + +*** + +### TryStatement + +> **TryStatement**: `258` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:366 + +*** + +### TupleType + +> **TupleType**: `188` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:296 + +*** + +### TypeAliasDeclaration + +> **TypeAliasDeclaration**: `266` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:374 + +*** + +### TypeAssertionExpression + +> **TypeAssertionExpression**: `215` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:323 + +*** + +### TypeKeyword + +> **TypeKeyword**: `155` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:263 + +*** + +### TypeLiteral + +> **TypeLiteral**: `186` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:294 + +*** + +### TypeOfExpression + +> **TypeOfExpression**: `221` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:329 + +*** + +### TypeOfKeyword + +> **TypeOfKeyword**: `113` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:221 + +*** + +### TypeOperator + +> **TypeOperator**: `197` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:305 + +*** + +### TypeParameter + +> **TypeParameter**: `167` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:275 + +*** + +### TypePredicate + +> **TypePredicate**: `181` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:289 + +*** + +### TypeQuery + +> **TypeQuery**: `185` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:293 + +*** + +### TypeReference + +> **TypeReference**: `182` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:290 + +*** + +### UndefinedKeyword + +> **UndefinedKeyword**: `157` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:265 + +*** + +### UnionType + +> **UnionType**: `191` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:299 + +*** + +### UniqueKeyword + +> **UniqueKeyword**: `158` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:266 + +*** + +### Unknown + +> **Unknown**: `0` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:106 + +*** + +### UnknownKeyword + +> **UnknownKeyword**: `159` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:267 + +*** + +### UnparsedInternalText + +> **UnparsedInternalText**: `310` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:418 + +*** + +### UnparsedPrepend + +> **UnparsedPrepend**: `308` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:416 + +*** + +### UnparsedPrologue + +> **UnparsedPrologue**: `307` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:415 + +*** + +### UnparsedSource + +> **UnparsedSource**: `314` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:422 + +*** + +### UnparsedSyntheticReference + +> **UnparsedSyntheticReference**: `311` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:419 + +*** + +### UnparsedText + +> **UnparsedText**: `309` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:417 + +*** + +### VariableDeclaration + +> **VariableDeclaration**: `260` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:368 + +*** + +### VariableDeclarationList + +> **VariableDeclarationList**: `261` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:369 + +*** + +### VariableStatement + +> **VariableStatement**: `243` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:351 + +*** + +### VarKeyword + +> **VarKeyword**: `114` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:222 + +*** + +### VoidExpression + +> **VoidExpression**: `222` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:330 + +*** + +### VoidKeyword + +> **VoidKeyword**: `115` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:223 + +*** + +### WhileKeyword + +> **WhileKeyword**: `116` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:224 + +*** + +### WhileStatement + +> **WhileStatement**: `247` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:355 + +*** + +### WhitespaceTrivia + +> **WhitespaceTrivia**: `5` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:111 + +*** + +### WithKeyword + +> **WithKeyword**: `117` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:225 + +*** + +### WithStatement + +> **WithStatement**: `254` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:362 + +*** + +### YieldExpression + +> **YieldExpression**: `229` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:337 + +*** + +### YieldKeyword + +> **YieldKeyword**: `126` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:234 diff --git a/docs/api_docs/namespaces/ts/enumerations/TimePhase.md b/docs/api_docs/namespaces/ts/enumerations/TimePhase.md new file mode 100644 index 0000000000000000000000000000000000000000..a42a66b648c97c7225d0cc6f8b449347062a3419 --- /dev/null +++ b/docs/api_docs/namespaces/ts/enumerations/TimePhase.md @@ -0,0 +1,89 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TimePhase + +# Enumeration: TimePhase + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9772 + +## Enumeration Members + +### EMIT\_BUILD\_INFO + +> **EMIT\_BUILD\_INFO**: `"emitBuildInfo"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9781 + +*** + +### GET\_PROGRAM + +> **GET\_PROGRAM**: `"getProgram(not ArkTSLinter)"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9774 + +*** + +### GET\_TSC\_DIAGNOSTICS + +> **GET\_TSC\_DIAGNOSTICS**: `"getTscDiagnostics"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9780 + +*** + +### INIT + +> **INIT**: `"init"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9776 + +*** + +### LINT + +> **LINT**: `"lint"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9782 + +*** + +### NON\_STRICT\_PROGRAM\_GET\_SEMANTIC\_DIAGNOSTICS + +> **NON\_STRICT\_PROGRAM\_GET\_SEMANTIC\_DIAGNOSTICS**: `"nonStrictProgramGetSemanticDiagnostics"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9778 + +*** + +### NON\_STRICT\_PROGRAM\_GET\_SYNTACTIC\_DIAGNOSTICS + +> **NON\_STRICT\_PROGRAM\_GET\_SYNTACTIC\_DIAGNOSTICS**: `"nonStrictProgramGetSyntacticDiagnostics"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9779 + +*** + +### START + +> **START**: `"start"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9773 + +*** + +### STRICT\_PROGRAM\_GET\_SEMANTIC\_DIAGNOSTICS + +> **STRICT\_PROGRAM\_GET\_SEMANTIC\_DIAGNOSTICS**: `"strictProgramGetSemanticDiagnostics"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9777 + +*** + +### UPDATE\_ERROR\_FILE + +> **UPDATE\_ERROR\_FILE**: `"updateErrorFile"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9775 diff --git a/docs/api_docs/namespaces/ts/enumerations/TokenClass.md b/docs/api_docs/namespaces/ts/enumerations/TokenClass.md new file mode 100644 index 0000000000000000000000000000000000000000..b59d56b93a48b387b7edd893ec1f7283edf55b42 --- /dev/null +++ b/docs/api_docs/namespaces/ts/enumerations/TokenClass.md @@ -0,0 +1,89 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TokenClass + +# Enumeration: TokenClass + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7096 + +## Enumeration Members + +### BigIntLiteral + +> **BigIntLiteral**: `7` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7104 + +*** + +### Comment + +> **Comment**: `3` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7100 + +*** + +### Identifier + +> **Identifier**: `5` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7102 + +*** + +### Keyword + +> **Keyword**: `1` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7098 + +*** + +### NumberLiteral + +> **NumberLiteral**: `6` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7103 + +*** + +### Operator + +> **Operator**: `2` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7099 + +*** + +### Punctuation + +> **Punctuation**: `0` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7097 + +*** + +### RegExpLiteral + +> **RegExpLiteral**: `9` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7106 + +*** + +### StringLiteral + +> **StringLiteral**: `8` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7105 + +*** + +### Whitespace + +> **Whitespace**: `4` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7101 diff --git a/docs/api_docs/namespaces/ts/enumerations/TokenFlags.md b/docs/api_docs/namespaces/ts/enumerations/TokenFlags.md new file mode 100644 index 0000000000000000000000000000000000000000..b40ed884fb33685fb8d3f161bcdf10adbcc2c850 --- /dev/null +++ b/docs/api_docs/namespaces/ts/enumerations/TokenFlags.md @@ -0,0 +1,57 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TokenFlags + +# Enumeration: TokenFlags + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1235 + +## Enumeration Members + +### BinarySpecifier + +> **BinarySpecifier**: `128` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1240 + +*** + +### HexSpecifier + +> **HexSpecifier**: `64` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1239 + +*** + +### None + +> **None**: `0` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1236 + +*** + +### Octal + +> **Octal**: `32` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1238 + +*** + +### OctalSpecifier + +> **OctalSpecifier**: `256` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1241 + +*** + +### Scientific + +> **Scientific**: `16` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1237 diff --git a/docs/api_docs/namespaces/ts/enumerations/TypeFlags.md b/docs/api_docs/namespaces/ts/enumerations/TypeFlags.md new file mode 100644 index 0000000000000000000000000000000000000000..3697c5fdccd3b7653be70fd8efe85657e08fde21 --- /dev/null +++ b/docs/api_docs/namespaces/ts/enumerations/TypeFlags.md @@ -0,0 +1,393 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TypeFlags + +# Enumeration: TypeFlags + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2718 + +## Enumeration Members + +### Any + +> **Any**: `1` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2719 + +*** + +### BigInt + +> **BigInt**: `64` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2725 + +*** + +### BigIntLike + +> **BigIntLike**: `2112` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2754 + +*** + +### BigIntLiteral + +> **BigIntLiteral**: `2048` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2730 + +*** + +### Boolean + +> **Boolean**: `16` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2723 + +*** + +### BooleanLike + +> **BooleanLike**: `528` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2755 + +*** + +### BooleanLiteral + +> **BooleanLiteral**: `512` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2728 + +*** + +### Conditional + +> **Conditional**: `16777216` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2743 + +*** + +### Enum + +> **Enum**: `32` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2724 + +*** + +### EnumLike + +> **EnumLike**: `1056` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2756 + +*** + +### EnumLiteral + +> **EnumLiteral**: `1024` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2729 + +*** + +### ESSymbol + +> **ESSymbol**: `4096` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2731 + +*** + +### ESSymbolLike + +> **ESSymbolLike**: `12288` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2757 + +*** + +### Index + +> **Index**: `4194304` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2741 + +*** + +### IndexedAccess + +> **IndexedAccess**: `8388608` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2742 + +*** + +### Instantiable + +> **Instantiable**: `465829888` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2764 + +*** + +### InstantiableNonPrimitive + +> **InstantiableNonPrimitive**: `58982400` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2762 + +*** + +### InstantiablePrimitive + +> **InstantiablePrimitive**: `406847488` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2763 + +*** + +### Intersection + +> **Intersection**: `2097152` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2740 + +*** + +### Literal + +> **Literal**: `2944` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2748 + +*** + +### Narrowable + +> **Narrowable**: `536624127` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2766 + +*** + +### Never + +> **Never**: `131072` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2736 + +*** + +### NonPrimitive + +> **NonPrimitive**: `67108864` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2745 + +*** + +### Null + +> **Null**: `65536` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2735 + +*** + +### Number + +> **Number**: `8` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2722 + +*** + +### NumberLike + +> **NumberLike**: `296` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2753 + +*** + +### NumberLiteral + +> **NumberLiteral**: `256` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2727 + +*** + +### Object + +> **Object**: `524288` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2738 + +*** + +### PossiblyFalsy + +> **PossiblyFalsy**: `117724` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2751 + +*** + +### String + +> **String**: `4` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2721 + +*** + +### StringLike + +> **StringLike**: `402653316` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2752 + +*** + +### StringLiteral + +> **StringLiteral**: `128` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2726 + +*** + +### StringMapping + +> **StringMapping**: `268435456` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2747 + +*** + +### StringOrNumberLiteral + +> **StringOrNumberLiteral**: `384` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2750 + +*** + +### StructuredOrInstantiable + +> **StructuredOrInstantiable**: `469499904` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2765 + +*** + +### StructuredType + +> **StructuredType**: `3670016` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2760 + +*** + +### Substitution + +> **Substitution**: `33554432` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2744 + +*** + +### TemplateLiteral + +> **TemplateLiteral**: `134217728` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2746 + +*** + +### TypeParameter + +> **TypeParameter**: `262144` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2737 + +*** + +### TypeVariable + +> **TypeVariable**: `8650752` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2761 + +*** + +### Undefined + +> **Undefined**: `32768` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2734 + +*** + +### Union + +> **Union**: `1048576` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2739 + +*** + +### UnionOrIntersection + +> **UnionOrIntersection**: `3145728` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2759 + +*** + +### UniqueESSymbol + +> **UniqueESSymbol**: `8192` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2732 + +*** + +### Unit + +> **Unit**: `109440` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2749 + +*** + +### Unknown + +> **Unknown**: `2` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2720 + +*** + +### Void + +> **Void**: `16384` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2733 + +*** + +### VoidLike + +> **VoidLike**: `49152` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2758 diff --git a/docs/api_docs/namespaces/ts/enumerations/TypeFormatFlags.md b/docs/api_docs/namespaces/ts/enumerations/TypeFormatFlags.md new file mode 100644 index 0000000000000000000000000000000000000000..a4cbb565c9f891c3307d0ba7d790c3c70a546c7f --- /dev/null +++ b/docs/api_docs/namespaces/ts/enumerations/TypeFormatFlags.md @@ -0,0 +1,203 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TypeFormatFlags + +# Enumeration: TypeFormatFlags + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2524 + +## Enumeration Members + +### AddUndefined + +> **AddUndefined**: `131072` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2541 + +*** + +### AllowUniqueESSymbolType + +> **AllowUniqueESSymbolType**: `1048576` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2540 + +*** + +### InArrayType + +> **InArrayType**: `524288` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2543 + +*** + +### InElementType + +> **InElementType**: `2097152` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2544 + +*** + +### InFirstTypeArgument + +> **InFirstTypeArgument**: `4194304` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2545 + +*** + +### InTypeAlias + +> **InTypeAlias**: `8388608` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2546 + +*** + +### MultilineObjectLiterals + +> **MultilineObjectLiterals**: `1024` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2532 + +*** + +### NodeBuilderFlagsMask + +> **NodeBuilderFlagsMask**: `848330091` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2548 + +*** + +### None + +> **None**: `0` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2525 + +*** + +### NoTruncation + +> **NoTruncation**: `1` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2526 + +*** + +### NoTypeReduction + +> **NoTypeReduction**: `536870912` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2538 + +*** + +### OmitParameterModifiers + +> **OmitParameterModifiers**: `8192` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2535 + +*** + +### OmitThisParameter + +> **OmitThisParameter**: `33554432` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2539 + +*** + +### SuppressAnyReturnType + +> **SuppressAnyReturnType**: `256` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2531 + +*** + +### UseAliasDefinedOutsideCurrentScope + +> **UseAliasDefinedOutsideCurrentScope**: `16384` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2536 + +*** + +### UseFullyQualifiedType + +> **UseFullyQualifiedType**: `64` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2530 + +*** + +### UseSingleQuotesForStringLiteralType + +> **UseSingleQuotesForStringLiteralType**: `268435456` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2537 + +*** + +### UseStructuralFallback + +> **UseStructuralFallback**: `8` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2528 + +*** + +### UseTypeOfFunction + +> **UseTypeOfFunction**: `4096` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2534 + +*** + +### WriteArrayAsGenericType + +> **WriteArrayAsGenericType**: `2` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2527 + +*** + +### WriteArrowStyleSignature + +> **WriteArrowStyleSignature**: `262144` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2542 + +*** + +### WriteClassExpressionAsTypeLiteral + +> **WriteClassExpressionAsTypeLiteral**: `2048` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2533 + +*** + +### ~~WriteOwnNameForAnyLike~~ + +> **WriteOwnNameForAnyLike**: `0` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2547 + +#### Deprecated + +*** + +### WriteTypeArgumentsOfSignature + +> **WriteTypeArgumentsOfSignature**: `32` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2529 diff --git a/docs/api_docs/namespaces/ts/enumerations/TypePredicateKind.md b/docs/api_docs/namespaces/ts/enumerations/TypePredicateKind.md new file mode 100644 index 0000000000000000000000000000000000000000..fbbdcdc6dc7ff894e856e0faeae49a78cb507df0 --- /dev/null +++ b/docs/api_docs/namespaces/ts/enumerations/TypePredicateKind.md @@ -0,0 +1,41 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TypePredicateKind + +# Enumeration: TypePredicateKind + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2571 + +## Enumeration Members + +### AssertsIdentifier + +> **AssertsIdentifier**: `3` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2575 + +*** + +### AssertsThis + +> **AssertsThis**: `2` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2574 + +*** + +### Identifier + +> **Identifier**: `1` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2573 + +*** + +### This + +> **This**: `0` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2572 diff --git a/docs/api_docs/namespaces/ts/enumerations/WatchDirectoryFlags.md b/docs/api_docs/namespaces/ts/enumerations/WatchDirectoryFlags.md new file mode 100644 index 0000000000000000000000000000000000000000..0b5807f2131d9d1ae7bd48d746b16ecad1e7af6b --- /dev/null +++ b/docs/api_docs/namespaces/ts/enumerations/WatchDirectoryFlags.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / WatchDirectoryFlags + +# Enumeration: WatchDirectoryFlags + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3327 + +## Enumeration Members + +### None + +> **None**: `0` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3328 + +*** + +### Recursive + +> **Recursive**: `1` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3329 diff --git a/docs/api_docs/namespaces/ts/enumerations/WatchDirectoryKind.md b/docs/api_docs/namespaces/ts/enumerations/WatchDirectoryKind.md new file mode 100644 index 0000000000000000000000000000000000000000..52d2d5154317e86b4e77478716d2d62f82f1da32 --- /dev/null +++ b/docs/api_docs/namespaces/ts/enumerations/WatchDirectoryKind.md @@ -0,0 +1,41 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / WatchDirectoryKind + +# Enumeration: WatchDirectoryKind + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3061 + +## Enumeration Members + +### DynamicPriorityPolling + +> **DynamicPriorityPolling**: `2` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3064 + +*** + +### FixedChunkSizePolling + +> **FixedChunkSizePolling**: `3` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3065 + +*** + +### FixedPollingInterval + +> **FixedPollingInterval**: `1` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3063 + +*** + +### UseFsEvents + +> **UseFsEvents**: `0` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3062 diff --git a/docs/api_docs/namespaces/ts/enumerations/WatchFileKind.md b/docs/api_docs/namespaces/ts/enumerations/WatchFileKind.md new file mode 100644 index 0000000000000000000000000000000000000000..9feff87616b78da1794ceb8f98a22fd5a47d5e73 --- /dev/null +++ b/docs/api_docs/namespaces/ts/enumerations/WatchFileKind.md @@ -0,0 +1,57 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / WatchFileKind + +# Enumeration: WatchFileKind + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3053 + +## Enumeration Members + +### DynamicPriorityPolling + +> **DynamicPriorityPolling**: `2` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3056 + +*** + +### FixedChunkSizePolling + +> **FixedChunkSizePolling**: `3` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3057 + +*** + +### FixedPollingInterval + +> **FixedPollingInterval**: `0` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3054 + +*** + +### PriorityPollingInterval + +> **PriorityPollingInterval**: `1` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3055 + +*** + +### UseFsEvents + +> **UseFsEvents**: `4` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3058 + +*** + +### UseFsEventsOnParentDirectory + +> **UseFsEventsOnParentDirectory**: `5` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3059 diff --git a/docs/api_docs/namespaces/ts/functions/addEmitHelper.md b/docs/api_docs/namespaces/ts/functions/addEmitHelper.md new file mode 100644 index 0000000000000000000000000000000000000000..7ca80792d816dfc88cfc52d2d2fd9f9124253caa --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/addEmitHelper.md @@ -0,0 +1,31 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / addEmitHelper + +# Function: addEmitHelper() + +> **addEmitHelper**\<`T`\>(`node`, `helper`): `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4988 + +Adds an EmitHelper to a node. + +## Type Parameters + +• **T** *extends* [`Node`](../interfaces/Node.md) + +## Parameters + +### node + +`T` + +### helper + +[`EmitHelper`](../type-aliases/EmitHelper.md) + +## Returns + +`T` diff --git a/docs/api_docs/namespaces/ts/functions/addEmitHelpers.md b/docs/api_docs/namespaces/ts/functions/addEmitHelpers.md new file mode 100644 index 0000000000000000000000000000000000000000..519d3195cce22c7ac2e5d7e3c16720dfe9c8a55d --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/addEmitHelpers.md @@ -0,0 +1,31 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / addEmitHelpers + +# Function: addEmitHelpers() + +> **addEmitHelpers**\<`T`\>(`node`, `helpers`): `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4992 + +Add EmitHelpers to a node. + +## Type Parameters + +• **T** *extends* [`Node`](../interfaces/Node.md) + +## Parameters + +### node + +`T` + +### helpers + +`undefined` | [`EmitHelper`](../type-aliases/EmitHelper.md)[] + +## Returns + +`T` diff --git a/docs/api_docs/namespaces/ts/functions/addSyntheticLeadingComment.md b/docs/api_docs/namespaces/ts/functions/addSyntheticLeadingComment.md new file mode 100644 index 0000000000000000000000000000000000000000..c782e0da9c243de0ee71a77df80c9593f4b727f1 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/addSyntheticLeadingComment.md @@ -0,0 +1,37 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / addSyntheticLeadingComment + +# Function: addSyntheticLeadingComment() + +> **addSyntheticLeadingComment**\<`T`\>(`node`, `kind`, `text`, `hasTrailingNewLine`?): `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4972 + +## Type Parameters + +• **T** *extends* [`Node`](../interfaces/Node.md) + +## Parameters + +### node + +`T` + +### kind + +[`SingleLineCommentTrivia`](../enumerations/SyntaxKind.md#singlelinecommenttrivia) | [`MultiLineCommentTrivia`](../enumerations/SyntaxKind.md#multilinecommenttrivia) + +### text + +`string` + +### hasTrailingNewLine? + +`boolean` + +## Returns + +`T` diff --git a/docs/api_docs/namespaces/ts/functions/addSyntheticTrailingComment.md b/docs/api_docs/namespaces/ts/functions/addSyntheticTrailingComment.md new file mode 100644 index 0000000000000000000000000000000000000000..43e8c34d6f01637d8c9123ac371255181f332b99 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/addSyntheticTrailingComment.md @@ -0,0 +1,37 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / addSyntheticTrailingComment + +# Function: addSyntheticTrailingComment() + +> **addSyntheticTrailingComment**\<`T`\>(`node`, `kind`, `text`, `hasTrailingNewLine`?): `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4975 + +## Type Parameters + +• **T** *extends* [`Node`](../interfaces/Node.md) + +## Parameters + +### node + +`T` + +### kind + +[`SingleLineCommentTrivia`](../enumerations/SyntaxKind.md#singlelinecommenttrivia) | [`MultiLineCommentTrivia`](../enumerations/SyntaxKind.md#multilinecommenttrivia) + +### text + +`string` + +### hasTrailingNewLine? + +`boolean` + +## Returns + +`T` diff --git a/docs/api_docs/namespaces/ts/functions/canHaveDecorators.md b/docs/api_docs/namespaces/ts/functions/canHaveDecorators.md new file mode 100644 index 0000000000000000000000000000000000000000..119117067471a2861d0e0d63e794cab2cf47fc5a --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/canHaveDecorators.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / canHaveDecorators + +# Function: canHaveDecorators() + +> **canHaveDecorators**(`node`): `node is HasDecorators` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5213 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is HasDecorators` diff --git a/docs/api_docs/namespaces/ts/functions/canHaveModifiers.md b/docs/api_docs/namespaces/ts/functions/canHaveModifiers.md new file mode 100644 index 0000000000000000000000000000000000000000..b92cc42a308b4299da20600d01734673cc17dd92 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/canHaveModifiers.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / canHaveModifiers + +# Function: canHaveModifiers() + +> **canHaveModifiers**(`node`): `node is HasModifiers` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5212 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is HasModifiers` diff --git a/docs/api_docs/namespaces/ts/functions/choosePathContainsModules.md b/docs/api_docs/namespaces/ts/functions/choosePathContainsModules.md new file mode 100644 index 0000000000000000000000000000000000000000..ed79e0c0b77e28bff9456f18d378fc8d16dc370a --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/choosePathContainsModules.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / choosePathContainsModules + +# Function: choosePathContainsModules() + +> **choosePathContainsModules**(`packageManagerType`, `fileName`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5434 + +## Parameters + +### packageManagerType + +`undefined` | `string` + +### fileName + +`string` + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/functions/classicNameResolver.md b/docs/api_docs/namespaces/ts/functions/classicNameResolver.md new file mode 100644 index 0000000000000000000000000000000000000000..05da59bedd607ddcbd13980017e3d8947d238deb --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/classicNameResolver.md @@ -0,0 +1,41 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / classicNameResolver + +# Function: classicNameResolver() + +> **classicNameResolver**(`moduleName`, `containingFile`, `compilerOptions`, `host`, `cache`?, `redirectedReference`?): [`ResolvedModuleWithFailedLookupLocations`](../interfaces/ResolvedModuleWithFailedLookupLocations.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5418 + +## Parameters + +### moduleName + +`string` + +### containingFile + +`string` + +### compilerOptions + +[`CompilerOptions`](../interfaces/CompilerOptions.md) + +### host + +[`ModuleResolutionHost`](../interfaces/ModuleResolutionHost.md) + +### cache? + +[`NonRelativeModuleNameResolutionCache`](../interfaces/NonRelativeModuleNameResolutionCache.md) + +### redirectedReference? + +[`ResolvedProjectReference`](../interfaces/ResolvedProjectReference.md) + +## Returns + +[`ResolvedModuleWithFailedLookupLocations`](../interfaces/ResolvedModuleWithFailedLookupLocations.md) diff --git a/docs/api_docs/namespaces/ts/functions/collapseTextChangeRangesAcrossMultipleVersions.md b/docs/api_docs/namespaces/ts/functions/collapseTextChangeRangesAcrossMultipleVersions.md new file mode 100644 index 0000000000000000000000000000000000000000..1d430d99ad3e3c67ce2ba48c737c740f53d0fdf5 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/collapseTextChangeRangesAcrossMultipleVersions.md @@ -0,0 +1,28 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / collapseTextChangeRangesAcrossMultipleVersions + +# Function: collapseTextChangeRangesAcrossMultipleVersions() + +> **collapseTextChangeRangesAcrossMultipleVersions**(`changes`): [`TextChangeRange`](../interfaces/TextChangeRange.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4665 + +Called to merge all the changes that occurred across several versions of a script snapshot +into a single change. i.e. if a user keeps making successive edits to a script we will +have a text change from V1 to V2, V2 to V3, ..., Vn. + +This function will then merge those changes into a single change range valid between V1 and +Vn. + +## Parameters + +### changes + +readonly [`TextChangeRange`](../interfaces/TextChangeRange.md)[] + +## Returns + +[`TextChangeRange`](../interfaces/TextChangeRange.md) diff --git a/docs/api_docs/namespaces/ts/functions/concatenateDecoratorsAndModifiers.md b/docs/api_docs/namespaces/ts/functions/concatenateDecoratorsAndModifiers.md new file mode 100644 index 0000000000000000000000000000000000000000..66955b2377caff62a6c4f1c8477020be86d83f84 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/concatenateDecoratorsAndModifiers.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / concatenateDecoratorsAndModifiers + +# Function: concatenateDecoratorsAndModifiers() + +> **concatenateDecoratorsAndModifiers**(`decorators`, `modifiers`): `undefined` \| readonly [`ModifierLike`](../type-aliases/ModifierLike.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5422 + +## Parameters + +### decorators + +`undefined` | readonly [`Decorator`](../interfaces/Decorator.md)[] + +### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +## Returns + +`undefined` \| readonly [`ModifierLike`](../type-aliases/ModifierLike.md)[] diff --git a/docs/api_docs/namespaces/ts/functions/convertCompilerOptionsFromJson.md b/docs/api_docs/namespaces/ts/functions/convertCompilerOptionsFromJson.md new file mode 100644 index 0000000000000000000000000000000000000000..4c767903aea22961cd31b6fe78a467ce08cbae86 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/convertCompilerOptionsFromJson.md @@ -0,0 +1,37 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / convertCompilerOptionsFromJson + +# Function: convertCompilerOptionsFromJson() + +> **convertCompilerOptionsFromJson**(`jsonOptions`, `basePath`, `configFileName`?): `object` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5335 + +## Parameters + +### jsonOptions + +`any` + +### basePath + +`string` + +### configFileName? + +`string` + +## Returns + +`object` + +### errors + +> **errors**: [`Diagnostic`](../interfaces/Diagnostic.md)[] + +### options + +> **options**: [`CompilerOptions`](../interfaces/CompilerOptions.md) diff --git a/docs/api_docs/namespaces/ts/functions/convertToObject.md b/docs/api_docs/namespaces/ts/functions/convertToObject.md new file mode 100644 index 0000000000000000000000000000000000000000..cec0f257353850ef4aa9c983ae155c2599565f14 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/convertToObject.md @@ -0,0 +1,27 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / convertToObject + +# Function: convertToObject() + +> **convertToObject**(`sourceFile`, `errors`): `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5304 + +Convert the json syntax tree into the json value + +## Parameters + +### sourceFile + +[`JsonSourceFile`](../interfaces/JsonSourceFile.md) + +### errors + +[`Push`](../interfaces/Push.md)\<[`Diagnostic`](../interfaces/Diagnostic.md)\> + +## Returns + +`any` diff --git a/docs/api_docs/namespaces/ts/functions/convertTypeAcquisitionFromJson.md b/docs/api_docs/namespaces/ts/functions/convertTypeAcquisitionFromJson.md new file mode 100644 index 0000000000000000000000000000000000000000..0dda4bda795ad97395d277a143af7ada294df436 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/convertTypeAcquisitionFromJson.md @@ -0,0 +1,37 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / convertTypeAcquisitionFromJson + +# Function: convertTypeAcquisitionFromJson() + +> **convertTypeAcquisitionFromJson**(`jsonOptions`, `basePath`, `configFileName`?): `object` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5339 + +## Parameters + +### jsonOptions + +`any` + +### basePath + +`string` + +### configFileName? + +`string` + +## Returns + +`object` + +### errors + +> **errors**: [`Diagnostic`](../interfaces/Diagnostic.md)[] + +### options + +> **options**: [`TypeAcquisition`](../interfaces/TypeAcquisition.md) diff --git a/docs/api_docs/namespaces/ts/functions/couldStartTrivia.md b/docs/api_docs/namespaces/ts/functions/couldStartTrivia.md new file mode 100644 index 0000000000000000000000000000000000000000..8483ee526138754346f33f7a89e8e2eeec9a2cf2 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/couldStartTrivia.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / couldStartTrivia + +# Function: couldStartTrivia() + +> **couldStartTrivia**(`text`, `pos`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4621 + +## Parameters + +### text + +`string` + +### pos + +`number` + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/functions/createAbstractBuilder.md b/docs/api_docs/namespaces/ts/functions/createAbstractBuilder.md new file mode 100644 index 0000000000000000000000000000000000000000..6da49985541b5d727adb1d1f7c2c389e9542df3c --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createAbstractBuilder.md @@ -0,0 +1,75 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createAbstractBuilder + +# Function: createAbstractBuilder() + +## Call Signature + +> **createAbstractBuilder**(`newProgram`, `host`, `oldProgram`?, `configFileParsingDiagnostics`?): [`BuilderProgram`](../interfaces/BuilderProgram.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5770 + +Creates a builder thats just abstraction over program and can be used with watch + +### Parameters + +#### newProgram + +[`Program`](../interfaces/Program.md) + +#### host + +[`BuilderProgramHost`](../interfaces/BuilderProgramHost.md) + +#### oldProgram? + +[`BuilderProgram`](../interfaces/BuilderProgram.md) + +#### configFileParsingDiagnostics? + +readonly [`Diagnostic`](../interfaces/Diagnostic.md)[] + +### Returns + +[`BuilderProgram`](../interfaces/BuilderProgram.md) + +## Call Signature + +> **createAbstractBuilder**(`rootNames`, `options`, `host`?, `oldProgram`?, `configFileParsingDiagnostics`?, `projectReferences`?): [`BuilderProgram`](../interfaces/BuilderProgram.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5771 + +Creates a builder thats just abstraction over program and can be used with watch + +### Parameters + +#### rootNames + +`undefined` | readonly `string`[] + +#### options + +`undefined` | [`CompilerOptions`](../interfaces/CompilerOptions.md) + +#### host? + +[`CompilerHost`](../interfaces/CompilerHost.md) + +#### oldProgram? + +[`BuilderProgram`](../interfaces/BuilderProgram.md) + +#### configFileParsingDiagnostics? + +readonly [`Diagnostic`](../interfaces/Diagnostic.md)[] + +#### projectReferences? + +readonly [`ProjectReference`](../interfaces/ProjectReference.md)[] + +### Returns + +[`BuilderProgram`](../interfaces/BuilderProgram.md) diff --git a/docs/api_docs/namespaces/ts/functions/createAdd.md b/docs/api_docs/namespaces/ts/functions/createAdd.md new file mode 100644 index 0000000000000000000000000000000000000000..f19b4f9da25646b0f0de6e29cb3692f7855f4696 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createAdd.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createAdd + +# Function: ~~createAdd()~~ + +> **createAdd**(`left`, `right`): [`BinaryExpression`](../interfaces/BinaryExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8293 + +## Parameters + +### left + +[`Expression`](../interfaces/Expression.md) + +### right + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`BinaryExpression`](../interfaces/BinaryExpression.md) + +## Deprecated + +Use `factory.createAdd` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createArrayBindingPattern.md b/docs/api_docs/namespaces/ts/functions/createArrayBindingPattern.md new file mode 100644 index 0000000000000000000000000000000000000000..85ed702c89625bb688aa807e33bd93c3bbb8d86f --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createArrayBindingPattern.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createArrayBindingPattern + +# Function: ~~createArrayBindingPattern()~~ + +> **createArrayBindingPattern**(`elements`): [`ArrayBindingPattern`](../interfaces/ArrayBindingPattern.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7681 + +## Parameters + +### elements + +readonly [`ArrayBindingElement`](../type-aliases/ArrayBindingElement.md)[] + +## Returns + +[`ArrayBindingPattern`](../interfaces/ArrayBindingPattern.md) + +## Deprecated + +Use `factory.createArrayBindingPattern` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createArrayLiteral.md b/docs/api_docs/namespaces/ts/functions/createArrayLiteral.md new file mode 100644 index 0000000000000000000000000000000000000000..d9cd2027a715923364ceb55b1919cb1cf0767cac --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createArrayLiteral.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createArrayLiteral + +# Function: ~~createArrayLiteral()~~ + +> **createArrayLiteral**(`elements`?, `multiLine`?): [`ArrayLiteralExpression`](../interfaces/ArrayLiteralExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7689 + +## Parameters + +### elements? + +readonly [`Expression`](../interfaces/Expression.md)[] + +### multiLine? + +`boolean` + +## Returns + +[`ArrayLiteralExpression`](../interfaces/ArrayLiteralExpression.md) + +## Deprecated + +Use `factory.createArrayLiteralExpression` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createArrayTypeNode.md b/docs/api_docs/namespaces/ts/functions/createArrayTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..b699179bd16262aa5d8c7c356f9b3c1821be600c --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createArrayTypeNode.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createArrayTypeNode + +# Function: ~~createArrayTypeNode()~~ + +> **createArrayTypeNode**(`elementType`): [`ArrayTypeNode`](../interfaces/ArrayTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7614 + +## Parameters + +### elementType + +[`TypeNode`](../interfaces/TypeNode.md) + +## Returns + +[`ArrayTypeNode`](../interfaces/ArrayTypeNode.md) + +## Deprecated + +Use `factory.createArrayTypeNode` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createArrowFunction.md b/docs/api_docs/namespaces/ts/functions/createArrowFunction.md new file mode 100644 index 0000000000000000000000000000000000000000..9041f7e18470bd1c65c932c43f74324b85d26a1f --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createArrowFunction.md @@ -0,0 +1,79 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createArrowFunction + +# Function: ~~createArrowFunction()~~ + +## Deprecated + +Use `factory.createArrowFunction` or the factory supplied by your transformation context instead. + +## Call Signature + +> **createArrowFunction**(`modifiers`, `typeParameters`, `parameters`, `type`, `equalsGreaterThanToken`, `body`): [`ArrowFunction`](../interfaces/ArrowFunction.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8254 + +### Parameters + +#### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +#### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](../interfaces/TypeParameterDeclaration.md)[] + +#### parameters + +readonly [`ParameterDeclaration`](../interfaces/ParameterDeclaration.md)[] + +#### type + +`undefined` | [`TypeNode`](../interfaces/TypeNode.md) + +#### equalsGreaterThanToken + +`undefined` | [`EqualsGreaterThanToken`](../type-aliases/EqualsGreaterThanToken.md) + +#### body + +[`ConciseBody`](../type-aliases/ConciseBody.md) + +### Returns + +[`ArrowFunction`](../interfaces/ArrowFunction.md) + +## Call Signature + +> **createArrowFunction**(`modifiers`, `typeParameters`, `parameters`, `type`, `body`): [`ArrowFunction`](../interfaces/ArrowFunction.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8255 + +### Parameters + +#### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +#### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](../interfaces/TypeParameterDeclaration.md)[] + +#### parameters + +readonly [`ParameterDeclaration`](../interfaces/ParameterDeclaration.md)[] + +#### type + +`undefined` | [`TypeNode`](../interfaces/TypeNode.md) + +#### body + +[`ConciseBody`](../type-aliases/ConciseBody.md) + +### Returns + +[`ArrowFunction`](../interfaces/ArrowFunction.md) diff --git a/docs/api_docs/namespaces/ts/functions/createAsExpression.md b/docs/api_docs/namespaces/ts/functions/createAsExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..2747288937a0975138ca643ff9b4ecfdb25a9494 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createAsExpression.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createAsExpression + +# Function: ~~createAsExpression()~~ + +> **createAsExpression**(`expression`, `type`): [`AsExpression`](../interfaces/AsExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7797 + +## Parameters + +### expression + +[`Expression`](../interfaces/Expression.md) + +### type + +[`TypeNode`](../interfaces/TypeNode.md) + +## Returns + +[`AsExpression`](../interfaces/AsExpression.md) + +## Deprecated + +Use `factory.createAsExpression` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createAssignment.md b/docs/api_docs/namespaces/ts/functions/createAssignment.md new file mode 100644 index 0000000000000000000000000000000000000000..184d880d7ca5fa24b5bda8fe6612dda31b62bcf5 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createAssignment.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createAssignment + +# Function: ~~createAssignment()~~ + +> **createAssignment**(`left`, `right`): [`BinaryExpression`](../interfaces/BinaryExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8287 + +## Parameters + +### left + +[`Expression`](../interfaces/Expression.md) + +### right + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`BinaryExpression`](../interfaces/BinaryExpression.md) + +## Deprecated + +Use `factory.createAssignment` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createAwait.md b/docs/api_docs/namespaces/ts/functions/createAwait.md new file mode 100644 index 0000000000000000000000000000000000000000..c9c0da7ad44143a528f1199ebc04ff15c11a87af --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createAwait.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createAwait + +# Function: ~~createAwait()~~ + +> **createAwait**(`expression`): [`AwaitExpression`](../interfaces/AwaitExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7749 + +## Parameters + +### expression + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`AwaitExpression`](../interfaces/AwaitExpression.md) + +## Deprecated + +Use `factory.createAwaitExpression` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createBigIntLiteral.md b/docs/api_docs/namespaces/ts/functions/createBigIntLiteral.md new file mode 100644 index 0000000000000000000000000000000000000000..9216c4e9d56bc1a749b9782978bfed05000c8bf5 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createBigIntLiteral.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createBigIntLiteral + +# Function: ~~createBigIntLiteral()~~ + +> **createBigIntLiteral**(`value`): [`BigIntLiteral`](../interfaces/BigIntLiteral.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7462 + +## Parameters + +### value + +`string` | [`PseudoBigInt`](../interfaces/PseudoBigInt.md) + +## Returns + +[`BigIntLiteral`](../interfaces/BigIntLiteral.md) + +## Deprecated + +Use `factory.createBigIntLiteral` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createBinary.md b/docs/api_docs/namespaces/ts/functions/createBinary.md new file mode 100644 index 0000000000000000000000000000000000000000..94826bd067ac7260775065825fb02d6f3677ddc4 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createBinary.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createBinary + +# Function: ~~createBinary()~~ + +> **createBinary**(`left`, `operator`, `right`): [`BinaryExpression`](../interfaces/BinaryExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7761 + +## Parameters + +### left + +[`Expression`](../interfaces/Expression.md) + +### operator + +[`BinaryOperatorToken`](../type-aliases/BinaryOperatorToken.md) | [`BinaryOperator`](../type-aliases/BinaryOperator.md) + +### right + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`BinaryExpression`](../interfaces/BinaryExpression.md) + +## Deprecated + +Use `factory.createBinaryExpression` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createBindingElement.md b/docs/api_docs/namespaces/ts/functions/createBindingElement.md new file mode 100644 index 0000000000000000000000000000000000000000..f508e5fa1e6159c2e6edd25e48f4e150f89c881a --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createBindingElement.md @@ -0,0 +1,37 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createBindingElement + +# Function: ~~createBindingElement()~~ + +> **createBindingElement**(`dotDotDotToken`, `propertyName`, `name`, `initializer`?): [`BindingElement`](../interfaces/BindingElement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7685 + +## Parameters + +### dotDotDotToken + +`undefined` | [`DotDotDotToken`](../type-aliases/DotDotDotToken.md) + +### propertyName + +`undefined` | `string` | [`PropertyName`](../type-aliases/PropertyName.md) + +### name + +`string` | [`BindingName`](../type-aliases/BindingName.md) + +### initializer? + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`BindingElement`](../interfaces/BindingElement.md) + +## Deprecated + +Use `factory.createBindingElement` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createBlock.md b/docs/api_docs/namespaces/ts/functions/createBlock.md new file mode 100644 index 0000000000000000000000000000000000000000..2301222f4f977ac127ddef950f320d23c8efec22 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createBlock.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createBlock + +# Function: ~~createBlock()~~ + +> **createBlock**(`statements`, `multiLine`?): [`Block`](../interfaces/Block.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7819 + +## Parameters + +### statements + +readonly [`Statement`](../interfaces/Statement.md)[] + +### multiLine? + +`boolean` + +## Returns + +[`Block`](../interfaces/Block.md) + +## Deprecated + +Use `factory.createBlock` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createBreak.md b/docs/api_docs/namespaces/ts/functions/createBreak.md new file mode 100644 index 0000000000000000000000000000000000000000..6cc7954827626fad8fb0e56e19e9fe93a34b0b6a --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createBreak.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createBreak + +# Function: ~~createBreak()~~ + +> **createBreak**(`label`?): [`BreakStatement`](../interfaces/BreakStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7865 + +## Parameters + +### label? + +`string` | [`Identifier`](../interfaces/Identifier.md) + +## Returns + +[`BreakStatement`](../interfaces/BreakStatement.md) + +## Deprecated + +Use `factory.createBreakStatement` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createBuilderStatusReporter.md b/docs/api_docs/namespaces/ts/functions/createBuilderStatusReporter.md new file mode 100644 index 0000000000000000000000000000000000000000..09b377f7e3a8a4f662b87d3d389fe62115bd8baf --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createBuilderStatusReporter.md @@ -0,0 +1,27 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createBuilderStatusReporter + +# Function: createBuilderStatusReporter() + +> **createBuilderStatusReporter**(`system`, `pretty`?): [`DiagnosticReporter`](../type-aliases/DiagnosticReporter.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5966 + +Create a function that reports watch status by writing to the system and handles the formating of the diagnostic + +## Parameters + +### system + +[`System`](../interfaces/System.md) + +### pretty? + +`boolean` + +## Returns + +[`DiagnosticReporter`](../type-aliases/DiagnosticReporter.md) diff --git a/docs/api_docs/namespaces/ts/functions/createBundle.md b/docs/api_docs/namespaces/ts/functions/createBundle.md new file mode 100644 index 0000000000000000000000000000000000000000..e9bed2b90eef04b775d528c9d338a3ccfcaef895 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createBundle.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createBundle + +# Function: ~~createBundle()~~ + +> **createBundle**(`sourceFiles`, `prepends`?): [`Bundle`](../interfaces/Bundle.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8161 + +## Parameters + +### sourceFiles + +readonly [`SourceFile`](../interfaces/SourceFile.md)[] + +### prepends? + +readonly ([`InputFiles`](../interfaces/InputFiles.md) \| [`UnparsedSource`](../interfaces/UnparsedSource.md))[] + +## Returns + +[`Bundle`](../interfaces/Bundle.md) + +## Deprecated + +Use `factory.createBundle` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createCall.md b/docs/api_docs/namespaces/ts/functions/createCall.md new file mode 100644 index 0000000000000000000000000000000000000000..65d09a7bc9668e1b8367b40f381b49ac74f69762 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createCall.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createCall + +# Function: ~~createCall()~~ + +> **createCall**(`expression`, `typeArguments`, `argumentsArray`): [`CallExpression`](../interfaces/CallExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7713 + +## Parameters + +### expression + +[`Expression`](../interfaces/Expression.md) + +### typeArguments + +`undefined` | readonly [`TypeNode`](../interfaces/TypeNode.md)[] + +### argumentsArray + +`undefined` | readonly [`Expression`](../interfaces/Expression.md)[] + +## Returns + +[`CallExpression`](../interfaces/CallExpression.md) + +## Deprecated + +Use `factory.createCallExpression` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createCallChain.md b/docs/api_docs/namespaces/ts/functions/createCallChain.md new file mode 100644 index 0000000000000000000000000000000000000000..cb0909b7d7f6155329ce633750e6227baf6b0585 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createCallChain.md @@ -0,0 +1,37 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createCallChain + +# Function: ~~createCallChain()~~ + +> **createCallChain**(`expression`, `questionDotToken`, `typeArguments`, `argumentsArray`): [`CallChain`](../interfaces/CallChain.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7717 + +## Parameters + +### expression + +[`Expression`](../interfaces/Expression.md) + +### questionDotToken + +`undefined` | [`QuestionDotToken`](../type-aliases/QuestionDotToken.md) + +### typeArguments + +`undefined` | readonly [`TypeNode`](../interfaces/TypeNode.md)[] + +### argumentsArray + +`undefined` | readonly [`Expression`](../interfaces/Expression.md)[] + +## Returns + +[`CallChain`](../interfaces/CallChain.md) + +## Deprecated + +Use `factory.createCallChain` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createCallSignature.md b/docs/api_docs/namespaces/ts/functions/createCallSignature.md new file mode 100644 index 0000000000000000000000000000000000000000..03d25d0bf9e01ed4cceaa063ba4d405c5e0823af --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createCallSignature.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createCallSignature + +# Function: ~~createCallSignature()~~ + +> **createCallSignature**(`typeParameters`, `parameters`, `type`): [`CallSignatureDeclaration`](../interfaces/CallSignatureDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7575 + +## Parameters + +### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](../interfaces/TypeParameterDeclaration.md)[] + +### parameters + +readonly [`ParameterDeclaration`](../interfaces/ParameterDeclaration.md)[] + +### type + +`undefined` | [`TypeNode`](../interfaces/TypeNode.md) + +## Returns + +[`CallSignatureDeclaration`](../interfaces/CallSignatureDeclaration.md) + +## Deprecated + +Use `factory.createCallSignature` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createCaseBlock.md b/docs/api_docs/namespaces/ts/functions/createCaseBlock.md new file mode 100644 index 0000000000000000000000000000000000000000..ba918e11cc5313f0f3942d3a4edd224df9f0afe3 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createCaseBlock.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createCaseBlock + +# Function: ~~createCaseBlock()~~ + +> **createCaseBlock**(`clauses`): [`CaseBlock`](../interfaces/CaseBlock.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7963 + +## Parameters + +### clauses + +readonly [`CaseOrDefaultClause`](../type-aliases/CaseOrDefaultClause.md)[] + +## Returns + +[`CaseBlock`](../interfaces/CaseBlock.md) + +## Deprecated + +Use `factory.createCaseBlock` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createCaseClause.md b/docs/api_docs/namespaces/ts/functions/createCaseClause.md new file mode 100644 index 0000000000000000000000000000000000000000..3f1032f07d4ea3fb2acadb6f1634ce8c5acd46d9 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createCaseClause.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createCaseClause + +# Function: ~~createCaseClause()~~ + +> **createCaseClause**(`expression`, `statements`): [`CaseClause`](../interfaces/CaseClause.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8117 + +## Parameters + +### expression + +[`Expression`](../interfaces/Expression.md) + +### statements + +readonly [`Statement`](../interfaces/Statement.md)[] + +## Returns + +[`CaseClause`](../interfaces/CaseClause.md) + +## Deprecated + +Use `factory.createCaseClause` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createCatchClause.md b/docs/api_docs/namespaces/ts/functions/createCatchClause.md new file mode 100644 index 0000000000000000000000000000000000000000..54ff0d8b0b5171d1dbc4ae92c067436bbf5b1b67 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createCatchClause.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createCatchClause + +# Function: ~~createCatchClause()~~ + +> **createCatchClause**(`variableDeclaration`, `block`): [`CatchClause`](../interfaces/CatchClause.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8129 + +## Parameters + +### variableDeclaration + +`undefined` | `string` | [`VariableDeclaration`](../interfaces/VariableDeclaration.md) | [`BindingName`](../type-aliases/BindingName.md) + +### block + +[`Block`](../interfaces/Block.md) + +## Returns + +[`CatchClause`](../interfaces/CatchClause.md) + +## Deprecated + +Use `factory.createCatchClause` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createClassDeclaration.md b/docs/api_docs/namespaces/ts/functions/createClassDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..20816e3f6a60b9b5dfe954887c58b523780a7153 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createClassDeclaration.md @@ -0,0 +1,79 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createClassDeclaration + +# Function: ~~createClassDeclaration()~~ + +## Deprecated + +Use `factory.createClassDeclaration` or the factory supplied by your transformation context instead. + +## Call Signature + +> **createClassDeclaration**(`modifiers`, `name`, `typeParameters`, `heritageClauses`, `members`): [`ClassDeclaration`](../interfaces/ClassDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7910 + +### Parameters + +#### modifiers + +`undefined` | readonly [`ModifierLike`](../type-aliases/ModifierLike.md)[] + +#### name + +`undefined` | `string` | [`Identifier`](../interfaces/Identifier.md) + +#### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](../interfaces/TypeParameterDeclaration.md)[] + +#### heritageClauses + +`undefined` | readonly [`HeritageClause`](../interfaces/HeritageClause.md)[] + +#### members + +readonly [`ClassElement`](../interfaces/ClassElement.md)[] + +### Returns + +[`ClassDeclaration`](../interfaces/ClassDeclaration.md) + +## Call Signature + +> **createClassDeclaration**(`decorators`, `modifiers`, `name`, `typeParameters`, `heritageClauses`, `members`): [`ClassDeclaration`](../interfaces/ClassDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7911 + +### Parameters + +#### decorators + +`undefined` | readonly [`Decorator`](../interfaces/Decorator.md)[] + +#### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +#### name + +`undefined` | `string` | [`Identifier`](../interfaces/Identifier.md) + +#### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](../interfaces/TypeParameterDeclaration.md)[] + +#### heritageClauses + +`undefined` | readonly [`HeritageClause`](../interfaces/HeritageClause.md)[] + +#### members + +readonly [`ClassElement`](../interfaces/ClassElement.md)[] + +### Returns + +[`ClassDeclaration`](../interfaces/ClassDeclaration.md) diff --git a/docs/api_docs/namespaces/ts/functions/createClassExpression.md b/docs/api_docs/namespaces/ts/functions/createClassExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..09d89a8778158e98cfa0becf65b84f7f7c65c2be --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createClassExpression.md @@ -0,0 +1,41 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createClassExpression + +# Function: ~~createClassExpression()~~ + +> **createClassExpression**(`modifiers`, `name`, `typeParameters`, `heritageClauses`, `members`): [`ClassExpression`](../interfaces/ClassExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8241 + +## Parameters + +### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +### name + +`undefined` | `string` | [`Identifier`](../interfaces/Identifier.md) + +### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](../interfaces/TypeParameterDeclaration.md)[] + +### heritageClauses + +`undefined` | readonly [`HeritageClause`](../interfaces/HeritageClause.md)[] + +### members + +readonly [`ClassElement`](../interfaces/ClassElement.md)[] + +## Returns + +[`ClassExpression`](../interfaces/ClassExpression.md) + +## Deprecated + +Use `factory.createClassExpression` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createClassifier.md b/docs/api_docs/namespaces/ts/functions/createClassifier.md new file mode 100644 index 0000000000000000000000000000000000000000..cda6bcba10d1937c1de065cf97e540d0683103b6 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createClassifier.md @@ -0,0 +1,17 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createClassifier + +# Function: createClassifier() + +> **createClassifier**(): [`Classifier`](../interfaces/Classifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7313 + +The classifier is used for syntactic highlighting in editors via the TSServer + +## Returns + +[`Classifier`](../interfaces/Classifier.md) diff --git a/docs/api_docs/namespaces/ts/functions/createComma.md b/docs/api_docs/namespaces/ts/functions/createComma.md new file mode 100644 index 0000000000000000000000000000000000000000..cb94331b92bb68df666d91d98725e781ece16b4a --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createComma.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createComma + +# Function: ~~createComma()~~ + +> **createComma**(`left`, `right`): [`Expression`](../interfaces/Expression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8283 + +## Parameters + +### left + +[`Expression`](../interfaces/Expression.md) + +### right + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`Expression`](../interfaces/Expression.md) + +## Deprecated + +Use `factory.createComma` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createCommaList.md b/docs/api_docs/namespaces/ts/functions/createCommaList.md new file mode 100644 index 0000000000000000000000000000000000000000..f4ab1db16aabbfc82ccd41b3e0e2a11f9bc4ba59 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createCommaList.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createCommaList + +# Function: ~~createCommaList()~~ + +> **createCommaList**(`elements`): [`CommaListExpression`](../interfaces/CommaListExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8157 + +## Parameters + +### elements + +readonly [`Expression`](../interfaces/Expression.md)[] + +## Returns + +[`CommaListExpression`](../interfaces/CommaListExpression.md) + +## Deprecated + +Use `factory.createCommaListExpression` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createCompilerHost.md b/docs/api_docs/namespaces/ts/functions/createCompilerHost.md new file mode 100644 index 0000000000000000000000000000000000000000..4992b3ab6e75d388c3036f8eba751fc031ff031f --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createCompilerHost.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createCompilerHost + +# Function: createCompilerHost() + +> **createCompilerHost**(`options`, `setParentNodes`?): [`CompilerHost`](../interfaces/CompilerHost.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5545 + +## Parameters + +### options + +[`CompilerOptions`](../interfaces/CompilerOptions.md) + +### setParentNodes? + +`boolean` + +## Returns + +[`CompilerHost`](../interfaces/CompilerHost.md) diff --git a/docs/api_docs/namespaces/ts/functions/createComputedPropertyName.md b/docs/api_docs/namespaces/ts/functions/createComputedPropertyName.md new file mode 100644 index 0000000000000000000000000000000000000000..e01b107ce32c310a6119db4eca1be0309bcf7756 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createComputedPropertyName.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createComputedPropertyName + +# Function: ~~createComputedPropertyName()~~ + +> **createComputedPropertyName**(`expression`): [`ComputedPropertyName`](../interfaces/ComputedPropertyName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7497 + +## Parameters + +### expression + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`ComputedPropertyName`](../interfaces/ComputedPropertyName.md) + +## Deprecated + +Use `factory.createComputedPropertyName` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createConditional.md b/docs/api_docs/namespaces/ts/functions/createConditional.md new file mode 100644 index 0000000000000000000000000000000000000000..78b57f625bab0e871293aed46b3622ecdb9f7c7f --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createConditional.md @@ -0,0 +1,67 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createConditional + +# Function: ~~createConditional()~~ + +## Deprecated + +Use `factory.createConditional` or the factory supplied by your transformation context instead. + +## Call Signature + +> **createConditional**(`condition`, `whenTrue`, `whenFalse`): [`ConditionalExpression`](../interfaces/ConditionalExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8232 + +### Parameters + +#### condition + +[`Expression`](../interfaces/Expression.md) + +#### whenTrue + +[`Expression`](../interfaces/Expression.md) + +#### whenFalse + +[`Expression`](../interfaces/Expression.md) + +### Returns + +[`ConditionalExpression`](../interfaces/ConditionalExpression.md) + +## Call Signature + +> **createConditional**(`condition`, `questionToken`, `whenTrue`, `colonToken`, `whenFalse`): [`ConditionalExpression`](../interfaces/ConditionalExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8233 + +### Parameters + +#### condition + +[`Expression`](../interfaces/Expression.md) + +#### questionToken + +[`QuestionToken`](../type-aliases/QuestionToken.md) + +#### whenTrue + +[`Expression`](../interfaces/Expression.md) + +#### colonToken + +[`ColonToken`](../type-aliases/ColonToken.md) + +#### whenFalse + +[`Expression`](../interfaces/Expression.md) + +### Returns + +[`ConditionalExpression`](../interfaces/ConditionalExpression.md) diff --git a/docs/api_docs/namespaces/ts/functions/createConditionalTypeNode.md b/docs/api_docs/namespaces/ts/functions/createConditionalTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..5966f97fde734628dd279148e87ef8542f5d3e35 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createConditionalTypeNode.md @@ -0,0 +1,37 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createConditionalTypeNode + +# Function: ~~createConditionalTypeNode()~~ + +> **createConditionalTypeNode**(`checkType`, `extendsType`, `trueType`, `falseType`): [`ConditionalTypeNode`](../interfaces/ConditionalTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7638 + +## Parameters + +### checkType + +[`TypeNode`](../interfaces/TypeNode.md) + +### extendsType + +[`TypeNode`](../interfaces/TypeNode.md) + +### trueType + +[`TypeNode`](../interfaces/TypeNode.md) + +### falseType + +[`TypeNode`](../interfaces/TypeNode.md) + +## Returns + +[`ConditionalTypeNode`](../interfaces/ConditionalTypeNode.md) + +## Deprecated + +Use `factory.createConditionalTypeNode` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createConstructSignature.md b/docs/api_docs/namespaces/ts/functions/createConstructSignature.md new file mode 100644 index 0000000000000000000000000000000000000000..2c60a95a2fc27af9d07755de38af0526f75ee40c --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createConstructSignature.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createConstructSignature + +# Function: ~~createConstructSignature()~~ + +> **createConstructSignature**(`typeParameters`, `parameters`, `type`): [`ConstructSignatureDeclaration`](../interfaces/ConstructSignatureDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7579 + +## Parameters + +### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](../interfaces/TypeParameterDeclaration.md)[] + +### parameters + +readonly [`ParameterDeclaration`](../interfaces/ParameterDeclaration.md)[] + +### type + +`undefined` | [`TypeNode`](../interfaces/TypeNode.md) + +## Returns + +[`ConstructSignatureDeclaration`](../interfaces/ConstructSignatureDeclaration.md) + +## Deprecated + +Use `factory.createConstructSignature` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createConstructor.md b/docs/api_docs/namespaces/ts/functions/createConstructor.md new file mode 100644 index 0000000000000000000000000000000000000000..272f00dd139dbf973dc6a84256f41ab6b68a2aa2 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createConstructor.md @@ -0,0 +1,63 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createConstructor + +# Function: ~~createConstructor()~~ + +## Deprecated + +Use `factory.createConstructorDeclaration` or the factory supplied by your transformation context instead. + +## Call Signature + +> **createConstructor**(`modifiers`, `parameters`, `body`): [`ConstructorDeclaration`](../interfaces/ConstructorDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7546 + +### Parameters + +#### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +#### parameters + +readonly [`ParameterDeclaration`](../interfaces/ParameterDeclaration.md)[] + +#### body + +`undefined` | [`Block`](../interfaces/Block.md) + +### Returns + +[`ConstructorDeclaration`](../interfaces/ConstructorDeclaration.md) + +## Call Signature + +> **createConstructor**(`decorators`, `modifiers`, `parameters`, `body`): [`ConstructorDeclaration`](../interfaces/ConstructorDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7547 + +### Parameters + +#### decorators + +`undefined` | readonly [`Decorator`](../interfaces/Decorator.md)[] + +#### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +#### parameters + +readonly [`ParameterDeclaration`](../interfaces/ParameterDeclaration.md)[] + +#### body + +`undefined` | [`Block`](../interfaces/Block.md) + +### Returns + +[`ConstructorDeclaration`](../interfaces/ConstructorDeclaration.md) diff --git a/docs/api_docs/namespaces/ts/functions/createConstructorTypeNode.md b/docs/api_docs/namespaces/ts/functions/createConstructorTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..4746521a9f9ab241208e4b572fea77f2bf4ee8c2 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createConstructorTypeNode.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createConstructorTypeNode + +# Function: ~~createConstructorTypeNode()~~ + +> **createConstructorTypeNode**(`typeParameters`, `parameters`, `type`): [`ConstructorTypeNode`](../interfaces/ConstructorTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7602 + +## Parameters + +### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](../interfaces/TypeParameterDeclaration.md)[] + +### parameters + +readonly [`ParameterDeclaration`](../interfaces/ParameterDeclaration.md)[] + +### type + +[`TypeNode`](../interfaces/TypeNode.md) + +## Returns + +[`ConstructorTypeNode`](../interfaces/ConstructorTypeNode.md) + +## Deprecated + +Use `factory.createConstructorTypeNode` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createContinue.md b/docs/api_docs/namespaces/ts/functions/createContinue.md new file mode 100644 index 0000000000000000000000000000000000000000..77352f2385526f122eb266fd08bae4068f38c23f --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createContinue.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createContinue + +# Function: ~~createContinue()~~ + +> **createContinue**(`label`?): [`ContinueStatement`](../interfaces/ContinueStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7861 + +## Parameters + +### label? + +`string` | [`Identifier`](../interfaces/Identifier.md) + +## Returns + +[`ContinueStatement`](../interfaces/ContinueStatement.md) + +## Deprecated + +Use `factory.createContinueStatement` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createDebuggerStatement.md b/docs/api_docs/namespaces/ts/functions/createDebuggerStatement.md new file mode 100644 index 0000000000000000000000000000000000000000..395f058ec60abb898dba8d4428c62b2ef79f7168 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createDebuggerStatement.md @@ -0,0 +1,19 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createDebuggerStatement + +# Function: ~~createDebuggerStatement()~~ + +> **createDebuggerStatement**(): [`DebuggerStatement`](../interfaces/DebuggerStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7893 + +## Returns + +[`DebuggerStatement`](../interfaces/DebuggerStatement.md) + +## Deprecated + +Use `factory.createDebuggerStatement` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createDecorator.md b/docs/api_docs/namespaces/ts/functions/createDecorator.md new file mode 100644 index 0000000000000000000000000000000000000000..967e1260322d3237b9781286c731d759787568e2 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createDecorator.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createDecorator + +# Function: ~~createDecorator()~~ + +> **createDecorator**(`expression`): [`Decorator`](../interfaces/Decorator.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7521 + +## Parameters + +### expression + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`Decorator`](../interfaces/Decorator.md) + +## Deprecated + +Use `factory.createDecorator` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createDefaultClause.md b/docs/api_docs/namespaces/ts/functions/createDefaultClause.md new file mode 100644 index 0000000000000000000000000000000000000000..1d47fd0a8585f2dc919afee213256d72c2e05288 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createDefaultClause.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createDefaultClause + +# Function: ~~createDefaultClause()~~ + +> **createDefaultClause**(`statements`): [`DefaultClause`](../interfaces/DefaultClause.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8121 + +## Parameters + +### statements + +readonly [`Statement`](../interfaces/Statement.md)[] + +## Returns + +[`DefaultClause`](../interfaces/DefaultClause.md) + +## Deprecated + +Use `factory.createDefaultClause` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createDelete.md b/docs/api_docs/namespaces/ts/functions/createDelete.md new file mode 100644 index 0000000000000000000000000000000000000000..d179997e164317e2b94e5070ad55db2880765a5a --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createDelete.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createDelete + +# Function: ~~createDelete()~~ + +> **createDelete**(`expression`): [`DeleteExpression`](../interfaces/DeleteExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7737 + +## Parameters + +### expression + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`DeleteExpression`](../interfaces/DeleteExpression.md) + +## Deprecated + +Use `factory.createDeleteExpression` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createDo.md b/docs/api_docs/namespaces/ts/functions/createDo.md new file mode 100644 index 0000000000000000000000000000000000000000..b2c63b1f98540b9ac6e8defbccb5602be0f312d7 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createDo.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createDo + +# Function: ~~createDo()~~ + +> **createDo**(`statement`, `expression`): [`DoStatement`](../interfaces/DoStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7841 + +## Parameters + +### statement + +[`Statement`](../interfaces/Statement.md) + +### expression + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`DoStatement`](../interfaces/DoStatement.md) + +## Deprecated + +Use `factory.createDoStatement` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createDocumentRegistry.md b/docs/api_docs/namespaces/ts/functions/createDocumentRegistry.md new file mode 100644 index 0000000000000000000000000000000000000000..a87b0cd84a7f4289d642a23adbe4cde69fe2696d --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createDocumentRegistry.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createDocumentRegistry + +# Function: createDocumentRegistry() + +> **createDocumentRegistry**(`useCaseSensitiveFileNames`?, `currentDirectory`?): [`DocumentRegistry`](../interfaces/DocumentRegistry.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7408 + +## Parameters + +### useCaseSensitiveFileNames? + +`boolean` + +### currentDirectory? + +`string` + +## Returns + +[`DocumentRegistry`](../interfaces/DocumentRegistry.md) diff --git a/docs/api_docs/namespaces/ts/functions/createElementAccess.md b/docs/api_docs/namespaces/ts/functions/createElementAccess.md new file mode 100644 index 0000000000000000000000000000000000000000..232d9bbd2599a28ec4d2be2a5f41824772583cd4 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createElementAccess.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createElementAccess + +# Function: ~~createElementAccess()~~ + +> **createElementAccess**(`expression`, `index`): [`ElementAccessExpression`](../interfaces/ElementAccessExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7705 + +## Parameters + +### expression + +[`Expression`](../interfaces/Expression.md) + +### index + +`number` | [`Expression`](../interfaces/Expression.md) + +## Returns + +[`ElementAccessExpression`](../interfaces/ElementAccessExpression.md) + +## Deprecated + +Use `factory.createElementAccessExpression` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createElementAccessChain.md b/docs/api_docs/namespaces/ts/functions/createElementAccessChain.md new file mode 100644 index 0000000000000000000000000000000000000000..6ef93682184136dadf01f9bf9f4a91b26bc11944 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createElementAccessChain.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createElementAccessChain + +# Function: ~~createElementAccessChain()~~ + +> **createElementAccessChain**(`expression`, `questionDotToken`, `index`): [`ElementAccessChain`](../interfaces/ElementAccessChain.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7709 + +## Parameters + +### expression + +[`Expression`](../interfaces/Expression.md) + +### questionDotToken + +`undefined` | [`QuestionDotToken`](../type-aliases/QuestionDotToken.md) + +### index + +`number` | [`Expression`](../interfaces/Expression.md) + +## Returns + +[`ElementAccessChain`](../interfaces/ElementAccessChain.md) + +## Deprecated + +Use `factory.createElementAccessChain` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createEmitAndSemanticDiagnosticsBuilderProgram.md b/docs/api_docs/namespaces/ts/functions/createEmitAndSemanticDiagnosticsBuilderProgram.md new file mode 100644 index 0000000000000000000000000000000000000000..4f093309b3cb4f64b9cefabcb69a71be8f26fcac --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createEmitAndSemanticDiagnosticsBuilderProgram.md @@ -0,0 +1,77 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createEmitAndSemanticDiagnosticsBuilderProgram + +# Function: createEmitAndSemanticDiagnosticsBuilderProgram() + +## Call Signature + +> **createEmitAndSemanticDiagnosticsBuilderProgram**(`newProgram`, `host`, `oldProgram`?, `configFileParsingDiagnostics`?): [`EmitAndSemanticDiagnosticsBuilderProgram`](../interfaces/EmitAndSemanticDiagnosticsBuilderProgram.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5764 + +Create the builder that can handle the changes in program and iterate through changed files +to emit the those files and manage semantic diagnostics cache as well + +### Parameters + +#### newProgram + +[`Program`](../interfaces/Program.md) + +#### host + +[`BuilderProgramHost`](../interfaces/BuilderProgramHost.md) + +#### oldProgram? + +[`EmitAndSemanticDiagnosticsBuilderProgram`](../interfaces/EmitAndSemanticDiagnosticsBuilderProgram.md) + +#### configFileParsingDiagnostics? + +readonly [`Diagnostic`](../interfaces/Diagnostic.md)[] + +### Returns + +[`EmitAndSemanticDiagnosticsBuilderProgram`](../interfaces/EmitAndSemanticDiagnosticsBuilderProgram.md) + +## Call Signature + +> **createEmitAndSemanticDiagnosticsBuilderProgram**(`rootNames`, `options`, `host`?, `oldProgram`?, `configFileParsingDiagnostics`?, `projectReferences`?): [`EmitAndSemanticDiagnosticsBuilderProgram`](../interfaces/EmitAndSemanticDiagnosticsBuilderProgram.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5765 + +Create the builder that can handle the changes in program and iterate through changed files +to emit the those files and manage semantic diagnostics cache as well + +### Parameters + +#### rootNames + +`undefined` | readonly `string`[] + +#### options + +`undefined` | [`CompilerOptions`](../interfaces/CompilerOptions.md) + +#### host? + +[`CompilerHost`](../interfaces/CompilerHost.md) + +#### oldProgram? + +[`EmitAndSemanticDiagnosticsBuilderProgram`](../interfaces/EmitAndSemanticDiagnosticsBuilderProgram.md) + +#### configFileParsingDiagnostics? + +readonly [`Diagnostic`](../interfaces/Diagnostic.md)[] + +#### projectReferences? + +readonly [`ProjectReference`](../interfaces/ProjectReference.md)[] + +### Returns + +[`EmitAndSemanticDiagnosticsBuilderProgram`](../interfaces/EmitAndSemanticDiagnosticsBuilderProgram.md) diff --git a/docs/api_docs/namespaces/ts/functions/createEmitAndSemanticDiagnosticsBuilderProgramForArkTs.md b/docs/api_docs/namespaces/ts/functions/createEmitAndSemanticDiagnosticsBuilderProgramForArkTs.md new file mode 100644 index 0000000000000000000000000000000000000000..6116a47ff3ba6a487a8a0fbe045c68a62b0de2a6 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createEmitAndSemanticDiagnosticsBuilderProgramForArkTs.md @@ -0,0 +1,41 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createEmitAndSemanticDiagnosticsBuilderProgramForArkTs + +# Function: createEmitAndSemanticDiagnosticsBuilderProgramForArkTs() + +> **createEmitAndSemanticDiagnosticsBuilderProgramForArkTs**(`newProgramOrRootNames`, `hostOrOptions`, `oldProgramOrHost`?, `configFileParsingDiagnosticsOrOldProgram`?, `configFileParsingDiagnostics`?, `projectReferences`?): [`EmitAndSemanticDiagnosticsBuilderProgram`](../interfaces/EmitAndSemanticDiagnosticsBuilderProgram.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5766 + +## Parameters + +### newProgramOrRootNames + +`undefined` | readonly `string`[] | [`Program`](../interfaces/Program.md) + +### hostOrOptions + +`undefined` | [`CompilerOptions`](../interfaces/CompilerOptions.md) | [`BuilderProgramHost`](../interfaces/BuilderProgramHost.md) + +### oldProgramOrHost? + +[`CompilerHost`](../interfaces/CompilerHost.md) | [`EmitAndSemanticDiagnosticsBuilderProgram`](../interfaces/EmitAndSemanticDiagnosticsBuilderProgram.md) + +### configFileParsingDiagnosticsOrOldProgram? + +readonly [`Diagnostic`](../interfaces/Diagnostic.md)[] | [`EmitAndSemanticDiagnosticsBuilderProgram`](../interfaces/EmitAndSemanticDiagnosticsBuilderProgram.md) + +### configFileParsingDiagnostics? + +readonly [`Diagnostic`](../interfaces/Diagnostic.md)[] + +### projectReferences? + +readonly [`ProjectReference`](../interfaces/ProjectReference.md)[] + +## Returns + +[`EmitAndSemanticDiagnosticsBuilderProgram`](../interfaces/EmitAndSemanticDiagnosticsBuilderProgram.md) diff --git a/docs/api_docs/namespaces/ts/functions/createEmptyStatement.md b/docs/api_docs/namespaces/ts/functions/createEmptyStatement.md new file mode 100644 index 0000000000000000000000000000000000000000..287389975807c3585a2ad921ce6269bf68da3585 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createEmptyStatement.md @@ -0,0 +1,19 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createEmptyStatement + +# Function: ~~createEmptyStatement()~~ + +> **createEmptyStatement**(): [`EmptyStatement`](../interfaces/EmptyStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7827 + +## Returns + +[`EmptyStatement`](../interfaces/EmptyStatement.md) + +## Deprecated + +Use `factory.createEmptyStatement` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createEnumDeclaration.md b/docs/api_docs/namespaces/ts/functions/createEnumDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..719bd0ad9a807a5fa889630bac85857bf7608e42 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createEnumDeclaration.md @@ -0,0 +1,63 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createEnumDeclaration + +# Function: ~~createEnumDeclaration()~~ + +## Deprecated + +Use `factory.createEnumDeclaration` or the factory supplied by your transformation context instead. + +## Call Signature + +> **createEnumDeclaration**(`modifiers`, `name`, `members`): [`EnumDeclaration`](../interfaces/EnumDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7940 + +### Parameters + +#### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +#### name + +`string` | [`Identifier`](../interfaces/Identifier.md) + +#### members + +readonly [`EnumMember`](../interfaces/EnumMember.md)[] + +### Returns + +[`EnumDeclaration`](../interfaces/EnumDeclaration.md) + +## Call Signature + +> **createEnumDeclaration**(`decorators`, `modifiers`, `name`, `members`): [`EnumDeclaration`](../interfaces/EnumDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7941 + +### Parameters + +#### decorators + +`undefined` | readonly [`Decorator`](../interfaces/Decorator.md)[] + +#### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +#### name + +`string` | [`Identifier`](../interfaces/Identifier.md) + +#### members + +readonly [`EnumMember`](../interfaces/EnumMember.md)[] + +### Returns + +[`EnumDeclaration`](../interfaces/EnumDeclaration.md) diff --git a/docs/api_docs/namespaces/ts/functions/createEnumMember.md b/docs/api_docs/namespaces/ts/functions/createEnumMember.md new file mode 100644 index 0000000000000000000000000000000000000000..d837c543d9999a48cdeb5407bc46fc05af52dc48 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createEnumMember.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createEnumMember + +# Function: ~~createEnumMember()~~ + +> **createEnumMember**(`name`, `initializer`?): [`EnumMember`](../interfaces/EnumMember.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8145 + +## Parameters + +### name + +`string` | [`PropertyName`](../type-aliases/PropertyName.md) + +### initializer? + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`EnumMember`](../interfaces/EnumMember.md) + +## Deprecated + +Use `factory.createEnumMember` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createExportAssignment.md b/docs/api_docs/namespaces/ts/functions/createExportAssignment.md new file mode 100644 index 0000000000000000000000000000000000000000..b5c3b039399c35648c04931ca14c831308501c88 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createExportAssignment.md @@ -0,0 +1,63 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createExportAssignment + +# Function: ~~createExportAssignment()~~ + +## Deprecated + +Use `factory.createExportAssignment` or the factory supplied by your transformation context instead. + +## Call Signature + +> **createExportAssignment**(`modifiers`, `isExportEquals`, `expression`): [`ExportAssignment`](../interfaces/ExportAssignment.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8004 + +### Parameters + +#### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +#### isExportEquals + +`undefined` | `boolean` + +#### expression + +[`Expression`](../interfaces/Expression.md) + +### Returns + +[`ExportAssignment`](../interfaces/ExportAssignment.md) + +## Call Signature + +> **createExportAssignment**(`decorators`, `modifiers`, `isExportEquals`, `expression`): [`ExportAssignment`](../interfaces/ExportAssignment.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8005 + +### Parameters + +#### decorators + +`undefined` | readonly [`Decorator`](../interfaces/Decorator.md)[] + +#### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +#### isExportEquals + +`undefined` | `boolean` + +#### expression + +[`Expression`](../interfaces/Expression.md) + +### Returns + +[`ExportAssignment`](../interfaces/ExportAssignment.md) diff --git a/docs/api_docs/namespaces/ts/functions/createExportDeclaration.md b/docs/api_docs/namespaces/ts/functions/createExportDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..9f8623bd58cf9c6264cff6f327af2147674ab506 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createExportDeclaration.md @@ -0,0 +1,41 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createExportDeclaration + +# Function: ~~createExportDeclaration()~~ + +> **createExportDeclaration**(`decorators`, `modifiers`, `exportClause`, `moduleSpecifier`?, `isTypeOnly`?): [`ExportDeclaration`](../interfaces/ExportDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8277 + +## Parameters + +### decorators + +`undefined` | readonly [`Decorator`](../interfaces/Decorator.md)[] + +### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +### exportClause + +`undefined` | [`NamedExportBindings`](../type-aliases/NamedExportBindings.md) + +### moduleSpecifier? + +[`Expression`](../interfaces/Expression.md) + +### isTypeOnly? + +`any` + +## Returns + +[`ExportDeclaration`](../interfaces/ExportDeclaration.md) + +## Deprecated + +Use `factory.createExportDeclaration` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createExportDefault.md b/docs/api_docs/namespaces/ts/functions/createExportDefault.md new file mode 100644 index 0000000000000000000000000000000000000000..a4f7cccd18faff2fd7f1f5e20eea14ce06e8b924 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createExportDefault.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createExportDefault + +# Function: ~~createExportDefault()~~ + +> **createExportDefault**(`expression`): [`ExportAssignment`](../interfaces/ExportAssignment.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8177 + +## Parameters + +### expression + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`ExportAssignment`](../interfaces/ExportAssignment.md) + +## Deprecated + +Use `factory.createExportDefault` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createExportSpecifier.md b/docs/api_docs/namespaces/ts/functions/createExportSpecifier.md new file mode 100644 index 0000000000000000000000000000000000000000..2cb846bd6d76951aa52ae44d7fecd36ed5897410 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createExportSpecifier.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createExportSpecifier + +# Function: ~~createExportSpecifier()~~ + +> **createExportSpecifier**(`isTypeOnly`, `propertyName`, `name`): [`ExportSpecifier`](../interfaces/ExportSpecifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8017 + +## Parameters + +### isTypeOnly + +`boolean` + +### propertyName + +`undefined` | `string` | [`Identifier`](../interfaces/Identifier.md) + +### name + +`string` | [`Identifier`](../interfaces/Identifier.md) + +## Returns + +[`ExportSpecifier`](../interfaces/ExportSpecifier.md) + +## Deprecated + +Use `factory.createExportSpecifier` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createExpressionStatement.md b/docs/api_docs/namespaces/ts/functions/createExpressionStatement.md new file mode 100644 index 0000000000000000000000000000000000000000..d46ff197df4fee51d8148504b34af4672033de5a --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createExpressionStatement.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createExpressionStatement + +# Function: ~~createExpressionStatement()~~ + +> **createExpressionStatement**(`expression`): [`ExpressionStatement`](../interfaces/ExpressionStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7829 + +## Parameters + +### expression + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`ExpressionStatement`](../interfaces/ExpressionStatement.md) + +## Deprecated + +Use `factory.createExpressionStatement` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createExpressionWithTypeArguments.md b/docs/api_docs/namespaces/ts/functions/createExpressionWithTypeArguments.md new file mode 100644 index 0000000000000000000000000000000000000000..80911b71244e373a638f878dc028c48b0569f8d5 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createExpressionWithTypeArguments.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createExpressionWithTypeArguments + +# Function: ~~createExpressionWithTypeArguments()~~ + +> **createExpressionWithTypeArguments**(`typeArguments`, `expression`): [`ExpressionWithTypeArguments`](../interfaces/ExpressionWithTypeArguments.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8249 + +## Parameters + +### typeArguments + +`undefined` | readonly [`TypeNode`](../interfaces/TypeNode.md)[] + +### expression + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`ExpressionWithTypeArguments`](../interfaces/ExpressionWithTypeArguments.md) + +## Deprecated + +Use `factory.createExpressionWithTypeArguments` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createExternalModuleExport.md b/docs/api_docs/namespaces/ts/functions/createExternalModuleExport.md new file mode 100644 index 0000000000000000000000000000000000000000..98091572480843a093328730b8cbd4543bce3f1a --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createExternalModuleExport.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createExternalModuleExport + +# Function: ~~createExternalModuleExport()~~ + +> **createExternalModuleExport**(`exportName`): [`ExportDeclaration`](../interfaces/ExportDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8179 + +## Parameters + +### exportName + +[`Identifier`](../interfaces/Identifier.md) + +## Returns + +[`ExportDeclaration`](../interfaces/ExportDeclaration.md) + +## Deprecated + +Use `factory.createExternalModuleExport` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createExternalModuleReference.md b/docs/api_docs/namespaces/ts/functions/createExternalModuleReference.md new file mode 100644 index 0000000000000000000000000000000000000000..edb2cc993283c2f77843debda6295a49497b7550 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createExternalModuleReference.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createExternalModuleReference + +# Function: ~~createExternalModuleReference()~~ + +> **createExternalModuleReference**(`expression`): [`ExternalModuleReference`](../interfaces/ExternalModuleReference.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8021 + +## Parameters + +### expression + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`ExternalModuleReference`](../interfaces/ExternalModuleReference.md) + +## Deprecated + +Use `factory.createExternalModuleReference` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createFalse.md b/docs/api_docs/namespaces/ts/functions/createFalse.md new file mode 100644 index 0000000000000000000000000000000000000000..80985ea3e12ad5ffff7afde27a585904d1be51f5 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createFalse.md @@ -0,0 +1,19 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createFalse + +# Function: ~~createFalse()~~ + +> **createFalse**(): [`FalseLiteral`](../interfaces/FalseLiteral.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7487 + +## Returns + +[`FalseLiteral`](../interfaces/FalseLiteral.md) + +## Deprecated + +Use `factory.createFalse` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createFileLevelUniqueName.md b/docs/api_docs/namespaces/ts/functions/createFileLevelUniqueName.md new file mode 100644 index 0000000000000000000000000000000000000000..4cd96f8df9a45ad8693cde3d21333378e5990205 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createFileLevelUniqueName.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createFileLevelUniqueName + +# Function: ~~createFileLevelUniqueName()~~ + +> **createFileLevelUniqueName**(`text`): [`Identifier`](../interfaces/Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8195 + +## Parameters + +### text + +`string` + +## Returns + +[`Identifier`](../interfaces/Identifier.md) + +## Deprecated + +Use `factory.createUniqueName(text, GeneratedIdentifierFlags.Optimistic | GeneratedIdentifierFlags.FileLevel)` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createFor.md b/docs/api_docs/namespaces/ts/functions/createFor.md new file mode 100644 index 0000000000000000000000000000000000000000..2daf9452ce358dfec1b0c16d56e68089f0ce77e0 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createFor.md @@ -0,0 +1,37 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createFor + +# Function: ~~createFor()~~ + +> **createFor**(`initializer`, `condition`, `incrementor`, `statement`): [`ForStatement`](../interfaces/ForStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7849 + +## Parameters + +### initializer + +`undefined` | [`ForInitializer`](../type-aliases/ForInitializer.md) + +### condition + +`undefined` | [`Expression`](../interfaces/Expression.md) + +### incrementor + +`undefined` | [`Expression`](../interfaces/Expression.md) + +### statement + +[`Statement`](../interfaces/Statement.md) + +## Returns + +[`ForStatement`](../interfaces/ForStatement.md) + +## Deprecated + +Use `factory.createForStatement` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createForIn.md b/docs/api_docs/namespaces/ts/functions/createForIn.md new file mode 100644 index 0000000000000000000000000000000000000000..ed5f7c881821c82861df6c7986e468297d1a0b7a --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createForIn.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createForIn + +# Function: ~~createForIn()~~ + +> **createForIn**(`initializer`, `expression`, `statement`): [`ForInStatement`](../interfaces/ForInStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7853 + +## Parameters + +### initializer + +[`ForInitializer`](../type-aliases/ForInitializer.md) + +### expression + +[`Expression`](../interfaces/Expression.md) + +### statement + +[`Statement`](../interfaces/Statement.md) + +## Returns + +[`ForInStatement`](../interfaces/ForInStatement.md) + +## Deprecated + +Use `factory.createForInStatement` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createForOf.md b/docs/api_docs/namespaces/ts/functions/createForOf.md new file mode 100644 index 0000000000000000000000000000000000000000..f03bbccaf781d31903244bfb3c8865065639f9ac --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createForOf.md @@ -0,0 +1,37 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createForOf + +# Function: ~~createForOf()~~ + +> **createForOf**(`awaitModifier`, `initializer`, `expression`, `statement`): [`ForOfStatement`](../interfaces/ForOfStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7857 + +## Parameters + +### awaitModifier + +`undefined` | [`AwaitKeyword`](../type-aliases/AwaitKeyword.md) + +### initializer + +[`ForInitializer`](../type-aliases/ForInitializer.md) + +### expression + +[`Expression`](../interfaces/Expression.md) + +### statement + +[`Statement`](../interfaces/Statement.md) + +## Returns + +[`ForOfStatement`](../interfaces/ForOfStatement.md) + +## Deprecated + +Use `factory.createForOfStatement` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createFunctionDeclaration.md b/docs/api_docs/namespaces/ts/functions/createFunctionDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..79378777c9244e5240032a916cb0900b9519b80b --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createFunctionDeclaration.md @@ -0,0 +1,95 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createFunctionDeclaration + +# Function: ~~createFunctionDeclaration()~~ + +## Deprecated + +Use `factory.createFunctionDeclaration` or the factory supplied by your transformation context instead. + +## Call Signature + +> **createFunctionDeclaration**(`modifiers`, `asteriskToken`, `name`, `typeParameters`, `parameters`, `type`, `body`): [`FunctionDeclaration`](../interfaces/FunctionDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7900 + +### Parameters + +#### modifiers + +`undefined` | readonly [`ModifierLike`](../type-aliases/ModifierLike.md)[] + +#### asteriskToken + +`undefined` | [`AsteriskToken`](../type-aliases/AsteriskToken.md) + +#### name + +`undefined` | `string` | [`Identifier`](../interfaces/Identifier.md) + +#### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](../interfaces/TypeParameterDeclaration.md)[] + +#### parameters + +readonly [`ParameterDeclaration`](../interfaces/ParameterDeclaration.md)[] + +#### type + +`undefined` | [`TypeNode`](../interfaces/TypeNode.md) + +#### body + +`undefined` | [`Block`](../interfaces/Block.md) + +### Returns + +[`FunctionDeclaration`](../interfaces/FunctionDeclaration.md) + +## Call Signature + +> **createFunctionDeclaration**(`decorators`, `modifiers`, `asteriskToken`, `name`, `typeParameters`, `parameters`, `type`, `body`): [`FunctionDeclaration`](../interfaces/FunctionDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7901 + +### Parameters + +#### decorators + +`undefined` | readonly [`Decorator`](../interfaces/Decorator.md)[] + +#### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +#### asteriskToken + +`undefined` | [`AsteriskToken`](../type-aliases/AsteriskToken.md) + +#### name + +`undefined` | `string` | [`Identifier`](../interfaces/Identifier.md) + +#### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](../interfaces/TypeParameterDeclaration.md)[] + +#### parameters + +readonly [`ParameterDeclaration`](../interfaces/ParameterDeclaration.md)[] + +#### type + +`undefined` | [`TypeNode`](../interfaces/TypeNode.md) + +#### body + +`undefined` | [`Block`](../interfaces/Block.md) + +### Returns + +[`FunctionDeclaration`](../interfaces/FunctionDeclaration.md) diff --git a/docs/api_docs/namespaces/ts/functions/createFunctionExpression.md b/docs/api_docs/namespaces/ts/functions/createFunctionExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..9fde1a1a8ef5a3880cb2e77925a9f850b072d1f3 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createFunctionExpression.md @@ -0,0 +1,49 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createFunctionExpression + +# Function: ~~createFunctionExpression()~~ + +> **createFunctionExpression**(`modifiers`, `asteriskToken`, `name`, `typeParameters`, `parameters`, `type`, `body`): [`FunctionExpression`](../interfaces/FunctionExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7733 + +## Parameters + +### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +### asteriskToken + +`undefined` | [`AsteriskToken`](../type-aliases/AsteriskToken.md) + +### name + +`undefined` | `string` | [`Identifier`](../interfaces/Identifier.md) + +### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](../interfaces/TypeParameterDeclaration.md)[] + +### parameters + +`undefined` | readonly [`ParameterDeclaration`](../interfaces/ParameterDeclaration.md)[] + +### type + +`undefined` | [`TypeNode`](../interfaces/TypeNode.md) + +### body + +[`Block`](../interfaces/Block.md) + +## Returns + +[`FunctionExpression`](../interfaces/FunctionExpression.md) + +## Deprecated + +Use `factory.createFunctionExpression` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createFunctionTypeNode.md b/docs/api_docs/namespaces/ts/functions/createFunctionTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..449f9414fd1e9343bbf31936f735513053785c54 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createFunctionTypeNode.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createFunctionTypeNode + +# Function: ~~createFunctionTypeNode()~~ + +> **createFunctionTypeNode**(`typeParameters`, `parameters`, `type`): [`FunctionTypeNode`](../interfaces/FunctionTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7598 + +## Parameters + +### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](../interfaces/TypeParameterDeclaration.md)[] + +### parameters + +readonly [`ParameterDeclaration`](../interfaces/ParameterDeclaration.md)[] + +### type + +[`TypeNode`](../interfaces/TypeNode.md) + +## Returns + +[`FunctionTypeNode`](../interfaces/FunctionTypeNode.md) + +## Deprecated + +Use `factory.createFunctionTypeNode` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createGetAccessor.md b/docs/api_docs/namespaces/ts/functions/createGetAccessor.md new file mode 100644 index 0000000000000000000000000000000000000000..2c84d3d808911ace43a42280cced840a8eb4e89a --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createGetAccessor.md @@ -0,0 +1,79 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createGetAccessor + +# Function: ~~createGetAccessor()~~ + +## Deprecated + +Use `factory.createGetAccessorDeclaration` or the factory supplied by your transformation context instead. + +## Call Signature + +> **createGetAccessor**(`modifiers`, `name`, `parameters`, `type`, `body`): [`GetAccessorDeclaration`](../interfaces/GetAccessorDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7556 + +### Parameters + +#### modifiers + +`undefined` | readonly [`ModifierLike`](../type-aliases/ModifierLike.md)[] + +#### name + +`string` | [`PropertyName`](../type-aliases/PropertyName.md) + +#### parameters + +readonly [`ParameterDeclaration`](../interfaces/ParameterDeclaration.md)[] + +#### type + +`undefined` | [`TypeNode`](../interfaces/TypeNode.md) + +#### body + +`undefined` | [`Block`](../interfaces/Block.md) + +### Returns + +[`GetAccessorDeclaration`](../interfaces/GetAccessorDeclaration.md) + +## Call Signature + +> **createGetAccessor**(`decorators`, `modifiers`, `name`, `parameters`, `type`, `body`): [`GetAccessorDeclaration`](../interfaces/GetAccessorDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7557 + +### Parameters + +#### decorators + +`undefined` | readonly [`Decorator`](../interfaces/Decorator.md)[] + +#### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +#### name + +`string` | [`PropertyName`](../type-aliases/PropertyName.md) + +#### parameters + +readonly [`ParameterDeclaration`](../interfaces/ParameterDeclaration.md)[] + +#### type + +`undefined` | [`TypeNode`](../interfaces/TypeNode.md) + +#### body + +`undefined` | [`Block`](../interfaces/Block.md) + +### Returns + +[`GetAccessorDeclaration`](../interfaces/GetAccessorDeclaration.md) diff --git a/docs/api_docs/namespaces/ts/functions/createHeritageClause.md b/docs/api_docs/namespaces/ts/functions/createHeritageClause.md new file mode 100644 index 0000000000000000000000000000000000000000..b0bb2ac814ae4c30266105f2db327de372d71252 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createHeritageClause.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createHeritageClause + +# Function: ~~createHeritageClause()~~ + +> **createHeritageClause**(`token`, `types`): [`HeritageClause`](../interfaces/HeritageClause.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8125 + +## Parameters + +### token + +[`ExtendsKeyword`](../enumerations/SyntaxKind.md#extendskeyword) | [`ImplementsKeyword`](../enumerations/SyntaxKind.md#implementskeyword) + +### types + +readonly [`ExpressionWithTypeArguments`](../interfaces/ExpressionWithTypeArguments.md)[] + +## Returns + +[`HeritageClause`](../interfaces/HeritageClause.md) + +## Deprecated + +Use `factory.createHeritageClause` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createIdentifier.md b/docs/api_docs/namespaces/ts/functions/createIdentifier.md new file mode 100644 index 0000000000000000000000000000000000000000..5408f4d352b24b4358d604de28a3bfd7fb7a14f9 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createIdentifier.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createIdentifier + +# Function: ~~createIdentifier()~~ + +> **createIdentifier**(`text`): [`Identifier`](../interfaces/Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8187 + +## Parameters + +### text + +`string` + +## Returns + +[`Identifier`](../interfaces/Identifier.md) + +## Deprecated + +Use `factory.createIdentifier` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createIf.md b/docs/api_docs/namespaces/ts/functions/createIf.md new file mode 100644 index 0000000000000000000000000000000000000000..a63db6e190ba07d9a2a17f0feb49f611481723c5 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createIf.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createIf + +# Function: ~~createIf()~~ + +> **createIf**(`expression`, `thenStatement`, `elseStatement`?): [`IfStatement`](../interfaces/IfStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7837 + +## Parameters + +### expression + +[`Expression`](../interfaces/Expression.md) + +### thenStatement + +[`Statement`](../interfaces/Statement.md) + +### elseStatement? + +[`Statement`](../interfaces/Statement.md) + +## Returns + +[`IfStatement`](../interfaces/IfStatement.md) + +## Deprecated + +Use `factory.createIfStatement` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createImmediatelyInvokedArrowFunction.md b/docs/api_docs/namespaces/ts/functions/createImmediatelyInvokedArrowFunction.md new file mode 100644 index 0000000000000000000000000000000000000000..b4be61fb40c006a7c37bfa8ed7f789d62f743d80 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createImmediatelyInvokedArrowFunction.md @@ -0,0 +1,51 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createImmediatelyInvokedArrowFunction + +# Function: ~~createImmediatelyInvokedArrowFunction()~~ + +## Deprecated + +Use `factory.createImmediatelyInvokedArrowFunction` or the factory supplied by your transformation context instead. + +## Call Signature + +> **createImmediatelyInvokedArrowFunction**(`statements`): [`CallExpression`](../interfaces/CallExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8171 + +### Parameters + +#### statements + +readonly [`Statement`](../interfaces/Statement.md)[] + +### Returns + +[`CallExpression`](../interfaces/CallExpression.md) + +## Call Signature + +> **createImmediatelyInvokedArrowFunction**(`statements`, `param`, `paramValue`): [`CallExpression`](../interfaces/CallExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8172 + +### Parameters + +#### statements + +readonly [`Statement`](../interfaces/Statement.md)[] + +#### param + +[`ParameterDeclaration`](../interfaces/ParameterDeclaration.md) + +#### paramValue + +[`Expression`](../interfaces/Expression.md) + +### Returns + +[`CallExpression`](../interfaces/CallExpression.md) diff --git a/docs/api_docs/namespaces/ts/functions/createImmediatelyInvokedFunctionExpression.md b/docs/api_docs/namespaces/ts/functions/createImmediatelyInvokedFunctionExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..34b39844f4f38953b8ba4b447a9fb4a2c55e4527 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createImmediatelyInvokedFunctionExpression.md @@ -0,0 +1,51 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createImmediatelyInvokedFunctionExpression + +# Function: ~~createImmediatelyInvokedFunctionExpression()~~ + +## Deprecated + +Use `factory.createImmediatelyInvokedFunctionExpression` or the factory supplied by your transformation context instead. + +## Call Signature + +> **createImmediatelyInvokedFunctionExpression**(`statements`): [`CallExpression`](../interfaces/CallExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8166 + +### Parameters + +#### statements + +readonly [`Statement`](../interfaces/Statement.md)[] + +### Returns + +[`CallExpression`](../interfaces/CallExpression.md) + +## Call Signature + +> **createImmediatelyInvokedFunctionExpression**(`statements`, `param`, `paramValue`): [`CallExpression`](../interfaces/CallExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8167 + +### Parameters + +#### statements + +readonly [`Statement`](../interfaces/Statement.md)[] + +#### param + +[`ParameterDeclaration`](../interfaces/ParameterDeclaration.md) + +#### paramValue + +[`Expression`](../interfaces/Expression.md) + +### Returns + +[`CallExpression`](../interfaces/CallExpression.md) diff --git a/docs/api_docs/namespaces/ts/functions/createImportClause.md b/docs/api_docs/namespaces/ts/functions/createImportClause.md new file mode 100644 index 0000000000000000000000000000000000000000..9c4626d1e1c6a89c0e795c6d6f452992296caffe --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createImportClause.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createImportClause + +# Function: ~~createImportClause()~~ + +> **createImportClause**(`name`, `namedBindings`, `isTypeOnly`?): [`ImportClause`](../interfaces/ImportClause.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8273 + +## Parameters + +### name + +`undefined` | [`Identifier`](../interfaces/Identifier.md) + +### namedBindings + +`undefined` | [`NamedImportBindings`](../type-aliases/NamedImportBindings.md) + +### isTypeOnly? + +`any` + +## Returns + +[`ImportClause`](../interfaces/ImportClause.md) + +## Deprecated + +Use `factory.createImportClause` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createImportDeclaration.md b/docs/api_docs/namespaces/ts/functions/createImportDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..0bc84e807c2159d33bf6e9cb31b8e3d5ded19842 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createImportDeclaration.md @@ -0,0 +1,71 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createImportDeclaration + +# Function: ~~createImportDeclaration()~~ + +## Deprecated + +Use `factory.createImportDeclaration` or the factory supplied by your transformation context instead. + +## Call Signature + +> **createImportDeclaration**(`modifiers`, `importClause`, `moduleSpecifier`, `assertClause`?): [`ImportDeclaration`](../interfaces/ImportDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7982 + +### Parameters + +#### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +#### importClause + +`undefined` | [`ImportClause`](../interfaces/ImportClause.md) + +#### moduleSpecifier + +[`Expression`](../interfaces/Expression.md) + +#### assertClause? + +[`AssertClause`](../interfaces/AssertClause.md) + +### Returns + +[`ImportDeclaration`](../interfaces/ImportDeclaration.md) + +## Call Signature + +> **createImportDeclaration**(`decorators`, `modifiers`, `importClause`, `moduleSpecifier`, `assertClause`?): [`ImportDeclaration`](../interfaces/ImportDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7983 + +### Parameters + +#### decorators + +`undefined` | readonly [`Decorator`](../interfaces/Decorator.md)[] + +#### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +#### importClause + +`undefined` | [`ImportClause`](../interfaces/ImportClause.md) + +#### moduleSpecifier + +[`Expression`](../interfaces/Expression.md) + +#### assertClause? + +[`AssertClause`](../interfaces/AssertClause.md) + +### Returns + +[`ImportDeclaration`](../interfaces/ImportDeclaration.md) diff --git a/docs/api_docs/namespaces/ts/functions/createImportEqualsDeclaration.md b/docs/api_docs/namespaces/ts/functions/createImportEqualsDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..9436f11d5a8a71b3a7f3a323de59ccefa75b5af2 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createImportEqualsDeclaration.md @@ -0,0 +1,71 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createImportEqualsDeclaration + +# Function: ~~createImportEqualsDeclaration()~~ + +## Deprecated + +Use `factory.createImportEqualsDeclaration` or the factory supplied by your transformation context instead. + +## Call Signature + +> **createImportEqualsDeclaration**(`modifiers`, `isTypeOnly`, `name`, `moduleReference`): [`ImportEqualsDeclaration`](../interfaces/ImportEqualsDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7972 + +### Parameters + +#### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +#### isTypeOnly + +`boolean` + +#### name + +`string` | [`Identifier`](../interfaces/Identifier.md) + +#### moduleReference + +[`ModuleReference`](../type-aliases/ModuleReference.md) + +### Returns + +[`ImportEqualsDeclaration`](../interfaces/ImportEqualsDeclaration.md) + +## Call Signature + +> **createImportEqualsDeclaration**(`decorators`, `modifiers`, `isTypeOnly`, `name`, `moduleReference`): [`ImportEqualsDeclaration`](../interfaces/ImportEqualsDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7973 + +### Parameters + +#### decorators + +`undefined` | readonly [`Decorator`](../interfaces/Decorator.md)[] + +#### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +#### isTypeOnly + +`boolean` + +#### name + +`string` | [`Identifier`](../interfaces/Identifier.md) + +#### moduleReference + +[`ModuleReference`](../type-aliases/ModuleReference.md) + +### Returns + +[`ImportEqualsDeclaration`](../interfaces/ImportEqualsDeclaration.md) diff --git a/docs/api_docs/namespaces/ts/functions/createImportSpecifier.md b/docs/api_docs/namespaces/ts/functions/createImportSpecifier.md new file mode 100644 index 0000000000000000000000000000000000000000..59aee35d5e9455e272e36c16180ba831b40dbc44 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createImportSpecifier.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createImportSpecifier + +# Function: ~~createImportSpecifier()~~ + +> **createImportSpecifier**(`isTypeOnly`, `propertyName`, `name`): [`ImportSpecifier`](../interfaces/ImportSpecifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7999 + +## Parameters + +### isTypeOnly + +`boolean` + +### propertyName + +`undefined` | [`Identifier`](../interfaces/Identifier.md) + +### name + +[`Identifier`](../interfaces/Identifier.md) + +## Returns + +[`ImportSpecifier`](../interfaces/ImportSpecifier.md) + +## Deprecated + +Use `factory.createImportSpecifier` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createImportTypeNode.md b/docs/api_docs/namespaces/ts/functions/createImportTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..b45649d704a6544c0956ea9ce68431902f7fcab4 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createImportTypeNode.md @@ -0,0 +1,103 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createImportTypeNode + +# Function: ~~createImportTypeNode()~~ + +## Deprecated + +Use `factory.createImportTypeNode` or the factory supplied by your transformation context instead. + +## Call Signature + +> **createImportTypeNode**(`argument`, `assertions`?, `qualifier`?, `typeArguments`?, `isTypeOf`?): [`ImportTypeNode`](../interfaces/ImportTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7647 + +### Parameters + +#### argument + +[`TypeNode`](../interfaces/TypeNode.md) + +#### assertions? + +[`ImportTypeAssertionContainer`](../interfaces/ImportTypeAssertionContainer.md) + +#### qualifier? + +[`EntityName`](../type-aliases/EntityName.md) + +#### typeArguments? + +readonly [`TypeNode`](../interfaces/TypeNode.md)[] + +#### isTypeOf? + +`boolean` + +### Returns + +[`ImportTypeNode`](../interfaces/ImportTypeNode.md) + +## Call Signature + +> **createImportTypeNode**(`argument`, `assertions`?, `qualifier`?, `typeArguments`?, `isTypeOf`?): [`ImportTypeNode`](../interfaces/ImportTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7648 + +### Parameters + +#### argument + +[`TypeNode`](../interfaces/TypeNode.md) + +#### assertions? + +[`ImportTypeAssertionContainer`](../interfaces/ImportTypeAssertionContainer.md) + +#### qualifier? + +[`EntityName`](../type-aliases/EntityName.md) + +#### typeArguments? + +readonly [`TypeNode`](../interfaces/TypeNode.md)[] + +#### isTypeOf? + +`boolean` + +### Returns + +[`ImportTypeNode`](../interfaces/ImportTypeNode.md) + +## Call Signature + +> **createImportTypeNode**(`argument`, `qualifier`?, `typeArguments`?, `isTypeOf`?): [`ImportTypeNode`](../interfaces/ImportTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7649 + +### Parameters + +#### argument + +[`TypeNode`](../interfaces/TypeNode.md) + +#### qualifier? + +[`EntityName`](../type-aliases/EntityName.md) + +#### typeArguments? + +readonly [`TypeNode`](../interfaces/TypeNode.md)[] + +#### isTypeOf? + +`boolean` + +### Returns + +[`ImportTypeNode`](../interfaces/ImportTypeNode.md) diff --git a/docs/api_docs/namespaces/ts/functions/createIncrementalCompilerHost.md b/docs/api_docs/namespaces/ts/functions/createIncrementalCompilerHost.md new file mode 100644 index 0000000000000000000000000000000000000000..827721c7d2582851eb864257f3fb8a2e161e6360 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createIncrementalCompilerHost.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createIncrementalCompilerHost + +# Function: createIncrementalCompilerHost() + +> **createIncrementalCompilerHost**(`options`, `system`?): [`CompilerHost`](../interfaces/CompilerHost.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5781 + +## Parameters + +### options + +[`CompilerOptions`](../interfaces/CompilerOptions.md) + +### system? + +[`System`](../interfaces/System.md) + +## Returns + +[`CompilerHost`](../interfaces/CompilerHost.md) diff --git a/docs/api_docs/namespaces/ts/functions/createIncrementalProgram.md b/docs/api_docs/namespaces/ts/functions/createIncrementalProgram.md new file mode 100644 index 0000000000000000000000000000000000000000..6a82ba2ef3e0962b8785e2acb7ba08a956b704e8 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createIncrementalProgram.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createIncrementalProgram + +# Function: createIncrementalProgram() + +> **createIncrementalProgram**\<`T`\>(`__namedParameters`): `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5790 + +## Type Parameters + +• **T** *extends* [`BuilderProgram`](../interfaces/BuilderProgram.md) = [`EmitAndSemanticDiagnosticsBuilderProgram`](../interfaces/EmitAndSemanticDiagnosticsBuilderProgram.md) + +## Parameters + +### \_\_namedParameters + +[`IncrementalProgramOptions`](../interfaces/IncrementalProgramOptions.md)\<`T`\> + +## Returns + +`T` diff --git a/docs/api_docs/namespaces/ts/functions/createIncrementalProgramForArkTs.md b/docs/api_docs/namespaces/ts/functions/createIncrementalProgramForArkTs.md new file mode 100644 index 0000000000000000000000000000000000000000..53a9b0cdb6b316fcd77f5e68471958dce8faefca --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createIncrementalProgramForArkTs.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createIncrementalProgramForArkTs + +# Function: createIncrementalProgramForArkTs() + +> **createIncrementalProgramForArkTs**(`__namedParameters`): [`EmitAndSemanticDiagnosticsBuilderProgram`](../interfaces/EmitAndSemanticDiagnosticsBuilderProgram.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5791 + +## Parameters + +### \_\_namedParameters + +[`IncrementalProgramOptions`](../interfaces/IncrementalProgramOptions.md)\<[`EmitAndSemanticDiagnosticsBuilderProgram`](../interfaces/EmitAndSemanticDiagnosticsBuilderProgram.md)\> + +## Returns + +[`EmitAndSemanticDiagnosticsBuilderProgram`](../interfaces/EmitAndSemanticDiagnosticsBuilderProgram.md) diff --git a/docs/api_docs/namespaces/ts/functions/createIndexSignature.md b/docs/api_docs/namespaces/ts/functions/createIndexSignature.md new file mode 100644 index 0000000000000000000000000000000000000000..42313a7183eff9fda8e6c94b44048d8417161127 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createIndexSignature.md @@ -0,0 +1,37 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createIndexSignature + +# Function: ~~createIndexSignature()~~ + +> **createIndexSignature**(`decorators`, `modifiers`, `parameters`, `type`): [`IndexSignatureDeclaration`](../interfaces/IndexSignatureDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8197 + +## Parameters + +### decorators + +`undefined` | readonly [`Decorator`](../interfaces/Decorator.md)[] + +### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +### parameters + +readonly [`ParameterDeclaration`](../interfaces/ParameterDeclaration.md)[] + +### type + +[`TypeNode`](../interfaces/TypeNode.md) + +## Returns + +[`IndexSignatureDeclaration`](../interfaces/IndexSignatureDeclaration.md) + +## Deprecated + +Use `factory.createIndexSignature` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createIndexedAccessTypeNode.md b/docs/api_docs/namespaces/ts/functions/createIndexedAccessTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..abc4b3c1a94c0fef6f99b22f708e8698c93caae2 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createIndexedAccessTypeNode.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createIndexedAccessTypeNode + +# Function: ~~createIndexedAccessTypeNode()~~ + +> **createIndexedAccessTypeNode**(`objectType`, `indexType`): [`IndexedAccessTypeNode`](../interfaces/IndexedAccessTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7665 + +## Parameters + +### objectType + +[`TypeNode`](../interfaces/TypeNode.md) + +### indexType + +[`TypeNode`](../interfaces/TypeNode.md) + +## Returns + +[`IndexedAccessTypeNode`](../interfaces/IndexedAccessTypeNode.md) + +## Deprecated + +Use `factory.createIndexedAccessTypeNode` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createInferTypeNode.md b/docs/api_docs/namespaces/ts/functions/createInferTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..3ba432868137c2d4976ec5084a0bcce4ce66b934 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createInferTypeNode.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createInferTypeNode + +# Function: ~~createInferTypeNode()~~ + +> **createInferTypeNode**(`typeParameter`): [`InferTypeNode`](../interfaces/InferTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7642 + +## Parameters + +### typeParameter + +[`TypeParameterDeclaration`](../interfaces/TypeParameterDeclaration.md) + +## Returns + +[`InferTypeNode`](../interfaces/InferTypeNode.md) + +## Deprecated + +Use `factory.createInferTypeNode` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createInputFiles.md b/docs/api_docs/namespaces/ts/functions/createInputFiles.md new file mode 100644 index 0000000000000000000000000000000000000000..98471aedb8fcf51d74fb5cad6b3ee0a97b7c172a --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createInputFiles.md @@ -0,0 +1,99 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createInputFiles + +# Function: createInputFiles() + +## Call Signature + +> **createInputFiles**(`javascriptText`, `declarationText`): [`InputFiles`](../interfaces/InputFiles.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4927 + +### Parameters + +#### javascriptText + +`string` + +#### declarationText + +`string` + +### Returns + +[`InputFiles`](../interfaces/InputFiles.md) + +## Call Signature + +> **createInputFiles**(`readFileText`, `javascriptPath`, `javascriptMapPath`, `declarationPath`, `declarationMapPath`, `buildInfoPath`): [`InputFiles`](../interfaces/InputFiles.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4928 + +### Parameters + +#### readFileText + +(`path`) => `undefined` \| `string` + +#### javascriptPath + +`string` + +#### javascriptMapPath + +`undefined` | `string` + +#### declarationPath + +`string` + +#### declarationMapPath + +`undefined` | `string` + +#### buildInfoPath + +`undefined` | `string` + +### Returns + +[`InputFiles`](../interfaces/InputFiles.md) + +## Call Signature + +> **createInputFiles**(`javascriptText`, `declarationText`, `javascriptMapPath`, `javascriptMapText`, `declarationMapPath`, `declarationMapText`): [`InputFiles`](../interfaces/InputFiles.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4929 + +### Parameters + +#### javascriptText + +`string` + +#### declarationText + +`string` + +#### javascriptMapPath + +`undefined` | `string` + +#### javascriptMapText + +`undefined` | `string` + +#### declarationMapPath + +`undefined` | `string` + +#### declarationMapText + +`undefined` | `string` + +### Returns + +[`InputFiles`](../interfaces/InputFiles.md) diff --git a/docs/api_docs/namespaces/ts/functions/createInterfaceDeclaration.md b/docs/api_docs/namespaces/ts/functions/createInterfaceDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..388948790a6a3af053c6ef881edfc71779a2d73b --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createInterfaceDeclaration.md @@ -0,0 +1,79 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createInterfaceDeclaration + +# Function: ~~createInterfaceDeclaration()~~ + +## Deprecated + +Use `factory.createInterfaceDeclaration` or the factory supplied by your transformation context instead. + +## Call Signature + +> **createInterfaceDeclaration**(`modifiers`, `name`, `typeParameters`, `heritageClauses`, `members`): [`InterfaceDeclaration`](../interfaces/InterfaceDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7920 + +### Parameters + +#### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +#### name + +`string` | [`Identifier`](../interfaces/Identifier.md) + +#### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](../interfaces/TypeParameterDeclaration.md)[] + +#### heritageClauses + +`undefined` | readonly [`HeritageClause`](../interfaces/HeritageClause.md)[] + +#### members + +readonly [`TypeElement`](../interfaces/TypeElement.md)[] + +### Returns + +[`InterfaceDeclaration`](../interfaces/InterfaceDeclaration.md) + +## Call Signature + +> **createInterfaceDeclaration**(`decorators`, `modifiers`, `name`, `typeParameters`, `heritageClauses`, `members`): [`InterfaceDeclaration`](../interfaces/InterfaceDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7921 + +### Parameters + +#### decorators + +`undefined` | readonly [`Decorator`](../interfaces/Decorator.md)[] + +#### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +#### name + +`string` | [`Identifier`](../interfaces/Identifier.md) + +#### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](../interfaces/TypeParameterDeclaration.md)[] + +#### heritageClauses + +`undefined` | readonly [`HeritageClause`](../interfaces/HeritageClause.md)[] + +#### members + +readonly [`TypeElement`](../interfaces/TypeElement.md)[] + +### Returns + +[`InterfaceDeclaration`](../interfaces/InterfaceDeclaration.md) diff --git a/docs/api_docs/namespaces/ts/functions/createIntersectionTypeNode.md b/docs/api_docs/namespaces/ts/functions/createIntersectionTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..ebbabf88d26ce90b9ccd33f43ce8036faf8f3017 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createIntersectionTypeNode.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createIntersectionTypeNode + +# Function: ~~createIntersectionTypeNode()~~ + +> **createIntersectionTypeNode**(`types`): [`IntersectionTypeNode`](../interfaces/IntersectionTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7634 + +## Parameters + +### types + +readonly [`TypeNode`](../interfaces/TypeNode.md)[] + +## Returns + +[`IntersectionTypeNode`](../interfaces/IntersectionTypeNode.md) + +## Deprecated + +Use `factory.createIntersectionTypeNode` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createJSDocAugmentsTag.md b/docs/api_docs/namespaces/ts/functions/createJSDocAugmentsTag.md new file mode 100644 index 0000000000000000000000000000000000000000..9c2caede2bff0589163b6cf4d5da96c205a8fe23 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createJSDocAugmentsTag.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createJSDocAugmentsTag + +# Function: ~~createJSDocAugmentsTag()~~ + +> **createJSDocAugmentsTag**(`tagName`, `className`, `comment`?): [`JSDocAugmentsTag`](../interfaces/JSDocAugmentsTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8039 + +## Parameters + +### tagName + +`undefined` | [`Identifier`](../interfaces/Identifier.md) + +### className + +[`ExpressionWithTypeArguments`](../interfaces/ExpressionWithTypeArguments.md) & `object` + +### comment? + +`string` | [`NodeArray`](../interfaces/NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +## Returns + +[`JSDocAugmentsTag`](../interfaces/JSDocAugmentsTag.md) + +## Deprecated + +Use `factory.createJSDocAugmentsTag` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createJSDocAuthorTag.md b/docs/api_docs/namespaces/ts/functions/createJSDocAuthorTag.md new file mode 100644 index 0000000000000000000000000000000000000000..c5c72f233a13961fd4baa9a58d5ca91058051bd8 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createJSDocAuthorTag.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createJSDocAuthorTag + +# Function: ~~createJSDocAuthorTag()~~ + +> **createJSDocAuthorTag**(`tagName`, `comment`?): [`JSDocAuthorTag`](../interfaces/JSDocAuthorTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8061 + +## Parameters + +### tagName + +`undefined` | [`Identifier`](../interfaces/Identifier.md) + +### comment? + +`string` | [`NodeArray`](../interfaces/NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +## Returns + +[`JSDocAuthorTag`](../interfaces/JSDocAuthorTag.md) + +## Deprecated + +Use `factory.createJSDocAuthorTag` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createJSDocCallbackTag.md b/docs/api_docs/namespaces/ts/functions/createJSDocCallbackTag.md new file mode 100644 index 0000000000000000000000000000000000000000..2b57e6ffd52e32812f6c3876b5ba4e1fb31df222 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createJSDocCallbackTag.md @@ -0,0 +1,37 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createJSDocCallbackTag + +# Function: ~~createJSDocCallbackTag()~~ + +> **createJSDocCallbackTag**(`tagName`, `typeExpression`, `fullName`?, `comment`?): [`JSDocCallbackTag`](../interfaces/JSDocCallbackTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8049 + +## Parameters + +### tagName + +`undefined` | [`Identifier`](../interfaces/Identifier.md) + +### typeExpression + +[`JSDocSignature`](../interfaces/JSDocSignature.md) + +### fullName? + +[`Identifier`](../interfaces/Identifier.md) | [`JSDocNamespaceDeclaration`](../interfaces/JSDocNamespaceDeclaration.md) + +### comment? + +`string` | [`NodeArray`](../interfaces/NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +## Returns + +[`JSDocCallbackTag`](../interfaces/JSDocCallbackTag.md) + +## Deprecated + +Use `factory.createJSDocCallbackTag` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createJSDocClassTag.md b/docs/api_docs/namespaces/ts/functions/createJSDocClassTag.md new file mode 100644 index 0000000000000000000000000000000000000000..1ebe00c200cee0e08509b47de16d09c35cfbe94b --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createJSDocClassTag.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createJSDocClassTag + +# Function: ~~createJSDocClassTag()~~ + +> **createJSDocClassTag**(`tagName`, `comment`?): [`JSDocClassTag`](../interfaces/JSDocClassTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8037 + +## Parameters + +### tagName + +`undefined` | [`Identifier`](../interfaces/Identifier.md) + +### comment? + +`string` | [`NodeArray`](../interfaces/NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +## Returns + +[`JSDocClassTag`](../interfaces/JSDocClassTag.md) + +## Deprecated + +Use `factory.createJSDocClassTag` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createJSDocComment.md b/docs/api_docs/namespaces/ts/functions/createJSDocComment.md new file mode 100644 index 0000000000000000000000000000000000000000..68eeec4237da392336f6b2440f744c43f5ecab8f --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createJSDocComment.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createJSDocComment + +# Function: ~~createJSDocComment()~~ + +> **createJSDocComment**(`comment`?, `tags`?): [`JSDoc`](../interfaces/JSDoc.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8033 + +## Parameters + +### comment? + +`string` | [`NodeArray`](../interfaces/NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +### tags? + +readonly [`JSDocTag`](../interfaces/JSDocTag.md)[] + +## Returns + +[`JSDoc`](../interfaces/JSDoc.md) + +## Deprecated + +Use `factory.createJSDocComment` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createJSDocEnumTag.md b/docs/api_docs/namespaces/ts/functions/createJSDocEnumTag.md new file mode 100644 index 0000000000000000000000000000000000000000..ccbab82ce32309ebb0bb7432632323e4553370b4 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createJSDocEnumTag.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createJSDocEnumTag + +# Function: ~~createJSDocEnumTag()~~ + +> **createJSDocEnumTag**(`tagName`, `typeExpression`, `comment`?): [`JSDocEnumTag`](../interfaces/JSDocEnumTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8043 + +## Parameters + +### tagName + +`undefined` | [`Identifier`](../interfaces/Identifier.md) + +### typeExpression + +[`JSDocTypeExpression`](../interfaces/JSDocTypeExpression.md) + +### comment? + +`string` | [`NodeArray`](../interfaces/NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +## Returns + +[`JSDocEnumTag`](../interfaces/JSDocEnumTag.md) + +## Deprecated + +Use `factory.createJSDocEnumTag` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createJSDocImplementsTag.md b/docs/api_docs/namespaces/ts/functions/createJSDocImplementsTag.md new file mode 100644 index 0000000000000000000000000000000000000000..a232d87181e2c0aef9eed0e4bd47f3424475255f --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createJSDocImplementsTag.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createJSDocImplementsTag + +# Function: ~~createJSDocImplementsTag()~~ + +> **createJSDocImplementsTag**(`tagName`, `className`, `comment`?): [`JSDocImplementsTag`](../interfaces/JSDocImplementsTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8057 + +## Parameters + +### tagName + +`undefined` | [`Identifier`](../interfaces/Identifier.md) + +### className + +[`ExpressionWithTypeArguments`](../interfaces/ExpressionWithTypeArguments.md) & `object` + +### comment? + +`string` | [`NodeArray`](../interfaces/NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +## Returns + +[`JSDocImplementsTag`](../interfaces/JSDocImplementsTag.md) + +## Deprecated + +Use `factory.createJSDocImplementsTag` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createJSDocParamTag.md b/docs/api_docs/namespaces/ts/functions/createJSDocParamTag.md new file mode 100644 index 0000000000000000000000000000000000000000..7ecd25ffbfe362e0c961607e97069c86e8f9c5d4 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createJSDocParamTag.md @@ -0,0 +1,37 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createJSDocParamTag + +# Function: ~~createJSDocParamTag()~~ + +> **createJSDocParamTag**(`name`, `isBracketed`, `typeExpression`?, `comment`?): [`JSDocParameterTag`](../interfaces/JSDocParameterTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8281 + +## Parameters + +### name + +[`EntityName`](../type-aliases/EntityName.md) + +### isBracketed + +`boolean` + +### typeExpression? + +[`JSDocTypeExpression`](../interfaces/JSDocTypeExpression.md) + +### comment? + +`string` + +## Returns + +[`JSDocParameterTag`](../interfaces/JSDocParameterTag.md) + +## Deprecated + +Use `factory.createJSDocParameterTag` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createJSDocParameterTag.md b/docs/api_docs/namespaces/ts/functions/createJSDocParameterTag.md new file mode 100644 index 0000000000000000000000000000000000000000..2377b591ce2792456158c78970a36a229e9d4077 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createJSDocParameterTag.md @@ -0,0 +1,45 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createJSDocParameterTag + +# Function: ~~createJSDocParameterTag()~~ + +> **createJSDocParameterTag**(`tagName`, `name`, `isBracketed`, `typeExpression`?, `isNameFirst`?, `comment`?): [`JSDocParameterTag`](../interfaces/JSDocParameterTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8035 + +## Parameters + +### tagName + +`undefined` | [`Identifier`](../interfaces/Identifier.md) + +### name + +[`EntityName`](../type-aliases/EntityName.md) + +### isBracketed + +`boolean` + +### typeExpression? + +[`JSDocTypeExpression`](../interfaces/JSDocTypeExpression.md) + +### isNameFirst? + +`boolean` + +### comment? + +`string` | [`NodeArray`](../interfaces/NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +## Returns + +[`JSDocParameterTag`](../interfaces/JSDocParameterTag.md) + +## Deprecated + +Use `factory.createJSDocParameterTag` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createJSDocPrivateTag.md b/docs/api_docs/namespaces/ts/functions/createJSDocPrivateTag.md new file mode 100644 index 0000000000000000000000000000000000000000..51287d2619359537d7e54d7d96fd5f4c9ec083d6 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createJSDocPrivateTag.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createJSDocPrivateTag + +# Function: ~~createJSDocPrivateTag()~~ + +> **createJSDocPrivateTag**(`tagName`, `comment`?): [`JSDocPrivateTag`](../interfaces/JSDocPrivateTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8065 + +## Parameters + +### tagName + +`undefined` | [`Identifier`](../interfaces/Identifier.md) + +### comment? + +`string` | [`NodeArray`](../interfaces/NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +## Returns + +[`JSDocPrivateTag`](../interfaces/JSDocPrivateTag.md) + +## Deprecated + +Use `factory.createJSDocPrivateTag` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createJSDocPropertyTag.md b/docs/api_docs/namespaces/ts/functions/createJSDocPropertyTag.md new file mode 100644 index 0000000000000000000000000000000000000000..c0a1a878dd5335ef2ce58c40de383f7d0fb8bceb --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createJSDocPropertyTag.md @@ -0,0 +1,45 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createJSDocPropertyTag + +# Function: ~~createJSDocPropertyTag()~~ + +> **createJSDocPropertyTag**(`tagName`, `name`, `isBracketed`, `typeExpression`?, `isNameFirst`?, `comment`?): [`JSDocPropertyTag`](../interfaces/JSDocPropertyTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8053 + +## Parameters + +### tagName + +`undefined` | [`Identifier`](../interfaces/Identifier.md) + +### name + +[`EntityName`](../type-aliases/EntityName.md) + +### isBracketed + +`boolean` + +### typeExpression? + +[`JSDocTypeExpression`](../interfaces/JSDocTypeExpression.md) + +### isNameFirst? + +`boolean` + +### comment? + +`string` | [`NodeArray`](../interfaces/NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +## Returns + +[`JSDocPropertyTag`](../interfaces/JSDocPropertyTag.md) + +## Deprecated + +Use `factory.createJSDocPropertyTag` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createJSDocProtectedTag.md b/docs/api_docs/namespaces/ts/functions/createJSDocProtectedTag.md new file mode 100644 index 0000000000000000000000000000000000000000..d29a9c885aefdd4ff36a9c62973101cdb7d2798f --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createJSDocProtectedTag.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createJSDocProtectedTag + +# Function: ~~createJSDocProtectedTag()~~ + +> **createJSDocProtectedTag**(`tagName`, `comment`?): [`JSDocProtectedTag`](../interfaces/JSDocProtectedTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8067 + +## Parameters + +### tagName + +`undefined` | [`Identifier`](../interfaces/Identifier.md) + +### comment? + +`string` | [`NodeArray`](../interfaces/NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +## Returns + +[`JSDocProtectedTag`](../interfaces/JSDocProtectedTag.md) + +## Deprecated + +Use `factory.createJSDocProtectedTag` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createJSDocPublicTag.md b/docs/api_docs/namespaces/ts/functions/createJSDocPublicTag.md new file mode 100644 index 0000000000000000000000000000000000000000..e8d508794484a9304c2d041fc0f061c9b9494b24 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createJSDocPublicTag.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createJSDocPublicTag + +# Function: ~~createJSDocPublicTag()~~ + +> **createJSDocPublicTag**(`tagName`, `comment`?): [`JSDocPublicTag`](../interfaces/JSDocPublicTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8063 + +## Parameters + +### tagName + +`undefined` | [`Identifier`](../interfaces/Identifier.md) + +### comment? + +`string` | [`NodeArray`](../interfaces/NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +## Returns + +[`JSDocPublicTag`](../interfaces/JSDocPublicTag.md) + +## Deprecated + +Use `factory.createJSDocPublicTag` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createJSDocReadonlyTag.md b/docs/api_docs/namespaces/ts/functions/createJSDocReadonlyTag.md new file mode 100644 index 0000000000000000000000000000000000000000..e802b9336a7d328a01d6804f28eeb7e17f3f30c7 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createJSDocReadonlyTag.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createJSDocReadonlyTag + +# Function: ~~createJSDocReadonlyTag()~~ + +> **createJSDocReadonlyTag**(`tagName`, `comment`?): [`JSDocReadonlyTag`](../interfaces/JSDocReadonlyTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8069 + +## Parameters + +### tagName + +`undefined` | [`Identifier`](../interfaces/Identifier.md) + +### comment? + +`string` | [`NodeArray`](../interfaces/NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +## Returns + +[`JSDocReadonlyTag`](../interfaces/JSDocReadonlyTag.md) + +## Deprecated + +Use `factory.createJSDocReadonlyTag` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createJSDocReturnTag.md b/docs/api_docs/namespaces/ts/functions/createJSDocReturnTag.md new file mode 100644 index 0000000000000000000000000000000000000000..813c11b1e5403752d6b0a0c6ebed12ab02c48d94 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createJSDocReturnTag.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createJSDocReturnTag + +# Function: ~~createJSDocReturnTag()~~ + +> **createJSDocReturnTag**(`tagName`, `typeExpression`?, `comment`?): [`JSDocReturnTag`](../interfaces/JSDocReturnTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8029 + +## Parameters + +### tagName + +`undefined` | [`Identifier`](../interfaces/Identifier.md) + +### typeExpression? + +[`JSDocTypeExpression`](../interfaces/JSDocTypeExpression.md) + +### comment? + +`string` | [`NodeArray`](../interfaces/NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +## Returns + +[`JSDocReturnTag`](../interfaces/JSDocReturnTag.md) + +## Deprecated + +Use `factory.createJSDocReturnTag` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createJSDocSignature.md b/docs/api_docs/namespaces/ts/functions/createJSDocSignature.md new file mode 100644 index 0000000000000000000000000000000000000000..f3fa19f5a7d6fe7b79d98df3c08b907707de0118 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createJSDocSignature.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createJSDocSignature + +# Function: ~~createJSDocSignature()~~ + +> **createJSDocSignature**(`typeParameters`, `parameters`, `type`?): [`JSDocSignature`](../interfaces/JSDocSignature.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8051 + +## Parameters + +### typeParameters + +`undefined` | readonly [`JSDocTemplateTag`](../interfaces/JSDocTemplateTag.md)[] + +### parameters + +readonly [`JSDocParameterTag`](../interfaces/JSDocParameterTag.md)[] + +### type? + +[`JSDocReturnTag`](../interfaces/JSDocReturnTag.md) + +## Returns + +[`JSDocSignature`](../interfaces/JSDocSignature.md) + +## Deprecated + +Use `factory.createJSDocSignature` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createJSDocTag.md b/docs/api_docs/namespaces/ts/functions/createJSDocTag.md new file mode 100644 index 0000000000000000000000000000000000000000..0c39a8e4af593a69889b88adcb969de69e4e4f80 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createJSDocTag.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createJSDocTag + +# Function: ~~createJSDocTag()~~ + +> **createJSDocTag**(`tagName`, `comment`?): [`JSDocUnknownTag`](../interfaces/JSDocUnknownTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8071 + +## Parameters + +### tagName + +[`Identifier`](../interfaces/Identifier.md) + +### comment? + +`string` | [`NodeArray`](../interfaces/NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +## Returns + +[`JSDocUnknownTag`](../interfaces/JSDocUnknownTag.md) + +## Deprecated + +Use `factory.createJSDocUnknownTag` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createJSDocTemplateTag.md b/docs/api_docs/namespaces/ts/functions/createJSDocTemplateTag.md new file mode 100644 index 0000000000000000000000000000000000000000..23d1182b12e9c87932a95901bc4ff1a6a520888e --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createJSDocTemplateTag.md @@ -0,0 +1,37 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createJSDocTemplateTag + +# Function: ~~createJSDocTemplateTag()~~ + +> **createJSDocTemplateTag**(`tagName`, `constraint`, `typeParameters`, `comment`?): [`JSDocTemplateTag`](../interfaces/JSDocTemplateTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8045 + +## Parameters + +### tagName + +`undefined` | [`Identifier`](../interfaces/Identifier.md) + +### constraint + +`undefined` | [`JSDocTypeExpression`](../interfaces/JSDocTypeExpression.md) + +### typeParameters + +readonly [`TypeParameterDeclaration`](../interfaces/TypeParameterDeclaration.md)[] + +### comment? + +`string` | [`NodeArray`](../interfaces/NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +## Returns + +[`JSDocTemplateTag`](../interfaces/JSDocTemplateTag.md) + +## Deprecated + +Use `factory.createJSDocTemplateTag` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createJSDocThisTag.md b/docs/api_docs/namespaces/ts/functions/createJSDocThisTag.md new file mode 100644 index 0000000000000000000000000000000000000000..6b6a24494a4102cd7ea8c69b6d00a915c8b5f8cc --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createJSDocThisTag.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createJSDocThisTag + +# Function: ~~createJSDocThisTag()~~ + +> **createJSDocThisTag**(`tagName`, `typeExpression`, `comment`?): [`JSDocThisTag`](../interfaces/JSDocThisTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8031 + +## Parameters + +### tagName + +`undefined` | [`Identifier`](../interfaces/Identifier.md) + +### typeExpression + +[`JSDocTypeExpression`](../interfaces/JSDocTypeExpression.md) + +### comment? + +`string` | [`NodeArray`](../interfaces/NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +## Returns + +[`JSDocThisTag`](../interfaces/JSDocThisTag.md) + +## Deprecated + +Use `factory.createJSDocThisTag` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createJSDocTypeExpression.md b/docs/api_docs/namespaces/ts/functions/createJSDocTypeExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..91093192d4b9308ba822e62bc4461ee06df11f8d --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createJSDocTypeExpression.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createJSDocTypeExpression + +# Function: ~~createJSDocTypeExpression()~~ + +> **createJSDocTypeExpression**(`type`): [`JSDocTypeExpression`](../interfaces/JSDocTypeExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8025 + +## Parameters + +### type + +[`TypeNode`](../interfaces/TypeNode.md) + +## Returns + +[`JSDocTypeExpression`](../interfaces/JSDocTypeExpression.md) + +## Deprecated + +Use `factory.createJSDocTypeExpression` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createJSDocTypeLiteral.md b/docs/api_docs/namespaces/ts/functions/createJSDocTypeLiteral.md new file mode 100644 index 0000000000000000000000000000000000000000..23c9b8cd20f84d0d25fa63d0a9e57dd97d4cf45a --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createJSDocTypeLiteral.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createJSDocTypeLiteral + +# Function: ~~createJSDocTypeLiteral()~~ + +> **createJSDocTypeLiteral**(`jsDocPropertyTags`?, `isArrayType`?): [`JSDocTypeLiteral`](../interfaces/JSDocTypeLiteral.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8055 + +## Parameters + +### jsDocPropertyTags? + +readonly [`JSDocPropertyLikeTag`](../interfaces/JSDocPropertyLikeTag.md)[] + +### isArrayType? + +`boolean` + +## Returns + +[`JSDocTypeLiteral`](../interfaces/JSDocTypeLiteral.md) + +## Deprecated + +Use `factory.createJSDocTypeLiteral` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createJSDocTypeTag.md b/docs/api_docs/namespaces/ts/functions/createJSDocTypeTag.md new file mode 100644 index 0000000000000000000000000000000000000000..3a63e8472421c2593a88c63516cbfe4ed3582237 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createJSDocTypeTag.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createJSDocTypeTag + +# Function: ~~createJSDocTypeTag()~~ + +> **createJSDocTypeTag**(`tagName`, `typeExpression`, `comment`?): [`JSDocTypeTag`](../interfaces/JSDocTypeTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8027 + +## Parameters + +### tagName + +`undefined` | [`Identifier`](../interfaces/Identifier.md) + +### typeExpression + +[`JSDocTypeExpression`](../interfaces/JSDocTypeExpression.md) + +### comment? + +`string` | [`NodeArray`](../interfaces/NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +## Returns + +[`JSDocTypeTag`](../interfaces/JSDocTypeTag.md) + +## Deprecated + +Use `factory.createJSDocTypeTag` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createJSDocTypedefTag.md b/docs/api_docs/namespaces/ts/functions/createJSDocTypedefTag.md new file mode 100644 index 0000000000000000000000000000000000000000..5a00027d283812d4dfbba033f55f6f472f6eecbb --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createJSDocTypedefTag.md @@ -0,0 +1,37 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createJSDocTypedefTag + +# Function: ~~createJSDocTypedefTag()~~ + +> **createJSDocTypedefTag**(`tagName`, `typeExpression`?, `fullName`?, `comment`?): [`JSDocTypedefTag`](../interfaces/JSDocTypedefTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8047 + +## Parameters + +### tagName + +`undefined` | [`Identifier`](../interfaces/Identifier.md) + +### typeExpression? + +[`JSDocTypeLiteral`](../interfaces/JSDocTypeLiteral.md) | [`JSDocTypeExpression`](../interfaces/JSDocTypeExpression.md) + +### fullName? + +[`Identifier`](../interfaces/Identifier.md) | [`JSDocNamespaceDeclaration`](../interfaces/JSDocNamespaceDeclaration.md) + +### comment? + +`string` | [`NodeArray`](../interfaces/NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +## Returns + +[`JSDocTypedefTag`](../interfaces/JSDocTypedefTag.md) + +## Deprecated + +Use `factory.createJSDocTypedefTag` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createJsxAttribute.md b/docs/api_docs/namespaces/ts/functions/createJsxAttribute.md new file mode 100644 index 0000000000000000000000000000000000000000..32660bde579040d1809d8d037f2dc5041c3102b8 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createJsxAttribute.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createJsxAttribute + +# Function: ~~createJsxAttribute()~~ + +> **createJsxAttribute**(`name`, `initializer`): [`JsxAttribute`](../interfaces/JsxAttribute.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8101 + +## Parameters + +### name + +[`Identifier`](../interfaces/Identifier.md) + +### initializer + +`undefined` | [`JsxAttributeValue`](../type-aliases/JsxAttributeValue.md) + +## Returns + +[`JsxAttribute`](../interfaces/JsxAttribute.md) + +## Deprecated + +Use `factory.createJsxAttribute` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createJsxAttributes.md b/docs/api_docs/namespaces/ts/functions/createJsxAttributes.md new file mode 100644 index 0000000000000000000000000000000000000000..8707ca5dc7d4e2ad7acae720b1ba5987ec274dd8 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createJsxAttributes.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createJsxAttributes + +# Function: ~~createJsxAttributes()~~ + +> **createJsxAttributes**(`properties`): [`JsxAttributes`](../interfaces/JsxAttributes.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8105 + +## Parameters + +### properties + +readonly [`JsxAttributeLike`](../type-aliases/JsxAttributeLike.md)[] + +## Returns + +[`JsxAttributes`](../interfaces/JsxAttributes.md) + +## Deprecated + +Use `factory.createJsxAttributes` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createJsxClosingElement.md b/docs/api_docs/namespaces/ts/functions/createJsxClosingElement.md new file mode 100644 index 0000000000000000000000000000000000000000..c7a06ee4d0a5cd12de99319035b47be378b91f9d --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createJsxClosingElement.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createJsxClosingElement + +# Function: ~~createJsxClosingElement()~~ + +> **createJsxClosingElement**(`tagName`): [`JsxClosingElement`](../interfaces/JsxClosingElement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8085 + +## Parameters + +### tagName + +[`JsxTagNameExpression`](../type-aliases/JsxTagNameExpression.md) + +## Returns + +[`JsxClosingElement`](../interfaces/JsxClosingElement.md) + +## Deprecated + +Use `factory.createJsxClosingElement` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createJsxElement.md b/docs/api_docs/namespaces/ts/functions/createJsxElement.md new file mode 100644 index 0000000000000000000000000000000000000000..3b6bdd17b4ab6f5d9774da3d185b39dd7c5ac540 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createJsxElement.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createJsxElement + +# Function: ~~createJsxElement()~~ + +> **createJsxElement**(`openingElement`, `children`, `closingElement`): [`JsxElement`](../interfaces/JsxElement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8073 + +## Parameters + +### openingElement + +[`JsxOpeningElement`](../interfaces/JsxOpeningElement.md) + +### children + +readonly [`JsxChild`](../type-aliases/JsxChild.md)[] + +### closingElement + +[`JsxClosingElement`](../interfaces/JsxClosingElement.md) + +## Returns + +[`JsxElement`](../interfaces/JsxElement.md) + +## Deprecated + +Use `factory.createJsxElement` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createJsxExpression.md b/docs/api_docs/namespaces/ts/functions/createJsxExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..25b8d3c9fed55977601f4dd3dfe6c9d4b581d017 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createJsxExpression.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createJsxExpression + +# Function: ~~createJsxExpression()~~ + +> **createJsxExpression**(`dotDotDotToken`, `expression`): [`JsxExpression`](../interfaces/JsxExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8113 + +## Parameters + +### dotDotDotToken + +`undefined` | [`DotDotDotToken`](../type-aliases/DotDotDotToken.md) + +### expression + +`undefined` | [`Expression`](../interfaces/Expression.md) + +## Returns + +[`JsxExpression`](../interfaces/JsxExpression.md) + +## Deprecated + +Use `factory.createJsxExpression` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createJsxFragment.md b/docs/api_docs/namespaces/ts/functions/createJsxFragment.md new file mode 100644 index 0000000000000000000000000000000000000000..577d30f9b86acbf20e52bbfd1e9443d0dc9216f4 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createJsxFragment.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createJsxFragment + +# Function: ~~createJsxFragment()~~ + +> **createJsxFragment**(`openingFragment`, `children`, `closingFragment`): [`JsxFragment`](../interfaces/JsxFragment.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8089 + +## Parameters + +### openingFragment + +[`JsxOpeningFragment`](../interfaces/JsxOpeningFragment.md) + +### children + +readonly [`JsxChild`](../type-aliases/JsxChild.md)[] + +### closingFragment + +[`JsxClosingFragment`](../interfaces/JsxClosingFragment.md) + +## Returns + +[`JsxFragment`](../interfaces/JsxFragment.md) + +## Deprecated + +Use `factory.createJsxFragment` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createJsxJsxClosingFragment.md b/docs/api_docs/namespaces/ts/functions/createJsxJsxClosingFragment.md new file mode 100644 index 0000000000000000000000000000000000000000..1aa3fbad7b5dd1e79f64af19d795600db588246f --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createJsxJsxClosingFragment.md @@ -0,0 +1,19 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createJsxJsxClosingFragment + +# Function: ~~createJsxJsxClosingFragment()~~ + +> **createJsxJsxClosingFragment**(): [`JsxClosingFragment`](../interfaces/JsxClosingFragment.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8097 + +## Returns + +[`JsxClosingFragment`](../interfaces/JsxClosingFragment.md) + +## Deprecated + +Use `factory.createJsxJsxClosingFragment` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createJsxOpeningElement.md b/docs/api_docs/namespaces/ts/functions/createJsxOpeningElement.md new file mode 100644 index 0000000000000000000000000000000000000000..46adfd848e9fec36f3d117526cfdce32a447a85d --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createJsxOpeningElement.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createJsxOpeningElement + +# Function: ~~createJsxOpeningElement()~~ + +> **createJsxOpeningElement**(`tagName`, `typeArguments`, `attributes`): [`JsxOpeningElement`](../interfaces/JsxOpeningElement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8081 + +## Parameters + +### tagName + +[`JsxTagNameExpression`](../type-aliases/JsxTagNameExpression.md) + +### typeArguments + +`undefined` | readonly [`TypeNode`](../interfaces/TypeNode.md)[] + +### attributes + +[`JsxAttributes`](../interfaces/JsxAttributes.md) + +## Returns + +[`JsxOpeningElement`](../interfaces/JsxOpeningElement.md) + +## Deprecated + +Use `factory.createJsxOpeningElement` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createJsxOpeningFragment.md b/docs/api_docs/namespaces/ts/functions/createJsxOpeningFragment.md new file mode 100644 index 0000000000000000000000000000000000000000..b00aac73cf1a2b4d3c3753d947beabbe1489f1d5 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createJsxOpeningFragment.md @@ -0,0 +1,19 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createJsxOpeningFragment + +# Function: ~~createJsxOpeningFragment()~~ + +> **createJsxOpeningFragment**(): [`JsxOpeningFragment`](../interfaces/JsxOpeningFragment.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8095 + +## Returns + +[`JsxOpeningFragment`](../interfaces/JsxOpeningFragment.md) + +## Deprecated + +Use `factory.createJsxOpeningFragment` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createJsxSelfClosingElement.md b/docs/api_docs/namespaces/ts/functions/createJsxSelfClosingElement.md new file mode 100644 index 0000000000000000000000000000000000000000..b763bb3b26590f563ce2660b97b5ead5b45a70e5 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createJsxSelfClosingElement.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createJsxSelfClosingElement + +# Function: ~~createJsxSelfClosingElement()~~ + +> **createJsxSelfClosingElement**(`tagName`, `typeArguments`, `attributes`): [`JsxSelfClosingElement`](../interfaces/JsxSelfClosingElement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8077 + +## Parameters + +### tagName + +[`JsxTagNameExpression`](../type-aliases/JsxTagNameExpression.md) + +### typeArguments + +`undefined` | readonly [`TypeNode`](../interfaces/TypeNode.md)[] + +### attributes + +[`JsxAttributes`](../interfaces/JsxAttributes.md) + +## Returns + +[`JsxSelfClosingElement`](../interfaces/JsxSelfClosingElement.md) + +## Deprecated + +Use `factory.createJsxSelfClosingElement` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createJsxSpreadAttribute.md b/docs/api_docs/namespaces/ts/functions/createJsxSpreadAttribute.md new file mode 100644 index 0000000000000000000000000000000000000000..bd606159e56a6c8781013bb75a6b1bfa8356aefd --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createJsxSpreadAttribute.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createJsxSpreadAttribute + +# Function: ~~createJsxSpreadAttribute()~~ + +> **createJsxSpreadAttribute**(`expression`): [`JsxSpreadAttribute`](../interfaces/JsxSpreadAttribute.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8109 + +## Parameters + +### expression + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`JsxSpreadAttribute`](../interfaces/JsxSpreadAttribute.md) + +## Deprecated + +Use `factory.createJsxSpreadAttribute` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createJsxText.md b/docs/api_docs/namespaces/ts/functions/createJsxText.md new file mode 100644 index 0000000000000000000000000000000000000000..8e2e8d318089a2285b4f6abe69e92e750f8d043b --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createJsxText.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createJsxText + +# Function: ~~createJsxText()~~ + +> **createJsxText**(`text`, `containsOnlyTriviaWhiteSpaces`?): [`JsxText`](../interfaces/JsxText.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8091 + +## Parameters + +### text + +`string` + +### containsOnlyTriviaWhiteSpaces? + +`boolean` + +## Returns + +[`JsxText`](../interfaces/JsxText.md) + +## Deprecated + +Use `factory.createJsxText` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createKeywordTypeNode.md b/docs/api_docs/namespaces/ts/functions/createKeywordTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..a66857ff275ba4f4c4770b64f3cde03acde07ccc --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createKeywordTypeNode.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createKeywordTypeNode + +# Function: ~~createKeywordTypeNode()~~ + +> **createKeywordTypeNode**\<`TKind`\>(`kind`): [`KeywordTypeNode`](../interfaces/KeywordTypeNode.md)\<`TKind`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7588 + +## Type Parameters + +• **TKind** *extends* [`KeywordTypeSyntaxKind`](../type-aliases/KeywordTypeSyntaxKind.md) + +## Parameters + +### kind + +`TKind` + +## Returns + +[`KeywordTypeNode`](../interfaces/KeywordTypeNode.md)\<`TKind`\> + +## Deprecated + +Use `factory.createKeywordTypeNode` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createLabel.md b/docs/api_docs/namespaces/ts/functions/createLabel.md new file mode 100644 index 0000000000000000000000000000000000000000..b6dd101da357d035d54455d00dc5e1a3d82463b3 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createLabel.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createLabel + +# Function: ~~createLabel()~~ + +> **createLabel**(`label`, `statement`): [`LabeledStatement`](../interfaces/LabeledStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7881 + +## Parameters + +### label + +`string` | [`Identifier`](../interfaces/Identifier.md) + +### statement + +[`Statement`](../interfaces/Statement.md) + +## Returns + +[`LabeledStatement`](../interfaces/LabeledStatement.md) + +## Deprecated + +Use `factory.createLabelStatement` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createLanguageService.md b/docs/api_docs/namespaces/ts/functions/createLanguageService.md new file mode 100644 index 0000000000000000000000000000000000000000..38394ec4d1eb947f7112b45d6ba8cee90fcb4f0f --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createLanguageService.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createLanguageService + +# Function: createLanguageService() + +> **createLanguageService**(`host`, `documentRegistry`?, `syntaxOnlyOrLanguageServiceMode`?): [`LanguageService`](../interfaces/LanguageService.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7439 + +## Parameters + +### host + +[`LanguageServiceHost`](../interfaces/LanguageServiceHost.md) + +### documentRegistry? + +[`DocumentRegistry`](../interfaces/DocumentRegistry.md) + +### syntaxOnlyOrLanguageServiceMode? + +`boolean` | [`LanguageServiceMode`](../enumerations/LanguageServiceMode.md) + +## Returns + +[`LanguageService`](../interfaces/LanguageService.md) diff --git a/docs/api_docs/namespaces/ts/functions/createLanguageServiceSourceFile.md b/docs/api_docs/namespaces/ts/functions/createLanguageServiceSourceFile.md new file mode 100644 index 0000000000000000000000000000000000000000..c5192116eb96c7b25d467200f9cb5139d304e5e6 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createLanguageServiceSourceFile.md @@ -0,0 +1,45 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createLanguageServiceSourceFile + +# Function: createLanguageServiceSourceFile() + +> **createLanguageServiceSourceFile**(`fileName`, `scriptSnapshot`, `scriptTargetOrOptions`, `version`, `setNodeParents`, `scriptKind`?, `option`?): [`SourceFile`](../interfaces/SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7437 + +## Parameters + +### fileName + +`string` + +### scriptSnapshot + +[`IScriptSnapshot`](../interfaces/IScriptSnapshot.md) + +### scriptTargetOrOptions + +[`ScriptTarget`](../enumerations/ScriptTarget.md) | [`CreateSourceFileOptions`](../interfaces/CreateSourceFileOptions.md) + +### version + +`string` + +### setNodeParents + +`boolean` + +### scriptKind? + +[`ScriptKind`](../enumerations/ScriptKind.md) + +### option? + +[`CompilerOptions`](../interfaces/CompilerOptions.md) + +## Returns + +[`SourceFile`](../interfaces/SourceFile.md) diff --git a/docs/api_docs/namespaces/ts/functions/createLessThan.md b/docs/api_docs/namespaces/ts/functions/createLessThan.md new file mode 100644 index 0000000000000000000000000000000000000000..ada44e4bc7dd0758c38ae25236cce6ca97dfa1a0 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createLessThan.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createLessThan + +# Function: ~~createLessThan()~~ + +> **createLessThan**(`left`, `right`): [`Expression`](../interfaces/Expression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8285 + +## Parameters + +### left + +[`Expression`](../interfaces/Expression.md) + +### right + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`Expression`](../interfaces/Expression.md) + +## Deprecated + +Use `factory.createLessThan` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createLiteral.md b/docs/api_docs/namespaces/ts/functions/createLiteral.md new file mode 100644 index 0000000000000000000000000000000000000000..b902f22fc277d77da748a0837b0d9d52a6401b0a --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createLiteral.md @@ -0,0 +1,75 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createLiteral + +# Function: ~~createLiteral()~~ + +## Deprecated + +Use `factory.createStringLiteral`, `factory.createStringLiteralFromNode`, `factory.createNumericLiteral`, `factory.createBigIntLiteral`, `factory.createTrue`, `factory.createFalse`, or the factory supplied by your transformation context instead. + +## Call Signature + +> **createLiteral**(`value`): [`StringLiteral`](../interfaces/StringLiteral.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8204 + +### Parameters + +#### value + +`string` | [`Identifier`](../interfaces/Identifier.md) | [`StringLiteral`](../interfaces/StringLiteral.md) | [`NumericLiteral`](../interfaces/NumericLiteral.md) | [`NoSubstitutionTemplateLiteral`](../interfaces/NoSubstitutionTemplateLiteral.md) + +### Returns + +[`StringLiteral`](../interfaces/StringLiteral.md) + +## Call Signature + +> **createLiteral**(`value`): [`NumericLiteral`](../interfaces/NumericLiteral.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8205 + +### Parameters + +#### value + +`number` | [`PseudoBigInt`](../interfaces/PseudoBigInt.md) + +### Returns + +[`NumericLiteral`](../interfaces/NumericLiteral.md) + +## Call Signature + +> **createLiteral**(`value`): [`BooleanLiteral`](../type-aliases/BooleanLiteral.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8206 + +### Parameters + +#### value + +`boolean` + +### Returns + +[`BooleanLiteral`](../type-aliases/BooleanLiteral.md) + +## Call Signature + +> **createLiteral**(`value`): [`PrimaryExpression`](../interfaces/PrimaryExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8207 + +### Parameters + +#### value + +`string` | `number` | `boolean` | [`PseudoBigInt`](../interfaces/PseudoBigInt.md) + +### Returns + +[`PrimaryExpression`](../interfaces/PrimaryExpression.md) diff --git a/docs/api_docs/namespaces/ts/functions/createLiteralTypeNode.md b/docs/api_docs/namespaces/ts/functions/createLiteralTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..2c0f60289afbddd1e70ea476be89b7d5cba9d840 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createLiteralTypeNode.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createLiteralTypeNode + +# Function: ~~createLiteralTypeNode()~~ + +> **createLiteralTypeNode**(`literal`): [`LiteralTypeNode`](../interfaces/LiteralTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7673 + +## Parameters + +### literal + +[`LiteralExpression`](../interfaces/LiteralExpression.md) | [`PrefixUnaryExpression`](../interfaces/PrefixUnaryExpression.md) | [`NullLiteral`](../interfaces/NullLiteral.md) | [`BooleanLiteral`](../type-aliases/BooleanLiteral.md) + +## Returns + +[`LiteralTypeNode`](../interfaces/LiteralTypeNode.md) + +## Deprecated + +Use `factory.createLiteralTypeNode` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createLogicalAnd.md b/docs/api_docs/namespaces/ts/functions/createLogicalAnd.md new file mode 100644 index 0000000000000000000000000000000000000000..5ebf065b7530fb4d42dd65e4048e2e54c520e60f --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createLogicalAnd.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createLogicalAnd + +# Function: ~~createLogicalAnd()~~ + +> **createLogicalAnd**(`left`, `right`): [`BinaryExpression`](../interfaces/BinaryExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8297 + +## Parameters + +### left + +[`Expression`](../interfaces/Expression.md) + +### right + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`BinaryExpression`](../interfaces/BinaryExpression.md) + +## Deprecated + +Use `factory.createLogicalAnd` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createLogicalNot.md b/docs/api_docs/namespaces/ts/functions/createLogicalNot.md new file mode 100644 index 0000000000000000000000000000000000000000..25f2b5b5be834422702d12e14d810a346a135e75 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createLogicalNot.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createLogicalNot + +# Function: ~~createLogicalNot()~~ + +> **createLogicalNot**(`operand`): [`PrefixUnaryExpression`](../interfaces/PrefixUnaryExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8303 + +## Parameters + +### operand + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`PrefixUnaryExpression`](../interfaces/PrefixUnaryExpression.md) + +## Deprecated + +Use `factory.createLogicalNot` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createLogicalOr.md b/docs/api_docs/namespaces/ts/functions/createLogicalOr.md new file mode 100644 index 0000000000000000000000000000000000000000..662424817e0afbfe1e0cf962870f3bcd5cdd5c6f --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createLogicalOr.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createLogicalOr + +# Function: ~~createLogicalOr()~~ + +> **createLogicalOr**(`left`, `right`): [`BinaryExpression`](../interfaces/BinaryExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8299 + +## Parameters + +### left + +[`Expression`](../interfaces/Expression.md) + +### right + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`BinaryExpression`](../interfaces/BinaryExpression.md) + +## Deprecated + +Use `factory.createLogicalOr` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createLoopVariable.md b/docs/api_docs/namespaces/ts/functions/createLoopVariable.md new file mode 100644 index 0000000000000000000000000000000000000000..e4ccbec4c6c57f8977d1bf584715c7ec7381f769 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createLoopVariable.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createLoopVariable + +# Function: ~~createLoopVariable()~~ + +> **createLoopVariable**(`reservedInNestedScopes`?): [`Identifier`](../interfaces/Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7473 + +## Parameters + +### reservedInNestedScopes? + +`boolean` + +## Returns + +[`Identifier`](../interfaces/Identifier.md) + +## Deprecated + +Use `factory.createLoopVariable` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createMappedTypeNode.md b/docs/api_docs/namespaces/ts/functions/createMappedTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..ea6c561f525d7b121f74013948fc723a1e467cd9 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createMappedTypeNode.md @@ -0,0 +1,45 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createMappedTypeNode + +# Function: ~~createMappedTypeNode()~~ + +> **createMappedTypeNode**(`readonlyToken`, `typeParameter`, `nameType`, `questionToken`, `type`, `members`): [`MappedTypeNode`](../interfaces/MappedTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7669 + +## Parameters + +### readonlyToken + +`undefined` | [`ReadonlyKeyword`](../type-aliases/ReadonlyKeyword.md) | [`PlusToken`](../type-aliases/PlusToken.md) | [`MinusToken`](../type-aliases/MinusToken.md) + +### typeParameter + +[`TypeParameterDeclaration`](../interfaces/TypeParameterDeclaration.md) + +### nameType + +`undefined` | [`TypeNode`](../interfaces/TypeNode.md) + +### questionToken + +`undefined` | [`QuestionToken`](../type-aliases/QuestionToken.md) | [`PlusToken`](../type-aliases/PlusToken.md) | [`MinusToken`](../type-aliases/MinusToken.md) + +### type + +`undefined` | [`TypeNode`](../interfaces/TypeNode.md) + +### members + +`undefined` | [`NodeArray`](../interfaces/NodeArray.md)\<[`TypeElement`](../interfaces/TypeElement.md)\> + +## Returns + +[`MappedTypeNode`](../interfaces/MappedTypeNode.md) + +## Deprecated + +Use `factory.createMappedTypeNode` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createMetaProperty.md b/docs/api_docs/namespaces/ts/functions/createMetaProperty.md new file mode 100644 index 0000000000000000000000000000000000000000..204cc908b9c3f264708cbc5616892c17999d891e --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createMetaProperty.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createMetaProperty + +# Function: ~~createMetaProperty()~~ + +> **createMetaProperty**(`keywordToken`, `name`): [`MetaProperty`](../interfaces/MetaProperty.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7809 + +## Parameters + +### keywordToken + +[`ImportKeyword`](../enumerations/SyntaxKind.md#importkeyword) | [`NewKeyword`](../enumerations/SyntaxKind.md#newkeyword) + +### name + +[`Identifier`](../interfaces/Identifier.md) + +## Returns + +[`MetaProperty`](../interfaces/MetaProperty.md) + +## Deprecated + +Use `factory.createMetaProperty` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createMethod.md b/docs/api_docs/namespaces/ts/functions/createMethod.md new file mode 100644 index 0000000000000000000000000000000000000000..8194711b851dd7e2c6111d4b3eb4bfe83db7c301 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createMethod.md @@ -0,0 +1,103 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createMethod + +# Function: ~~createMethod()~~ + +## Deprecated + +Use `factory.createMethodDeclaration` or the factory supplied by your transformation context instead. + +## Call Signature + +> **createMethod**(`modifiers`, `asteriskToken`, `name`, `questionToken`, `typeParameters`, `parameters`, `type`, `body`): [`MethodDeclaration`](../interfaces/MethodDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7536 + +### Parameters + +#### modifiers + +`undefined` | readonly [`ModifierLike`](../type-aliases/ModifierLike.md)[] + +#### asteriskToken + +`undefined` | [`AsteriskToken`](../type-aliases/AsteriskToken.md) + +#### name + +`string` | [`PropertyName`](../type-aliases/PropertyName.md) + +#### questionToken + +`undefined` | [`QuestionToken`](../type-aliases/QuestionToken.md) + +#### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](../interfaces/TypeParameterDeclaration.md)[] + +#### parameters + +readonly [`ParameterDeclaration`](../interfaces/ParameterDeclaration.md)[] + +#### type + +`undefined` | [`TypeNode`](../interfaces/TypeNode.md) + +#### body + +`undefined` | [`Block`](../interfaces/Block.md) + +### Returns + +[`MethodDeclaration`](../interfaces/MethodDeclaration.md) + +## Call Signature + +> **createMethod**(`decorators`, `modifiers`, `asteriskToken`, `name`, `questionToken`, `typeParameters`, `parameters`, `type`, `body`): [`MethodDeclaration`](../interfaces/MethodDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7537 + +### Parameters + +#### decorators + +`undefined` | readonly [`Decorator`](../interfaces/Decorator.md)[] + +#### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +#### asteriskToken + +`undefined` | [`AsteriskToken`](../type-aliases/AsteriskToken.md) + +#### name + +`string` | [`PropertyName`](../type-aliases/PropertyName.md) + +#### questionToken + +`undefined` | [`QuestionToken`](../type-aliases/QuestionToken.md) + +#### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](../interfaces/TypeParameterDeclaration.md)[] + +#### parameters + +readonly [`ParameterDeclaration`](../interfaces/ParameterDeclaration.md)[] + +#### type + +`undefined` | [`TypeNode`](../interfaces/TypeNode.md) + +#### body + +`undefined` | [`Block`](../interfaces/Block.md) + +### Returns + +[`MethodDeclaration`](../interfaces/MethodDeclaration.md) diff --git a/docs/api_docs/namespaces/ts/functions/createMethodSignature.md b/docs/api_docs/namespaces/ts/functions/createMethodSignature.md new file mode 100644 index 0000000000000000000000000000000000000000..6a3404fe4533f599a09a7854922ff7342ef4ebfb --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createMethodSignature.md @@ -0,0 +1,41 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createMethodSignature + +# Function: ~~createMethodSignature()~~ + +> **createMethodSignature**(`typeParameters`, `parameters`, `type`, `name`, `questionToken`): [`MethodSignature`](../interfaces/MethodSignature.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8210 + +## Parameters + +### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](../interfaces/TypeParameterDeclaration.md)[] + +### parameters + +readonly [`ParameterDeclaration`](../interfaces/ParameterDeclaration.md)[] + +### type + +`undefined` | [`TypeNode`](../interfaces/TypeNode.md) + +### name + +`string` | [`PropertyName`](../type-aliases/PropertyName.md) + +### questionToken + +`undefined` | [`QuestionToken`](../type-aliases/QuestionToken.md) + +## Returns + +[`MethodSignature`](../interfaces/MethodSignature.md) + +## Deprecated + +Use `factory.createMethodSignature` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createModifier.md b/docs/api_docs/namespaces/ts/functions/createModifier.md new file mode 100644 index 0000000000000000000000000000000000000000..8aef101acf519851aa2e6977106a67d7c9b59268 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createModifier.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createModifier + +# Function: ~~createModifier()~~ + +> **createModifier**\<`T`\>(`kind`): [`ModifierToken`](../interfaces/ModifierToken.md)\<`T`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7489 + +## Type Parameters + +• **T** *extends* [`ModifierSyntaxKind`](../type-aliases/ModifierSyntaxKind.md) + +## Parameters + +### kind + +`T` + +## Returns + +[`ModifierToken`](../interfaces/ModifierToken.md)\<`T`\> + +## Deprecated + +Use `factory.createModifier` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createModifiersFromModifierFlags.md b/docs/api_docs/namespaces/ts/functions/createModifiersFromModifierFlags.md new file mode 100644 index 0000000000000000000000000000000000000000..3b219b531b2fc7b8f4fb56ece26e614761105762 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createModifiersFromModifierFlags.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createModifiersFromModifierFlags + +# Function: ~~createModifiersFromModifierFlags()~~ + +> **createModifiersFromModifierFlags**(`flags`): `undefined` \| [`Modifier`](../type-aliases/Modifier.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7491 + +## Parameters + +### flags + +[`ModifierFlags`](../enumerations/ModifierFlags.md) + +## Returns + +`undefined` \| [`Modifier`](../type-aliases/Modifier.md)[] + +## Deprecated + +Use `factory.createModifiersFromModifierFlags` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createModuleBlock.md b/docs/api_docs/namespaces/ts/functions/createModuleBlock.md new file mode 100644 index 0000000000000000000000000000000000000000..522963230c05b13829bcbb876345e50d13aecf15 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createModuleBlock.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createModuleBlock + +# Function: ~~createModuleBlock()~~ + +> **createModuleBlock**(`statements`): [`ModuleBlock`](../interfaces/ModuleBlock.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7959 + +## Parameters + +### statements + +readonly [`Statement`](../interfaces/Statement.md)[] + +## Returns + +[`ModuleBlock`](../interfaces/ModuleBlock.md) + +## Deprecated + +Use `factory.createModuleBlock` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createModuleDeclaration.md b/docs/api_docs/namespaces/ts/functions/createModuleDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..0de1003aa1284dc3a0fb97aeb24d3cae655b149c --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createModuleDeclaration.md @@ -0,0 +1,71 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createModuleDeclaration + +# Function: ~~createModuleDeclaration()~~ + +## Deprecated + +Use `factory.createModuleDeclaration` or the factory supplied by your transformation context instead. + +## Call Signature + +> **createModuleDeclaration**(`modifiers`, `name`, `body`, `flags`?): [`ModuleDeclaration`](../interfaces/ModuleDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7950 + +### Parameters + +#### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +#### name + +[`ModuleName`](../type-aliases/ModuleName.md) + +#### body + +`undefined` | [`ModuleBody`](../type-aliases/ModuleBody.md) + +#### flags? + +[`NodeFlags`](../enumerations/NodeFlags.md) + +### Returns + +[`ModuleDeclaration`](../interfaces/ModuleDeclaration.md) + +## Call Signature + +> **createModuleDeclaration**(`decorators`, `modifiers`, `name`, `body`, `flags`?): [`ModuleDeclaration`](../interfaces/ModuleDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7951 + +### Parameters + +#### decorators + +`undefined` | readonly [`Decorator`](../interfaces/Decorator.md)[] + +#### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +#### name + +[`ModuleName`](../type-aliases/ModuleName.md) + +#### body + +`undefined` | [`ModuleBody`](../type-aliases/ModuleBody.md) + +#### flags? + +[`NodeFlags`](../enumerations/NodeFlags.md) + +### Returns + +[`ModuleDeclaration`](../interfaces/ModuleDeclaration.md) diff --git a/docs/api_docs/namespaces/ts/functions/createModuleResolutionCache.md b/docs/api_docs/namespaces/ts/functions/createModuleResolutionCache.md new file mode 100644 index 0000000000000000000000000000000000000000..a74d9f6eb59d9c0e888f87ad85eff9ecc9ac60bc --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createModuleResolutionCache.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createModuleResolutionCache + +# Function: createModuleResolutionCache() + +> **createModuleResolutionCache**(`currentDirectory`, `getCanonicalFileName`, `options`?): [`ModuleResolutionCache`](../interfaces/ModuleResolutionCache.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5402 + +## Parameters + +### currentDirectory + +`string` + +### getCanonicalFileName + +(`s`) => `string` + +### options? + +[`CompilerOptions`](../interfaces/CompilerOptions.md) + +## Returns + +[`ModuleResolutionCache`](../interfaces/ModuleResolutionCache.md) diff --git a/docs/api_docs/namespaces/ts/functions/createNamedExports.md b/docs/api_docs/namespaces/ts/functions/createNamedExports.md new file mode 100644 index 0000000000000000000000000000000000000000..8b78a81667ffc4e7e853306db1f25a66b016946b --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createNamedExports.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createNamedExports + +# Function: ~~createNamedExports()~~ + +> **createNamedExports**(`elements`): [`NamedExports`](../interfaces/NamedExports.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8013 + +## Parameters + +### elements + +readonly [`ExportSpecifier`](../interfaces/ExportSpecifier.md)[] + +## Returns + +[`NamedExports`](../interfaces/NamedExports.md) + +## Deprecated + +Use `factory.createNamedExports` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createNamedImports.md b/docs/api_docs/namespaces/ts/functions/createNamedImports.md new file mode 100644 index 0000000000000000000000000000000000000000..848e047cc0f36c4ee8dc23734e972044f77c175c --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createNamedImports.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createNamedImports + +# Function: ~~createNamedImports()~~ + +> **createNamedImports**(`elements`): [`NamedImports`](../interfaces/NamedImports.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7995 + +## Parameters + +### elements + +readonly [`ImportSpecifier`](../interfaces/ImportSpecifier.md)[] + +## Returns + +[`NamedImports`](../interfaces/NamedImports.md) + +## Deprecated + +Use `factory.createNamedImports` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createNamespaceExport.md b/docs/api_docs/namespaces/ts/functions/createNamespaceExport.md new file mode 100644 index 0000000000000000000000000000000000000000..eaf280e95f641aef2924b09f3c247c2234e14273 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createNamespaceExport.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createNamespaceExport + +# Function: ~~createNamespaceExport()~~ + +> **createNamespaceExport**(`name`): [`NamespaceExport`](../interfaces/NamespaceExport.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8181 + +## Parameters + +### name + +[`Identifier`](../interfaces/Identifier.md) + +## Returns + +[`NamespaceExport`](../interfaces/NamespaceExport.md) + +## Deprecated + +Use `factory.createNamespaceExport` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createNamespaceExportDeclaration.md b/docs/api_docs/namespaces/ts/functions/createNamespaceExportDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..c190da2d38c3f6847366d7bce344ad21b5c1fbd7 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createNamespaceExportDeclaration.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createNamespaceExportDeclaration + +# Function: ~~createNamespaceExportDeclaration()~~ + +> **createNamespaceExportDeclaration**(`name`): [`NamespaceExportDeclaration`](../interfaces/NamespaceExportDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7967 + +## Parameters + +### name + +`string` | [`Identifier`](../interfaces/Identifier.md) + +## Returns + +[`NamespaceExportDeclaration`](../interfaces/NamespaceExportDeclaration.md) + +## Deprecated + +Use `factory.createNamespaceExportDeclaration` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createNamespaceImport.md b/docs/api_docs/namespaces/ts/functions/createNamespaceImport.md new file mode 100644 index 0000000000000000000000000000000000000000..d64f4fcb5209426dcc68175ff409dad06275b03d --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createNamespaceImport.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createNamespaceImport + +# Function: ~~createNamespaceImport()~~ + +> **createNamespaceImport**(`name`): [`NamespaceImport`](../interfaces/NamespaceImport.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7991 + +## Parameters + +### name + +[`Identifier`](../interfaces/Identifier.md) + +## Returns + +[`NamespaceImport`](../interfaces/NamespaceImport.md) + +## Deprecated + +Use `factory.createNamespaceImport` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createNew.md b/docs/api_docs/namespaces/ts/functions/createNew.md new file mode 100644 index 0000000000000000000000000000000000000000..9abab6bc0e6f2cd88ba2e3dfa6dc7b1e9008150c --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createNew.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createNew + +# Function: ~~createNew()~~ + +> **createNew**(`expression`, `typeArguments`, `argumentsArray`): [`NewExpression`](../interfaces/NewExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7721 + +## Parameters + +### expression + +[`Expression`](../interfaces/Expression.md) + +### typeArguments + +`undefined` | readonly [`TypeNode`](../interfaces/TypeNode.md)[] + +### argumentsArray + +`undefined` | readonly [`Expression`](../interfaces/Expression.md)[] + +## Returns + +[`NewExpression`](../interfaces/NewExpression.md) + +## Deprecated + +Use `factory.createNewExpression` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createNoSubstitutionTemplateLiteral.md b/docs/api_docs/namespaces/ts/functions/createNoSubstitutionTemplateLiteral.md new file mode 100644 index 0000000000000000000000000000000000000000..7779d610e9ed8b4db5e30ca98914429744c3106e --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createNoSubstitutionTemplateLiteral.md @@ -0,0 +1,51 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createNoSubstitutionTemplateLiteral + +# Function: ~~createNoSubstitutionTemplateLiteral()~~ + +## Deprecated + +Use `factory.createNoSubstitutionTemplateLiteral` or the factory supplied by your transformation context instead. + +## Call Signature + +> **createNoSubstitutionTemplateLiteral**(`text`, `rawText`?): [`NoSubstitutionTemplateLiteral`](../interfaces/NoSubstitutionTemplateLiteral.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7785 + +### Parameters + +#### text + +`string` + +#### rawText? + +`string` + +### Returns + +[`NoSubstitutionTemplateLiteral`](../interfaces/NoSubstitutionTemplateLiteral.md) + +## Call Signature + +> **createNoSubstitutionTemplateLiteral**(`text`, `rawText`): [`NoSubstitutionTemplateLiteral`](../interfaces/NoSubstitutionTemplateLiteral.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7786 + +### Parameters + +#### text + +`undefined` | `string` + +#### rawText + +`string` + +### Returns + +[`NoSubstitutionTemplateLiteral`](../interfaces/NoSubstitutionTemplateLiteral.md) diff --git a/docs/api_docs/namespaces/ts/functions/createNode.md b/docs/api_docs/namespaces/ts/functions/createNode.md new file mode 100644 index 0000000000000000000000000000000000000000..69f156737b63c75a2dcf633ccd761c060cedb21e --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createNode.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createNode + +# Function: ~~createNode()~~ + +> **createNode**(`kind`, `pos`?, `end`?): [`Node`](../interfaces/Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8305 + +## Parameters + +### kind + +[`SyntaxKind`](../enumerations/SyntaxKind.md) + +### pos? + +`any` + +### end? + +`any` + +## Returns + +[`Node`](../interfaces/Node.md) + +## Deprecated + +Use an appropriate `factory` method instead. diff --git a/docs/api_docs/namespaces/ts/functions/createNodeArray.md b/docs/api_docs/namespaces/ts/functions/createNodeArray.md new file mode 100644 index 0000000000000000000000000000000000000000..b8a0dbf304b153c0d8650e1d37e13d3cc86512b6 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createNodeArray.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createNodeArray + +# Function: ~~createNodeArray()~~ + +> **createNodeArray**\<`T`\>(`elements`?, `hasTrailingComma`?): [`NodeArray`](../interfaces/NodeArray.md)\<`T`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7458 + +## Type Parameters + +• **T** *extends* [`Node`](../interfaces/Node.md) + +## Parameters + +### elements? + +readonly `T`[] + +### hasTrailingComma? + +`boolean` + +## Returns + +[`NodeArray`](../interfaces/NodeArray.md)\<`T`\> + +## Deprecated + +Use `factory.createNodeArray` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createNonNullChain.md b/docs/api_docs/namespaces/ts/functions/createNonNullChain.md new file mode 100644 index 0000000000000000000000000000000000000000..84ea67d2aeb8ece8c5ff4fee32c7451b7df9a0e3 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createNonNullChain.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createNonNullChain + +# Function: ~~createNonNullChain()~~ + +> **createNonNullChain**(`expression`): [`NonNullChain`](../interfaces/NonNullChain.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7805 + +## Parameters + +### expression + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`NonNullChain`](../interfaces/NonNullChain.md) + +## Deprecated + +Use `factory.createNonNullChain` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createNonNullExpression.md b/docs/api_docs/namespaces/ts/functions/createNonNullExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..cd679ddc0946724305edc8dc0102a81e96533a77 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createNonNullExpression.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createNonNullExpression + +# Function: ~~createNonNullExpression()~~ + +> **createNonNullExpression**(`expression`): [`NonNullExpression`](../interfaces/NonNullExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7801 + +## Parameters + +### expression + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`NonNullExpression`](../interfaces/NonNullExpression.md) + +## Deprecated + +Use `factory.createNonNullExpression` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createNotEmittedStatement.md b/docs/api_docs/namespaces/ts/functions/createNotEmittedStatement.md new file mode 100644 index 0000000000000000000000000000000000000000..29eae58976afe2980afddd4d67ccb3ac5e66c1f2 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createNotEmittedStatement.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createNotEmittedStatement + +# Function: ~~createNotEmittedStatement()~~ + +> **createNotEmittedStatement**(`original`): [`NotEmittedStatement`](../interfaces/NotEmittedStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8151 + +## Parameters + +### original + +[`Node`](../interfaces/Node.md) + +## Returns + +[`NotEmittedStatement`](../interfaces/NotEmittedStatement.md) + +## Deprecated + +Use `factory.createNotEmittedStatement` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createNull.md b/docs/api_docs/namespaces/ts/functions/createNull.md new file mode 100644 index 0000000000000000000000000000000000000000..371e5b09d6fe2ec0a00f1c7d567c074e82740395 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createNull.md @@ -0,0 +1,19 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createNull + +# Function: ~~createNull()~~ + +> **createNull**(): [`NullLiteral`](../interfaces/NullLiteral.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7483 + +## Returns + +[`NullLiteral`](../interfaces/NullLiteral.md) + +## Deprecated + +Use `factory.createNull` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createNumericLiteral.md b/docs/api_docs/namespaces/ts/functions/createNumericLiteral.md new file mode 100644 index 0000000000000000000000000000000000000000..b367a831f86fe2c25f15d3641d87a6617cc48566 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createNumericLiteral.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createNumericLiteral + +# Function: ~~createNumericLiteral()~~ + +> **createNumericLiteral**(`value`, `numericLiteralFlags`?): [`NumericLiteral`](../interfaces/NumericLiteral.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7460 + +## Parameters + +### value + +`string` | `number` + +### numericLiteralFlags? + +[`TokenFlags`](../enumerations/TokenFlags.md) + +## Returns + +[`NumericLiteral`](../interfaces/NumericLiteral.md) + +## Deprecated + +Use `factory.createNumericLiteral` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createObfTextSingleLineWriter.md b/docs/api_docs/namespaces/ts/functions/createObfTextSingleLineWriter.md new file mode 100644 index 0000000000000000000000000000000000000000..5e537838b3d2f4248de049d73ba200afcdda602a --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createObfTextSingleLineWriter.md @@ -0,0 +1,15 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createObfTextSingleLineWriter + +# Function: createObfTextSingleLineWriter() + +> **createObfTextSingleLineWriter**(): [`EmitTextWriter`](../interfaces/EmitTextWriter.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5442 + +## Returns + +[`EmitTextWriter`](../interfaces/EmitTextWriter.md) diff --git a/docs/api_docs/namespaces/ts/functions/createObjectBindingPattern.md b/docs/api_docs/namespaces/ts/functions/createObjectBindingPattern.md new file mode 100644 index 0000000000000000000000000000000000000000..57e72b00a1d8fd3f7c9d52c477b0ef8d6ea029aa --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createObjectBindingPattern.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createObjectBindingPattern + +# Function: ~~createObjectBindingPattern()~~ + +> **createObjectBindingPattern**(`elements`): [`ObjectBindingPattern`](../interfaces/ObjectBindingPattern.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7677 + +## Parameters + +### elements + +readonly [`BindingElement`](../interfaces/BindingElement.md)[] + +## Returns + +[`ObjectBindingPattern`](../interfaces/ObjectBindingPattern.md) + +## Deprecated + +Use `factory.createObjectBindingPattern` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createObjectLiteral.md b/docs/api_docs/namespaces/ts/functions/createObjectLiteral.md new file mode 100644 index 0000000000000000000000000000000000000000..82bcb4fc082717282d2a11b275a4dc7fdc3a4bb6 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createObjectLiteral.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createObjectLiteral + +# Function: ~~createObjectLiteral()~~ + +> **createObjectLiteral**(`properties`?, `multiLine`?): [`ObjectLiteralExpression`](../interfaces/ObjectLiteralExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7693 + +## Parameters + +### properties? + +readonly [`ObjectLiteralElementLike`](../type-aliases/ObjectLiteralElementLike.md)[] + +### multiLine? + +`boolean` + +## Returns + +[`ObjectLiteralExpression`](../interfaces/ObjectLiteralExpression.md) + +## Deprecated + +Use `factory.createObjectLiteralExpression` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createOmittedExpression.md b/docs/api_docs/namespaces/ts/functions/createOmittedExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..51327d97c4276b815ea8fcb12fcda06559524c2c --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createOmittedExpression.md @@ -0,0 +1,19 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createOmittedExpression + +# Function: ~~createOmittedExpression()~~ + +> **createOmittedExpression**(): [`OmittedExpression`](../interfaces/OmittedExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7795 + +## Returns + +[`OmittedExpression`](../interfaces/OmittedExpression.md) + +## Deprecated + +Use `factory.createOmittedExpression` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createOptimisticUniqueName.md b/docs/api_docs/namespaces/ts/functions/createOptimisticUniqueName.md new file mode 100644 index 0000000000000000000000000000000000000000..f256a8276e606416ebfcb692dd757f3885c69e52 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createOptimisticUniqueName.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createOptimisticUniqueName + +# Function: ~~createOptimisticUniqueName()~~ + +> **createOptimisticUniqueName**(`text`): [`Identifier`](../interfaces/Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8193 + +## Parameters + +### text + +`string` + +## Returns + +[`Identifier`](../interfaces/Identifier.md) + +## Deprecated + +Use `factory.createUniqueName(text, GeneratedIdentifierFlags.Optimistic)` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createOptionalTypeNode.md b/docs/api_docs/namespaces/ts/functions/createOptionalTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..c9044be61f201aab8864f91e046e28e92885f80c --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createOptionalTypeNode.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createOptionalTypeNode + +# Function: ~~createOptionalTypeNode()~~ + +> **createOptionalTypeNode**(`type`): [`OptionalTypeNode`](../interfaces/OptionalTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7622 + +## Parameters + +### type + +[`TypeNode`](../interfaces/TypeNode.md) + +## Returns + +[`OptionalTypeNode`](../interfaces/OptionalTypeNode.md) + +## Deprecated + +Use `factory.createOptionalTypeNode` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createParameter.md b/docs/api_docs/namespaces/ts/functions/createParameter.md new file mode 100644 index 0000000000000000000000000000000000000000..26569306dd82396bf33ad7925ad39f7f1719f7c1 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createParameter.md @@ -0,0 +1,87 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createParameter + +# Function: ~~createParameter()~~ + +## Deprecated + +Use `factory.createParameterDeclaration` or the factory supplied by your transformation context instead. + +## Call Signature + +> **createParameter**(`modifiers`, `dotDotDotToken`, `name`, `questionToken`?, `type`?, `initializer`?): [`ParameterDeclaration`](../interfaces/ParameterDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7512 + +### Parameters + +#### modifiers + +`undefined` | readonly [`ModifierLike`](../type-aliases/ModifierLike.md)[] + +#### dotDotDotToken + +`undefined` | [`DotDotDotToken`](../type-aliases/DotDotDotToken.md) + +#### name + +`string` | [`BindingName`](../type-aliases/BindingName.md) + +#### questionToken? + +[`QuestionToken`](../type-aliases/QuestionToken.md) + +#### type? + +[`TypeNode`](../interfaces/TypeNode.md) + +#### initializer? + +[`Expression`](../interfaces/Expression.md) + +### Returns + +[`ParameterDeclaration`](../interfaces/ParameterDeclaration.md) + +## Call Signature + +> **createParameter**(`decorators`, `modifiers`, `dotDotDotToken`, `name`, `questionToken`?, `type`?, `initializer`?): [`ParameterDeclaration`](../interfaces/ParameterDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7513 + +### Parameters + +#### decorators + +`undefined` | readonly [`Decorator`](../interfaces/Decorator.md)[] + +#### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +#### dotDotDotToken + +`undefined` | [`DotDotDotToken`](../type-aliases/DotDotDotToken.md) + +#### name + +`string` | [`BindingName`](../type-aliases/BindingName.md) + +#### questionToken? + +[`QuestionToken`](../type-aliases/QuestionToken.md) + +#### type? + +[`TypeNode`](../interfaces/TypeNode.md) + +#### initializer? + +[`Expression`](../interfaces/Expression.md) + +### Returns + +[`ParameterDeclaration`](../interfaces/ParameterDeclaration.md) diff --git a/docs/api_docs/namespaces/ts/functions/createParen.md b/docs/api_docs/namespaces/ts/functions/createParen.md new file mode 100644 index 0000000000000000000000000000000000000000..7c245cb47c017683750970daaea8a5e474fbb026 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createParen.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createParen + +# Function: ~~createParen()~~ + +> **createParen**(`expression`): [`ParenthesizedExpression`](../interfaces/ParenthesizedExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7729 + +## Parameters + +### expression + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`ParenthesizedExpression`](../interfaces/ParenthesizedExpression.md) + +## Deprecated + +Use `factory.createParenthesizedExpression` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createParenthesizedType.md b/docs/api_docs/namespaces/ts/functions/createParenthesizedType.md new file mode 100644 index 0000000000000000000000000000000000000000..820f58d317959f5f8667b607ecece35fcfe2cb7c --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createParenthesizedType.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createParenthesizedType + +# Function: ~~createParenthesizedType()~~ + +> **createParenthesizedType**(`type`): [`ParenthesizedTypeNode`](../interfaces/ParenthesizedTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7657 + +## Parameters + +### type + +[`TypeNode`](../interfaces/TypeNode.md) + +## Returns + +[`ParenthesizedTypeNode`](../interfaces/ParenthesizedTypeNode.md) + +## Deprecated + +Use `factory.createParenthesizedType` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createPartiallyEmittedExpression.md b/docs/api_docs/namespaces/ts/functions/createPartiallyEmittedExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..1389e0340adcb701d8369140b649cb9a4f31bf82 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createPartiallyEmittedExpression.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createPartiallyEmittedExpression + +# Function: ~~createPartiallyEmittedExpression()~~ + +> **createPartiallyEmittedExpression**(`expression`, `original`?): [`PartiallyEmittedExpression`](../interfaces/PartiallyEmittedExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8153 + +## Parameters + +### expression + +[`Expression`](../interfaces/Expression.md) + +### original? + +[`Node`](../interfaces/Node.md) + +## Returns + +[`PartiallyEmittedExpression`](../interfaces/PartiallyEmittedExpression.md) + +## Deprecated + +Use `factory.createPartiallyEmittedExpression` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createPostfix.md b/docs/api_docs/namespaces/ts/functions/createPostfix.md new file mode 100644 index 0000000000000000000000000000000000000000..4194ed0b0801206ff8b54c6e3dbf56698f83b543 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createPostfix.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createPostfix + +# Function: ~~createPostfix()~~ + +> **createPostfix**(`operand`, `operator`): [`PostfixUnaryExpression`](../interfaces/PostfixUnaryExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7757 + +## Parameters + +### operand + +[`Expression`](../interfaces/Expression.md) + +### operator + +[`PostfixUnaryOperator`](../type-aliases/PostfixUnaryOperator.md) + +## Returns + +[`PostfixUnaryExpression`](../interfaces/PostfixUnaryExpression.md) + +## Deprecated + +Use `factory.createPostfixUnaryExpression` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createPostfixIncrement.md b/docs/api_docs/namespaces/ts/functions/createPostfixIncrement.md new file mode 100644 index 0000000000000000000000000000000000000000..be6a3830790fa9bf2c93e7c8bee83b8943ccdde8 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createPostfixIncrement.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createPostfixIncrement + +# Function: ~~createPostfixIncrement()~~ + +> **createPostfixIncrement**(`operand`): [`PostfixUnaryExpression`](../interfaces/PostfixUnaryExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8301 + +## Parameters + +### operand + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`PostfixUnaryExpression`](../interfaces/PostfixUnaryExpression.md) + +## Deprecated + +Use `factory.createPostfixIncrement` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createPrefix.md b/docs/api_docs/namespaces/ts/functions/createPrefix.md new file mode 100644 index 0000000000000000000000000000000000000000..df99ed51a1611b618ca26da58d7c1e50509aa46b --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createPrefix.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createPrefix + +# Function: ~~createPrefix()~~ + +> **createPrefix**(`operator`, `operand`): [`PrefixUnaryExpression`](../interfaces/PrefixUnaryExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7753 + +## Parameters + +### operator + +[`PrefixUnaryOperator`](../type-aliases/PrefixUnaryOperator.md) + +### operand + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`PrefixUnaryExpression`](../interfaces/PrefixUnaryExpression.md) + +## Deprecated + +Use `factory.createPrefixExpression` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createPrinter.md b/docs/api_docs/namespaces/ts/functions/createPrinter.md new file mode 100644 index 0000000000000000000000000000000000000000..655dba8310cf35e4356869b1f96bde4fe1e4a568 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createPrinter.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createPrinter + +# Function: createPrinter() + +> **createPrinter**(`printerOptions`?, `handlers`?): [`Printer`](../interfaces/Printer.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5540 + +## Parameters + +### printerOptions? + +[`PrinterOptions`](../interfaces/PrinterOptions.md) + +### handlers? + +[`PrintHandlers`](../interfaces/PrintHandlers.md) + +## Returns + +[`Printer`](../interfaces/Printer.md) diff --git a/docs/api_docs/namespaces/ts/functions/createPrivateIdentifier.md b/docs/api_docs/namespaces/ts/functions/createPrivateIdentifier.md new file mode 100644 index 0000000000000000000000000000000000000000..5327f821d6e621a700d47116f322a7b4bd3f73e5 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createPrivateIdentifier.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createPrivateIdentifier + +# Function: ~~createPrivateIdentifier()~~ + +> **createPrivateIdentifier**(`text`): [`PrivateIdentifier`](../interfaces/PrivateIdentifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7477 + +## Parameters + +### text + +`string` + +## Returns + +[`PrivateIdentifier`](../interfaces/PrivateIdentifier.md) + +## Deprecated + +Use `factory.createPrivateIdentifier` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createProgram.md b/docs/api_docs/namespaces/ts/functions/createProgram.md new file mode 100644 index 0000000000000000000000000000000000000000..dac91e55d8360859603dafadf8ed509574c8832e --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createProgram.md @@ -0,0 +1,83 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createProgram + +# Function: createProgram() + +## Call Signature + +> **createProgram**(`createProgramOptions`): [`Program`](../interfaces/Program.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5603 + +Create a new 'Program' instance. A Program is an immutable collection of 'SourceFile's and a 'CompilerOptions' +that represent a compilation unit. + +Creating a program proceeds from a set of root files, expanding the set of inputs by following imports and +triple-slash-reference-path directives transitively. '@types' and triple-slash-reference-types are also pulled in. + +### Parameters + +#### createProgramOptions + +[`CreateProgramOptions`](../interfaces/CreateProgramOptions.md) + +The options for creating a program. + +### Returns + +[`Program`](../interfaces/Program.md) + +A 'Program' object. + +## Call Signature + +> **createProgram**(`rootNames`, `options`, `host`?, `oldProgram`?, `configFileParsingDiagnostics`?): [`Program`](../interfaces/Program.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5618 + +Create a new 'Program' instance. A Program is an immutable collection of 'SourceFile's and a 'CompilerOptions' +that represent a compilation unit. + +Creating a program proceeds from a set of root files, expanding the set of inputs by following imports and +triple-slash-reference-path directives transitively. '@types' and triple-slash-reference-types are also pulled in. + +### Parameters + +#### rootNames + +readonly `string`[] + +A set of root files. + +#### options + +[`CompilerOptions`](../interfaces/CompilerOptions.md) + +The compiler options which should be used. + +#### host? + +[`CompilerHost`](../interfaces/CompilerHost.md) + +The host interacts with the underlying file system. + +#### oldProgram? + +[`Program`](../interfaces/Program.md) + +Reuses an old program structure. + +#### configFileParsingDiagnostics? + +readonly [`Diagnostic`](../interfaces/Diagnostic.md)[] + +error during config file parsing + +### Returns + +[`Program`](../interfaces/Program.md) + +A 'Program' object. diff --git a/docs/api_docs/namespaces/ts/functions/createProperty.md b/docs/api_docs/namespaces/ts/functions/createProperty.md new file mode 100644 index 0000000000000000000000000000000000000000..f0021d6903dbd1956c17a9dc0e5a6b6a0cd2dbaf --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createProperty.md @@ -0,0 +1,79 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createProperty + +# Function: ~~createProperty()~~ + +## Deprecated + +Use `factory.createPropertyDeclaration` or the factory supplied by your transformation context instead. + +## Call Signature + +> **createProperty**(`modifiers`, `name`, `questionOrExclamationToken`, `type`, `initializer`): [`PropertyDeclaration`](../interfaces/PropertyDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7526 + +### Parameters + +#### modifiers + +`undefined` | readonly [`ModifierLike`](../type-aliases/ModifierLike.md)[] + +#### name + +`string` | [`PropertyName`](../type-aliases/PropertyName.md) + +#### questionOrExclamationToken + +`undefined` | [`QuestionToken`](../type-aliases/QuestionToken.md) | [`ExclamationToken`](../type-aliases/ExclamationToken.md) + +#### type + +`undefined` | [`TypeNode`](../interfaces/TypeNode.md) + +#### initializer + +`undefined` | [`Expression`](../interfaces/Expression.md) + +### Returns + +[`PropertyDeclaration`](../interfaces/PropertyDeclaration.md) + +## Call Signature + +> **createProperty**(`decorators`, `modifiers`, `name`, `questionOrExclamationToken`, `type`, `initializer`): [`PropertyDeclaration`](../interfaces/PropertyDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7527 + +### Parameters + +#### decorators + +`undefined` | readonly [`Decorator`](../interfaces/Decorator.md)[] + +#### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +#### name + +`string` | [`PropertyName`](../type-aliases/PropertyName.md) + +#### questionOrExclamationToken + +`undefined` | [`QuestionToken`](../type-aliases/QuestionToken.md) | [`ExclamationToken`](../type-aliases/ExclamationToken.md) + +#### type + +`undefined` | [`TypeNode`](../interfaces/TypeNode.md) + +#### initializer + +`undefined` | [`Expression`](../interfaces/Expression.md) + +### Returns + +[`PropertyDeclaration`](../interfaces/PropertyDeclaration.md) diff --git a/docs/api_docs/namespaces/ts/functions/createPropertyAccess.md b/docs/api_docs/namespaces/ts/functions/createPropertyAccess.md new file mode 100644 index 0000000000000000000000000000000000000000..7304e222efcfd16daa368f69785ef0cf533e9c45 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createPropertyAccess.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createPropertyAccess + +# Function: ~~createPropertyAccess()~~ + +> **createPropertyAccess**(`expression`, `name`): [`PropertyAccessExpression`](../interfaces/PropertyAccessExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7697 + +## Parameters + +### expression + +[`Expression`](../interfaces/Expression.md) + +### name + +`string` | [`MemberName`](../type-aliases/MemberName.md) + +## Returns + +[`PropertyAccessExpression`](../interfaces/PropertyAccessExpression.md) + +## Deprecated + +Use `factory.createPropertyAccessExpression` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createPropertyAccessChain.md b/docs/api_docs/namespaces/ts/functions/createPropertyAccessChain.md new file mode 100644 index 0000000000000000000000000000000000000000..def312cac28f560bf5686e5513ed84e0d6817236 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createPropertyAccessChain.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createPropertyAccessChain + +# Function: ~~createPropertyAccessChain()~~ + +> **createPropertyAccessChain**(`expression`, `questionDotToken`, `name`): [`PropertyAccessChain`](../interfaces/PropertyAccessChain.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7701 + +## Parameters + +### expression + +[`Expression`](../interfaces/Expression.md) + +### questionDotToken + +`undefined` | [`QuestionDotToken`](../type-aliases/QuestionDotToken.md) + +### name + +`string` | [`MemberName`](../type-aliases/MemberName.md) + +## Returns + +[`PropertyAccessChain`](../interfaces/PropertyAccessChain.md) + +## Deprecated + +Use `factory.createPropertyAccessChain` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createPropertyAssignment.md b/docs/api_docs/namespaces/ts/functions/createPropertyAssignment.md new file mode 100644 index 0000000000000000000000000000000000000000..516d0d501047f5f26e3c6e87fb84f49fae92a0ef --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createPropertyAssignment.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createPropertyAssignment + +# Function: ~~createPropertyAssignment()~~ + +> **createPropertyAssignment**(`name`, `initializer`): [`PropertyAssignment`](../interfaces/PropertyAssignment.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8133 + +## Parameters + +### name + +`string` | [`PropertyName`](../type-aliases/PropertyName.md) + +### initializer + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`PropertyAssignment`](../interfaces/PropertyAssignment.md) + +## Deprecated + +Use `factory.createPropertyAssignment` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createPropertySignature.md b/docs/api_docs/namespaces/ts/functions/createPropertySignature.md new file mode 100644 index 0000000000000000000000000000000000000000..633ea236342b6bc6a832023e2d04ef7275ce3444 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createPropertySignature.md @@ -0,0 +1,41 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createPropertySignature + +# Function: ~~createPropertySignature()~~ + +> **createPropertySignature**(`modifiers`, `name`, `questionToken`, `type`, `initializer`?): [`PropertySignature`](../interfaces/PropertySignature.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8245 + +## Parameters + +### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +### name + +`string` | [`PropertyName`](../type-aliases/PropertyName.md) + +### questionToken + +`undefined` | [`QuestionToken`](../type-aliases/QuestionToken.md) + +### type + +`undefined` | [`TypeNode`](../interfaces/TypeNode.md) + +### initializer? + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`PropertySignature`](../interfaces/PropertySignature.md) + +## Deprecated + +Use `factory.createPropertySignature` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createQualifiedName.md b/docs/api_docs/namespaces/ts/functions/createQualifiedName.md new file mode 100644 index 0000000000000000000000000000000000000000..affe26d07f446aee791cf2baafa1431e5ce76d08 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createQualifiedName.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createQualifiedName + +# Function: ~~createQualifiedName()~~ + +> **createQualifiedName**(`left`, `right`): [`QualifiedName`](../interfaces/QualifiedName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7493 + +## Parameters + +### left + +[`EntityName`](../type-aliases/EntityName.md) + +### right + +`string` | [`Identifier`](../interfaces/Identifier.md) + +## Returns + +[`QualifiedName`](../interfaces/QualifiedName.md) + +## Deprecated + +Use `factory.createQualifiedName` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createRegularExpressionLiteral.md b/docs/api_docs/namespaces/ts/functions/createRegularExpressionLiteral.md new file mode 100644 index 0000000000000000000000000000000000000000..9c133a369e3a3679839e2063daba8e75e0a2bed3 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createRegularExpressionLiteral.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createRegularExpressionLiteral + +# Function: ~~createRegularExpressionLiteral()~~ + +> **createRegularExpressionLiteral**(`text`): [`RegularExpressionLiteral`](../interfaces/RegularExpressionLiteral.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7471 + +## Parameters + +### text + +`string` + +## Returns + +[`RegularExpressionLiteral`](../interfaces/RegularExpressionLiteral.md) + +## Deprecated + +Use `factory.createRegularExpressionLiteral` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createRestTypeNode.md b/docs/api_docs/namespaces/ts/functions/createRestTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..dbb8e30d41f62c875dbf1ead3917eb5c44798e42 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createRestTypeNode.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createRestTypeNode + +# Function: ~~createRestTypeNode()~~ + +> **createRestTypeNode**(`type`): [`RestTypeNode`](../interfaces/RestTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7626 + +## Parameters + +### type + +[`TypeNode`](../interfaces/TypeNode.md) + +## Returns + +[`RestTypeNode`](../interfaces/RestTypeNode.md) + +## Deprecated + +Use `factory.createRestTypeNode` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createReturn.md b/docs/api_docs/namespaces/ts/functions/createReturn.md new file mode 100644 index 0000000000000000000000000000000000000000..3d401ea9447c82fdc30dffaa4f169db69cca391f --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createReturn.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createReturn + +# Function: ~~createReturn()~~ + +> **createReturn**(`expression`?): [`ReturnStatement`](../interfaces/ReturnStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7869 + +## Parameters + +### expression? + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`ReturnStatement`](../interfaces/ReturnStatement.md) + +## Deprecated + +Use `factory.createReturnStatement` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createScanner.md b/docs/api_docs/namespaces/ts/functions/createScanner.md new file mode 100644 index 0000000000000000000000000000000000000000..69ed4d6bbce0e21464751cd1f4714a2b22e36a88 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createScanner.md @@ -0,0 +1,45 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createScanner + +# Function: createScanner() + +> **createScanner**(`languageVersion`, `skipTrivia`, `languageVariant`?, `textInitial`?, `onError`?, `start`?, `length`?): [`Scanner`](../interfaces/Scanner.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4634 + +## Parameters + +### languageVersion + +[`ScriptTarget`](../enumerations/ScriptTarget.md) + +### skipTrivia + +`boolean` + +### languageVariant? + +[`LanguageVariant`](../enumerations/LanguageVariant.md) + +### textInitial? + +`string` + +### onError? + +[`ErrorCallback`](../type-aliases/ErrorCallback.md) + +### start? + +`number` + +### length? + +`number` + +## Returns + +[`Scanner`](../interfaces/Scanner.md) diff --git a/docs/api_docs/namespaces/ts/functions/createSemanticDiagnosticsBuilderProgram.md b/docs/api_docs/namespaces/ts/functions/createSemanticDiagnosticsBuilderProgram.md new file mode 100644 index 0000000000000000000000000000000000000000..539b7da2d7205d0c49754684e9038fd001d5847f --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createSemanticDiagnosticsBuilderProgram.md @@ -0,0 +1,75 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createSemanticDiagnosticsBuilderProgram + +# Function: createSemanticDiagnosticsBuilderProgram() + +## Call Signature + +> **createSemanticDiagnosticsBuilderProgram**(`newProgram`, `host`, `oldProgram`?, `configFileParsingDiagnostics`?): [`SemanticDiagnosticsBuilderProgram`](../interfaces/SemanticDiagnosticsBuilderProgram.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5758 + +Create the builder to manage semantic diagnostics and cache them + +### Parameters + +#### newProgram + +[`Program`](../interfaces/Program.md) + +#### host + +[`BuilderProgramHost`](../interfaces/BuilderProgramHost.md) + +#### oldProgram? + +[`SemanticDiagnosticsBuilderProgram`](../interfaces/SemanticDiagnosticsBuilderProgram.md) + +#### configFileParsingDiagnostics? + +readonly [`Diagnostic`](../interfaces/Diagnostic.md)[] + +### Returns + +[`SemanticDiagnosticsBuilderProgram`](../interfaces/SemanticDiagnosticsBuilderProgram.md) + +## Call Signature + +> **createSemanticDiagnosticsBuilderProgram**(`rootNames`, `options`, `host`?, `oldProgram`?, `configFileParsingDiagnostics`?, `projectReferences`?): [`SemanticDiagnosticsBuilderProgram`](../interfaces/SemanticDiagnosticsBuilderProgram.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5759 + +Create the builder to manage semantic diagnostics and cache them + +### Parameters + +#### rootNames + +`undefined` | readonly `string`[] + +#### options + +`undefined` | [`CompilerOptions`](../interfaces/CompilerOptions.md) + +#### host? + +[`CompilerHost`](../interfaces/CompilerHost.md) + +#### oldProgram? + +[`SemanticDiagnosticsBuilderProgram`](../interfaces/SemanticDiagnosticsBuilderProgram.md) + +#### configFileParsingDiagnostics? + +readonly [`Diagnostic`](../interfaces/Diagnostic.md)[] + +#### projectReferences? + +readonly [`ProjectReference`](../interfaces/ProjectReference.md)[] + +### Returns + +[`SemanticDiagnosticsBuilderProgram`](../interfaces/SemanticDiagnosticsBuilderProgram.md) diff --git a/docs/api_docs/namespaces/ts/functions/createSemicolonClassElement.md b/docs/api_docs/namespaces/ts/functions/createSemicolonClassElement.md new file mode 100644 index 0000000000000000000000000000000000000000..3465fa570d7da2778adc84d32cee2408fae8911d --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createSemicolonClassElement.md @@ -0,0 +1,19 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createSemicolonClassElement + +# Function: ~~createSemicolonClassElement()~~ + +> **createSemicolonClassElement**(): [`SemicolonClassElement`](../interfaces/SemicolonClassElement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7817 + +## Returns + +[`SemicolonClassElement`](../interfaces/SemicolonClassElement.md) + +## Deprecated + +Use `factory.createSemicolonClassElement` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createSetAccessor.md b/docs/api_docs/namespaces/ts/functions/createSetAccessor.md new file mode 100644 index 0000000000000000000000000000000000000000..88497373a35c1fa13e1338f1d5e87471ccbcca6c --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createSetAccessor.md @@ -0,0 +1,71 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createSetAccessor + +# Function: ~~createSetAccessor()~~ + +## Deprecated + +Use `factory.createSetAccessorDeclaration` or the factory supplied by your transformation context instead. + +## Call Signature + +> **createSetAccessor**(`modifiers`, `name`, `parameters`, `body`): [`SetAccessorDeclaration`](../interfaces/SetAccessorDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7566 + +### Parameters + +#### modifiers + +`undefined` | readonly [`ModifierLike`](../type-aliases/ModifierLike.md)[] + +#### name + +`string` | [`PropertyName`](../type-aliases/PropertyName.md) + +#### parameters + +readonly [`ParameterDeclaration`](../interfaces/ParameterDeclaration.md)[] + +#### body + +`undefined` | [`Block`](../interfaces/Block.md) + +### Returns + +[`SetAccessorDeclaration`](../interfaces/SetAccessorDeclaration.md) + +## Call Signature + +> **createSetAccessor**(`decorators`, `modifiers`, `name`, `parameters`, `body`): [`SetAccessorDeclaration`](../interfaces/SetAccessorDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7567 + +### Parameters + +#### decorators + +`undefined` | readonly [`Decorator`](../interfaces/Decorator.md)[] + +#### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +#### name + +`string` | [`PropertyName`](../type-aliases/PropertyName.md) + +#### parameters + +readonly [`ParameterDeclaration`](../interfaces/ParameterDeclaration.md)[] + +#### body + +`undefined` | [`Block`](../interfaces/Block.md) + +### Returns + +[`SetAccessorDeclaration`](../interfaces/SetAccessorDeclaration.md) diff --git a/docs/api_docs/namespaces/ts/functions/createShorthandPropertyAssignment.md b/docs/api_docs/namespaces/ts/functions/createShorthandPropertyAssignment.md new file mode 100644 index 0000000000000000000000000000000000000000..e88bf68e4e6cdc427b70ca6184b0cf8d9fbab50a --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createShorthandPropertyAssignment.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createShorthandPropertyAssignment + +# Function: ~~createShorthandPropertyAssignment()~~ + +> **createShorthandPropertyAssignment**(`name`, `objectAssignmentInitializer`?): [`ShorthandPropertyAssignment`](../interfaces/ShorthandPropertyAssignment.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8137 + +## Parameters + +### name + +`string` | [`Identifier`](../interfaces/Identifier.md) + +### objectAssignmentInitializer? + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`ShorthandPropertyAssignment`](../interfaces/ShorthandPropertyAssignment.md) + +## Deprecated + +Use `factory.createShorthandPropertyAssignment` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createSolutionBuilder.md b/docs/api_docs/namespaces/ts/functions/createSolutionBuilder.md new file mode 100644 index 0000000000000000000000000000000000000000..662ab66799bc8bd16171993172e8e06858518944 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createSolutionBuilder.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createSolutionBuilder + +# Function: createSolutionBuilder() + +> **createSolutionBuilder**\<`T`\>(`host`, `rootNames`, `defaultOptions`): [`SolutionBuilder`](../interfaces/SolutionBuilder.md)\<`T`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5969 + +## Type Parameters + +• **T** *extends* [`BuilderProgram`](../interfaces/BuilderProgram.md) + +## Parameters + +### host + +[`SolutionBuilderHost`](../interfaces/SolutionBuilderHost.md)\<`T`\> + +### rootNames + +readonly `string`[] + +### defaultOptions + +[`BuildOptions`](../interfaces/BuildOptions.md) + +## Returns + +[`SolutionBuilder`](../interfaces/SolutionBuilder.md)\<`T`\> diff --git a/docs/api_docs/namespaces/ts/functions/createSolutionBuilderHost.md b/docs/api_docs/namespaces/ts/functions/createSolutionBuilderHost.md new file mode 100644 index 0000000000000000000000000000000000000000..105d09a5d9606e654e53630d827ac595b9ee462f --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createSolutionBuilderHost.md @@ -0,0 +1,41 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createSolutionBuilderHost + +# Function: createSolutionBuilderHost() + +> **createSolutionBuilderHost**\<`T`\>(`system`?, `createProgram`?, `reportDiagnostic`?, `reportSolutionBuilderStatus`?, `reportErrorSummary`?): [`SolutionBuilderHost`](../interfaces/SolutionBuilderHost.md)\<`T`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5967 + +## Type Parameters + +• **T** *extends* [`BuilderProgram`](../interfaces/BuilderProgram.md) = [`EmitAndSemanticDiagnosticsBuilderProgram`](../interfaces/EmitAndSemanticDiagnosticsBuilderProgram.md) + +## Parameters + +### system? + +[`System`](../interfaces/System.md) + +### createProgram? + +[`CreateProgram`](../type-aliases/CreateProgram.md)\<`T`\> + +### reportDiagnostic? + +[`DiagnosticReporter`](../type-aliases/DiagnosticReporter.md) + +### reportSolutionBuilderStatus? + +[`DiagnosticReporter`](../type-aliases/DiagnosticReporter.md) + +### reportErrorSummary? + +[`ReportEmitErrorSummary`](../type-aliases/ReportEmitErrorSummary.md) + +## Returns + +[`SolutionBuilderHost`](../interfaces/SolutionBuilderHost.md)\<`T`\> diff --git a/docs/api_docs/namespaces/ts/functions/createSolutionBuilderWithWatch.md b/docs/api_docs/namespaces/ts/functions/createSolutionBuilderWithWatch.md new file mode 100644 index 0000000000000000000000000000000000000000..b39b66c63a6d3900ff0020be001beafe780d5d7d --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createSolutionBuilderWithWatch.md @@ -0,0 +1,37 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createSolutionBuilderWithWatch + +# Function: createSolutionBuilderWithWatch() + +> **createSolutionBuilderWithWatch**\<`T`\>(`host`, `rootNames`, `defaultOptions`, `baseWatchOptions`?): [`SolutionBuilder`](../interfaces/SolutionBuilder.md)\<`T`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5970 + +## Type Parameters + +• **T** *extends* [`BuilderProgram`](../interfaces/BuilderProgram.md) + +## Parameters + +### host + +[`SolutionBuilderWithWatchHost`](../interfaces/SolutionBuilderWithWatchHost.md)\<`T`\> + +### rootNames + +readonly `string`[] + +### defaultOptions + +[`BuildOptions`](../interfaces/BuildOptions.md) + +### baseWatchOptions? + +[`WatchOptions`](../interfaces/WatchOptions.md) + +## Returns + +[`SolutionBuilder`](../interfaces/SolutionBuilder.md)\<`T`\> diff --git a/docs/api_docs/namespaces/ts/functions/createSolutionBuilderWithWatchHost.md b/docs/api_docs/namespaces/ts/functions/createSolutionBuilderWithWatchHost.md new file mode 100644 index 0000000000000000000000000000000000000000..6aa435bb20b79966a9482bc4eb3981c03798052f --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createSolutionBuilderWithWatchHost.md @@ -0,0 +1,41 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createSolutionBuilderWithWatchHost + +# Function: createSolutionBuilderWithWatchHost() + +> **createSolutionBuilderWithWatchHost**\<`T`\>(`system`?, `createProgram`?, `reportDiagnostic`?, `reportSolutionBuilderStatus`?, `reportWatchStatus`?): [`SolutionBuilderWithWatchHost`](../interfaces/SolutionBuilderWithWatchHost.md)\<`T`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5968 + +## Type Parameters + +• **T** *extends* [`BuilderProgram`](../interfaces/BuilderProgram.md) = [`EmitAndSemanticDiagnosticsBuilderProgram`](../interfaces/EmitAndSemanticDiagnosticsBuilderProgram.md) + +## Parameters + +### system? + +[`System`](../interfaces/System.md) + +### createProgram? + +[`CreateProgram`](../type-aliases/CreateProgram.md)\<`T`\> + +### reportDiagnostic? + +[`DiagnosticReporter`](../type-aliases/DiagnosticReporter.md) + +### reportSolutionBuilderStatus? + +[`DiagnosticReporter`](../type-aliases/DiagnosticReporter.md) + +### reportWatchStatus? + +[`WatchStatusReporter`](../type-aliases/WatchStatusReporter.md) + +## Returns + +[`SolutionBuilderWithWatchHost`](../interfaces/SolutionBuilderWithWatchHost.md)\<`T`\> diff --git a/docs/api_docs/namespaces/ts/functions/createSourceFile.md b/docs/api_docs/namespaces/ts/functions/createSourceFile.md new file mode 100644 index 0000000000000000000000000000000000000000..50f1681433a7f803ee3874ef7cdb619e618b5c03 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createSourceFile.md @@ -0,0 +1,41 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createSourceFile + +# Function: createSourceFile() + +> **createSourceFile**(`fileName`, `sourceText`, `languageVersionOrOptions`, `setParentNodes`?, `scriptKind`?, `options`?): [`SourceFile`](../interfaces/SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5245 + +## Parameters + +### fileName + +`string` + +### sourceText + +`string` + +### languageVersionOrOptions + +[`ScriptTarget`](../enumerations/ScriptTarget.md) | [`CreateSourceFileOptions`](../interfaces/CreateSourceFileOptions.md) + +### setParentNodes? + +`boolean` + +### scriptKind? + +[`ScriptKind`](../enumerations/ScriptKind.md) + +### options? + +[`CompilerOptions`](../interfaces/CompilerOptions.md) + +## Returns + +[`SourceFile`](../interfaces/SourceFile.md) diff --git a/docs/api_docs/namespaces/ts/functions/createSourceMapGenerator.md b/docs/api_docs/namespaces/ts/functions/createSourceMapGenerator.md new file mode 100644 index 0000000000000000000000000000000000000000..434e0d99d6420265295e2458138bbc1a041d0f24 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createSourceMapGenerator.md @@ -0,0 +1,37 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createSourceMapGenerator + +# Function: createSourceMapGenerator() + +> **createSourceMapGenerator**(`host`, `file`, `sourceRoot`, `sourcesDirectoryPath`, `generatorOptions`): [`SourceMapGenerator`](../interfaces/SourceMapGenerator.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5534 + +## Parameters + +### host + +[`EmitHost`](../interfaces/EmitHost.md) + +### file + +`string` + +### sourceRoot + +`string` + +### sourcesDirectoryPath + +`string` + +### generatorOptions + +[`SourceMapGeneratorOptions`](../interfaces/SourceMapGeneratorOptions.md) + +## Returns + +[`SourceMapGenerator`](../interfaces/SourceMapGenerator.md) diff --git a/docs/api_docs/namespaces/ts/functions/createSourceMapSource.md b/docs/api_docs/namespaces/ts/functions/createSourceMapSource.md new file mode 100644 index 0000000000000000000000000000000000000000..922b26955c580c98de0b129e5bf31e875fd48f1a --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createSourceMapSource.md @@ -0,0 +1,31 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createSourceMapSource + +# Function: createSourceMapSource() + +> **createSourceMapSource**(`fileName`, `text`, `skipTrivia`?): [`SourceMapSource`](../interfaces/SourceMapSource.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4933 + +Create an external source map source file reference + +## Parameters + +### fileName + +`string` + +### text + +`string` + +### skipTrivia? + +(`pos`) => `number` + +## Returns + +[`SourceMapSource`](../interfaces/SourceMapSource.md) diff --git a/docs/api_docs/namespaces/ts/functions/createSpread.md b/docs/api_docs/namespaces/ts/functions/createSpread.md new file mode 100644 index 0000000000000000000000000000000000000000..b8cf498ceaa4687d2343c68a78c9315f4890881e --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createSpread.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createSpread + +# Function: ~~createSpread()~~ + +> **createSpread**(`expression`): [`SpreadElement`](../interfaces/SpreadElement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7791 + +## Parameters + +### expression + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`SpreadElement`](../interfaces/SpreadElement.md) + +## Deprecated + +Use `factory.createSpreadExpression` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createSpreadAssignment.md b/docs/api_docs/namespaces/ts/functions/createSpreadAssignment.md new file mode 100644 index 0000000000000000000000000000000000000000..95a8dc8dd9e2a2735b31fc0c2ac2e081a441add6 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createSpreadAssignment.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createSpreadAssignment + +# Function: ~~createSpreadAssignment()~~ + +> **createSpreadAssignment**(`expression`): [`SpreadAssignment`](../interfaces/SpreadAssignment.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8141 + +## Parameters + +### expression + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`SpreadAssignment`](../interfaces/SpreadAssignment.md) + +## Deprecated + +Use `factory.createSpreadAssignment` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createStatement.md b/docs/api_docs/namespaces/ts/functions/createStatement.md new file mode 100644 index 0000000000000000000000000000000000000000..a83fe4686bfef7f84df2289c1845092c41bc7edc --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createStatement.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createStatement + +# Function: ~~createStatement()~~ + +> **createStatement**(`expression`): [`ExpressionStatement`](../interfaces/ExpressionStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7833 + +## Parameters + +### expression + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`ExpressionStatement`](../interfaces/ExpressionStatement.md) + +## Deprecated + +Use `factory.createExpressionStatement` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createStrictEquality.md b/docs/api_docs/namespaces/ts/functions/createStrictEquality.md new file mode 100644 index 0000000000000000000000000000000000000000..fa62a0d16da70bd91ba06aa849a95df7c2b18c8d --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createStrictEquality.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createStrictEquality + +# Function: ~~createStrictEquality()~~ + +> **createStrictEquality**(`left`, `right`): [`BinaryExpression`](../interfaces/BinaryExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8289 + +## Parameters + +### left + +[`Expression`](../interfaces/Expression.md) + +### right + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`BinaryExpression`](../interfaces/BinaryExpression.md) + +## Deprecated + +Use `factory.createStrictEquality` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createStrictInequality.md b/docs/api_docs/namespaces/ts/functions/createStrictInequality.md new file mode 100644 index 0000000000000000000000000000000000000000..e1bce75231867ef4b26c4c4c5b01b0c923ebaff3 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createStrictInequality.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createStrictInequality + +# Function: ~~createStrictInequality()~~ + +> **createStrictInequality**(`left`, `right`): [`BinaryExpression`](../interfaces/BinaryExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8291 + +## Parameters + +### left + +[`Expression`](../interfaces/Expression.md) + +### right + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`BinaryExpression`](../interfaces/BinaryExpression.md) + +## Deprecated + +Use `factory.createStrictInequality` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createStringLiteral.md b/docs/api_docs/namespaces/ts/functions/createStringLiteral.md new file mode 100644 index 0000000000000000000000000000000000000000..d7832698fe233d4be6d5dfc939491e15805a7e1e --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createStringLiteral.md @@ -0,0 +1,55 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createStringLiteral + +# Function: ~~createStringLiteral()~~ + +## Deprecated + +Use `factory.createStringLiteral` or the factory supplied by your transformation context instead. + +## Call Signature + +> **createStringLiteral**(`text`, `isSingleQuote`?): [`StringLiteral`](../interfaces/StringLiteral.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7465 + +### Parameters + +#### text + +`string` + +#### isSingleQuote? + +`boolean` + +### Returns + +[`StringLiteral`](../interfaces/StringLiteral.md) + +## Call Signature + +> **createStringLiteral**(`text`, `isSingleQuote`?, `hasExtendedUnicodeEscape`?): [`StringLiteral`](../interfaces/StringLiteral.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7466 + +### Parameters + +#### text + +`string` + +#### isSingleQuote? + +`boolean` + +#### hasExtendedUnicodeEscape? + +`boolean` + +### Returns + +[`StringLiteral`](../interfaces/StringLiteral.md) diff --git a/docs/api_docs/namespaces/ts/functions/createStringLiteralFromNode.md b/docs/api_docs/namespaces/ts/functions/createStringLiteralFromNode.md new file mode 100644 index 0000000000000000000000000000000000000000..e80d3fde99ecca14b71fca568ee2e87e0d071881 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createStringLiteralFromNode.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createStringLiteralFromNode + +# Function: ~~createStringLiteralFromNode()~~ + +> **createStringLiteralFromNode**(`sourceNode`, `isSingleQuote`?): [`StringLiteral`](../interfaces/StringLiteral.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7469 + +## Parameters + +### sourceNode + +[`PrivateIdentifier`](../interfaces/PrivateIdentifier.md) | [`PropertyNameLiteral`](../type-aliases/PropertyNameLiteral.md) + +### isSingleQuote? + +`boolean` + +## Returns + +[`StringLiteral`](../interfaces/StringLiteral.md) + +## Deprecated + +Use `factory.createStringLiteralFromNode` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createSubtract.md b/docs/api_docs/namespaces/ts/functions/createSubtract.md new file mode 100644 index 0000000000000000000000000000000000000000..b85009cd43577d7d4d71a1585bbd49c9ef9e9e5e --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createSubtract.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createSubtract + +# Function: ~~createSubtract()~~ + +> **createSubtract**(`left`, `right`): [`BinaryExpression`](../interfaces/BinaryExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8295 + +## Parameters + +### left + +[`Expression`](../interfaces/Expression.md) + +### right + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`BinaryExpression`](../interfaces/BinaryExpression.md) + +## Deprecated + +Use `factory.createSubtract` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createSuper.md b/docs/api_docs/namespaces/ts/functions/createSuper.md new file mode 100644 index 0000000000000000000000000000000000000000..2299cb3525353fc03b01ca336ae7d6598111a866 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createSuper.md @@ -0,0 +1,19 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createSuper + +# Function: ~~createSuper()~~ + +> **createSuper**(): [`SuperExpression`](../interfaces/SuperExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7479 + +## Returns + +[`SuperExpression`](../interfaces/SuperExpression.md) + +## Deprecated + +Use `factory.createSuper` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createSwitch.md b/docs/api_docs/namespaces/ts/functions/createSwitch.md new file mode 100644 index 0000000000000000000000000000000000000000..d8eadad2140312f42fbad6a3e241620cdf272dfc --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createSwitch.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createSwitch + +# Function: ~~createSwitch()~~ + +> **createSwitch**(`expression`, `caseBlock`): [`SwitchStatement`](../interfaces/SwitchStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7877 + +## Parameters + +### expression + +[`Expression`](../interfaces/Expression.md) + +### caseBlock + +[`CaseBlock`](../interfaces/CaseBlock.md) + +## Returns + +[`SwitchStatement`](../interfaces/SwitchStatement.md) + +## Deprecated + +Use `factory.createSwitchStatement` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createTaggedTemplate.md b/docs/api_docs/namespaces/ts/functions/createTaggedTemplate.md new file mode 100644 index 0000000000000000000000000000000000000000..197b4946c23da6d7ee4a3cf63fdde7d10842063d --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createTaggedTemplate.md @@ -0,0 +1,55 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createTaggedTemplate + +# Function: ~~createTaggedTemplate()~~ + +## Deprecated + +Use `factory.createTaggedTemplate` or the factory supplied by your transformation context instead. + +## Call Signature + +> **createTaggedTemplate**(`tag`, `template`): [`TaggedTemplateExpression`](../interfaces/TaggedTemplateExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8220 + +### Parameters + +#### tag + +[`Expression`](../interfaces/Expression.md) + +#### template + +[`TemplateLiteral`](../type-aliases/TemplateLiteral.md) + +### Returns + +[`TaggedTemplateExpression`](../interfaces/TaggedTemplateExpression.md) + +## Call Signature + +> **createTaggedTemplate**(`tag`, `typeArguments`, `template`): [`TaggedTemplateExpression`](../interfaces/TaggedTemplateExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8221 + +### Parameters + +#### tag + +[`Expression`](../interfaces/Expression.md) + +#### typeArguments + +`undefined` | readonly [`TypeNode`](../interfaces/TypeNode.md)[] + +#### template + +[`TemplateLiteral`](../type-aliases/TemplateLiteral.md) + +### Returns + +[`TaggedTemplateExpression`](../interfaces/TaggedTemplateExpression.md) diff --git a/docs/api_docs/namespaces/ts/functions/createTempVariable.md b/docs/api_docs/namespaces/ts/functions/createTempVariable.md new file mode 100644 index 0000000000000000000000000000000000000000..90001bf4c1e58ac61a6bcdc3b739d2a28b6eea03 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createTempVariable.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createTempVariable + +# Function: ~~createTempVariable()~~ + +> **createTempVariable**(`recordTempVariable`): [`Identifier`](../interfaces/Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8189 + +## Parameters + +### recordTempVariable + +`undefined` | (`node`) => `void` + +## Returns + +[`Identifier`](../interfaces/Identifier.md) + +## Deprecated + +Use `factory.createTempVariable` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createTemplateExpression.md b/docs/api_docs/namespaces/ts/functions/createTemplateExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..34747d7a3623825e445357af8cf1e7def66f5f22 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createTemplateExpression.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createTemplateExpression + +# Function: ~~createTemplateExpression()~~ + +> **createTemplateExpression**(`head`, `templateSpans`): [`TemplateExpression`](../interfaces/TemplateExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7765 + +## Parameters + +### head + +[`TemplateHead`](../interfaces/TemplateHead.md) + +### templateSpans + +readonly [`TemplateSpan`](../interfaces/TemplateSpan.md)[] + +## Returns + +[`TemplateExpression`](../interfaces/TemplateExpression.md) + +## Deprecated + +Use `factory.createTemplateExpression` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createTemplateHead.md b/docs/api_docs/namespaces/ts/functions/createTemplateHead.md new file mode 100644 index 0000000000000000000000000000000000000000..da7249f2aa2e3228c4ede90fc172cb0db04b2770 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createTemplateHead.md @@ -0,0 +1,59 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createTemplateHead + +# Function: ~~createTemplateHead()~~ + +## Deprecated + +Use `factory.createTemplateHead` or the factory supplied by your transformation context instead. + +## Call Signature + +> **createTemplateHead**(`text`, `rawText`?, `templateFlags`?): [`TemplateHead`](../interfaces/TemplateHead.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7770 + +### Parameters + +#### text + +`string` + +#### rawText? + +`string` + +#### templateFlags? + +[`TokenFlags`](../enumerations/TokenFlags.md) + +### Returns + +[`TemplateHead`](../interfaces/TemplateHead.md) + +## Call Signature + +> **createTemplateHead**(`text`, `rawText`, `templateFlags`?): [`TemplateHead`](../interfaces/TemplateHead.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7771 + +### Parameters + +#### text + +`undefined` | `string` + +#### rawText + +`string` + +#### templateFlags? + +[`TokenFlags`](../enumerations/TokenFlags.md) + +### Returns + +[`TemplateHead`](../interfaces/TemplateHead.md) diff --git a/docs/api_docs/namespaces/ts/functions/createTemplateMiddle.md b/docs/api_docs/namespaces/ts/functions/createTemplateMiddle.md new file mode 100644 index 0000000000000000000000000000000000000000..93b0f3f4650a72251833d59987b93e40afcdc01f --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createTemplateMiddle.md @@ -0,0 +1,59 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createTemplateMiddle + +# Function: ~~createTemplateMiddle()~~ + +## Deprecated + +Use `factory.createTemplateMiddle` or the factory supplied by your transformation context instead. + +## Call Signature + +> **createTemplateMiddle**(`text`, `rawText`?, `templateFlags`?): [`TemplateMiddle`](../interfaces/TemplateMiddle.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7775 + +### Parameters + +#### text + +`string` + +#### rawText? + +`string` + +#### templateFlags? + +[`TokenFlags`](../enumerations/TokenFlags.md) + +### Returns + +[`TemplateMiddle`](../interfaces/TemplateMiddle.md) + +## Call Signature + +> **createTemplateMiddle**(`text`, `rawText`, `templateFlags`?): [`TemplateMiddle`](../interfaces/TemplateMiddle.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7776 + +### Parameters + +#### text + +`undefined` | `string` + +#### rawText + +`string` + +#### templateFlags? + +[`TokenFlags`](../enumerations/TokenFlags.md) + +### Returns + +[`TemplateMiddle`](../interfaces/TemplateMiddle.md) diff --git a/docs/api_docs/namespaces/ts/functions/createTemplateSpan.md b/docs/api_docs/namespaces/ts/functions/createTemplateSpan.md new file mode 100644 index 0000000000000000000000000000000000000000..f9d4ea9df2607fd698d15271eb6c59aad1de0fc9 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createTemplateSpan.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createTemplateSpan + +# Function: ~~createTemplateSpan()~~ + +> **createTemplateSpan**(`expression`, `literal`): [`TemplateSpan`](../interfaces/TemplateSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7813 + +## Parameters + +### expression + +[`Expression`](../interfaces/Expression.md) + +### literal + +[`TemplateMiddle`](../interfaces/TemplateMiddle.md) | [`TemplateTail`](../interfaces/TemplateTail.md) + +## Returns + +[`TemplateSpan`](../interfaces/TemplateSpan.md) + +## Deprecated + +Use `factory.createTemplateSpan` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createTemplateTail.md b/docs/api_docs/namespaces/ts/functions/createTemplateTail.md new file mode 100644 index 0000000000000000000000000000000000000000..9ea47d39b5484c13b23bc6d64f40d4a4991ca827 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createTemplateTail.md @@ -0,0 +1,59 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createTemplateTail + +# Function: ~~createTemplateTail()~~ + +## Deprecated + +Use `factory.createTemplateTail` or the factory supplied by your transformation context instead. + +## Call Signature + +> **createTemplateTail**(`text`, `rawText`?, `templateFlags`?): [`TemplateTail`](../interfaces/TemplateTail.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7780 + +### Parameters + +#### text + +`string` + +#### rawText? + +`string` + +#### templateFlags? + +[`TokenFlags`](../enumerations/TokenFlags.md) + +### Returns + +[`TemplateTail`](../interfaces/TemplateTail.md) + +## Call Signature + +> **createTemplateTail**(`text`, `rawText`, `templateFlags`?): [`TemplateTail`](../interfaces/TemplateTail.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7781 + +### Parameters + +#### text + +`undefined` | `string` + +#### rawText + +`string` + +#### templateFlags? + +[`TokenFlags`](../enumerations/TokenFlags.md) + +### Returns + +[`TemplateTail`](../interfaces/TemplateTail.md) diff --git a/docs/api_docs/namespaces/ts/functions/createTextChangeRange.md b/docs/api_docs/namespaces/ts/functions/createTextChangeRange.md new file mode 100644 index 0000000000000000000000000000000000000000..a85e9eaf0da4dd32aec8d2573897dde15e1c9978 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createTextChangeRange.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createTextChangeRange + +# Function: createTextChangeRange() + +> **createTextChangeRange**(`span`, `newLength`): [`TextChangeRange`](../interfaces/TextChangeRange.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4655 + +## Parameters + +### span + +[`TextSpan`](../interfaces/TextSpan.md) + +### newLength + +`number` + +## Returns + +[`TextChangeRange`](../interfaces/TextChangeRange.md) diff --git a/docs/api_docs/namespaces/ts/functions/createTextSpan.md b/docs/api_docs/namespaces/ts/functions/createTextSpan.md new file mode 100644 index 0000000000000000000000000000000000000000..5fb946b0365abbbf746ecb2aa328c86de4c9c8a0 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createTextSpan.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createTextSpan + +# Function: createTextSpan() + +> **createTextSpan**(`start`, `length`): [`TextSpan`](../interfaces/TextSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4651 + +## Parameters + +### start + +`number` + +### length + +`number` + +## Returns + +[`TextSpan`](../interfaces/TextSpan.md) diff --git a/docs/api_docs/namespaces/ts/functions/createTextSpanFromBounds.md b/docs/api_docs/namespaces/ts/functions/createTextSpanFromBounds.md new file mode 100644 index 0000000000000000000000000000000000000000..e475f2e4bf650f0fdd9fb17f9ab34b06218ffef6 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createTextSpanFromBounds.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createTextSpanFromBounds + +# Function: createTextSpanFromBounds() + +> **createTextSpanFromBounds**(`start`, `end`): [`TextSpan`](../interfaces/TextSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4652 + +## Parameters + +### start + +`number` + +### end + +`number` + +## Returns + +[`TextSpan`](../interfaces/TextSpan.md) diff --git a/docs/api_docs/namespaces/ts/functions/createTextWriter.md b/docs/api_docs/namespaces/ts/functions/createTextWriter.md new file mode 100644 index 0000000000000000000000000000000000000000..f5193d23d93a1115b57c6f89ea85f836dfaae9a6 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createTextWriter.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createTextWriter + +# Function: createTextWriter() + +> **createTextWriter**(`newLine`): [`EmitTextWriter`](../interfaces/EmitTextWriter.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4912 + +## Parameters + +### newLine + +`string` + +## Returns + +[`EmitTextWriter`](../interfaces/EmitTextWriter.md) diff --git a/docs/api_docs/namespaces/ts/functions/createThis.md b/docs/api_docs/namespaces/ts/functions/createThis.md new file mode 100644 index 0000000000000000000000000000000000000000..bc12a260c67b83075a157d1648a02246270a8984 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createThis.md @@ -0,0 +1,19 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createThis + +# Function: ~~createThis()~~ + +> **createThis**(): [`ThisExpression`](../interfaces/ThisExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7481 + +## Returns + +[`ThisExpression`](../interfaces/ThisExpression.md) + +## Deprecated + +Use `factory.createThis` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createThisTypeNode.md b/docs/api_docs/namespaces/ts/functions/createThisTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..3386123c7bbf7308af308b9aaa64229b8498d30f --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createThisTypeNode.md @@ -0,0 +1,19 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createThisTypeNode + +# Function: ~~createThisTypeNode()~~ + +> **createThisTypeNode**(): [`ThisTypeNode`](../interfaces/ThisTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7661 + +## Returns + +[`ThisTypeNode`](../interfaces/ThisTypeNode.md) + +## Deprecated + +Use `factory.createThisTypeNode` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createThrow.md b/docs/api_docs/namespaces/ts/functions/createThrow.md new file mode 100644 index 0000000000000000000000000000000000000000..ec7f4cd66600ed30e8b179903b3cb32f004292d3 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createThrow.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createThrow + +# Function: ~~createThrow()~~ + +> **createThrow**(`expression`): [`ThrowStatement`](../interfaces/ThrowStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7885 + +## Parameters + +### expression + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`ThrowStatement`](../interfaces/ThrowStatement.md) + +## Deprecated + +Use `factory.createThrowStatement` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createToken.md b/docs/api_docs/namespaces/ts/functions/createToken.md new file mode 100644 index 0000000000000000000000000000000000000000..3844230354b41000f3a65c63d86d0d1d2c144f54 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createToken.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createToken + +# Function: ~~createToken()~~ + +> **createToken**\<`TKind`\>(`kind`): [`Token`](../interfaces/Token.md)\<`TKind`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8185 + +## Type Parameters + +• **TKind** *extends* [`SyntaxKind`](../enumerations/SyntaxKind.md) + +## Parameters + +### kind + +`TKind` + +## Returns + +[`Token`](../interfaces/Token.md)\<`TKind`\> + +## Deprecated + +Use `factory.createToken` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createTrue.md b/docs/api_docs/namespaces/ts/functions/createTrue.md new file mode 100644 index 0000000000000000000000000000000000000000..5fd275455025bb1908b2a7e3717a6fe7677bd531 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createTrue.md @@ -0,0 +1,19 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createTrue + +# Function: ~~createTrue()~~ + +> **createTrue**(): [`TrueLiteral`](../interfaces/TrueLiteral.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7485 + +## Returns + +[`TrueLiteral`](../interfaces/TrueLiteral.md) + +## Deprecated + +Use `factory.createTrue` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createTry.md b/docs/api_docs/namespaces/ts/functions/createTry.md new file mode 100644 index 0000000000000000000000000000000000000000..07835fbaea7cc9760bb0fac60f44c2383afb23f3 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createTry.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createTry + +# Function: ~~createTry()~~ + +> **createTry**(`tryBlock`, `catchClause`, `finallyBlock`): [`TryStatement`](../interfaces/TryStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7889 + +## Parameters + +### tryBlock + +[`Block`](../interfaces/Block.md) + +### catchClause + +`undefined` | [`CatchClause`](../interfaces/CatchClause.md) + +### finallyBlock + +`undefined` | [`Block`](../interfaces/Block.md) + +## Returns + +[`TryStatement`](../interfaces/TryStatement.md) + +## Deprecated + +Use `factory.createTryStatement` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createTupleTypeNode.md b/docs/api_docs/namespaces/ts/functions/createTupleTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..2fe4aaa5dda0cb06edaa5a023549a4195651d5c3 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createTupleTypeNode.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createTupleTypeNode + +# Function: ~~createTupleTypeNode()~~ + +> **createTupleTypeNode**(`elements`): [`TupleTypeNode`](../interfaces/TupleTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7618 + +## Parameters + +### elements + +readonly ([`TypeNode`](../interfaces/TypeNode.md) \| [`NamedTupleMember`](../interfaces/NamedTupleMember.md))[] + +## Returns + +[`TupleTypeNode`](../interfaces/TupleTypeNode.md) + +## Deprecated + +Use `factory.createTupleTypeNode` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createTypeAliasDeclaration.md b/docs/api_docs/namespaces/ts/functions/createTypeAliasDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..81ed158cafb52aba1fa9c97ff30a644de20dca05 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createTypeAliasDeclaration.md @@ -0,0 +1,71 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createTypeAliasDeclaration + +# Function: ~~createTypeAliasDeclaration()~~ + +## Deprecated + +Use `factory.createTypeAliasDeclaration` or the factory supplied by your transformation context instead. + +## Call Signature + +> **createTypeAliasDeclaration**(`modifiers`, `name`, `typeParameters`, `type`): [`TypeAliasDeclaration`](../interfaces/TypeAliasDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7930 + +### Parameters + +#### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +#### name + +`string` | [`Identifier`](../interfaces/Identifier.md) + +#### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](../interfaces/TypeParameterDeclaration.md)[] + +#### type + +[`TypeNode`](../interfaces/TypeNode.md) + +### Returns + +[`TypeAliasDeclaration`](../interfaces/TypeAliasDeclaration.md) + +## Call Signature + +> **createTypeAliasDeclaration**(`decorators`, `modifiers`, `name`, `typeParameters`, `type`): [`TypeAliasDeclaration`](../interfaces/TypeAliasDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7931 + +### Parameters + +#### decorators + +`undefined` | readonly [`Decorator`](../interfaces/Decorator.md)[] + +#### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +#### name + +`string` | [`Identifier`](../interfaces/Identifier.md) + +#### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](../interfaces/TypeParameterDeclaration.md)[] + +#### type + +[`TypeNode`](../interfaces/TypeNode.md) + +### Returns + +[`TypeAliasDeclaration`](../interfaces/TypeAliasDeclaration.md) diff --git a/docs/api_docs/namespaces/ts/functions/createTypeAssertion.md b/docs/api_docs/namespaces/ts/functions/createTypeAssertion.md new file mode 100644 index 0000000000000000000000000000000000000000..0c7e4263391408701b5a28522062287e6eeb8cc1 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createTypeAssertion.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createTypeAssertion + +# Function: ~~createTypeAssertion()~~ + +> **createTypeAssertion**(`type`, `expression`): [`TypeAssertion`](../interfaces/TypeAssertion.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7725 + +## Parameters + +### type + +[`TypeNode`](../interfaces/TypeNode.md) + +### expression + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`TypeAssertion`](../interfaces/TypeAssertion.md) + +## Deprecated + +Use `factory.createTypeAssertion` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createTypeLiteralNode.md b/docs/api_docs/namespaces/ts/functions/createTypeLiteralNode.md new file mode 100644 index 0000000000000000000000000000000000000000..e15a655f50e7ad2c0a94a3d6e3d310d4c8b8cc32 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createTypeLiteralNode.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createTypeLiteralNode + +# Function: ~~createTypeLiteralNode()~~ + +> **createTypeLiteralNode**(`members`): [`TypeLiteralNode`](../interfaces/TypeLiteralNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7610 + +## Parameters + +### members + +`undefined` | readonly [`TypeElement`](../interfaces/TypeElement.md)[] + +## Returns + +[`TypeLiteralNode`](../interfaces/TypeLiteralNode.md) + +## Deprecated + +Use `factory.createTypeLiteralNode` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createTypeOf.md b/docs/api_docs/namespaces/ts/functions/createTypeOf.md new file mode 100644 index 0000000000000000000000000000000000000000..59899b5c0b7615a8c858f8f35b695db3224943ae --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createTypeOf.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createTypeOf + +# Function: ~~createTypeOf()~~ + +> **createTypeOf**(`expression`): [`TypeOfExpression`](../interfaces/TypeOfExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7741 + +## Parameters + +### expression + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`TypeOfExpression`](../interfaces/TypeOfExpression.md) + +## Deprecated + +Use `factory.createTypeOfExpression` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createTypeOperatorNode.md b/docs/api_docs/namespaces/ts/functions/createTypeOperatorNode.md new file mode 100644 index 0000000000000000000000000000000000000000..3241d60c3759b0b987d64ed6b5b9da41f2d8dbfa --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createTypeOperatorNode.md @@ -0,0 +1,47 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createTypeOperatorNode + +# Function: ~~createTypeOperatorNode()~~ + +## Deprecated + +Use `factory.createTypeOperatorNode` or the factory supplied by your transformation context instead. + +## Call Signature + +> **createTypeOperatorNode**(`type`): [`TypeOperatorNode`](../interfaces/TypeOperatorNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8215 + +### Parameters + +#### type + +[`TypeNode`](../interfaces/TypeNode.md) + +### Returns + +[`TypeOperatorNode`](../interfaces/TypeOperatorNode.md) + +## Call Signature + +> **createTypeOperatorNode**(`operator`, `type`): [`TypeOperatorNode`](../interfaces/TypeOperatorNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8216 + +### Parameters + +#### operator + +[`KeyOfKeyword`](../enumerations/SyntaxKind.md#keyofkeyword) | [`ReadonlyKeyword`](../enumerations/SyntaxKind.md#readonlykeyword) | [`UniqueKeyword`](../enumerations/SyntaxKind.md#uniquekeyword) + +#### type + +[`TypeNode`](../interfaces/TypeNode.md) + +### Returns + +[`TypeOperatorNode`](../interfaces/TypeOperatorNode.md) diff --git a/docs/api_docs/namespaces/ts/functions/createTypeParameterDeclaration.md b/docs/api_docs/namespaces/ts/functions/createTypeParameterDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..a57b9c20d6c938b2aad3bc1fe02e07d9d007383b --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createTypeParameterDeclaration.md @@ -0,0 +1,63 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createTypeParameterDeclaration + +# Function: ~~createTypeParameterDeclaration()~~ + +## Deprecated + +Use `factory.createTypeParameterDeclaration` or the factory supplied by your transformation context instead. + +## Call Signature + +> **createTypeParameterDeclaration**(`modifiers`, `name`, `constraint`?, `defaultType`?): [`TypeParameterDeclaration`](../interfaces/TypeParameterDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7502 + +### Parameters + +#### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +#### name + +`string` | [`Identifier`](../interfaces/Identifier.md) + +#### constraint? + +[`TypeNode`](../interfaces/TypeNode.md) + +#### defaultType? + +[`TypeNode`](../interfaces/TypeNode.md) + +### Returns + +[`TypeParameterDeclaration`](../interfaces/TypeParameterDeclaration.md) + +## Call Signature + +> **createTypeParameterDeclaration**(`name`, `constraint`?, `defaultType`?): [`TypeParameterDeclaration`](../interfaces/TypeParameterDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7503 + +### Parameters + +#### name + +`string` | [`Identifier`](../interfaces/Identifier.md) + +#### constraint? + +[`TypeNode`](../interfaces/TypeNode.md) + +#### defaultType? + +[`TypeNode`](../interfaces/TypeNode.md) + +### Returns + +[`TypeParameterDeclaration`](../interfaces/TypeParameterDeclaration.md) diff --git a/docs/api_docs/namespaces/ts/functions/createTypePredicateNode.md b/docs/api_docs/namespaces/ts/functions/createTypePredicateNode.md new file mode 100644 index 0000000000000000000000000000000000000000..932e718b4fb786ca3248e1f920d8f1d02d0cc0d1 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createTypePredicateNode.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createTypePredicateNode + +# Function: ~~createTypePredicateNode()~~ + +> **createTypePredicateNode**(`parameterName`, `type`): [`TypePredicateNode`](../interfaces/TypePredicateNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8199 + +## Parameters + +### parameterName + +`string` | [`Identifier`](../interfaces/Identifier.md) | [`ThisTypeNode`](../interfaces/ThisTypeNode.md) + +### type + +[`TypeNode`](../interfaces/TypeNode.md) + +## Returns + +[`TypePredicateNode`](../interfaces/TypePredicateNode.md) + +## Deprecated + +Use `factory.createTypePredicateNode` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createTypePredicateNodeWithModifier.md b/docs/api_docs/namespaces/ts/functions/createTypePredicateNodeWithModifier.md new file mode 100644 index 0000000000000000000000000000000000000000..1948ee00beadb64198f8ecdd5d4c87626615a643 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createTypePredicateNodeWithModifier.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createTypePredicateNodeWithModifier + +# Function: ~~createTypePredicateNodeWithModifier()~~ + +> **createTypePredicateNodeWithModifier**(`assertsModifier`, `parameterName`, `type`): [`TypePredicateNode`](../interfaces/TypePredicateNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7590 + +## Parameters + +### assertsModifier + +`undefined` | [`AssertsKeyword`](../type-aliases/AssertsKeyword.md) + +### parameterName + +`string` | [`Identifier`](../interfaces/Identifier.md) | [`ThisTypeNode`](../interfaces/ThisTypeNode.md) + +### type + +`undefined` | [`TypeNode`](../interfaces/TypeNode.md) + +## Returns + +[`TypePredicateNode`](../interfaces/TypePredicateNode.md) + +## Deprecated + +Use `factory.createTypePredicateNode` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createTypeQueryNode.md b/docs/api_docs/namespaces/ts/functions/createTypeQueryNode.md new file mode 100644 index 0000000000000000000000000000000000000000..7952b193af8aae52013fd4094ccf295d02e88351 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createTypeQueryNode.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createTypeQueryNode + +# Function: ~~createTypeQueryNode()~~ + +> **createTypeQueryNode**(`exprName`, `typeArguments`?): [`TypeQueryNode`](../interfaces/TypeQueryNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7606 + +## Parameters + +### exprName + +[`EntityName`](../type-aliases/EntityName.md) + +### typeArguments? + +readonly [`TypeNode`](../interfaces/TypeNode.md)[] + +## Returns + +[`TypeQueryNode`](../interfaces/TypeQueryNode.md) + +## Deprecated + +Use `factory.createTypeQueryNode` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createTypeReferenceDirectiveResolutionCache.md b/docs/api_docs/namespaces/ts/functions/createTypeReferenceDirectiveResolutionCache.md new file mode 100644 index 0000000000000000000000000000000000000000..cfe444494ea2649c58948455b462808c2b772f0f --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createTypeReferenceDirectiveResolutionCache.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createTypeReferenceDirectiveResolutionCache + +# Function: createTypeReferenceDirectiveResolutionCache() + +> **createTypeReferenceDirectiveResolutionCache**(`currentDirectory`, `getCanonicalFileName`, `options`?, `packageJsonInfoCache`?): [`TypeReferenceDirectiveResolutionCache`](../interfaces/TypeReferenceDirectiveResolutionCache.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5403 + +## Parameters + +### currentDirectory + +`string` + +### getCanonicalFileName + +(`s`) => `string` + +### options? + +[`CompilerOptions`](../interfaces/CompilerOptions.md) + +### packageJsonInfoCache? + +[`PackageJsonInfoCache`](../interfaces/PackageJsonInfoCache.md) + +## Returns + +[`TypeReferenceDirectiveResolutionCache`](../interfaces/TypeReferenceDirectiveResolutionCache.md) diff --git a/docs/api_docs/namespaces/ts/functions/createTypeReferenceNode.md b/docs/api_docs/namespaces/ts/functions/createTypeReferenceNode.md new file mode 100644 index 0000000000000000000000000000000000000000..474aea98a3926098becd2c4152ddbc85b08568d6 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createTypeReferenceNode.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createTypeReferenceNode + +# Function: ~~createTypeReferenceNode()~~ + +> **createTypeReferenceNode**(`typeName`, `typeArguments`?): [`TypeReferenceNode`](../interfaces/TypeReferenceNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7594 + +## Parameters + +### typeName + +`string` | [`EntityName`](../type-aliases/EntityName.md) + +### typeArguments? + +readonly [`TypeNode`](../interfaces/TypeNode.md)[] + +## Returns + +[`TypeReferenceNode`](../interfaces/TypeReferenceNode.md) + +## Deprecated + +Use `factory.createTypeReferenceNode` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createUnionTypeNode.md b/docs/api_docs/namespaces/ts/functions/createUnionTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..41ec627f2ad55aba1a3b048c3445f12d7328f891 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createUnionTypeNode.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createUnionTypeNode + +# Function: ~~createUnionTypeNode()~~ + +> **createUnionTypeNode**(`types`): [`UnionTypeNode`](../interfaces/UnionTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7630 + +## Parameters + +### types + +readonly [`TypeNode`](../interfaces/TypeNode.md)[] + +## Returns + +[`UnionTypeNode`](../interfaces/UnionTypeNode.md) + +## Deprecated + +Use `factory.createUnionTypeNode` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createUniqueName.md b/docs/api_docs/namespaces/ts/functions/createUniqueName.md new file mode 100644 index 0000000000000000000000000000000000000000..b6c76cc52d615ba34363963b11022b7a1e878eb2 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createUniqueName.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createUniqueName + +# Function: ~~createUniqueName()~~ + +> **createUniqueName**(`text`, `flags`?): [`Identifier`](../interfaces/Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7475 + +## Parameters + +### text + +`string` + +### flags? + +[`GeneratedIdentifierFlags`](../enumerations/GeneratedIdentifierFlags.md) + +## Returns + +[`Identifier`](../interfaces/Identifier.md) + +## Deprecated + +Use `factory.createUniqueName` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createUnparsedSourceFile.md b/docs/api_docs/namespaces/ts/functions/createUnparsedSourceFile.md new file mode 100644 index 0000000000000000000000000000000000000000..d04e62b4597d92b78b43a0084956b797b03857ed --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createUnparsedSourceFile.md @@ -0,0 +1,71 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createUnparsedSourceFile + +# Function: createUnparsedSourceFile() + +## Call Signature + +> **createUnparsedSourceFile**(`text`): [`UnparsedSource`](../interfaces/UnparsedSource.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4924 + +### Parameters + +#### text + +`string` + +### Returns + +[`UnparsedSource`](../interfaces/UnparsedSource.md) + +## Call Signature + +> **createUnparsedSourceFile**(`inputFile`, `type`, `stripInternal`?): [`UnparsedSource`](../interfaces/UnparsedSource.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4925 + +### Parameters + +#### inputFile + +[`InputFiles`](../interfaces/InputFiles.md) + +#### type + +`"js"` | `"dts"` + +#### stripInternal? + +`boolean` + +### Returns + +[`UnparsedSource`](../interfaces/UnparsedSource.md) + +## Call Signature + +> **createUnparsedSourceFile**(`text`, `mapPath`, `map`): [`UnparsedSource`](../interfaces/UnparsedSource.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4926 + +### Parameters + +#### text + +`string` + +#### mapPath + +`undefined` | `string` + +#### map + +`undefined` | `string` + +### Returns + +[`UnparsedSource`](../interfaces/UnparsedSource.md) diff --git a/docs/api_docs/namespaces/ts/functions/createVariableDeclaration.md b/docs/api_docs/namespaces/ts/functions/createVariableDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..b03ce380ff6c79c4135c6551df92d118c6001ad7 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createVariableDeclaration.md @@ -0,0 +1,63 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createVariableDeclaration + +# Function: ~~createVariableDeclaration()~~ + +## Deprecated + +Use `factory.createVariableDeclaration` or the factory supplied by your transformation context instead. + +## Call Signature + +> **createVariableDeclaration**(`name`, `type`?, `initializer`?): [`VariableDeclaration`](../interfaces/VariableDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8264 + +### Parameters + +#### name + +`string` | [`BindingName`](../type-aliases/BindingName.md) + +#### type? + +[`TypeNode`](../interfaces/TypeNode.md) + +#### initializer? + +[`Expression`](../interfaces/Expression.md) + +### Returns + +[`VariableDeclaration`](../interfaces/VariableDeclaration.md) + +## Call Signature + +> **createVariableDeclaration**(`name`, `exclamationToken`, `type`, `initializer`): [`VariableDeclaration`](../interfaces/VariableDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8265 + +### Parameters + +#### name + +`string` | [`BindingName`](../type-aliases/BindingName.md) + +#### exclamationToken + +`undefined` | [`ExclamationToken`](../type-aliases/ExclamationToken.md) + +#### type + +`undefined` | [`TypeNode`](../interfaces/TypeNode.md) + +#### initializer + +`undefined` | [`Expression`](../interfaces/Expression.md) + +### Returns + +[`VariableDeclaration`](../interfaces/VariableDeclaration.md) diff --git a/docs/api_docs/namespaces/ts/functions/createVariableDeclarationList.md b/docs/api_docs/namespaces/ts/functions/createVariableDeclarationList.md new file mode 100644 index 0000000000000000000000000000000000000000..50b31c9c0f91eecc86635b49bfb3757221572962 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createVariableDeclarationList.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createVariableDeclarationList + +# Function: ~~createVariableDeclarationList()~~ + +> **createVariableDeclarationList**(`declarations`, `flags`?): [`VariableDeclarationList`](../interfaces/VariableDeclarationList.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7895 + +## Parameters + +### declarations + +readonly [`VariableDeclaration`](../interfaces/VariableDeclaration.md)[] + +### flags? + +[`NodeFlags`](../enumerations/NodeFlags.md) + +## Returns + +[`VariableDeclarationList`](../interfaces/VariableDeclarationList.md) + +## Deprecated + +Use `factory.createVariableDeclarationList` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createVariableStatement.md b/docs/api_docs/namespaces/ts/functions/createVariableStatement.md new file mode 100644 index 0000000000000000000000000000000000000000..1511d54a152ce3ca112a9a0e4c6629556e93f750 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createVariableStatement.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createVariableStatement + +# Function: ~~createVariableStatement()~~ + +> **createVariableStatement**(`modifiers`, `declarationList`): [`VariableStatement`](../interfaces/VariableStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7823 + +## Parameters + +### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +### declarationList + +[`VariableDeclarationList`](../interfaces/VariableDeclarationList.md) | readonly [`VariableDeclaration`](../interfaces/VariableDeclaration.md)[] + +## Returns + +[`VariableStatement`](../interfaces/VariableStatement.md) + +## Deprecated + +Use `factory.createVariableStatement` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createVoid.md b/docs/api_docs/namespaces/ts/functions/createVoid.md new file mode 100644 index 0000000000000000000000000000000000000000..fb62aa9384594c55d6d67089d2ffddfd5358b979 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createVoid.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createVoid + +# Function: ~~createVoid()~~ + +> **createVoid**(`expression`): [`VoidExpression`](../interfaces/VoidExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7745 + +## Parameters + +### expression + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`VoidExpression`](../interfaces/VoidExpression.md) + +## Deprecated + +Use `factory.createVoidExpression` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createVoidZero.md b/docs/api_docs/namespaces/ts/functions/createVoidZero.md new file mode 100644 index 0000000000000000000000000000000000000000..efd4796f5e03da1ca69883110274e6b316bec0e6 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createVoidZero.md @@ -0,0 +1,19 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createVoidZero + +# Function: ~~createVoidZero()~~ + +> **createVoidZero**(): [`VoidExpression`](../interfaces/VoidExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8175 + +## Returns + +[`VoidExpression`](../interfaces/VoidExpression.md) + +## Deprecated + +Use `factory.createVoidZero` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createWatchCompilerHost.md b/docs/api_docs/namespaces/ts/functions/createWatchCompilerHost.md new file mode 100644 index 0000000000000000000000000000000000000000..a050b0a54e72520e53cf358f24073eb98bd89c02 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createWatchCompilerHost.md @@ -0,0 +1,107 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createWatchCompilerHost + +# Function: createWatchCompilerHost() + +## Call Signature + +> **createWatchCompilerHost**\<`T`\>(`configFileName`, `optionsToExtend`, `system`, `createProgram`?, `reportDiagnostic`?, `reportWatchStatus`?, `watchOptionsToExtend`?, `extraFileExtensions`?): [`WatchCompilerHostOfConfigFile`](../interfaces/WatchCompilerHostOfConfigFile.md)\<`T`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5909 + +Create the watch compiler host for either configFile or fileNames and its options + +### Type Parameters + +• **T** *extends* [`BuilderProgram`](../interfaces/BuilderProgram.md) + +### Parameters + +#### configFileName + +`string` + +#### optionsToExtend + +`undefined` | [`CompilerOptions`](../interfaces/CompilerOptions.md) + +#### system + +[`System`](../interfaces/System.md) + +#### createProgram? + +[`CreateProgram`](../type-aliases/CreateProgram.md)\<`T`\> + +#### reportDiagnostic? + +[`DiagnosticReporter`](../type-aliases/DiagnosticReporter.md) + +#### reportWatchStatus? + +[`WatchStatusReporter`](../type-aliases/WatchStatusReporter.md) + +#### watchOptionsToExtend? + +[`WatchOptions`](../interfaces/WatchOptions.md) + +#### extraFileExtensions? + +readonly [`FileExtensionInfo`](../interfaces/FileExtensionInfo.md)[] + +### Returns + +[`WatchCompilerHostOfConfigFile`](../interfaces/WatchCompilerHostOfConfigFile.md)\<`T`\> + +## Call Signature + +> **createWatchCompilerHost**\<`T`\>(`rootFiles`, `options`, `system`, `createProgram`?, `reportDiagnostic`?, `reportWatchStatus`?, `projectReferences`?, `watchOptions`?): [`WatchCompilerHostOfFilesAndCompilerOptions`](../interfaces/WatchCompilerHostOfFilesAndCompilerOptions.md)\<`T`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5910 + +Create the watch compiler host for either configFile or fileNames and its options + +### Type Parameters + +• **T** *extends* [`BuilderProgram`](../interfaces/BuilderProgram.md) + +### Parameters + +#### rootFiles + +`string`[] + +#### options + +[`CompilerOptions`](../interfaces/CompilerOptions.md) + +#### system + +[`System`](../interfaces/System.md) + +#### createProgram? + +[`CreateProgram`](../type-aliases/CreateProgram.md)\<`T`\> + +#### reportDiagnostic? + +[`DiagnosticReporter`](../type-aliases/DiagnosticReporter.md) + +#### reportWatchStatus? + +[`WatchStatusReporter`](../type-aliases/WatchStatusReporter.md) + +#### projectReferences? + +readonly [`ProjectReference`](../interfaces/ProjectReference.md)[] + +#### watchOptions? + +[`WatchOptions`](../interfaces/WatchOptions.md) + +### Returns + +[`WatchCompilerHostOfFilesAndCompilerOptions`](../interfaces/WatchCompilerHostOfFilesAndCompilerOptions.md)\<`T`\> diff --git a/docs/api_docs/namespaces/ts/functions/createWatchProgram.md b/docs/api_docs/namespaces/ts/functions/createWatchProgram.md new file mode 100644 index 0000000000000000000000000000000000000000..7e143471676a0f7507710eb4b98ed86bfb2ed654 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createWatchProgram.md @@ -0,0 +1,51 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createWatchProgram + +# Function: createWatchProgram() + +## Call Signature + +> **createWatchProgram**\<`T`\>(`host`): [`WatchOfFilesAndCompilerOptions`](../interfaces/WatchOfFilesAndCompilerOptions.md)\<`T`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5914 + +Creates the watch from the host for root files and compiler options + +### Type Parameters + +• **T** *extends* [`BuilderProgram`](../interfaces/BuilderProgram.md) + +### Parameters + +#### host + +[`WatchCompilerHostOfFilesAndCompilerOptions`](../interfaces/WatchCompilerHostOfFilesAndCompilerOptions.md)\<`T`\> + +### Returns + +[`WatchOfFilesAndCompilerOptions`](../interfaces/WatchOfFilesAndCompilerOptions.md)\<`T`\> + +## Call Signature + +> **createWatchProgram**\<`T`\>(`host`): [`WatchOfConfigFile`](../interfaces/WatchOfConfigFile.md)\<`T`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5918 + +Creates the watch from the host for config file + +### Type Parameters + +• **T** *extends* [`BuilderProgram`](../interfaces/BuilderProgram.md) + +### Parameters + +#### host + +[`WatchCompilerHostOfConfigFile`](../interfaces/WatchCompilerHostOfConfigFile.md)\<`T`\> + +### Returns + +[`WatchOfConfigFile`](../interfaces/WatchOfConfigFile.md)\<`T`\> diff --git a/docs/api_docs/namespaces/ts/functions/createWhile.md b/docs/api_docs/namespaces/ts/functions/createWhile.md new file mode 100644 index 0000000000000000000000000000000000000000..914005a6711ba8f47a738ecdb6a7cece7b4d9be7 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createWhile.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createWhile + +# Function: ~~createWhile()~~ + +> **createWhile**(`expression`, `statement`): [`WhileStatement`](../interfaces/WhileStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7845 + +## Parameters + +### expression + +[`Expression`](../interfaces/Expression.md) + +### statement + +[`Statement`](../interfaces/Statement.md) + +## Returns + +[`WhileStatement`](../interfaces/WhileStatement.md) + +## Deprecated + +Use `factory.createWhileStatement` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createWith.md b/docs/api_docs/namespaces/ts/functions/createWith.md new file mode 100644 index 0000000000000000000000000000000000000000..f0a23e58b66830762c53e78674e5b17be059a07f --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createWith.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createWith + +# Function: ~~createWith()~~ + +> **createWith**(`expression`, `statement`): [`WithStatement`](../interfaces/WithStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7873 + +## Parameters + +### expression + +[`Expression`](../interfaces/Expression.md) + +### statement + +[`Statement`](../interfaces/Statement.md) + +## Returns + +[`WithStatement`](../interfaces/WithStatement.md) + +## Deprecated + +Use `factory.createWithStatement` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/createYield.md b/docs/api_docs/namespaces/ts/functions/createYield.md new file mode 100644 index 0000000000000000000000000000000000000000..47423dcc3b65dc50e1979b790e87cf137772069f --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/createYield.md @@ -0,0 +1,47 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / createYield + +# Function: ~~createYield()~~ + +## Deprecated + +Use `factory.createYield` or the factory supplied by your transformation context instead. + +## Call Signature + +> **createYield**(`expression`?): [`YieldExpression`](../interfaces/YieldExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8237 + +### Parameters + +#### expression? + +[`Expression`](../interfaces/Expression.md) + +### Returns + +[`YieldExpression`](../interfaces/YieldExpression.md) + +## Call Signature + +> **createYield**(`asteriskToken`, `expression`): [`YieldExpression`](../interfaces/YieldExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8238 + +### Parameters + +#### asteriskToken + +`undefined` | [`AsteriskToken`](../type-aliases/AsteriskToken.md) + +#### expression + +[`Expression`](../interfaces/Expression.md) + +### Returns + +[`YieldExpression`](../interfaces/YieldExpression.md) diff --git a/docs/api_docs/namespaces/ts/functions/decodedTextSpanIntersectsWith.md b/docs/api_docs/namespaces/ts/functions/decodedTextSpanIntersectsWith.md new file mode 100644 index 0000000000000000000000000000000000000000..f453e7d683ef17d9c11e1c92da0abcf102ab46d4 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/decodedTextSpanIntersectsWith.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / decodedTextSpanIntersectsWith + +# Function: decodedTextSpanIntersectsWith() + +> **decodedTextSpanIntersectsWith**(`start1`, `length1`, `start2`, `length2`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4648 + +## Parameters + +### start1 + +`number` + +### length1 + +`number` + +### start2 + +`number` + +### length2 + +`number` + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/functions/displayPartsToString.md b/docs/api_docs/namespaces/ts/functions/displayPartsToString.md new file mode 100644 index 0000000000000000000000000000000000000000..0716aa1014d2ee82e5a7dd35447183f4d963551e --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/displayPartsToString.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / displayPartsToString + +# Function: displayPartsToString() + +> **displayPartsToString**(`displayParts`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7434 + +## Parameters + +### displayParts + +`undefined` | [`SymbolDisplayPart`](../interfaces/SymbolDisplayPart.md)[] + +## Returns + +`string` diff --git a/docs/api_docs/namespaces/ts/functions/disposeEmitNodes.md b/docs/api_docs/namespaces/ts/functions/disposeEmitNodes.md new file mode 100644 index 0000000000000000000000000000000000000000..995f4c8e7a631d7e1250900f667dacf0b5d0fc55 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/disposeEmitNodes.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / disposeEmitNodes + +# Function: disposeEmitNodes() + +> **disposeEmitNodes**(`sourceFile`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4941 + +Clears any `EmitNode` entries from parse-tree nodes. + +## Parameters + +### sourceFile + +A source file. + +`undefined` | [`SourceFile`](../interfaces/SourceFile.md) + +## Returns + +`void` diff --git a/docs/api_docs/namespaces/ts/functions/escapeLeadingUnderscores.md b/docs/api_docs/namespaces/ts/functions/escapeLeadingUnderscores.md new file mode 100644 index 0000000000000000000000000000000000000000..1f3a6e821d50dbb4d8b9dbbd810e3eab1b010d12 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/escapeLeadingUnderscores.md @@ -0,0 +1,23 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / escapeLeadingUnderscores + +# Function: escapeLeadingUnderscores() + +> **escapeLeadingUnderscores**(`identifier`): [`__String`](../type-aliases/String.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4721 + +Add an extra underscore to identifiers that start with two underscores to avoid issues with magic names like '__proto__' + +## Parameters + +### identifier + +`string` + +## Returns + +[`__String`](../type-aliases/String.md) diff --git a/docs/api_docs/namespaces/ts/functions/findAncestor.md b/docs/api_docs/namespaces/ts/functions/findAncestor.md new file mode 100644 index 0000000000000000000000000000000000000000..ef4a7f84330cbd6bf476f9d8bad59c89dbfdb33c --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/findAncestor.md @@ -0,0 +1,61 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / findAncestor + +# Function: findAncestor() + +## Call Signature + +> **findAncestor**\<`T`\>(`node`, `callback`): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4697 + +Iterates through the parent chain of a node and performs the callback on each parent until the callback +returns a truthy value, then returns that value. +If no such value is found, it applies the callback until the parent pointer is undefined or the callback returns "quit" +At that point findAncestor returns undefined. + +### Type Parameters + +• **T** *extends* [`Node`](../interfaces/Node.md) + +### Parameters + +#### node + +`undefined` | [`Node`](../interfaces/Node.md) + +#### callback + +(`element`) => `element is T` + +### Returns + +`undefined` \| `T` + +## Call Signature + +> **findAncestor**(`node`, `callback`): `undefined` \| [`Node`](../interfaces/Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4698 + +Iterates through the parent chain of a node and performs the callback on each parent until the callback +returns a truthy value, then returns that value. +If no such value is found, it applies the callback until the parent pointer is undefined or the callback returns "quit" +At that point findAncestor returns undefined. + +### Parameters + +#### node + +`undefined` | [`Node`](../interfaces/Node.md) + +#### callback + +(`element`) => `boolean` \| `"quit"` + +### Returns + +`undefined` \| [`Node`](../interfaces/Node.md) diff --git a/docs/api_docs/namespaces/ts/functions/findConfigFile.md b/docs/api_docs/namespaces/ts/functions/findConfigFile.md new file mode 100644 index 0000000000000000000000000000000000000000..79fdd887f37b63d1b178fa2c0550dc5360780fdd --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/findConfigFile.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / findConfigFile + +# Function: findConfigFile() + +> **findConfigFile**(`searchPath`, `fileExists`, `configName`?): `undefined` \| `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5543 + +## Parameters + +### searchPath + +`string` + +### fileExists + +(`fileName`) => `boolean` + +### configName? + +`string` + +## Returns + +`undefined` \| `string` diff --git a/docs/api_docs/namespaces/ts/functions/flattenDiagnosticMessageText.md b/docs/api_docs/namespaces/ts/functions/flattenDiagnosticMessageText.md new file mode 100644 index 0000000000000000000000000000000000000000..03dea7d0f7e469e526ca84dc179ee53d5040e034 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/flattenDiagnosticMessageText.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / flattenDiagnosticMessageText + +# Function: flattenDiagnosticMessageText() + +> **flattenDiagnosticMessageText**(`diag`, `newLine`, `indent`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5555 + +## Parameters + +### diag + +`undefined` | `string` | [`DiagnosticMessageChain`](../interfaces/DiagnosticMessageChain.md) + +### newLine + +`string` + +### indent? + +`number` + +## Returns + +`string` diff --git a/docs/api_docs/namespaces/ts/functions/forEachChild.md b/docs/api_docs/namespaces/ts/functions/forEachChild.md new file mode 100644 index 0000000000000000000000000000000000000000..d7157a0f3506d415f6844eefa4b058a51184dcb8 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/forEachChild.md @@ -0,0 +1,49 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / forEachChild + +# Function: forEachChild() + +> **forEachChild**\<`T`\>(`node`, `cbNode`, `cbNodes`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5229 + +Invokes a callback for each child of the given node. The 'cbNode' callback is invoked for all child nodes +stored in properties. If a 'cbNodes' callback is specified, it is invoked for embedded arrays; otherwise, +embedded arrays are flattened and the 'cbNode' callback is invoked for each element. If a callback returns +a truthy value, iteration stops and that value is returned. Otherwise, undefined is returned. + +## Type Parameters + +• **T** + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +a given node to visit its children + +### cbNode + +(`node`) => `undefined` \| `T` + +a callback to be invoked for all child nodes + +### cbNodes? + +(`nodes`) => `undefined` \| `T` + +a callback to be invoked for embedded array + +## Returns + +`undefined` \| `T` + +## Remarks + +`forEachChild` must visit the children of a node in the order +that they appear in the source code. The language service depends on this property to locate nodes by position. diff --git a/docs/api_docs/namespaces/ts/functions/forEachLeadingCommentRange.md b/docs/api_docs/namespaces/ts/functions/forEachLeadingCommentRange.md new file mode 100644 index 0000000000000000000000000000000000000000..b61320b7c003a1ed833f1ecdb9090a913ae8b7aa --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/forEachLeadingCommentRange.md @@ -0,0 +1,69 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / forEachLeadingCommentRange + +# Function: forEachLeadingCommentRange() + +## Call Signature + +> **forEachLeadingCommentRange**\<`U`\>(`text`, `pos`, `cb`): `undefined` \| `U` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4622 + +### Type Parameters + +• **U** + +### Parameters + +#### text + +`string` + +#### pos + +`number` + +#### cb + +(`pos`, `end`, `kind`, `hasTrailingNewLine`) => `U` + +### Returns + +`undefined` \| `U` + +## Call Signature + +> **forEachLeadingCommentRange**\<`T`, `U`\>(`text`, `pos`, `cb`, `state`): `undefined` \| `U` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4623 + +### Type Parameters + +• **T** + +• **U** + +### Parameters + +#### text + +`string` + +#### pos + +`number` + +#### cb + +(`pos`, `end`, `kind`, `hasTrailingNewLine`, `state`) => `U` + +#### state + +`T` + +### Returns + +`undefined` \| `U` diff --git a/docs/api_docs/namespaces/ts/functions/forEachTrailingCommentRange.md b/docs/api_docs/namespaces/ts/functions/forEachTrailingCommentRange.md new file mode 100644 index 0000000000000000000000000000000000000000..2d2a80c29a8926a2cfc99191781deacdaec0336c --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/forEachTrailingCommentRange.md @@ -0,0 +1,69 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / forEachTrailingCommentRange + +# Function: forEachTrailingCommentRange() + +## Call Signature + +> **forEachTrailingCommentRange**\<`U`\>(`text`, `pos`, `cb`): `undefined` \| `U` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4624 + +### Type Parameters + +• **U** + +### Parameters + +#### text + +`string` + +#### pos + +`number` + +#### cb + +(`pos`, `end`, `kind`, `hasTrailingNewLine`) => `U` + +### Returns + +`undefined` \| `U` + +## Call Signature + +> **forEachTrailingCommentRange**\<`T`, `U`\>(`text`, `pos`, `cb`, `state`): `undefined` \| `U` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4625 + +### Type Parameters + +• **T** + +• **U** + +### Parameters + +#### text + +`string` + +#### pos + +`number` + +#### cb + +(`pos`, `end`, `kind`, `hasTrailingNewLine`, `state`) => `U` + +#### state + +`T` + +### Returns + +`undefined` \| `U` diff --git a/docs/api_docs/namespaces/ts/functions/formatDiagnostic.md b/docs/api_docs/namespaces/ts/functions/formatDiagnostic.md new file mode 100644 index 0000000000000000000000000000000000000000..81e694f8a6b50052c83bae80ec496b143eae5a33 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/formatDiagnostic.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / formatDiagnostic + +# Function: formatDiagnostic() + +> **formatDiagnostic**(`diagnostic`, `host`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5553 + +## Parameters + +### diagnostic + +[`Diagnostic`](../interfaces/Diagnostic.md) + +### host + +[`FormatDiagnosticsHost`](../interfaces/FormatDiagnosticsHost.md) + +## Returns + +`string` diff --git a/docs/api_docs/namespaces/ts/functions/formatDiagnostics.md b/docs/api_docs/namespaces/ts/functions/formatDiagnostics.md new file mode 100644 index 0000000000000000000000000000000000000000..5959c444acb82109b50188a6bdeb83a6902d0ffd --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/formatDiagnostics.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / formatDiagnostics + +# Function: formatDiagnostics() + +> **formatDiagnostics**(`diagnostics`, `host`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5552 + +## Parameters + +### diagnostics + +readonly [`Diagnostic`](../interfaces/Diagnostic.md)[] + +### host + +[`FormatDiagnosticsHost`](../interfaces/FormatDiagnosticsHost.md) + +## Returns + +`string` diff --git a/docs/api_docs/namespaces/ts/functions/formatDiagnosticsWithColorAndContext.md b/docs/api_docs/namespaces/ts/functions/formatDiagnosticsWithColorAndContext.md new file mode 100644 index 0000000000000000000000000000000000000000..6455bbc97f7b436b82db284dfcd3324954418f15 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/formatDiagnosticsWithColorAndContext.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / formatDiagnosticsWithColorAndContext + +# Function: formatDiagnosticsWithColorAndContext() + +> **formatDiagnosticsWithColorAndContext**(`diagnostics`, `host`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5554 + +## Parameters + +### diagnostics + +readonly [`Diagnostic`](../interfaces/Diagnostic.md)[] + +### host + +[`FormatDiagnosticsHost`](../interfaces/FormatDiagnosticsHost.md) + +## Returns + +`string` diff --git a/docs/api_docs/namespaces/ts/functions/getAllDecorators.md b/docs/api_docs/namespaces/ts/functions/getAllDecorators.md new file mode 100644 index 0000000000000000000000000000000000000000..2fda6776499a21c7062ebdba6bbe5990eabfbc6a --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getAllDecorators.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getAllDecorators + +# Function: getAllDecorators() + +> **getAllDecorators**(`node`): readonly [`Decorator`](../interfaces/Decorator.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4735 + +## Parameters + +### node + +`undefined` | [`Node`](../interfaces/Node.md) + +## Returns + +readonly [`Decorator`](../interfaces/Decorator.md)[] diff --git a/docs/api_docs/namespaces/ts/functions/getAllJSDocTags.md b/docs/api_docs/namespaces/ts/functions/getAllJSDocTags.md new file mode 100644 index 0000000000000000000000000000000000000000..f77f6c1c67d5300bd69e4a62b04508b94a155bcc --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getAllJSDocTags.md @@ -0,0 +1,31 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getAllJSDocTags + +# Function: getAllJSDocTags() + +> **getAllJSDocTags**\<`T`\>(`node`, `predicate`): readonly `T`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4817 + +Gets all JSDoc tags that match a specified predicate + +## Type Parameters + +• **T** *extends* [`JSDocTag`](../interfaces/JSDocTag.md) + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +### predicate + +(`tag`) => `tag is T` + +## Returns + +readonly `T`[] diff --git a/docs/api_docs/namespaces/ts/functions/getAllJSDocTagsOfKind.md b/docs/api_docs/namespaces/ts/functions/getAllJSDocTagsOfKind.md new file mode 100644 index 0000000000000000000000000000000000000000..4844cbd5f0cefc01e1a62961d4240325078eb6cd --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getAllJSDocTagsOfKind.md @@ -0,0 +1,27 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getAllJSDocTagsOfKind + +# Function: getAllJSDocTagsOfKind() + +> **getAllJSDocTagsOfKind**(`node`, `kind`): readonly [`JSDocTag`](../interfaces/JSDocTag.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4819 + +Gets all JSDoc tags of a specified kind + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +### kind + +[`SyntaxKind`](../enumerations/SyntaxKind.md) + +## Returns + +readonly [`JSDocTag`](../interfaces/JSDocTag.md)[] diff --git a/docs/api_docs/namespaces/ts/functions/getAutomaticTypeDirectiveNames.md b/docs/api_docs/namespaces/ts/functions/getAutomaticTypeDirectiveNames.md new file mode 100644 index 0000000000000000000000000000000000000000..84f325eaffe282ae12d88a2d4afb5489e3f30cac --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getAutomaticTypeDirectiveNames.md @@ -0,0 +1,32 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getAutomaticTypeDirectiveNames + +# Function: getAutomaticTypeDirectiveNames() + +> **getAutomaticTypeDirectiveNames**(`options`, `host`): `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5361 + +Given a set of options, returns the set of type directive names + that should be included for this program automatically. +This list could either come from the config file, + or from enumerating the types root + initial secondary types lookup location. +More type directives might appear in the program later as a result of loading actual source files; + this list is only the set of defaults that are implicitly included. + +## Parameters + +### options + +[`CompilerOptions`](../interfaces/CompilerOptions.md) + +### host + +[`ModuleResolutionHost`](../interfaces/ModuleResolutionHost.md) + +## Returns + +`string`[] diff --git a/docs/api_docs/namespaces/ts/functions/getCombinedModifierFlags.md b/docs/api_docs/namespaces/ts/functions/getCombinedModifierFlags.md new file mode 100644 index 0000000000000000000000000000000000000000..5164463ca5f00f30c37fd37573876fcd4a2ec926 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getCombinedModifierFlags.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getCombinedModifierFlags + +# Function: getCombinedModifierFlags() + +> **getCombinedModifierFlags**(`node`): [`ModifierFlags`](../enumerations/ModifierFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4675 + +## Parameters + +### node + +[`Declaration`](../interfaces/Declaration.md) + +## Returns + +[`ModifierFlags`](../enumerations/ModifierFlags.md) diff --git a/docs/api_docs/namespaces/ts/functions/getCombinedNodeFlags.md b/docs/api_docs/namespaces/ts/functions/getCombinedNodeFlags.md new file mode 100644 index 0000000000000000000000000000000000000000..389937bef70a14521f3bcdfa5dfaeac6e2aede5e --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getCombinedNodeFlags.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getCombinedNodeFlags + +# Function: getCombinedNodeFlags() + +> **getCombinedNodeFlags**(`node`): [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4676 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +[`NodeFlags`](../enumerations/NodeFlags.md) diff --git a/docs/api_docs/namespaces/ts/functions/getCommentRange.md b/docs/api_docs/namespaces/ts/functions/getCommentRange.md new file mode 100644 index 0000000000000000000000000000000000000000..2d980184e98e2d9a139adcf641724a950ca6643f --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getCommentRange.md @@ -0,0 +1,23 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getCommentRange + +# Function: getCommentRange() + +> **getCommentRange**(`node`): [`TextRange`](../interfaces/TextRange.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4965 + +Gets a custom text range to use when emitting comments. + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +[`TextRange`](../interfaces/TextRange.md) diff --git a/docs/api_docs/namespaces/ts/functions/getConfigFileParsingDiagnostics.md b/docs/api_docs/namespaces/ts/functions/getConfigFileParsingDiagnostics.md new file mode 100644 index 0000000000000000000000000000000000000000..92b9760cb917b45294592b77d7adb0d53649831a --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getConfigFileParsingDiagnostics.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getConfigFileParsingDiagnostics + +# Function: getConfigFileParsingDiagnostics() + +> **getConfigFileParsingDiagnostics**(`configFileParseResult`): readonly [`Diagnostic`](../interfaces/Diagnostic.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5581 + +## Parameters + +### configFileParseResult + +[`ParsedCommandLine`](../interfaces/ParsedCommandLine.md) + +## Returns + +readonly [`Diagnostic`](../interfaces/Diagnostic.md)[] diff --git a/docs/api_docs/namespaces/ts/functions/getConstantValue.md b/docs/api_docs/namespaces/ts/functions/getConstantValue.md new file mode 100644 index 0000000000000000000000000000000000000000..391fd902359b35174e9cf4f000e959036803ffad --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getConstantValue.md @@ -0,0 +1,23 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getConstantValue + +# Function: getConstantValue() + +> **getConstantValue**(`node`): `undefined` \| `string` \| `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4980 + +Gets the constant value to emit for an expression representing an enum. + +## Parameters + +### node + +[`AccessExpression`](../type-aliases/AccessExpression.md) + +## Returns + +`undefined` \| `string` \| `number` diff --git a/docs/api_docs/namespaces/ts/functions/getDecorators.md b/docs/api_docs/namespaces/ts/functions/getDecorators.md new file mode 100644 index 0000000000000000000000000000000000000000..ef1b806d1dac319e0a7c96816cf293d5a705e04a --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getDecorators.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getDecorators + +# Function: getDecorators() + +> **getDecorators**(`node`): `undefined` \| readonly [`Decorator`](../interfaces/Decorator.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4733 + +## Parameters + +### node + +[`HasDecorators`](../type-aliases/HasDecorators.md) + +## Returns + +`undefined` \| readonly [`Decorator`](../interfaces/Decorator.md)[] diff --git a/docs/api_docs/namespaces/ts/functions/getDefaultCompilerOptions.md b/docs/api_docs/namespaces/ts/functions/getDefaultCompilerOptions.md new file mode 100644 index 0000000000000000000000000000000000000000..622e58b2cf601b32c9f0dbeb9f1168270459acb9 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getDefaultCompilerOptions.md @@ -0,0 +1,15 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getDefaultCompilerOptions + +# Function: getDefaultCompilerOptions() + +> **getDefaultCompilerOptions**(): [`CompilerOptions`](../interfaces/CompilerOptions.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7435 + +## Returns + +[`CompilerOptions`](../interfaces/CompilerOptions.md) diff --git a/docs/api_docs/namespaces/ts/functions/getDefaultFormatCodeSettings.md b/docs/api_docs/namespaces/ts/functions/getDefaultFormatCodeSettings.md new file mode 100644 index 0000000000000000000000000000000000000000..e0523c04cc2c2ffee9c9d66688b53a278c3228d7 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getDefaultFormatCodeSettings.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getDefaultFormatCodeSettings + +# Function: getDefaultFormatCodeSettings() + +> **getDefaultFormatCodeSettings**(`newLineCharacter`?): [`FormatCodeSettings`](../interfaces/FormatCodeSettings.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6820 + +## Parameters + +### newLineCharacter? + +`string` + +## Returns + +[`FormatCodeSettings`](../interfaces/FormatCodeSettings.md) diff --git a/docs/api_docs/namespaces/ts/functions/getDefaultLibFileName.md b/docs/api_docs/namespaces/ts/functions/getDefaultLibFileName.md new file mode 100644 index 0000000000000000000000000000000000000000..ba67aa6a8ad2f0626bae5bc011d0459f74afaf1f --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getDefaultLibFileName.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getDefaultLibFileName + +# Function: getDefaultLibFileName() + +> **getDefaultLibFileName**(`options`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4639 + +## Parameters + +### options + +[`CompilerOptions`](../interfaces/CompilerOptions.md) + +## Returns + +`string` diff --git a/docs/api_docs/namespaces/ts/functions/getDefaultLibFilePath.md b/docs/api_docs/namespaces/ts/functions/getDefaultLibFilePath.md new file mode 100644 index 0000000000000000000000000000000000000000..f7af07bebd34d4226272ef1c501c4c6866ffe2ea --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getDefaultLibFilePath.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getDefaultLibFilePath + +# Function: getDefaultLibFilePath() + +> **getDefaultLibFilePath**(`options`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7445 + +Get the path of the default library files (lib.d.ts) as distributed with the typescript +node package. +The functionality is not supported if the ts module is consumed outside of a node module. + +## Parameters + +### options + +[`CompilerOptions`](../interfaces/CompilerOptions.md) + +## Returns + +`string` diff --git a/docs/api_docs/namespaces/ts/functions/getEffectiveConstraintOfTypeParameter.md b/docs/api_docs/namespaces/ts/functions/getEffectiveConstraintOfTypeParameter.md new file mode 100644 index 0000000000000000000000000000000000000000..6a87fd39942bdb7fa16b042b1affc058e96b5616 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getEffectiveConstraintOfTypeParameter.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getEffectiveConstraintOfTypeParameter + +# Function: getEffectiveConstraintOfTypeParameter() + +> **getEffectiveConstraintOfTypeParameter**(`node`): `undefined` \| [`TypeNode`](../interfaces/TypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4833 + +## Parameters + +### node + +[`TypeParameterDeclaration`](../interfaces/TypeParameterDeclaration.md) + +## Returns + +`undefined` \| [`TypeNode`](../interfaces/TypeNode.md) diff --git a/docs/api_docs/namespaces/ts/functions/getEffectiveTypeParameterDeclarations.md b/docs/api_docs/namespaces/ts/functions/getEffectiveTypeParameterDeclarations.md new file mode 100644 index 0000000000000000000000000000000000000000..de46b3db1d317275b4e62131f526076f789fe29c --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getEffectiveTypeParameterDeclarations.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getEffectiveTypeParameterDeclarations + +# Function: getEffectiveTypeParameterDeclarations() + +> **getEffectiveTypeParameterDeclarations**(`node`): readonly [`TypeParameterDeclaration`](../interfaces/TypeParameterDeclaration.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4832 + +Gets the effective type parameters. If the node was parsed in a +JavaScript file, gets the type parameters from the `@template` tag from JSDoc. + +This does *not* return type parameters from a jsdoc reference to a generic type, eg + +type Id = (x: T) => T +/** + +## Parameters + +### node + +[`DeclarationWithTypeParameters`](../type-aliases/DeclarationWithTypeParameters.md) + +## Returns + +readonly [`TypeParameterDeclaration`](../interfaces/TypeParameterDeclaration.md)[] diff --git a/docs/api_docs/namespaces/ts/functions/getEffectiveTypeRoots.md b/docs/api_docs/namespaces/ts/functions/getEffectiveTypeRoots.md new file mode 100644 index 0000000000000000000000000000000000000000..7032a75382081d25ec3f27a640d81301cf9d63da --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getEffectiveTypeRoots.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getEffectiveTypeRoots + +# Function: getEffectiveTypeRoots() + +> **getEffectiveTypeRoots**(`options`, `host`): `undefined` \| `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5346 + +## Parameters + +### options + +[`CompilerOptions`](../interfaces/CompilerOptions.md) + +### host + +[`GetEffectiveTypeRootsHost`](../interfaces/GetEffectiveTypeRootsHost.md) + +## Returns + +`undefined` \| `string`[] diff --git a/docs/api_docs/namespaces/ts/functions/getEmitHelpers.md b/docs/api_docs/namespaces/ts/functions/getEmitHelpers.md new file mode 100644 index 0000000000000000000000000000000000000000..22819f717295020403be6709ab6e16fde3d88a4f --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getEmitHelpers.md @@ -0,0 +1,23 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getEmitHelpers + +# Function: getEmitHelpers() + +> **getEmitHelpers**(`node`): `undefined` \| [`EmitHelper`](../type-aliases/EmitHelper.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5000 + +Gets the EmitHelpers of a node. + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`undefined` \| [`EmitHelper`](../type-aliases/EmitHelper.md)[] diff --git a/docs/api_docs/namespaces/ts/functions/getGeneratedNameForNode.md b/docs/api_docs/namespaces/ts/functions/getGeneratedNameForNode.md new file mode 100644 index 0000000000000000000000000000000000000000..d64da45fd3a7da874115f160371e749e78657aaf --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getGeneratedNameForNode.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getGeneratedNameForNode + +# Function: ~~getGeneratedNameForNode()~~ + +> **getGeneratedNameForNode**(`node`): [`Identifier`](../interfaces/Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8191 + +## Parameters + +### node + +`undefined` | [`Node`](../interfaces/Node.md) + +## Returns + +[`Identifier`](../interfaces/Identifier.md) + +## Deprecated + +Use `factory.getGeneratedNameForNode` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/getIllegalDecorators.md b/docs/api_docs/namespaces/ts/functions/getIllegalDecorators.md new file mode 100644 index 0000000000000000000000000000000000000000..6dae3ccf9ead7b46a1ec11b5df5dc400efe38312 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getIllegalDecorators.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getIllegalDecorators + +# Function: getIllegalDecorators() + +> **getIllegalDecorators**(`node`): `undefined` \| readonly [`Decorator`](../interfaces/Decorator.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4736 + +## Parameters + +### node + +[`HasIllegalDecorators`](../type-aliases/HasIllegalDecorators.md) + +## Returns + +`undefined` \| readonly [`Decorator`](../interfaces/Decorator.md)[] diff --git a/docs/api_docs/namespaces/ts/functions/getImpliedNodeFormatForFile.md b/docs/api_docs/namespaces/ts/functions/getImpliedNodeFormatForFile.md new file mode 100644 index 0000000000000000000000000000000000000000..b16cacb54a5b65ef90c2238d49992e049684406d --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getImpliedNodeFormatForFile.md @@ -0,0 +1,46 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getImpliedNodeFormatForFile + +# Function: getImpliedNodeFormatForFile() + +> **getImpliedNodeFormatForFile**(`fileName`, `packageJsonInfoCache`?, `host`?, `options`?): `undefined` \| [`CommonJS`](../enumerations/ModuleKind.md#commonjs) \| [`ESNext`](../enumerations/ModuleKind.md#esnext) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5592 + +A function for determining if a given file is esm or cjs format, assuming modern node module resolution rules, as configured by the +`options` parameter. + +## Parameters + +### fileName + +[`Path`](../type-aliases/Path.md) + +The normalized absolute path to check the format of (it need not exist on disk) + +### packageJsonInfoCache? + +[`PackageJsonInfoCache`](../interfaces/PackageJsonInfoCache.md) + +A cache for package file lookups - it's best to have a cache when this function is called often + +### host? + +[`ModuleResolutionHost`](../interfaces/ModuleResolutionHost.md) + +The ModuleResolutionHost which can perform the filesystem lookups for package json data + +### options? + +[`CompilerOptions`](../interfaces/CompilerOptions.md) + +The compiler options to perform the analysis under - relevant options are `moduleResolution` and `traceResolution` + +## Returns + +`undefined` \| [`CommonJS`](../enumerations/ModuleKind.md#commonjs) \| [`ESNext`](../enumerations/ModuleKind.md#esnext) + +`undefined` if the path has no relevant implied format, `ModuleKind.ESNext` for esm format, and `ModuleKind.CommonJS` for cjs format diff --git a/docs/api_docs/namespaces/ts/functions/getJSDocAugmentsTag.md b/docs/api_docs/namespaces/ts/functions/getJSDocAugmentsTag.md new file mode 100644 index 0000000000000000000000000000000000000000..8f9ea638d91acc2cfe10d6d5d2eef8bd7dea5499 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getJSDocAugmentsTag.md @@ -0,0 +1,23 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getJSDocAugmentsTag + +# Function: getJSDocAugmentsTag() + +> **getJSDocAugmentsTag**(`node`): `undefined` \| [`JSDocAugmentsTag`](../interfaces/JSDocAugmentsTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4769 + +Gets the JSDoc augments tag for the node if present + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`undefined` \| [`JSDocAugmentsTag`](../interfaces/JSDocAugmentsTag.md) diff --git a/docs/api_docs/namespaces/ts/functions/getJSDocClassTag.md b/docs/api_docs/namespaces/ts/functions/getJSDocClassTag.md new file mode 100644 index 0000000000000000000000000000000000000000..d3eb2a7fca6e2685d7443ae935c9f3ae1df264d0 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getJSDocClassTag.md @@ -0,0 +1,23 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getJSDocClassTag + +# Function: getJSDocClassTag() + +> **getJSDocClassTag**(`node`): `undefined` \| [`JSDocClassTag`](../interfaces/JSDocClassTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4773 + +Gets the JSDoc class tag for the node if present + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`undefined` \| [`JSDocClassTag`](../interfaces/JSDocClassTag.md) diff --git a/docs/api_docs/namespaces/ts/functions/getJSDocDeprecatedTag.md b/docs/api_docs/namespaces/ts/functions/getJSDocDeprecatedTag.md new file mode 100644 index 0000000000000000000000000000000000000000..7a3623907adbf5aa78e3be33bf90b5a6ad3c855e --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getJSDocDeprecatedTag.md @@ -0,0 +1,23 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getJSDocDeprecatedTag + +# Function: getJSDocDeprecatedTag() + +> **getJSDocDeprecatedTag**(`node`): `undefined` \| [`JSDocDeprecatedTag`](../interfaces/JSDocDeprecatedTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4784 + +Gets the JSDoc deprecated tag for the node if present + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`undefined` \| [`JSDocDeprecatedTag`](../interfaces/JSDocDeprecatedTag.md) diff --git a/docs/api_docs/namespaces/ts/functions/getJSDocEnumTag.md b/docs/api_docs/namespaces/ts/functions/getJSDocEnumTag.md new file mode 100644 index 0000000000000000000000000000000000000000..0b0dc2a8c2fbc098e51d4ebe02c1b3d203fca33b --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getJSDocEnumTag.md @@ -0,0 +1,23 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getJSDocEnumTag + +# Function: getJSDocEnumTag() + +> **getJSDocEnumTag**(`node`): `undefined` \| [`JSDocEnumTag`](../interfaces/JSDocEnumTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4786 + +Gets the JSDoc enum tag for the node if present + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`undefined` \| [`JSDocEnumTag`](../interfaces/JSDocEnumTag.md) diff --git a/docs/api_docs/namespaces/ts/functions/getJSDocImplementsTags.md b/docs/api_docs/namespaces/ts/functions/getJSDocImplementsTags.md new file mode 100644 index 0000000000000000000000000000000000000000..bcf75dd00ce6a259c63fd00d60e4a6554063d916 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getJSDocImplementsTags.md @@ -0,0 +1,23 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getJSDocImplementsTags + +# Function: getJSDocImplementsTags() + +> **getJSDocImplementsTags**(`node`): readonly [`JSDocImplementsTag`](../interfaces/JSDocImplementsTag.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4771 + +Gets the JSDoc implements tags for the node if present + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +readonly [`JSDocImplementsTag`](../interfaces/JSDocImplementsTag.md)[] diff --git a/docs/api_docs/namespaces/ts/functions/getJSDocOverrideTagNoCache.md b/docs/api_docs/namespaces/ts/functions/getJSDocOverrideTagNoCache.md new file mode 100644 index 0000000000000000000000000000000000000000..46ea570b4ec320e0880e5c0623369d5550360276 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getJSDocOverrideTagNoCache.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getJSDocOverrideTagNoCache + +# Function: getJSDocOverrideTagNoCache() + +> **getJSDocOverrideTagNoCache**(`node`): `undefined` \| [`JSDocOverrideTag`](../interfaces/JSDocOverrideTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4782 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`undefined` \| [`JSDocOverrideTag`](../interfaces/JSDocOverrideTag.md) diff --git a/docs/api_docs/namespaces/ts/functions/getJSDocParameterTags.md b/docs/api_docs/namespaces/ts/functions/getJSDocParameterTags.md new file mode 100644 index 0000000000000000000000000000000000000000..5ac95f7c250d1ae24b3690f6b4adb5b66f3162de --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getJSDocParameterTags.md @@ -0,0 +1,34 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getJSDocParameterTags + +# Function: getJSDocParameterTags() + +> **getJSDocParameterTags**(`param`): readonly [`JSDocParameterTag`](../interfaces/JSDocParameterTag.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4749 + +Gets the JSDoc parameter tags for the node if present. + +## Parameters + +### param + +[`ParameterDeclaration`](../interfaces/ParameterDeclaration.md) + +## Returns + +readonly [`JSDocParameterTag`](../interfaces/JSDocParameterTag.md)[] + +## Remarks + +Returns any JSDoc param tag whose name matches the provided +parameter, whether a param tag on a containing function +expression, or a param tag on a variable declaration whose +initializer is the containing function. The tags closest to the +node are returned first, so in the previous example, the param +tag on the containing function expression would be first. + +For binding patterns, parameter tags are matched by position. diff --git a/docs/api_docs/namespaces/ts/functions/getJSDocPrivateTag.md b/docs/api_docs/namespaces/ts/functions/getJSDocPrivateTag.md new file mode 100644 index 0000000000000000000000000000000000000000..60ffbd9660ef7ed0bfb6edb6102c1d7964c82c5b --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getJSDocPrivateTag.md @@ -0,0 +1,23 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getJSDocPrivateTag + +# Function: getJSDocPrivateTag() + +> **getJSDocPrivateTag**(`node`): `undefined` \| [`JSDocPrivateTag`](../interfaces/JSDocPrivateTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4777 + +Gets the JSDoc private tag for the node if present + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`undefined` \| [`JSDocPrivateTag`](../interfaces/JSDocPrivateTag.md) diff --git a/docs/api_docs/namespaces/ts/functions/getJSDocProtectedTag.md b/docs/api_docs/namespaces/ts/functions/getJSDocProtectedTag.md new file mode 100644 index 0000000000000000000000000000000000000000..d825b990841801901a0e3d7c58ef20db4ef666e9 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getJSDocProtectedTag.md @@ -0,0 +1,23 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getJSDocProtectedTag + +# Function: getJSDocProtectedTag() + +> **getJSDocProtectedTag**(`node`): `undefined` \| [`JSDocProtectedTag`](../interfaces/JSDocProtectedTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4779 + +Gets the JSDoc protected tag for the node if present + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`undefined` \| [`JSDocProtectedTag`](../interfaces/JSDocProtectedTag.md) diff --git a/docs/api_docs/namespaces/ts/functions/getJSDocPublicTag.md b/docs/api_docs/namespaces/ts/functions/getJSDocPublicTag.md new file mode 100644 index 0000000000000000000000000000000000000000..3003ac2450fcfaf0c93e772bc4cc32991c87c0a9 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getJSDocPublicTag.md @@ -0,0 +1,23 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getJSDocPublicTag + +# Function: getJSDocPublicTag() + +> **getJSDocPublicTag**(`node`): `undefined` \| [`JSDocPublicTag`](../interfaces/JSDocPublicTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4775 + +Gets the JSDoc public tag for the node if present + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`undefined` \| [`JSDocPublicTag`](../interfaces/JSDocPublicTag.md) diff --git a/docs/api_docs/namespaces/ts/functions/getJSDocReadonlyTag.md b/docs/api_docs/namespaces/ts/functions/getJSDocReadonlyTag.md new file mode 100644 index 0000000000000000000000000000000000000000..a46337cdb29f8e9fffb6d592e00e0caf6c9402fe --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getJSDocReadonlyTag.md @@ -0,0 +1,23 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getJSDocReadonlyTag + +# Function: getJSDocReadonlyTag() + +> **getJSDocReadonlyTag**(`node`): `undefined` \| [`JSDocReadonlyTag`](../interfaces/JSDocReadonlyTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4781 + +Gets the JSDoc protected tag for the node if present + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`undefined` \| [`JSDocReadonlyTag`](../interfaces/JSDocReadonlyTag.md) diff --git a/docs/api_docs/namespaces/ts/functions/getJSDocReturnTag.md b/docs/api_docs/namespaces/ts/functions/getJSDocReturnTag.md new file mode 100644 index 0000000000000000000000000000000000000000..03fce4281eab4637f8cf24858ab708b10afe03a4 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getJSDocReturnTag.md @@ -0,0 +1,23 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getJSDocReturnTag + +# Function: getJSDocReturnTag() + +> **getJSDocReturnTag**(`node`): `undefined` \| [`JSDocReturnTag`](../interfaces/JSDocReturnTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4790 + +Gets the JSDoc return tag for the node if present + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`undefined` \| [`JSDocReturnTag`](../interfaces/JSDocReturnTag.md) diff --git a/docs/api_docs/namespaces/ts/functions/getJSDocReturnType.md b/docs/api_docs/namespaces/ts/functions/getJSDocReturnType.md new file mode 100644 index 0000000000000000000000000000000000000000..c07b5975eb72a3b5e254b9a4f4119d5b5e414580 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getJSDocReturnType.md @@ -0,0 +1,28 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getJSDocReturnType + +# Function: getJSDocReturnType() + +> **getJSDocReturnType**(`node`): `undefined` \| [`TypeNode`](../interfaces/TypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4813 + +Gets the return type node for the node if provided via JSDoc return tag or type tag. + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`undefined` \| [`TypeNode`](../interfaces/TypeNode.md) + +## Remarks + +`getJSDocReturnTag` just gets the whole JSDoc tag. This function +gets the type from inside the braces, after the fat arrow, etc. diff --git a/docs/api_docs/namespaces/ts/functions/getJSDocTags.md b/docs/api_docs/namespaces/ts/functions/getJSDocTags.md new file mode 100644 index 0000000000000000000000000000000000000000..1874f75765a08d05357c6368f7008bdb9e56687f --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getJSDocTags.md @@ -0,0 +1,23 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getJSDocTags + +# Function: getJSDocTags() + +> **getJSDocTags**(`node`): readonly [`JSDocTag`](../interfaces/JSDocTag.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4815 + +Get all JSDoc tags related to a node, including those on parent nodes. + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +readonly [`JSDocTag`](../interfaces/JSDocTag.md)[] diff --git a/docs/api_docs/namespaces/ts/functions/getJSDocTemplateTag.md b/docs/api_docs/namespaces/ts/functions/getJSDocTemplateTag.md new file mode 100644 index 0000000000000000000000000000000000000000..fab8714e15beb2276dfdb21536247b5c4360d2a6 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getJSDocTemplateTag.md @@ -0,0 +1,23 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getJSDocTemplateTag + +# Function: getJSDocTemplateTag() + +> **getJSDocTemplateTag**(`node`): `undefined` \| [`JSDocTemplateTag`](../interfaces/JSDocTemplateTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4792 + +Gets the JSDoc template tag for the node if present + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`undefined` \| [`JSDocTemplateTag`](../interfaces/JSDocTemplateTag.md) diff --git a/docs/api_docs/namespaces/ts/functions/getJSDocThisTag.md b/docs/api_docs/namespaces/ts/functions/getJSDocThisTag.md new file mode 100644 index 0000000000000000000000000000000000000000..23fe04627046b2d45de438cf4fd4680e45cf89fe --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getJSDocThisTag.md @@ -0,0 +1,23 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getJSDocThisTag + +# Function: getJSDocThisTag() + +> **getJSDocThisTag**(`node`): `undefined` \| [`JSDocThisTag`](../interfaces/JSDocThisTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4788 + +Gets the JSDoc this tag for the node if present + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`undefined` \| [`JSDocThisTag`](../interfaces/JSDocThisTag.md) diff --git a/docs/api_docs/namespaces/ts/functions/getJSDocType.md b/docs/api_docs/namespaces/ts/functions/getJSDocType.md new file mode 100644 index 0000000000000000000000000000000000000000..1587e4efeb0f347a4d2bca7e8b8ae504cc03f833 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getJSDocType.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getJSDocType + +# Function: getJSDocType() + +> **getJSDocType**(`node`): `undefined` \| [`TypeNode`](../interfaces/TypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4806 + +Gets the type node for the node if provided via JSDoc. + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`undefined` \| [`TypeNode`](../interfaces/TypeNode.md) + +## Remarks + +The search includes any JSDoc param tag that relates +to the provided parameter, for example a type tag on the +parameter itself, or a param tag on a containing function +expression, or a param tag on a variable declaration whose +initializer is the containing function. The tags closest to the +node are examined first, so in the previous example, the type +tag directly on the node would be returned. diff --git a/docs/api_docs/namespaces/ts/functions/getJSDocTypeParameterTags.md b/docs/api_docs/namespaces/ts/functions/getJSDocTypeParameterTags.md new file mode 100644 index 0000000000000000000000000000000000000000..a4b0bac5b96a68d4f4d4fe095dcc97e64991019d --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getJSDocTypeParameterTags.md @@ -0,0 +1,32 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getJSDocTypeParameterTags + +# Function: getJSDocTypeParameterTags() + +> **getJSDocTypeParameterTags**(`param`): readonly [`JSDocTemplateTag`](../interfaces/JSDocTemplateTag.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4760 + +Gets the JSDoc type parameter tags for the node if present. + +## Parameters + +### param + +[`TypeParameterDeclaration`](../interfaces/TypeParameterDeclaration.md) + +## Returns + +readonly [`JSDocTemplateTag`](../interfaces/JSDocTemplateTag.md)[] + +## Remarks + +Returns any JSDoc template tag whose names match the provided +parameter, whether a template tag on a containing function +expression, or a template tag on a variable declaration whose +initializer is the containing function. The tags closest to the +node are returned first, so in the previous example, the template +tag on the containing function expression would be first. diff --git a/docs/api_docs/namespaces/ts/functions/getJSDocTypeTag.md b/docs/api_docs/namespaces/ts/functions/getJSDocTypeTag.md new file mode 100644 index 0000000000000000000000000000000000000000..1ca1884ced98c6fc3638ce0dcc9c9a8d30611e58 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getJSDocTypeTag.md @@ -0,0 +1,23 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getJSDocTypeTag + +# Function: getJSDocTypeTag() + +> **getJSDocTypeTag**(`node`): `undefined` \| [`JSDocTypeTag`](../interfaces/JSDocTypeTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4794 + +Gets the JSDoc type tag for the node if present and valid + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`undefined` \| [`JSDocTypeTag`](../interfaces/JSDocTypeTag.md) diff --git a/docs/api_docs/namespaces/ts/functions/getLeadingCommentRanges.md b/docs/api_docs/namespaces/ts/functions/getLeadingCommentRanges.md new file mode 100644 index 0000000000000000000000000000000000000000..92c41e00cb27ecb6c9e0b03a4d5cc5d2900e7cbe --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getLeadingCommentRanges.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getLeadingCommentRanges + +# Function: getLeadingCommentRanges() + +> **getLeadingCommentRanges**(`text`, `pos`): `undefined` \| [`CommentRange`](../interfaces/CommentRange.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4628 + +## Parameters + +### text + +`string` + +### pos + +`number` + +## Returns + +`undefined` \| [`CommentRange`](../interfaces/CommentRange.md)[] diff --git a/docs/api_docs/namespaces/ts/functions/getLeadingCommentRangesOfNode.md b/docs/api_docs/namespaces/ts/functions/getLeadingCommentRangesOfNode.md new file mode 100644 index 0000000000000000000000000000000000000000..b259e9d3b2b48dd3e565f84c2275a301d03d6d4f --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getLeadingCommentRangesOfNode.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getLeadingCommentRangesOfNode + +# Function: getLeadingCommentRangesOfNode() + +> **getLeadingCommentRangesOfNode**(`node`, `sourceFileOfNode`): `undefined` \| [`CommentRange`](../interfaces/CommentRange.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4911 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +### sourceFileOfNode + +[`SourceFile`](../interfaces/SourceFile.md) + +## Returns + +`undefined` \| [`CommentRange`](../interfaces/CommentRange.md)[] diff --git a/docs/api_docs/namespaces/ts/functions/getLineAndCharacterOfPosition.md b/docs/api_docs/namespaces/ts/functions/getLineAndCharacterOfPosition.md new file mode 100644 index 0000000000000000000000000000000000000000..b255a8d35c619637aff98ba9956fa9c27e183014 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getLineAndCharacterOfPosition.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getLineAndCharacterOfPosition + +# Function: getLineAndCharacterOfPosition() + +> **getLineAndCharacterOfPosition**(`sourceFile`, `position`): [`LineAndCharacter`](../interfaces/LineAndCharacter.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4616 + +## Parameters + +### sourceFile + +[`SourceFileLike`](../interfaces/SourceFileLike.md) + +### position + +`number` + +## Returns + +[`LineAndCharacter`](../interfaces/LineAndCharacter.md) diff --git a/docs/api_docs/namespaces/ts/functions/getModeForFileReference.md b/docs/api_docs/namespaces/ts/functions/getModeForFileReference.md new file mode 100644 index 0000000000000000000000000000000000000000..490014c6344887f157d5e260ecae41be8b2d09c3 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getModeForFileReference.md @@ -0,0 +1,28 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getModeForFileReference + +# Function: getModeForFileReference() + +> **getModeForFileReference**(`ref`, `containingFileMode`): `undefined` \| [`CommonJS`](../enumerations/ModuleKind.md#commonjs) \| [`ESNext`](../enumerations/ModuleKind.md#esnext) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5560 + +Calculates the resulting resolution mode for some reference in some file - this is generally the explicitly +provided resolution mode in the reference, unless one is not present, in which case it is the mode of the containing file. + +## Parameters + +### ref + +`string` | [`FileReference`](../interfaces/FileReference.md) + +### containingFileMode + +`undefined` | [`CommonJS`](../enumerations/ModuleKind.md#commonjs) | [`ESNext`](../enumerations/ModuleKind.md#esnext) + +## Returns + +`undefined` \| [`CommonJS`](../enumerations/ModuleKind.md#commonjs) \| [`ESNext`](../enumerations/ModuleKind.md#esnext) diff --git a/docs/api_docs/namespaces/ts/functions/getModeForResolutionAtIndex.md b/docs/api_docs/namespaces/ts/functions/getModeForResolutionAtIndex.md new file mode 100644 index 0000000000000000000000000000000000000000..652608c8a9ae87aaab2d80cf2bc1b20517fd2bf6 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getModeForResolutionAtIndex.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getModeForResolutionAtIndex + +# Function: getModeForResolutionAtIndex() + +> **getModeForResolutionAtIndex**(`file`, `index`): `undefined` \| [`CommonJS`](../enumerations/ModuleKind.md#commonjs) \| [`ESNext`](../enumerations/ModuleKind.md#esnext) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5568 + +Calculates the final resolution mode for an import at some index within a file's imports list. This is generally the explicitly +defined mode of the import if provided, or, if not, the mode of the containing file (with some exceptions: import=require is always commonjs, dynamic import is always esm). +If you have an actual import node, prefer using getModeForUsageLocation on the reference string node. + +## Parameters + +### file + +[`SourceFile`](../interfaces/SourceFile.md) + +File to fetch the resolution mode within + +### index + +`number` + +Index into the file's complete resolution list to get the resolution of - this is a concatenation of the file's imports and module augmentations + +## Returns + +`undefined` \| [`CommonJS`](../enumerations/ModuleKind.md#commonjs) \| [`ESNext`](../enumerations/ModuleKind.md#esnext) diff --git a/docs/api_docs/namespaces/ts/functions/getModeForUsageLocation.md b/docs/api_docs/namespaces/ts/functions/getModeForUsageLocation.md new file mode 100644 index 0000000000000000000000000000000000000000..aa4c00822001dd078d57300dead451914a4600a4 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getModeForUsageLocation.md @@ -0,0 +1,38 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getModeForUsageLocation + +# Function: getModeForUsageLocation() + +> **getModeForUsageLocation**(`file`, `usage`): `undefined` \| [`CommonJS`](../enumerations/ModuleKind.md#commonjs) \| [`ESNext`](../enumerations/ModuleKind.md#esnext) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5578 + +Calculates the final resolution mode for a given module reference node. This is generally the explicitly provided resolution mode, if +one exists, or the mode of the containing source file. (Excepting import=require, which is always commonjs, and dynamic import, which is always esm). +Notably, this function always returns `undefined` if the containing file has an `undefined` `impliedNodeFormat` - this field is only set when +`moduleResolution` is `node16`+. + +## Parameters + +### file + +The file the import or import-like reference is contained within + +#### impliedNodeFormat? + +[`CommonJS`](../enumerations/ModuleKind.md#commonjs) \| [`ESNext`](../enumerations/ModuleKind.md#esnext) + +### usage + +[`StringLiteralLike`](../type-aliases/StringLiteralLike.md) + +The module reference string + +## Returns + +`undefined` \| [`CommonJS`](../enumerations/ModuleKind.md#commonjs) \| [`ESNext`](../enumerations/ModuleKind.md#esnext) + +The final resolution mode of the import diff --git a/docs/api_docs/namespaces/ts/functions/getModifiers.md b/docs/api_docs/namespaces/ts/functions/getModifiers.md new file mode 100644 index 0000000000000000000000000000000000000000..877d054348be1bdbff6f73114e1557603d998b15 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getModifiers.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getModifiers + +# Function: getModifiers() + +> **getModifiers**(`node`): `undefined` \| readonly [`Modifier`](../type-aliases/Modifier.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4734 + +## Parameters + +### node + +[`HasModifiers`](../type-aliases/HasModifiers.md) + +## Returns + +`undefined` \| readonly [`Modifier`](../type-aliases/Modifier.md)[] diff --git a/docs/api_docs/namespaces/ts/functions/getModuleByPMType.md b/docs/api_docs/namespaces/ts/functions/getModuleByPMType.md new file mode 100644 index 0000000000000000000000000000000000000000..cb1994bbb6c3c98a1476c412afce9a1378dc09e7 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getModuleByPMType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getModuleByPMType + +# Function: getModuleByPMType() + +> **getModuleByPMType**(`packageManagerType`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5429 + +## Parameters + +### packageManagerType + +`undefined` | `string` + +## Returns + +`string` diff --git a/docs/api_docs/namespaces/ts/functions/getModulePathPartByPMType.md b/docs/api_docs/namespaces/ts/functions/getModulePathPartByPMType.md new file mode 100644 index 0000000000000000000000000000000000000000..f8a850163508a1c41eaf49c8dddd982edb04033f --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getModulePathPartByPMType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getModulePathPartByPMType + +# Function: getModulePathPartByPMType() + +> **getModulePathPartByPMType**(`packageManagerType`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5428 + +## Parameters + +### packageManagerType + +`undefined` | `string` + +## Returns + +`string` diff --git a/docs/api_docs/namespaces/ts/functions/getMutableClone.md b/docs/api_docs/namespaces/ts/functions/getMutableClone.md new file mode 100644 index 0000000000000000000000000000000000000000..2333321c9200e300f98acc3738485a895de52c7c --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getMutableClone.md @@ -0,0 +1,34 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getMutableClone + +# Function: ~~getMutableClone()~~ + +> **getMutableClone**\<`T`\>(`node`): `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8314 + +Creates a shallow, memberwise clone of a node ~for mutation~ with its `pos`, `end`, and `parent` set. + +NOTE: It is unsafe to change any properties of a `Node` that relate to its AST children, as those changes won't be +captured with respect to transformations. + +## Type Parameters + +• **T** *extends* [`Node`](../interfaces/Node.md) + +## Parameters + +### node + +`T` + +## Returns + +`T` + +## Deprecated + +Use an appropriate `factory.update...` method instead, use `setCommentRange` or `setSourceMapRange`, and avoid setting `parent`. diff --git a/docs/api_docs/namespaces/ts/functions/getNameOfDeclaration.md b/docs/api_docs/namespaces/ts/functions/getNameOfDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..d3512206d9830e14102c354d741cd84a7345ff16 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getNameOfDeclaration.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getNameOfDeclaration + +# Function: getNameOfDeclaration() + +> **getNameOfDeclaration**(`declaration`): `undefined` \| [`DeclarationName`](../type-aliases/DeclarationName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4732 + +## Parameters + +### declaration + +`undefined` | [`Declaration`](../interfaces/Declaration.md) | [`Expression`](../interfaces/Expression.md) + +## Returns + +`undefined` \| [`DeclarationName`](../type-aliases/DeclarationName.md) diff --git a/docs/api_docs/namespaces/ts/functions/getNameOfJSDocTypedef.md b/docs/api_docs/namespaces/ts/functions/getNameOfJSDocTypedef.md new file mode 100644 index 0000000000000000000000000000000000000000..6a4ce303b65bda3bef9b887f1cb0a496c5f74ec4 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getNameOfJSDocTypedef.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getNameOfJSDocTypedef + +# Function: getNameOfJSDocTypedef() + +> **getNameOfJSDocTypedef**(`declaration`): `undefined` \| [`Identifier`](../interfaces/Identifier.md) \| [`PrivateIdentifier`](../interfaces/PrivateIdentifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4731 + +## Parameters + +### declaration + +[`JSDocTypedefTag`](../interfaces/JSDocTypedefTag.md) + +## Returns + +`undefined` \| [`Identifier`](../interfaces/Identifier.md) \| [`PrivateIdentifier`](../interfaces/PrivateIdentifier.md) diff --git a/docs/api_docs/namespaces/ts/functions/getNodeMajorVersion.md b/docs/api_docs/namespaces/ts/functions/getNodeMajorVersion.md new file mode 100644 index 0000000000000000000000000000000000000000..3fb599e9891ad3885a54d501fac791b91c3714ca --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getNodeMajorVersion.md @@ -0,0 +1,15 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getNodeMajorVersion + +# Function: getNodeMajorVersion() + +> **getNodeMajorVersion**(): `undefined` \| `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4568 + +## Returns + +`undefined` \| `number` diff --git a/docs/api_docs/namespaces/ts/functions/getOriginalNode.md b/docs/api_docs/namespaces/ts/functions/getOriginalNode.md new file mode 100644 index 0000000000000000000000000000000000000000..9658f808867d272c9cdf7684670ce2b7b7d9a577 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getOriginalNode.md @@ -0,0 +1,87 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getOriginalNode + +# Function: getOriginalNode() + +## Call Signature + +> **getOriginalNode**(`node`): [`Node`](../interfaces/Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4687 + +### Parameters + +#### node + +[`Node`](../interfaces/Node.md) + +### Returns + +[`Node`](../interfaces/Node.md) + +## Call Signature + +> **getOriginalNode**\<`T`\>(`node`, `nodeTest`): `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4688 + +### Type Parameters + +• **T** *extends* [`Node`](../interfaces/Node.md) + +### Parameters + +#### node + +[`Node`](../interfaces/Node.md) + +#### nodeTest + +(`node`) => `node is T` + +### Returns + +`T` + +## Call Signature + +> **getOriginalNode**(`node`): `undefined` \| [`Node`](../interfaces/Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4689 + +### Parameters + +#### node + +`undefined` | [`Node`](../interfaces/Node.md) + +### Returns + +`undefined` \| [`Node`](../interfaces/Node.md) + +## Call Signature + +> **getOriginalNode**\<`T`\>(`node`, `nodeTest`): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4690 + +### Type Parameters + +• **T** *extends* [`Node`](../interfaces/Node.md) + +### Parameters + +#### node + +`undefined` | [`Node`](../interfaces/Node.md) + +#### nodeTest + +(`node`) => `node is T` + +### Returns + +`undefined` \| `T` diff --git a/docs/api_docs/namespaces/ts/functions/getOutputFileNames.md b/docs/api_docs/namespaces/ts/functions/getOutputFileNames.md new file mode 100644 index 0000000000000000000000000000000000000000..bb970cae0fd518cad2e95c7e4747554e1d2d0bd1 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getOutputFileNames.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getOutputFileNames + +# Function: getOutputFileNames() + +> **getOutputFileNames**(`commandLine`, `inputFileName`, `ignoreCase`): readonly `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5539 + +## Parameters + +### commandLine + +[`ParsedCommandLine`](../interfaces/ParsedCommandLine.md) + +### inputFileName + +`string` + +### ignoreCase + +`boolean` + +## Returns + +readonly `string`[] diff --git a/docs/api_docs/namespaces/ts/functions/getPackageJsonByPMType.md b/docs/api_docs/namespaces/ts/functions/getPackageJsonByPMType.md new file mode 100644 index 0000000000000000000000000000000000000000..077edd4e2e13ca0f047144759b680b5276105081 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getPackageJsonByPMType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getPackageJsonByPMType + +# Function: getPackageJsonByPMType() + +> **getPackageJsonByPMType**(`packageManagerType`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5430 + +## Parameters + +### packageManagerType + +`undefined` | `string` + +## Returns + +`string` diff --git a/docs/api_docs/namespaces/ts/functions/getParseTreeNode.md b/docs/api_docs/namespaces/ts/functions/getParseTreeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..e593675aeb77ca5f4fd713eebc34b8d1356e5ec8 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getParseTreeNode.md @@ -0,0 +1,61 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getParseTreeNode + +# Function: getParseTreeNode() + +## Call Signature + +> **getParseTreeNode**(`node`): `undefined` \| [`Node`](../interfaces/Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4711 + +Gets the original parse tree node for a node. + +### Parameters + +#### node + +The original node. + +`undefined` | [`Node`](../interfaces/Node.md) + +### Returns + +`undefined` \| [`Node`](../interfaces/Node.md) + +The original parse tree node if found; otherwise, undefined. + +## Call Signature + +> **getParseTreeNode**\<`T`\>(`node`, `nodeTest`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4719 + +Gets the original parse tree node for a node. + +### Type Parameters + +• **T** *extends* [`Node`](../interfaces/Node.md) + +### Parameters + +#### node + +The original node. + +`undefined` | `T` + +#### nodeTest? + +(`node`) => `node is T` + +A callback used to ensure the correct type of parse tree node is returned. + +### Returns + +`undefined` \| `T` + +The original parse tree node if found; otherwise, undefined. diff --git a/docs/api_docs/namespaces/ts/functions/getParsedCommandLineOfConfigFile.md b/docs/api_docs/namespaces/ts/functions/getParsedCommandLineOfConfigFile.md new file mode 100644 index 0000000000000000000000000000000000000000..61388091b8af0326d3828b2ed4edbf61703dbf06 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getParsedCommandLineOfConfigFile.md @@ -0,0 +1,43 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getParsedCommandLineOfConfigFile + +# Function: getParsedCommandLineOfConfigFile() + +> **getParsedCommandLineOfConfigFile**(`configFileName`, `optionsToExtend`, `host`, `extendedConfigCache`?, `watchOptionsToExtend`?, `extraFileExtensions`?): `undefined` \| [`ParsedCommandLine`](../interfaces/ParsedCommandLine.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5278 + +Reads the config file, reports errors if any and exits if the config file cannot be found + +## Parameters + +### configFileName + +`string` + +### optionsToExtend + +`undefined` | [`CompilerOptions`](../interfaces/CompilerOptions.md) + +### host + +[`ParseConfigFileHost`](../interfaces/ParseConfigFileHost.md) + +### extendedConfigCache? + +[`Map`](../interfaces/Map.md)\<[`ExtendedConfigCacheEntry`](../interfaces/ExtendedConfigCacheEntry.md)\> + +### watchOptionsToExtend? + +[`WatchOptions`](../interfaces/WatchOptions.md) + +### extraFileExtensions? + +readonly [`FileExtensionInfo`](../interfaces/FileExtensionInfo.md)[] + +## Returns + +`undefined` \| [`ParsedCommandLine`](../interfaces/ParsedCommandLine.md) diff --git a/docs/api_docs/namespaces/ts/functions/getPositionOfLineAndCharacter.md b/docs/api_docs/namespaces/ts/functions/getPositionOfLineAndCharacter.md new file mode 100644 index 0000000000000000000000000000000000000000..9af609f24c6d7ffb50c3daaa8a14c15fd37dda2d --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getPositionOfLineAndCharacter.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getPositionOfLineAndCharacter + +# Function: getPositionOfLineAndCharacter() + +> **getPositionOfLineAndCharacter**(`sourceFile`, `line`, `character`): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4615 + +## Parameters + +### sourceFile + +[`SourceFileLike`](../interfaces/SourceFileLike.md) + +### line + +`number` + +### character + +`number` + +## Returns + +`number` diff --git a/docs/api_docs/namespaces/ts/functions/getPreEmitDiagnostics.md b/docs/api_docs/namespaces/ts/functions/getPreEmitDiagnostics.md new file mode 100644 index 0000000000000000000000000000000000000000..87e9258489e17b17ed32890d7adfdcada31ecd81 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getPreEmitDiagnostics.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getPreEmitDiagnostics + +# Function: getPreEmitDiagnostics() + +> **getPreEmitDiagnostics**(`program`, `sourceFile`?, `cancellationToken`?): readonly [`Diagnostic`](../interfaces/Diagnostic.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5546 + +## Parameters + +### program + +[`Program`](../interfaces/Program.md) + +### sourceFile? + +[`SourceFile`](../interfaces/SourceFile.md) + +### cancellationToken? + +[`CancellationToken`](../interfaces/CancellationToken.md) + +## Returns + +readonly [`Diagnostic`](../interfaces/Diagnostic.md)[] diff --git a/docs/api_docs/namespaces/ts/functions/getShebang.md b/docs/api_docs/namespaces/ts/functions/getShebang.md new file mode 100644 index 0000000000000000000000000000000000000000..402a8aba250b436e3f8ea4d279d52e5411ca2691 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getShebang.md @@ -0,0 +1,23 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getShebang + +# Function: getShebang() + +> **getShebang**(`text`): `undefined` \| `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4631 + +Optionally, get the shebang + +## Parameters + +### text + +`string` + +## Returns + +`undefined` \| `string` diff --git a/docs/api_docs/namespaces/ts/functions/getSourceMapRange.md b/docs/api_docs/namespaces/ts/functions/getSourceMapRange.md new file mode 100644 index 0000000000000000000000000000000000000000..8635f7b41035f3be25f779c022bb0d339565d03a --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getSourceMapRange.md @@ -0,0 +1,23 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getSourceMapRange + +# Function: getSourceMapRange() + +> **getSourceMapRange**(`node`): [`SourceMapRange`](../interfaces/SourceMapRange.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4949 + +Gets a custom text range to use when emitting source maps. + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +[`SourceMapRange`](../interfaces/SourceMapRange.md) diff --git a/docs/api_docs/namespaces/ts/functions/getSupportedCodeFixes.md b/docs/api_docs/namespaces/ts/functions/getSupportedCodeFixes.md new file mode 100644 index 0000000000000000000000000000000000000000..754627aa8586314341e9672420072af79fa11527 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getSupportedCodeFixes.md @@ -0,0 +1,15 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getSupportedCodeFixes + +# Function: getSupportedCodeFixes() + +> **getSupportedCodeFixes**(): `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7436 + +## Returns + +`string`[] diff --git a/docs/api_docs/namespaces/ts/functions/getSyntheticLeadingComments.md b/docs/api_docs/namespaces/ts/functions/getSyntheticLeadingComments.md new file mode 100644 index 0000000000000000000000000000000000000000..a5c8cb96f4b467c94bc8c29f3c2ed03cde92f8d8 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getSyntheticLeadingComments.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getSyntheticLeadingComments + +# Function: getSyntheticLeadingComments() + +> **getSyntheticLeadingComments**(`node`): `undefined` \| [`SynthesizedComment`](../interfaces/SynthesizedComment.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4970 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`undefined` \| [`SynthesizedComment`](../interfaces/SynthesizedComment.md)[] diff --git a/docs/api_docs/namespaces/ts/functions/getSyntheticTrailingComments.md b/docs/api_docs/namespaces/ts/functions/getSyntheticTrailingComments.md new file mode 100644 index 0000000000000000000000000000000000000000..fa526a9b624317756dcb5e860a7263b7c904e34d --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getSyntheticTrailingComments.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getSyntheticTrailingComments + +# Function: getSyntheticTrailingComments() + +> **getSyntheticTrailingComments**(`node`): `undefined` \| [`SynthesizedComment`](../interfaces/SynthesizedComment.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4973 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`undefined` \| [`SynthesizedComment`](../interfaces/SynthesizedComment.md)[] diff --git a/docs/api_docs/namespaces/ts/functions/getTextOfJSDocComment.md b/docs/api_docs/namespaces/ts/functions/getTextOfJSDocComment.md new file mode 100644 index 0000000000000000000000000000000000000000..a45e193dfdd63b74209a59f13e0c90dafb617526 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getTextOfJSDocComment.md @@ -0,0 +1,23 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getTextOfJSDocComment + +# Function: getTextOfJSDocComment() + +> **getTextOfJSDocComment**(`comment`?): `undefined` \| `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4821 + +Gets the text of a jsdoc comment, flattening links to their text. + +## Parameters + +### comment? + +`string` | [`NodeArray`](../interfaces/NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +## Returns + +`undefined` \| `string` diff --git a/docs/api_docs/namespaces/ts/functions/getTokenSourceMapRange.md b/docs/api_docs/namespaces/ts/functions/getTokenSourceMapRange.md new file mode 100644 index 0000000000000000000000000000000000000000..52a20eadc382cb16872f64adafd306b18ee315c1 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getTokenSourceMapRange.md @@ -0,0 +1,27 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getTokenSourceMapRange + +# Function: getTokenSourceMapRange() + +> **getTokenSourceMapRange**(`node`, `token`): `undefined` \| [`SourceMapRange`](../interfaces/SourceMapRange.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4957 + +Gets the TextRange to use for source maps for a token of a node. + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +### token + +[`SyntaxKind`](../enumerations/SyntaxKind.md) + +## Returns + +`undefined` \| [`SourceMapRange`](../interfaces/SourceMapRange.md) diff --git a/docs/api_docs/namespaces/ts/functions/getTrailingCommentRanges.md b/docs/api_docs/namespaces/ts/functions/getTrailingCommentRanges.md new file mode 100644 index 0000000000000000000000000000000000000000..55de1687c0751fc6f810f12f7c39494f03badf88 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getTrailingCommentRanges.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getTrailingCommentRanges + +# Function: getTrailingCommentRanges() + +> **getTrailingCommentRanges**(`text`, `pos`): `undefined` \| [`CommentRange`](../interfaces/CommentRange.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4629 + +## Parameters + +### text + +`string` + +### pos + +`number` + +## Returns + +`undefined` \| [`CommentRange`](../interfaces/CommentRange.md)[] diff --git a/docs/api_docs/namespaces/ts/functions/getTsBuildInfoEmitOutputFilePath.md b/docs/api_docs/namespaces/ts/functions/getTsBuildInfoEmitOutputFilePath.md new file mode 100644 index 0000000000000000000000000000000000000000..00bb7da584f9c555cd0a0d5deb6676a03d926225 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getTsBuildInfoEmitOutputFilePath.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getTsBuildInfoEmitOutputFilePath + +# Function: getTsBuildInfoEmitOutputFilePath() + +> **getTsBuildInfoEmitOutputFilePath**(`options`): `undefined` \| `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5537 + +## Parameters + +### options + +[`CompilerOptions`](../interfaces/CompilerOptions.md) + +## Returns + +`undefined` \| `string` diff --git a/docs/api_docs/namespaces/ts/functions/getTsBuildInfoEmitOutputFilePathForLinter.md b/docs/api_docs/namespaces/ts/functions/getTsBuildInfoEmitOutputFilePathForLinter.md new file mode 100644 index 0000000000000000000000000000000000000000..15bfc0915cc30e76307049d010e81fc88f282c48 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getTsBuildInfoEmitOutputFilePathForLinter.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getTsBuildInfoEmitOutputFilePathForLinter + +# Function: getTsBuildInfoEmitOutputFilePathForLinter() + +> **getTsBuildInfoEmitOutputFilePathForLinter**(`tsBuildInfoPath`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5538 + +## Parameters + +### tsBuildInfoPath + +`string` + +## Returns + +`string` diff --git a/docs/api_docs/namespaces/ts/functions/getTypeExportImportAndConstEnumTransformer.md b/docs/api_docs/namespaces/ts/functions/getTypeExportImportAndConstEnumTransformer.md new file mode 100644 index 0000000000000000000000000000000000000000..cc4ecf3af244ec551e0af737db0ebed89c63e31b --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getTypeExportImportAndConstEnumTransformer.md @@ -0,0 +1,31 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getTypeExportImportAndConstEnumTransformer + +# Function: getTypeExportImportAndConstEnumTransformer() + +> **getTypeExportImportAndConstEnumTransformer**(`context`): (`node`) => [`SourceFile`](../interfaces/SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5435 + +## Parameters + +### context + +[`TransformationContext`](../interfaces/TransformationContext.md) + +## Returns + +`Function` + +### Parameters + +#### node + +[`SourceFile`](../interfaces/SourceFile.md) + +### Returns + +[`SourceFile`](../interfaces/SourceFile.md) diff --git a/docs/api_docs/namespaces/ts/functions/getTypeParameterOwner.md b/docs/api_docs/namespaces/ts/functions/getTypeParameterOwner.md new file mode 100644 index 0000000000000000000000000000000000000000..3eeb6be9d863c6e4a4db05adb8a6de9ca4a5fb99 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/getTypeParameterOwner.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / getTypeParameterOwner + +# Function: getTypeParameterOwner() + +> **getTypeParameterOwner**(`d`): `undefined` \| [`Declaration`](../interfaces/Declaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4666 + +## Parameters + +### d + +[`Declaration`](../interfaces/Declaration.md) + +## Returns + +`undefined` \| [`Declaration`](../interfaces/Declaration.md) diff --git a/docs/api_docs/namespaces/ts/functions/hasJSDocParameterTags.md b/docs/api_docs/namespaces/ts/functions/hasJSDocParameterTags.md new file mode 100644 index 0000000000000000000000000000000000000000..2af50d84a5a5dbacac565bb360d06e68ef6ed96f --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/hasJSDocParameterTags.md @@ -0,0 +1,28 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / hasJSDocParameterTags + +# Function: hasJSDocParameterTags() + +> **hasJSDocParameterTags**(`node`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4767 + +Return true if the node has JSDoc parameter tags. + +## Parameters + +### node + +[`MethodDeclaration`](../interfaces/MethodDeclaration.md) | [`GetAccessorDeclaration`](../interfaces/GetAccessorDeclaration.md) | [`SetAccessorDeclaration`](../interfaces/SetAccessorDeclaration.md) | [`IndexSignatureDeclaration`](../interfaces/IndexSignatureDeclaration.md) | [`FunctionDeclaration`](../interfaces/FunctionDeclaration.md) | [`ConstructorDeclaration`](../interfaces/ConstructorDeclaration.md) | [`ArrowFunction`](../interfaces/ArrowFunction.md) | [`FunctionExpression`](../interfaces/FunctionExpression.md) | [`MethodSignature`](../interfaces/MethodSignature.md) | [`ConstructSignatureDeclaration`](../interfaces/ConstructSignatureDeclaration.md) | [`CallSignatureDeclaration`](../interfaces/CallSignatureDeclaration.md) | [`FunctionTypeNode`](../interfaces/FunctionTypeNode.md) | [`ConstructorTypeNode`](../interfaces/ConstructorTypeNode.md) | [`JSDocFunctionType`](../interfaces/JSDocFunctionType.md) + +## Returns + +`boolean` + +## Remarks + +Includes parameter tags that are not directly on the node, +for example on a variable declaration whose initializer is a function expression. diff --git a/docs/api_docs/namespaces/ts/functions/hasOnlyExpressionInitializer.md b/docs/api_docs/namespaces/ts/functions/hasOnlyExpressionInitializer.md new file mode 100644 index 0000000000000000000000000000000000000000..613ce5f5dfe4511714b999aca516aa50944c85fb --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/hasOnlyExpressionInitializer.md @@ -0,0 +1,23 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / hasOnlyExpressionInitializer + +# Function: hasOnlyExpressionInitializer() + +> **hasOnlyExpressionInitializer**(`node`): `node is HasExpressionInitializer` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4903 + +True if has initializer node attached to it. + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is HasExpressionInitializer` diff --git a/docs/api_docs/namespaces/ts/functions/hasRestParameter.md b/docs/api_docs/namespaces/ts/functions/hasRestParameter.md new file mode 100644 index 0000000000000000000000000000000000000000..199e8a47b988aee4d3682ef3bca8cbd839cef3c2 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/hasRestParameter.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / hasRestParameter + +# Function: hasRestParameter() + +> **hasRestParameter**(`s`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4907 + +## Parameters + +### s + +[`SignatureDeclaration`](../type-aliases/SignatureDeclaration.md) | [`JSDocSignature`](../interfaces/JSDocSignature.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/functions/hasTsNoCheckOrTsIgnoreFlag.md b/docs/api_docs/namespaces/ts/functions/hasTsNoCheckOrTsIgnoreFlag.md new file mode 100644 index 0000000000000000000000000000000000000000..8e552335be18cdaabff0376866cbd2f84641819b --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/hasTsNoCheckOrTsIgnoreFlag.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / hasTsNoCheckOrTsIgnoreFlag + +# Function: hasTsNoCheckOrTsIgnoreFlag() + +> **hasTsNoCheckOrTsIgnoreFlag**(`node`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5441 + +## Parameters + +### node + +[`SourceFile`](../interfaces/SourceFile.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/functions/idText.md b/docs/api_docs/namespaces/ts/functions/idText.md new file mode 100644 index 0000000000000000000000000000000000000000..d1faa3f0ed6d1c51753771ae9c507652f3638129 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/idText.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / idText + +# Function: idText() + +> **idText**(`identifierOrPrivateName`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4729 + +## Parameters + +### identifierOrPrivateName + +[`Identifier`](../interfaces/Identifier.md) | [`PrivateIdentifier`](../interfaces/PrivateIdentifier.md) + +## Returns + +`string` diff --git a/docs/api_docs/namespaces/ts/functions/isAccessor.md b/docs/api_docs/namespaces/ts/functions/isAccessor.md new file mode 100644 index 0000000000000000000000000000000000000000..0b44e43b0e6e5af5bc8a2644594ddac9ee38cc54 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isAccessor.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isAccessor + +# Function: isAccessor() + +> **isAccessor**(`node`): `node is AccessorDeclaration` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4876 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is AccessorDeclaration` diff --git a/docs/api_docs/namespaces/ts/functions/isArrayBindingPattern.md b/docs/api_docs/namespaces/ts/functions/isArrayBindingPattern.md new file mode 100644 index 0000000000000000000000000000000000000000..da74a5b6471878e724c84c5f70f7f65d7d6377f6 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isArrayBindingPattern.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isArrayBindingPattern + +# Function: isArrayBindingPattern() + +> **isArrayBindingPattern**(`node`): `node is ArrayBindingPattern` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5063 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is ArrayBindingPattern` diff --git a/docs/api_docs/namespaces/ts/functions/isArrayLiteralExpression.md b/docs/api_docs/namespaces/ts/functions/isArrayLiteralExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..1fcc94a63146435c9efec85630b5540d7352dd9c --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isArrayLiteralExpression.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isArrayLiteralExpression + +# Function: isArrayLiteralExpression() + +> **isArrayLiteralExpression**(`node`): `node is ArrayLiteralExpression` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5065 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is ArrayLiteralExpression` diff --git a/docs/api_docs/namespaces/ts/functions/isArrayTypeNode.md b/docs/api_docs/namespaces/ts/functions/isArrayTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..1f804c135e26562528c3efef51fe6385d92d6146 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isArrayTypeNode.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isArrayTypeNode + +# Function: isArrayTypeNode() + +> **isArrayTypeNode**(`node`): `node is ArrayTypeNode` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5044 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is ArrayTypeNode` diff --git a/docs/api_docs/namespaces/ts/functions/isArrowFunction.md b/docs/api_docs/namespaces/ts/functions/isArrowFunction.md new file mode 100644 index 0000000000000000000000000000000000000000..153de4fc0322a8994348c3773a41cb3eef596bd0 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isArrowFunction.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isArrowFunction + +# Function: isArrowFunction() + +> **isArrowFunction**(`node`): `node is ArrowFunction` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5076 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is ArrowFunction` diff --git a/docs/api_docs/namespaces/ts/functions/isAsExpression.md b/docs/api_docs/namespaces/ts/functions/isAsExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..45feccf9d45e4d4ef5a0049049649a8185f274da --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isAsExpression.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isAsExpression + +# Function: isAsExpression() + +> **isAsExpression**(`node`): `node is AsExpression` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5091 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is AsExpression` diff --git a/docs/api_docs/namespaces/ts/functions/isAssertClause.md b/docs/api_docs/namespaces/ts/functions/isAssertClause.md new file mode 100644 index 0000000000000000000000000000000000000000..2a33b48d0e3d00176deeb527a14846d5d3a22fa9 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isAssertClause.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isAssertClause + +# Function: isAssertClause() + +> **isAssertClause**(`node`): `node is AssertClause` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5135 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is AssertClause` diff --git a/docs/api_docs/namespaces/ts/functions/isAssertEntry.md b/docs/api_docs/namespaces/ts/functions/isAssertEntry.md new file mode 100644 index 0000000000000000000000000000000000000000..b50eac9a3be325aeccf91041c4f335c303c201b7 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isAssertEntry.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isAssertEntry + +# Function: isAssertEntry() + +> **isAssertEntry**(`node`): `node is AssertEntry` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5136 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is AssertEntry` diff --git a/docs/api_docs/namespaces/ts/functions/isAssertionExpression.md b/docs/api_docs/namespaces/ts/functions/isAssertionExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..3f4026dc1405881d9f7ba53dd5c2bab940da47a3 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isAssertionExpression.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isAssertionExpression + +# Function: isAssertionExpression() + +> **isAssertionExpression**(`node`): `node is AssertionExpression` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4893 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is AssertionExpression` diff --git a/docs/api_docs/namespaces/ts/functions/isAssertionKey.md b/docs/api_docs/namespaces/ts/functions/isAssertionKey.md new file mode 100644 index 0000000000000000000000000000000000000000..0efde87e0e89066b3472a7b81e4a4a471c8d97bb --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isAssertionKey.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isAssertionKey + +# Function: isAssertionKey() + +> **isAssertionKey**(`node`): `node is AssertionKey` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4866 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is AssertionKey` diff --git a/docs/api_docs/namespaces/ts/functions/isAsteriskToken.md b/docs/api_docs/namespaces/ts/functions/isAsteriskToken.md new file mode 100644 index 0000000000000000000000000000000000000000..36175ccba463563488e57096fcd67b9f4dd89d5b --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isAsteriskToken.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isAsteriskToken + +# Function: isAsteriskToken() + +> **isAsteriskToken**(`node`): `node is AsteriskToken` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5019 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is AsteriskToken` diff --git a/docs/api_docs/namespaces/ts/functions/isAutoAccessorPropertyDeclaration.md b/docs/api_docs/namespaces/ts/functions/isAutoAccessorPropertyDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..401073aef95ca77fea0be84223480463d8445def --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isAutoAccessorPropertyDeclaration.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isAutoAccessorPropertyDeclaration + +# Function: isAutoAccessorPropertyDeclaration() + +> **isAutoAccessorPropertyDeclaration**(`node`): `node is AutoAccessorPropertyDeclaration` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4877 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is AutoAccessorPropertyDeclaration` diff --git a/docs/api_docs/namespaces/ts/functions/isAwaitExpression.md b/docs/api_docs/namespaces/ts/functions/isAwaitExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..f95326f00fa838f41ac6e4ec25899f9c18cdf581 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isAwaitExpression.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isAwaitExpression + +# Function: isAwaitExpression() + +> **isAwaitExpression**(`node`): `node is AwaitExpression` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5080 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is AwaitExpression` diff --git a/docs/api_docs/namespaces/ts/functions/isBigIntLiteral.md b/docs/api_docs/namespaces/ts/functions/isBigIntLiteral.md new file mode 100644 index 0000000000000000000000000000000000000000..2612560dfd7ce90ec57ac26d2f3c6fd9ab33a7c0 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isBigIntLiteral.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isBigIntLiteral + +# Function: isBigIntLiteral() + +> **isBigIntLiteral**(`node`): `node is BigIntLiteral` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5008 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is BigIntLiteral` diff --git a/docs/api_docs/namespaces/ts/functions/isBinaryExpression.md b/docs/api_docs/namespaces/ts/functions/isBinaryExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..6994f071ac1fb4683e12663ef36256258ef31aa7 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isBinaryExpression.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isBinaryExpression + +# Function: isBinaryExpression() + +> **isBinaryExpression**(`node`): `node is BinaryExpression` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5083 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is BinaryExpression` diff --git a/docs/api_docs/namespaces/ts/functions/isBindingElement.md b/docs/api_docs/namespaces/ts/functions/isBindingElement.md new file mode 100644 index 0000000000000000000000000000000000000000..6ba1e764eb7a5cf5ae893b0a341aee994b8fbc0a --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isBindingElement.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isBindingElement + +# Function: isBindingElement() + +> **isBindingElement**(`node`): `node is BindingElement` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5064 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is BindingElement` diff --git a/docs/api_docs/namespaces/ts/functions/isBindingName.md b/docs/api_docs/namespaces/ts/functions/isBindingName.md new file mode 100644 index 0000000000000000000000000000000000000000..32f2eb44d45cc782c94b50353f88ff3828eaa664 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isBindingName.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isBindingName + +# Function: isBindingName() + +> **isBindingName**(`node`): `node is BindingName` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4871 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is BindingName` diff --git a/docs/api_docs/namespaces/ts/functions/isBlock.md b/docs/api_docs/namespaces/ts/functions/isBlock.md new file mode 100644 index 0000000000000000000000000000000000000000..e746cd90c2bfaf3708b1df71bd18e7dc6ba27298 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isBlock.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isBlock + +# Function: isBlock() + +> **isBlock**(`node`): `node is Block` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5100 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is Block` diff --git a/docs/api_docs/namespaces/ts/functions/isBreakOrContinueStatement.md b/docs/api_docs/namespaces/ts/functions/isBreakOrContinueStatement.md new file mode 100644 index 0000000000000000000000000000000000000000..4d82ce6a8d89b8cabc09bb3ab0e03d1fbad01b2c --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isBreakOrContinueStatement.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isBreakOrContinueStatement + +# Function: isBreakOrContinueStatement() + +> **isBreakOrContinueStatement**(`node`): `node is BreakOrContinueStatement` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4844 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is BreakOrContinueStatement` diff --git a/docs/api_docs/namespaces/ts/functions/isBreakStatement.md b/docs/api_docs/namespaces/ts/functions/isBreakStatement.md new file mode 100644 index 0000000000000000000000000000000000000000..881dfcbb98fd7401062a80680c90996a12211a08 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isBreakStatement.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isBreakStatement + +# Function: isBreakStatement() + +> **isBreakStatement**(`node`): `node is BreakStatement` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5111 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is BreakStatement` diff --git a/docs/api_docs/namespaces/ts/functions/isBundle.md b/docs/api_docs/namespaces/ts/functions/isBundle.md new file mode 100644 index 0000000000000000000000000000000000000000..d14c2568cabefa7ddb2424c316b6dcd43a9d99d9 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isBundle.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isBundle + +# Function: isBundle() + +> **isBundle**(`node`): `node is Bundle` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5169 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is Bundle` diff --git a/docs/api_docs/namespaces/ts/functions/isCallChain.md b/docs/api_docs/namespaces/ts/functions/isCallChain.md new file mode 100644 index 0000000000000000000000000000000000000000..54b8305883b5b7d1d693f43438d0ae71c81044fe --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isCallChain.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isCallChain + +# Function: isCallChain() + +> **isCallChain**(`node`): `node is CallChain` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4837 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is CallChain` diff --git a/docs/api_docs/namespaces/ts/functions/isCallExpression.md b/docs/api_docs/namespaces/ts/functions/isCallExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..2d1767a93df4c997bc8bd8710144bea7ec5ff4e2 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isCallExpression.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isCallExpression + +# Function: isCallExpression() + +> **isCallExpression**(`node`): `node is CallExpression` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5069 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is CallExpression` diff --git a/docs/api_docs/namespaces/ts/functions/isCallLikeExpression.md b/docs/api_docs/namespaces/ts/functions/isCallLikeExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..d8d922910826555f7085e283910514be50d21c25 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isCallLikeExpression.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isCallLikeExpression + +# Function: isCallLikeExpression() + +> **isCallLikeExpression**(`node`): `node is CallLikeExpression` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4890 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is CallLikeExpression` diff --git a/docs/api_docs/namespaces/ts/functions/isCallOrNewExpression.md b/docs/api_docs/namespaces/ts/functions/isCallOrNewExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..4383ebc452da8d18339c3ba3be65b5af70ed4d93 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isCallOrNewExpression.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isCallOrNewExpression + +# Function: isCallOrNewExpression() + +> **isCallOrNewExpression**(`node`): node is CallExpression \| NewExpression + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4891 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +node is CallExpression \| NewExpression diff --git a/docs/api_docs/namespaces/ts/functions/isCallSignatureDeclaration.md b/docs/api_docs/namespaces/ts/functions/isCallSignatureDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..26bc9a4a3cd8b32d52866e4ef57ca8745c1fc317 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isCallSignatureDeclaration.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isCallSignatureDeclaration + +# Function: isCallSignatureDeclaration() + +> **isCallSignatureDeclaration**(`node`): `node is CallSignatureDeclaration` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5035 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is CallSignatureDeclaration` diff --git a/docs/api_docs/namespaces/ts/functions/isCaseBlock.md b/docs/api_docs/namespaces/ts/functions/isCaseBlock.md new file mode 100644 index 0000000000000000000000000000000000000000..4eaf65abde0fd1e870558f2c58431b9c9986202e --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isCaseBlock.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isCaseBlock + +# Function: isCaseBlock() + +> **isCaseBlock**(`node`): `node is CaseBlock` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5129 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is CaseBlock` diff --git a/docs/api_docs/namespaces/ts/functions/isCaseClause.md b/docs/api_docs/namespaces/ts/functions/isCaseClause.md new file mode 100644 index 0000000000000000000000000000000000000000..4ee5580afddc0d55aef28bf43e97392ffe1e8c58 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isCaseClause.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isCaseClause + +# Function: isCaseClause() + +> **isCaseClause**(`node`): `node is CaseClause` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5159 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is CaseClause` diff --git a/docs/api_docs/namespaces/ts/functions/isCaseOrDefaultClause.md b/docs/api_docs/namespaces/ts/functions/isCaseOrDefaultClause.md new file mode 100644 index 0000000000000000000000000000000000000000..bc42e16dcfe1cc2cc72edc445375cdf7e0a276ee --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isCaseOrDefaultClause.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isCaseOrDefaultClause + +# Function: isCaseOrDefaultClause() + +> **isCaseOrDefaultClause**(`node`): `node is CaseOrDefaultClause` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4897 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is CaseOrDefaultClause` diff --git a/docs/api_docs/namespaces/ts/functions/isCatchClause.md b/docs/api_docs/namespaces/ts/functions/isCatchClause.md new file mode 100644 index 0000000000000000000000000000000000000000..b4f139686768cda6dd18ca2e39c6204b8a2edca1 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isCatchClause.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isCatchClause + +# Function: isCatchClause() + +> **isCatchClause**(`node`): `node is CatchClause` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5162 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is CatchClause` diff --git a/docs/api_docs/namespaces/ts/functions/isClassDeclaration.md b/docs/api_docs/namespaces/ts/functions/isClassDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..d11df735200cc94f3fd6472b9a48638ebab4bb45 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isClassDeclaration.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isClassDeclaration + +# Function: isClassDeclaration() + +> **isClassDeclaration**(`node`): `node is ClassDeclaration` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5122 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is ClassDeclaration` diff --git a/docs/api_docs/namespaces/ts/functions/isClassElement.md b/docs/api_docs/namespaces/ts/functions/isClassElement.md new file mode 100644 index 0000000000000000000000000000000000000000..4a6ab112b03bfb27c4c6c4c84010541952abe189 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isClassElement.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isClassElement + +# Function: isClassElement() + +> **isClassElement**(`node`): `node is ClassElement` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4873 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is ClassElement` diff --git a/docs/api_docs/namespaces/ts/functions/isClassExpression.md b/docs/api_docs/namespaces/ts/functions/isClassExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..ab9cbabbb09ae805562f62fdef81762dad87f02a --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isClassExpression.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isClassExpression + +# Function: isClassExpression() + +> **isClassExpression**(`node`): `node is ClassExpression` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5088 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is ClassExpression` diff --git a/docs/api_docs/namespaces/ts/functions/isClassLike.md b/docs/api_docs/namespaces/ts/functions/isClassLike.md new file mode 100644 index 0000000000000000000000000000000000000000..d3ceec35abc28365417babf3a7ac161d1eaf6c90 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isClassLike.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isClassLike + +# Function: isClassLike() + +> **isClassLike**(`node`): `node is ClassLikeDeclaration` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4874 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is ClassLikeDeclaration` diff --git a/docs/api_docs/namespaces/ts/functions/isClassOrTypeElement.md b/docs/api_docs/namespaces/ts/functions/isClassOrTypeElement.md new file mode 100644 index 0000000000000000000000000000000000000000..dbad4287970feeeab6d389a503049e61ace08988 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isClassOrTypeElement.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isClassOrTypeElement + +# Function: isClassOrTypeElement() + +> **isClassOrTypeElement**(`node`): node is ClassElement \| TypeElement + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4880 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +node is ClassElement \| TypeElement diff --git a/docs/api_docs/namespaces/ts/functions/isClassStaticBlockDeclaration.md b/docs/api_docs/namespaces/ts/functions/isClassStaticBlockDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..51931ffdf8bad2c30084f479f6717e7cd21de178 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isClassStaticBlockDeclaration.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isClassStaticBlockDeclaration + +# Function: isClassStaticBlockDeclaration() + +> **isClassStaticBlockDeclaration**(`node`): `node is ClassStaticBlockDeclaration` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5031 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is ClassStaticBlockDeclaration` diff --git a/docs/api_docs/namespaces/ts/functions/isCommaListExpression.md b/docs/api_docs/namespaces/ts/functions/isCommaListExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..588a38f673df028d9924dc649d0875f72bb65e12 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isCommaListExpression.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isCommaListExpression + +# Function: isCommaListExpression() + +> **isCommaListExpression**(`node`): `node is CommaListExpression` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5097 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is CommaListExpression` diff --git a/docs/api_docs/namespaces/ts/functions/isComputedPropertyName.md b/docs/api_docs/namespaces/ts/functions/isComputedPropertyName.md new file mode 100644 index 0000000000000000000000000000000000000000..24d112609620778e6ab914336f88e4665bddedd1 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isComputedPropertyName.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isComputedPropertyName + +# Function: isComputedPropertyName() + +> **isComputedPropertyName**(`node`): `node is ComputedPropertyName` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5023 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is ComputedPropertyName` diff --git a/docs/api_docs/namespaces/ts/functions/isConditionalExpression.md b/docs/api_docs/namespaces/ts/functions/isConditionalExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..ae60c704290a1eb995b6f6e2141bc7f6025e8886 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isConditionalExpression.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isConditionalExpression + +# Function: isConditionalExpression() + +> **isConditionalExpression**(`node`): `node is ConditionalExpression` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5084 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is ConditionalExpression` diff --git a/docs/api_docs/namespaces/ts/functions/isConditionalTypeNode.md b/docs/api_docs/namespaces/ts/functions/isConditionalTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..dd599be50e0a74b44295f2a73ee35f9f118a04fb --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isConditionalTypeNode.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isConditionalTypeNode + +# Function: isConditionalTypeNode() + +> **isConditionalTypeNode**(`node`): `node is ConditionalTypeNode` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5051 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is ConditionalTypeNode` diff --git a/docs/api_docs/namespaces/ts/functions/isConstTypeReference.md b/docs/api_docs/namespaces/ts/functions/isConstTypeReference.md new file mode 100644 index 0000000000000000000000000000000000000000..731181c77969d8d7c91f2a24e339f8bdfb38ab9d --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isConstTypeReference.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isConstTypeReference + +# Function: isConstTypeReference() + +> **isConstTypeReference**(`node`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4840 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/functions/isConstructSignatureDeclaration.md b/docs/api_docs/namespaces/ts/functions/isConstructSignatureDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..5a15279b929ec2fcb0e483023cca5f4b0239ea25 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isConstructSignatureDeclaration.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isConstructSignatureDeclaration + +# Function: isConstructSignatureDeclaration() + +> **isConstructSignatureDeclaration**(`node`): `node is ConstructSignatureDeclaration` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5036 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is ConstructSignatureDeclaration` diff --git a/docs/api_docs/namespaces/ts/functions/isConstructorDeclaration.md b/docs/api_docs/namespaces/ts/functions/isConstructorDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..451281eef054e49176af64a5d890262395d44a95 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isConstructorDeclaration.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isConstructorDeclaration + +# Function: isConstructorDeclaration() + +> **isConstructorDeclaration**(`node`): `node is ConstructorDeclaration` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5032 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is ConstructorDeclaration` diff --git a/docs/api_docs/namespaces/ts/functions/isConstructorTypeNode.md b/docs/api_docs/namespaces/ts/functions/isConstructorTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..6d9184bb928af30d714b456422844a539cc63755 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isConstructorTypeNode.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isConstructorTypeNode + +# Function: isConstructorTypeNode() + +> **isConstructorTypeNode**(`node`): `node is ConstructorTypeNode` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5041 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is ConstructorTypeNode` diff --git a/docs/api_docs/namespaces/ts/functions/isContinueStatement.md b/docs/api_docs/namespaces/ts/functions/isContinueStatement.md new file mode 100644 index 0000000000000000000000000000000000000000..f02f2e5c427e3939f99e1fdbdc3ff505a618bdb2 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isContinueStatement.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isContinueStatement + +# Function: isContinueStatement() + +> **isContinueStatement**(`node`): `node is ContinueStatement` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5110 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is ContinueStatement` diff --git a/docs/api_docs/namespaces/ts/functions/isDebuggerStatement.md b/docs/api_docs/namespaces/ts/functions/isDebuggerStatement.md new file mode 100644 index 0000000000000000000000000000000000000000..062db497fa64c535344816703c61d737a366caa3 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isDebuggerStatement.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isDebuggerStatement + +# Function: isDebuggerStatement() + +> **isDebuggerStatement**(`node`): `node is DebuggerStatement` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5118 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is DebuggerStatement` diff --git a/docs/api_docs/namespaces/ts/functions/isDecorator.md b/docs/api_docs/namespaces/ts/functions/isDecorator.md new file mode 100644 index 0000000000000000000000000000000000000000..8dca35d86c7bb00b8a3d4f8bfa9ab426f7ac882f --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isDecorator.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isDecorator + +# Function: isDecorator() + +> **isDecorator**(`node`): `node is Decorator` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5026 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is Decorator` diff --git a/docs/api_docs/namespaces/ts/functions/isDefaultClause.md b/docs/api_docs/namespaces/ts/functions/isDefaultClause.md new file mode 100644 index 0000000000000000000000000000000000000000..1c66dd74f868eea11c60d03b724de0c11904eb64 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isDefaultClause.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isDefaultClause + +# Function: isDefaultClause() + +> **isDefaultClause**(`node`): `node is DefaultClause` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5160 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is DefaultClause` diff --git a/docs/api_docs/namespaces/ts/functions/isDeleteExpression.md b/docs/api_docs/namespaces/ts/functions/isDeleteExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..17e590ca468e9ff3f8a0352d584259ff3ff1ba5f --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isDeleteExpression.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isDeleteExpression + +# Function: isDeleteExpression() + +> **isDeleteExpression**(`node`): `node is DeleteExpression` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5077 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is DeleteExpression` diff --git a/docs/api_docs/namespaces/ts/functions/isDoStatement.md b/docs/api_docs/namespaces/ts/functions/isDoStatement.md new file mode 100644 index 0000000000000000000000000000000000000000..57d8be4a6c0bd53fac36746bfb15a6ab79f21fa1 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isDoStatement.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isDoStatement + +# Function: isDoStatement() + +> **isDoStatement**(`node`): `node is DoStatement` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5105 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is DoStatement` diff --git a/docs/api_docs/namespaces/ts/functions/isDotDotDotToken.md b/docs/api_docs/namespaces/ts/functions/isDotDotDotToken.md new file mode 100644 index 0000000000000000000000000000000000000000..f1969ed04bf9859f6c73f7cafe0fae0d8ffe85c0 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isDotDotDotToken.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isDotDotDotToken + +# Function: isDotDotDotToken() + +> **isDotDotDotToken**(`node`): `node is DotDotDotToken` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5016 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is DotDotDotToken` diff --git a/docs/api_docs/namespaces/ts/functions/isElementAccessChain.md b/docs/api_docs/namespaces/ts/functions/isElementAccessChain.md new file mode 100644 index 0000000000000000000000000000000000000000..7c04392c3b92508535a2dd417c101648b1ec44a9 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isElementAccessChain.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isElementAccessChain + +# Function: isElementAccessChain() + +> **isElementAccessChain**(`node`): `node is ElementAccessChain` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4836 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is ElementAccessChain` diff --git a/docs/api_docs/namespaces/ts/functions/isElementAccessExpression.md b/docs/api_docs/namespaces/ts/functions/isElementAccessExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..807237239814ad8c248984af4a35c4e3b6a99926 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isElementAccessExpression.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isElementAccessExpression + +# Function: isElementAccessExpression() + +> **isElementAccessExpression**(`node`): `node is ElementAccessExpression` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5068 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is ElementAccessExpression` diff --git a/docs/api_docs/namespaces/ts/functions/isEmptyBindingElement.md b/docs/api_docs/namespaces/ts/functions/isEmptyBindingElement.md new file mode 100644 index 0000000000000000000000000000000000000000..b3fcfe40b5ac5ebe193540aff3c39fe586b050b5 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isEmptyBindingElement.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isEmptyBindingElement + +# Function: isEmptyBindingElement() + +> **isEmptyBindingElement**(`node`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4673 + +## Parameters + +### node + +[`BindingElement`](../interfaces/BindingElement.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/functions/isEmptyBindingPattern.md b/docs/api_docs/namespaces/ts/functions/isEmptyBindingPattern.md new file mode 100644 index 0000000000000000000000000000000000000000..9af5fa2ce4cc1091f9df469712b9693fcfd68a37 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isEmptyBindingPattern.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isEmptyBindingPattern + +# Function: isEmptyBindingPattern() + +> **isEmptyBindingPattern**(`node`): `node is BindingPattern` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4672 + +## Parameters + +### node + +[`BindingName`](../type-aliases/BindingName.md) + +## Returns + +`node is BindingPattern` diff --git a/docs/api_docs/namespaces/ts/functions/isEmptyStatement.md b/docs/api_docs/namespaces/ts/functions/isEmptyStatement.md new file mode 100644 index 0000000000000000000000000000000000000000..1f00449aa14e547f355980ca669a8f1ebba0a800 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isEmptyStatement.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isEmptyStatement + +# Function: isEmptyStatement() + +> **isEmptyStatement**(`node`): `node is EmptyStatement` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5102 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is EmptyStatement` diff --git a/docs/api_docs/namespaces/ts/functions/isEntityName.md b/docs/api_docs/namespaces/ts/functions/isEntityName.md new file mode 100644 index 0000000000000000000000000000000000000000..4cd72269c8f273d1f62ebee52bb844f3e7e80320 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isEntityName.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isEntityName + +# Function: isEntityName() + +> **isEntityName**(`node`): `node is EntityName` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4869 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is EntityName` diff --git a/docs/api_docs/namespaces/ts/functions/isEnumDeclaration.md b/docs/api_docs/namespaces/ts/functions/isEnumDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..fe7f91b8f7a1393c0b85f330b922647502088de4 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isEnumDeclaration.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isEnumDeclaration + +# Function: isEnumDeclaration() + +> **isEnumDeclaration**(`node`): `node is EnumDeclaration` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5126 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is EnumDeclaration` diff --git a/docs/api_docs/namespaces/ts/functions/isEnumMember.md b/docs/api_docs/namespaces/ts/functions/isEnumMember.md new file mode 100644 index 0000000000000000000000000000000000000000..e1f41078b1f46c8a00f3678ebb2d2ef0e79dff0e --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isEnumMember.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isEnumMember + +# Function: isEnumMember() + +> **isEnumMember**(`node`): `node is EnumMember` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5166 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is EnumMember` diff --git a/docs/api_docs/namespaces/ts/functions/isEtsComponentExpression.md b/docs/api_docs/namespaces/ts/functions/isEtsComponentExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..627fbca9bd7b781caaff1aefcb15bf2d2b118f5e --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isEtsComponentExpression.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isEtsComponentExpression + +# Function: isEtsComponentExpression() + +> **isEtsComponentExpression**(`node`): `node is EtsComponentExpression` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5075 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is EtsComponentExpression` diff --git a/docs/api_docs/namespaces/ts/functions/isEtsFunctionDecorators.md b/docs/api_docs/namespaces/ts/functions/isEtsFunctionDecorators.md new file mode 100644 index 0000000000000000000000000000000000000000..24506121ca6128afb003a001da1cbd17e98c7aa0 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isEtsFunctionDecorators.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isEtsFunctionDecorators + +# Function: isEtsFunctionDecorators() + +> **isEtsFunctionDecorators**(`name`, `options`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5423 + +## Parameters + +### name + +`undefined` | `string` + +### options + +[`CompilerOptions`](../interfaces/CompilerOptions.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/functions/isExportAssignment.md b/docs/api_docs/namespaces/ts/functions/isExportAssignment.md new file mode 100644 index 0000000000000000000000000000000000000000..a0fffababd14b581b5c7d5f7de0bf70213ee4470 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isExportAssignment.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isExportAssignment + +# Function: isExportAssignment() + +> **isExportAssignment**(`node`): `node is ExportAssignment` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5141 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is ExportAssignment` diff --git a/docs/api_docs/namespaces/ts/functions/isExportDeclaration.md b/docs/api_docs/namespaces/ts/functions/isExportDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..d7fbf91d234b4eb844c30a0304f287a1ec911a1e --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isExportDeclaration.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isExportDeclaration + +# Function: isExportDeclaration() + +> **isExportDeclaration**(`node`): `node is ExportDeclaration` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5142 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is ExportDeclaration` diff --git a/docs/api_docs/namespaces/ts/functions/isExportSpecifier.md b/docs/api_docs/namespaces/ts/functions/isExportSpecifier.md new file mode 100644 index 0000000000000000000000000000000000000000..22a268e8d5f4bb56dd4ac7d60a0885b4b5df6197 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isExportSpecifier.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isExportSpecifier + +# Function: isExportSpecifier() + +> **isExportSpecifier**(`node`): `node is ExportSpecifier` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5144 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is ExportSpecifier` diff --git a/docs/api_docs/namespaces/ts/functions/isExpressionStatement.md b/docs/api_docs/namespaces/ts/functions/isExpressionStatement.md new file mode 100644 index 0000000000000000000000000000000000000000..cab6d08d5692fd36d6253efd91bcbaa9f49fb02d --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isExpressionStatement.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isExpressionStatement + +# Function: isExpressionStatement() + +> **isExpressionStatement**(`node`): `node is ExpressionStatement` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5103 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is ExpressionStatement` diff --git a/docs/api_docs/namespaces/ts/functions/isExpressionWithTypeArguments.md b/docs/api_docs/namespaces/ts/functions/isExpressionWithTypeArguments.md new file mode 100644 index 0000000000000000000000000000000000000000..1e59bbb694538f737f592dc86f506bb29cbc4363 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isExpressionWithTypeArguments.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isExpressionWithTypeArguments + +# Function: isExpressionWithTypeArguments() + +> **isExpressionWithTypeArguments**(`node`): `node is ExpressionWithTypeArguments` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5090 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is ExpressionWithTypeArguments` diff --git a/docs/api_docs/namespaces/ts/functions/isExternalModule.md b/docs/api_docs/namespaces/ts/functions/isExternalModule.md new file mode 100644 index 0000000000000000000000000000000000000000..b5888a67302501f99714ddf4125987fc43051bf0 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isExternalModule.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isExternalModule + +# Function: isExternalModule() + +> **isExternalModule**(`file`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5253 + +## Parameters + +### file + +[`SourceFile`](../interfaces/SourceFile.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/functions/isExternalModuleNameRelative.md b/docs/api_docs/namespaces/ts/functions/isExternalModuleNameRelative.md new file mode 100644 index 0000000000000000000000000000000000000000..aecd2fa966082ef28fb51ffd4b098b1571b79e64 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isExternalModuleNameRelative.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isExternalModuleNameRelative + +# Function: isExternalModuleNameRelative() + +> **isExternalModuleNameRelative**(`moduleName`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4637 + +## Parameters + +### moduleName + +`string` + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/functions/isExternalModuleReference.md b/docs/api_docs/namespaces/ts/functions/isExternalModuleReference.md new file mode 100644 index 0000000000000000000000000000000000000000..1df27f4b02931d93a7bea8540e471858fc947589 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isExternalModuleReference.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isExternalModuleReference + +# Function: isExternalModuleReference() + +> **isExternalModuleReference**(`node`): `node is ExternalModuleReference` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5147 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is ExternalModuleReference` diff --git a/docs/api_docs/namespaces/ts/functions/isForInStatement.md b/docs/api_docs/namespaces/ts/functions/isForInStatement.md new file mode 100644 index 0000000000000000000000000000000000000000..bc09791d148e5843b8bf914531da36dbabe1e9ad --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isForInStatement.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isForInStatement + +# Function: isForInStatement() + +> **isForInStatement**(`node`): `node is ForInStatement` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5108 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is ForInStatement` diff --git a/docs/api_docs/namespaces/ts/functions/isForOfStatement.md b/docs/api_docs/namespaces/ts/functions/isForOfStatement.md new file mode 100644 index 0000000000000000000000000000000000000000..a7f421b9baad2d0355397b4a69e9af4e3f324164 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isForOfStatement.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isForOfStatement + +# Function: isForOfStatement() + +> **isForOfStatement**(`node`): `node is ForOfStatement` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5109 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is ForOfStatement` diff --git a/docs/api_docs/namespaces/ts/functions/isForStatement.md b/docs/api_docs/namespaces/ts/functions/isForStatement.md new file mode 100644 index 0000000000000000000000000000000000000000..b1e3fb88ce8566297f302b423b8d7da7d1f74aa4 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isForStatement.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isForStatement + +# Function: isForStatement() + +> **isForStatement**(`node`): `node is ForStatement` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5107 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is ForStatement` diff --git a/docs/api_docs/namespaces/ts/functions/isFunctionDeclaration.md b/docs/api_docs/namespaces/ts/functions/isFunctionDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..f751d77174eb992457a3dc2a4eea4cf1317af04f --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isFunctionDeclaration.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isFunctionDeclaration + +# Function: isFunctionDeclaration() + +> **isFunctionDeclaration**(`node`): `node is FunctionDeclaration` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5121 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is FunctionDeclaration` diff --git a/docs/api_docs/namespaces/ts/functions/isFunctionExpression.md b/docs/api_docs/namespaces/ts/functions/isFunctionExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..36da9c8b191f2b837282403188b252eabea593af --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isFunctionExpression.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isFunctionExpression + +# Function: isFunctionExpression() + +> **isFunctionExpression**(`node`): `node is FunctionExpression` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5074 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is FunctionExpression` diff --git a/docs/api_docs/namespaces/ts/functions/isFunctionLike.md b/docs/api_docs/namespaces/ts/functions/isFunctionLike.md new file mode 100644 index 0000000000000000000000000000000000000000..67ee67919a0ad3bb7807aecca59275bb96f07c55 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isFunctionLike.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isFunctionLike + +# Function: isFunctionLike() + +> **isFunctionLike**(`node`): `node is SignatureDeclaration` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4872 + +## Parameters + +### node + +`undefined` | [`Node`](../interfaces/Node.md) + +## Returns + +`node is SignatureDeclaration` diff --git a/docs/api_docs/namespaces/ts/functions/isFunctionOrConstructorTypeNode.md b/docs/api_docs/namespaces/ts/functions/isFunctionOrConstructorTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..921438dc228dcb9750c779996c7624e67c8fd177 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isFunctionOrConstructorTypeNode.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isFunctionOrConstructorTypeNode + +# Function: isFunctionOrConstructorTypeNode() + +> **isFunctionOrConstructorTypeNode**(`node`): node is FunctionTypeNode \| ConstructorTypeNode + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4888 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +node is FunctionTypeNode \| ConstructorTypeNode diff --git a/docs/api_docs/namespaces/ts/functions/isFunctionTypeNode.md b/docs/api_docs/namespaces/ts/functions/isFunctionTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..1853be5650e8a2c95cd603969ac821a633a1f17d --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isFunctionTypeNode.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isFunctionTypeNode + +# Function: isFunctionTypeNode() + +> **isFunctionTypeNode**(`node`): `node is FunctionTypeNode` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5040 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is FunctionTypeNode` diff --git a/docs/api_docs/namespaces/ts/functions/isGetAccessor.md b/docs/api_docs/namespaces/ts/functions/isGetAccessor.md new file mode 100644 index 0000000000000000000000000000000000000000..50a6a014b3f909b23b1eeb63f56b319b2c28b824 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isGetAccessor.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isGetAccessor + +# Function: isGetAccessor() + +> **isGetAccessor**(`node`): `node is GetAccessorDeclaration` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4901 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is GetAccessorDeclaration` diff --git a/docs/api_docs/namespaces/ts/functions/isGetAccessorDeclaration.md b/docs/api_docs/namespaces/ts/functions/isGetAccessorDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..28cf75eb3056822ee4668218462d3b09d041fb78 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isGetAccessorDeclaration.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isGetAccessorDeclaration + +# Function: isGetAccessorDeclaration() + +> **isGetAccessorDeclaration**(`node`): `node is GetAccessorDeclaration` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5033 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is GetAccessorDeclaration` diff --git a/docs/api_docs/namespaces/ts/functions/isHeritageClause.md b/docs/api_docs/namespaces/ts/functions/isHeritageClause.md new file mode 100644 index 0000000000000000000000000000000000000000..1a007af4a8312076301a3e53efee4a50fa0fe14b --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isHeritageClause.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isHeritageClause + +# Function: isHeritageClause() + +> **isHeritageClause**(`node`): `node is HeritageClause` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5161 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is HeritageClause` diff --git a/docs/api_docs/namespaces/ts/functions/isIdentifier.md b/docs/api_docs/namespaces/ts/functions/isIdentifier.md new file mode 100644 index 0000000000000000000000000000000000000000..bd75abc2cf2522070cb99ea1ba5695fb267b2ada --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isIdentifier.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isIdentifier + +# Function: isIdentifier() + +> **isIdentifier**(`node`): `node is Identifier` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5020 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is Identifier` diff --git a/docs/api_docs/namespaces/ts/functions/isIdentifierOrPrivateIdentifier.md b/docs/api_docs/namespaces/ts/functions/isIdentifierOrPrivateIdentifier.md new file mode 100644 index 0000000000000000000000000000000000000000..c86cb4439acc8cb9811284f987633a142f99c2f2 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isIdentifierOrPrivateIdentifier.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isIdentifierOrPrivateIdentifier + +# Function: ~~isIdentifierOrPrivateIdentifier()~~ + +> **isIdentifierOrPrivateIdentifier**(`node`): `node is MemberName` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8336 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is MemberName` + +## Deprecated + +Use `isMemberName` instead. diff --git a/docs/api_docs/namespaces/ts/functions/isIdentifierPart.md b/docs/api_docs/namespaces/ts/functions/isIdentifierPart.md new file mode 100644 index 0000000000000000000000000000000000000000..ce22c7b4cae94bfb6efbc88bf260e537a63b2b9e --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isIdentifierPart.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isIdentifierPart + +# Function: isIdentifierPart() + +> **isIdentifierPart**(`ch`, `languageVersion`, `identifierVariant`?): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4633 + +## Parameters + +### ch + +`number` + +### languageVersion + +`undefined` | [`ScriptTarget`](../enumerations/ScriptTarget.md) + +### identifierVariant? + +[`LanguageVariant`](../enumerations/LanguageVariant.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/functions/isIdentifierStart.md b/docs/api_docs/namespaces/ts/functions/isIdentifierStart.md new file mode 100644 index 0000000000000000000000000000000000000000..21ef113c26ad5a1df985dc3717fce0e92f0f0ea9 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isIdentifierStart.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isIdentifierStart + +# Function: isIdentifierStart() + +> **isIdentifierStart**(`ch`, `languageVersion`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4632 + +## Parameters + +### ch + +`number` + +### languageVersion + +`undefined` | [`ScriptTarget`](../enumerations/ScriptTarget.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/functions/isIfStatement.md b/docs/api_docs/namespaces/ts/functions/isIfStatement.md new file mode 100644 index 0000000000000000000000000000000000000000..0adb617eb5da58e51b0bcb82d9d728977c1f29cd --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isIfStatement.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isIfStatement + +# Function: isIfStatement() + +> **isIfStatement**(`node`): `node is IfStatement` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5104 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is IfStatement` diff --git a/docs/api_docs/namespaces/ts/functions/isImportClause.md b/docs/api_docs/namespaces/ts/functions/isImportClause.md new file mode 100644 index 0000000000000000000000000000000000000000..199edcfc3351bf3bed7489905cd86c69ee213ae7 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isImportClause.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isImportClause + +# Function: isImportClause() + +> **isImportClause**(`node`): `node is ImportClause` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5133 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is ImportClause` diff --git a/docs/api_docs/namespaces/ts/functions/isImportDeclaration.md b/docs/api_docs/namespaces/ts/functions/isImportDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..aaddec7a8442d9f7330a94b7c892f8c325614c25 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isImportDeclaration.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isImportDeclaration + +# Function: isImportDeclaration() + +> **isImportDeclaration**(`node`): `node is ImportDeclaration` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5132 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is ImportDeclaration` diff --git a/docs/api_docs/namespaces/ts/functions/isImportEqualsDeclaration.md b/docs/api_docs/namespaces/ts/functions/isImportEqualsDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..d2478597f13bf652f7ddcb3f09353b290e6e4ac4 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isImportEqualsDeclaration.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isImportEqualsDeclaration + +# Function: isImportEqualsDeclaration() + +> **isImportEqualsDeclaration**(`node`): `node is ImportEqualsDeclaration` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5131 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is ImportEqualsDeclaration` diff --git a/docs/api_docs/namespaces/ts/functions/isImportOrExportSpecifier.md b/docs/api_docs/namespaces/ts/functions/isImportOrExportSpecifier.md new file mode 100644 index 0000000000000000000000000000000000000000..311d1bfcee808d4c761f706bcb5fe780304428b5 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isImportOrExportSpecifier.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isImportOrExportSpecifier + +# Function: isImportOrExportSpecifier() + +> **isImportOrExportSpecifier**(`node`): node is ExportSpecifier \| ImportSpecifier + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4864 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +node is ExportSpecifier \| ImportSpecifier diff --git a/docs/api_docs/namespaces/ts/functions/isImportSpecifier.md b/docs/api_docs/namespaces/ts/functions/isImportSpecifier.md new file mode 100644 index 0000000000000000000000000000000000000000..eb67981a0af1b90b3c430bacdd8a203d453a9989 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isImportSpecifier.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isImportSpecifier + +# Function: isImportSpecifier() + +> **isImportSpecifier**(`node`): `node is ImportSpecifier` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5140 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is ImportSpecifier` diff --git a/docs/api_docs/namespaces/ts/functions/isImportTypeAssertionContainer.md b/docs/api_docs/namespaces/ts/functions/isImportTypeAssertionContainer.md new file mode 100644 index 0000000000000000000000000000000000000000..7d17b1a728faa6a53c8752d8e37fa70135872d0b --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isImportTypeAssertionContainer.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isImportTypeAssertionContainer + +# Function: isImportTypeAssertionContainer() + +> **isImportTypeAssertionContainer**(`node`): `node is ImportTypeAssertionContainer` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5134 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is ImportTypeAssertionContainer` diff --git a/docs/api_docs/namespaces/ts/functions/isImportTypeNode.md b/docs/api_docs/namespaces/ts/functions/isImportTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..11bb0f1d676868eef65486cf1b6bd3f258b6b182 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isImportTypeNode.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isImportTypeNode + +# Function: isImportTypeNode() + +> **isImportTypeNode**(`node`): `node is ImportTypeNode` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5059 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is ImportTypeNode` diff --git a/docs/api_docs/namespaces/ts/functions/isIndexSignatureDeclaration.md b/docs/api_docs/namespaces/ts/functions/isIndexSignatureDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..e29e600245495a4ec26d590c46ea24c0398b4d6d --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isIndexSignatureDeclaration.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isIndexSignatureDeclaration + +# Function: isIndexSignatureDeclaration() + +> **isIndexSignatureDeclaration**(`node`): `node is IndexSignatureDeclaration` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5037 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is IndexSignatureDeclaration` diff --git a/docs/api_docs/namespaces/ts/functions/isIndexedAccessTypeNode.md b/docs/api_docs/namespaces/ts/functions/isIndexedAccessTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..d2f2028a5bdbe1b38d82f1f94a7a8ad43ed1bad8 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isIndexedAccessTypeNode.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isIndexedAccessTypeNode + +# Function: isIndexedAccessTypeNode() + +> **isIndexedAccessTypeNode**(`node`): `node is IndexedAccessTypeNode` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5056 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is IndexedAccessTypeNode` diff --git a/docs/api_docs/namespaces/ts/functions/isInferTypeNode.md b/docs/api_docs/namespaces/ts/functions/isInferTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..b304487fbdbf8a449a3fb9b1be995a45ae13deb5 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isInferTypeNode.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isInferTypeNode + +# Function: isInferTypeNode() + +> **isInferTypeNode**(`node`): `node is InferTypeNode` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5052 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is InferTypeNode` diff --git a/docs/api_docs/namespaces/ts/functions/isInterfaceDeclaration.md b/docs/api_docs/namespaces/ts/functions/isInterfaceDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..782847fb6cd3e6193651367000910f105414440e --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isInterfaceDeclaration.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isInterfaceDeclaration + +# Function: isInterfaceDeclaration() + +> **isInterfaceDeclaration**(`node`): `node is InterfaceDeclaration` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5124 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is InterfaceDeclaration` diff --git a/docs/api_docs/namespaces/ts/functions/isIntersectionTypeNode.md b/docs/api_docs/namespaces/ts/functions/isIntersectionTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..1c98203befc6b86b3ef29febee3e4fa972906349 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isIntersectionTypeNode.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isIntersectionTypeNode + +# Function: isIntersectionTypeNode() + +> **isIntersectionTypeNode**(`node`): `node is IntersectionTypeNode` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5050 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is IntersectionTypeNode` diff --git a/docs/api_docs/namespaces/ts/functions/isIterationStatement.md b/docs/api_docs/namespaces/ts/functions/isIterationStatement.md new file mode 100644 index 0000000000000000000000000000000000000000..bbd0370fb6b81382e25532693a7f69e67d7479c9 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isIterationStatement.md @@ -0,0 +1,47 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isIterationStatement + +# Function: isIterationStatement() + +## Call Signature + +> **isIterationStatement**(`node`, `lookInLabeledStatements`): `node is IterationStatement` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4894 + +### Parameters + +#### node + +[`Node`](../interfaces/Node.md) + +#### lookInLabeledStatements + +`false` + +### Returns + +`node is IterationStatement` + +## Call Signature + +> **isIterationStatement**(`node`, `lookInLabeledStatements`): node is IterationStatement \| LabeledStatement + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4895 + +### Parameters + +#### node + +[`Node`](../interfaces/Node.md) + +#### lookInLabeledStatements + +`boolean` + +### Returns + +node is IterationStatement \| LabeledStatement diff --git a/docs/api_docs/namespaces/ts/functions/isJSDoc.md b/docs/api_docs/namespaces/ts/functions/isJSDoc.md new file mode 100644 index 0000000000000000000000000000000000000000..dddcec16dbe726a92442d115a80cc4685ba04ad6 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isJSDoc.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isJSDoc + +# Function: isJSDoc() + +> **isJSDoc**(`node`): `node is JSDoc` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5185 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is JSDoc` diff --git a/docs/api_docs/namespaces/ts/functions/isJSDocAllType.md b/docs/api_docs/namespaces/ts/functions/isJSDocAllType.md new file mode 100644 index 0000000000000000000000000000000000000000..b7768230c510f3af3385e3629164c10a08bf419e --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isJSDocAllType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isJSDocAllType + +# Function: isJSDocAllType() + +> **isJSDocAllType**(`node`): `node is JSDocAllType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5177 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is JSDocAllType` diff --git a/docs/api_docs/namespaces/ts/functions/isJSDocAugmentsTag.md b/docs/api_docs/namespaces/ts/functions/isJSDocAugmentsTag.md new file mode 100644 index 0000000000000000000000000000000000000000..68a51dde01ca2c3e9482f2b313cf363f8b850b3b --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isJSDocAugmentsTag.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isJSDocAugmentsTag + +# Function: isJSDocAugmentsTag() + +> **isJSDocAugmentsTag**(`node`): `node is JSDocAugmentsTag` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5188 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is JSDocAugmentsTag` diff --git a/docs/api_docs/namespaces/ts/functions/isJSDocAuthorTag.md b/docs/api_docs/namespaces/ts/functions/isJSDocAuthorTag.md new file mode 100644 index 0000000000000000000000000000000000000000..28a0f47a21055d8126870ad4c852e4af19009a14 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isJSDocAuthorTag.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isJSDocAuthorTag + +# Function: isJSDocAuthorTag() + +> **isJSDocAuthorTag**(`node`): `node is JSDocAuthorTag` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5189 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is JSDocAuthorTag` diff --git a/docs/api_docs/namespaces/ts/functions/isJSDocCallbackTag.md b/docs/api_docs/namespaces/ts/functions/isJSDocCallbackTag.md new file mode 100644 index 0000000000000000000000000000000000000000..d92577bb88e269253f7677425b577273bb99ed26 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isJSDocCallbackTag.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isJSDocCallbackTag + +# Function: isJSDocCallbackTag() + +> **isJSDocCallbackTag**(`node`): `node is JSDocCallbackTag` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5191 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is JSDocCallbackTag` diff --git a/docs/api_docs/namespaces/ts/functions/isJSDocClassTag.md b/docs/api_docs/namespaces/ts/functions/isJSDocClassTag.md new file mode 100644 index 0000000000000000000000000000000000000000..f2208984d08b68d92250013362a8a2b94babe4f0 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isJSDocClassTag.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isJSDocClassTag + +# Function: isJSDocClassTag() + +> **isJSDocClassTag**(`node`): `node is JSDocClassTag` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5190 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is JSDocClassTag` diff --git a/docs/api_docs/namespaces/ts/functions/isJSDocCommentContainingNode.md b/docs/api_docs/namespaces/ts/functions/isJSDocCommentContainingNode.md new file mode 100644 index 0000000000000000000000000000000000000000..b23faafd0f25361d8cbad6fa6eaea0bdab5b1a07 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isJSDocCommentContainingNode.md @@ -0,0 +1,23 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isJSDocCommentContainingNode + +# Function: isJSDocCommentContainingNode() + +> **isJSDocCommentContainingNode**(`node`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4899 + +True if node is of a kind that may contain comment text. + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/functions/isJSDocDeprecatedTag.md b/docs/api_docs/namespaces/ts/functions/isJSDocDeprecatedTag.md new file mode 100644 index 0000000000000000000000000000000000000000..60f5b76da2adff31e02e73a455b9b15cfe9d626b --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isJSDocDeprecatedTag.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isJSDocDeprecatedTag + +# Function: isJSDocDeprecatedTag() + +> **isJSDocDeprecatedTag**(`node`): `node is JSDocDeprecatedTag` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5197 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is JSDocDeprecatedTag` diff --git a/docs/api_docs/namespaces/ts/functions/isJSDocEnumTag.md b/docs/api_docs/namespaces/ts/functions/isJSDocEnumTag.md new file mode 100644 index 0000000000000000000000000000000000000000..c158ddd3077a251b510e99afa77cc18d163489f9 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isJSDocEnumTag.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isJSDocEnumTag + +# Function: isJSDocEnumTag() + +> **isJSDocEnumTag**(`node`): `node is JSDocEnumTag` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5199 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is JSDocEnumTag` diff --git a/docs/api_docs/namespaces/ts/functions/isJSDocFunctionType.md b/docs/api_docs/namespaces/ts/functions/isJSDocFunctionType.md new file mode 100644 index 0000000000000000000000000000000000000000..ef9d812d3087e472328e6a9f5af2a0c2d7ded62b --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isJSDocFunctionType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isJSDocFunctionType + +# Function: isJSDocFunctionType() + +> **isJSDocFunctionType**(`node`): `node is JSDocFunctionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5182 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is JSDocFunctionType` diff --git a/docs/api_docs/namespaces/ts/functions/isJSDocImplementsTag.md b/docs/api_docs/namespaces/ts/functions/isJSDocImplementsTag.md new file mode 100644 index 0000000000000000000000000000000000000000..84ec94573db4790e1fb79999370ca61f0dd38051 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isJSDocImplementsTag.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isJSDocImplementsTag + +# Function: isJSDocImplementsTag() + +> **isJSDocImplementsTag**(`node`): `node is JSDocImplementsTag` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5208 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is JSDocImplementsTag` diff --git a/docs/api_docs/namespaces/ts/functions/isJSDocLink.md b/docs/api_docs/namespaces/ts/functions/isJSDocLink.md new file mode 100644 index 0000000000000000000000000000000000000000..af162a0bacda8ac95568825c008382e753b62dc5 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isJSDocLink.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isJSDocLink + +# Function: isJSDocLink() + +> **isJSDocLink**(`node`): `node is JSDocLink` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5174 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is JSDocLink` diff --git a/docs/api_docs/namespaces/ts/functions/isJSDocLinkCode.md b/docs/api_docs/namespaces/ts/functions/isJSDocLinkCode.md new file mode 100644 index 0000000000000000000000000000000000000000..50e96e0a720eda9820e937cecefb4fa8a5caaf8c --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isJSDocLinkCode.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isJSDocLinkCode + +# Function: isJSDocLinkCode() + +> **isJSDocLinkCode**(`node`): `node is JSDocLinkCode` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5175 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is JSDocLinkCode` diff --git a/docs/api_docs/namespaces/ts/functions/isJSDocLinkLike.md b/docs/api_docs/namespaces/ts/functions/isJSDocLinkLike.md new file mode 100644 index 0000000000000000000000000000000000000000..0ca76c4e6ad5cf630f46ebf4943e1e03bdc904be --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isJSDocLinkLike.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isJSDocLinkLike + +# Function: isJSDocLinkLike() + +> **isJSDocLinkLike**(`node`): node is JSDocLink \| JSDocLinkCode \| JSDocLinkPlain + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4906 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +node is JSDocLink \| JSDocLinkCode \| JSDocLinkPlain diff --git a/docs/api_docs/namespaces/ts/functions/isJSDocLinkPlain.md b/docs/api_docs/namespaces/ts/functions/isJSDocLinkPlain.md new file mode 100644 index 0000000000000000000000000000000000000000..013860843c779afe80717d0bb44f0899a36c499c --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isJSDocLinkPlain.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isJSDocLinkPlain + +# Function: isJSDocLinkPlain() + +> **isJSDocLinkPlain**(`node`): `node is JSDocLinkPlain` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5176 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is JSDocLinkPlain` diff --git a/docs/api_docs/namespaces/ts/functions/isJSDocMemberName.md b/docs/api_docs/namespaces/ts/functions/isJSDocMemberName.md new file mode 100644 index 0000000000000000000000000000000000000000..a7b8ea3aad6e0950bc65935fc9a22bb6fdce6957 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isJSDocMemberName.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isJSDocMemberName + +# Function: isJSDocMemberName() + +> **isJSDocMemberName**(`node`): `node is JSDocMemberName` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5173 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is JSDocMemberName` diff --git a/docs/api_docs/namespaces/ts/functions/isJSDocNameReference.md b/docs/api_docs/namespaces/ts/functions/isJSDocNameReference.md new file mode 100644 index 0000000000000000000000000000000000000000..d2675d54aa71c814c5d616218911fc2e11868f35 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isJSDocNameReference.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isJSDocNameReference + +# Function: isJSDocNameReference() + +> **isJSDocNameReference**(`node`): `node is JSDocNameReference` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5172 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is JSDocNameReference` diff --git a/docs/api_docs/namespaces/ts/functions/isJSDocNamepathType.md b/docs/api_docs/namespaces/ts/functions/isJSDocNamepathType.md new file mode 100644 index 0000000000000000000000000000000000000000..3199d0888d5e31fa39b90fd743667b9a3f72c8ff --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isJSDocNamepathType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isJSDocNamepathType + +# Function: isJSDocNamepathType() + +> **isJSDocNamepathType**(`node`): `node is JSDocNamepathType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5184 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is JSDocNamepathType` diff --git a/docs/api_docs/namespaces/ts/functions/isJSDocNonNullableType.md b/docs/api_docs/namespaces/ts/functions/isJSDocNonNullableType.md new file mode 100644 index 0000000000000000000000000000000000000000..be5122b7d771751d030a5000e6bf4c392de5be38 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isJSDocNonNullableType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isJSDocNonNullableType + +# Function: isJSDocNonNullableType() + +> **isJSDocNonNullableType**(`node`): `node is JSDocNonNullableType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5180 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is JSDocNonNullableType` diff --git a/docs/api_docs/namespaces/ts/functions/isJSDocNullableType.md b/docs/api_docs/namespaces/ts/functions/isJSDocNullableType.md new file mode 100644 index 0000000000000000000000000000000000000000..34d8d32fe4d7d1aab1982f7fef09aa585c3ef73b --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isJSDocNullableType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isJSDocNullableType + +# Function: isJSDocNullableType() + +> **isJSDocNullableType**(`node`): `node is JSDocNullableType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5179 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is JSDocNullableType` diff --git a/docs/api_docs/namespaces/ts/functions/isJSDocOptionalType.md b/docs/api_docs/namespaces/ts/functions/isJSDocOptionalType.md new file mode 100644 index 0000000000000000000000000000000000000000..4e6f70f02cdeba79e2bba25c7fe3ce5f63e15374 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isJSDocOptionalType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isJSDocOptionalType + +# Function: isJSDocOptionalType() + +> **isJSDocOptionalType**(`node`): `node is JSDocOptionalType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5181 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is JSDocOptionalType` diff --git a/docs/api_docs/namespaces/ts/functions/isJSDocOverrideTag.md b/docs/api_docs/namespaces/ts/functions/isJSDocOverrideTag.md new file mode 100644 index 0000000000000000000000000000000000000000..bbf613948200141ba7116818e5c38ce1304224eb --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isJSDocOverrideTag.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isJSDocOverrideTag + +# Function: isJSDocOverrideTag() + +> **isJSDocOverrideTag**(`node`): `node is JSDocOverrideTag` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5196 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is JSDocOverrideTag` diff --git a/docs/api_docs/namespaces/ts/functions/isJSDocParameterTag.md b/docs/api_docs/namespaces/ts/functions/isJSDocParameterTag.md new file mode 100644 index 0000000000000000000000000000000000000000..6ab81abdc5895fd64664fedf15220e70325e28e3 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isJSDocParameterTag.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isJSDocParameterTag + +# Function: isJSDocParameterTag() + +> **isJSDocParameterTag**(`node`): `node is JSDocParameterTag` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5200 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is JSDocParameterTag` diff --git a/docs/api_docs/namespaces/ts/functions/isJSDocPrivateTag.md b/docs/api_docs/namespaces/ts/functions/isJSDocPrivateTag.md new file mode 100644 index 0000000000000000000000000000000000000000..50b4a2a6ed02850890f1f7c72517fd4ad038b0a4 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isJSDocPrivateTag.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isJSDocPrivateTag + +# Function: isJSDocPrivateTag() + +> **isJSDocPrivateTag**(`node`): `node is JSDocPrivateTag` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5193 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is JSDocPrivateTag` diff --git a/docs/api_docs/namespaces/ts/functions/isJSDocPropertyLikeTag.md b/docs/api_docs/namespaces/ts/functions/isJSDocPropertyLikeTag.md new file mode 100644 index 0000000000000000000000000000000000000000..a12334dea17991eb95b720324a62c563c6818cea --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isJSDocPropertyLikeTag.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isJSDocPropertyLikeTag + +# Function: isJSDocPropertyLikeTag() + +> **isJSDocPropertyLikeTag**(`node`): `node is JSDocPropertyLikeTag` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4848 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is JSDocPropertyLikeTag` diff --git a/docs/api_docs/namespaces/ts/functions/isJSDocPropertyTag.md b/docs/api_docs/namespaces/ts/functions/isJSDocPropertyTag.md new file mode 100644 index 0000000000000000000000000000000000000000..db6e3bf6797e933856049d4b6e761a5f399cfabc --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isJSDocPropertyTag.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isJSDocPropertyTag + +# Function: isJSDocPropertyTag() + +> **isJSDocPropertyTag**(`node`): `node is JSDocPropertyTag` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5207 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is JSDocPropertyTag` diff --git a/docs/api_docs/namespaces/ts/functions/isJSDocProtectedTag.md b/docs/api_docs/namespaces/ts/functions/isJSDocProtectedTag.md new file mode 100644 index 0000000000000000000000000000000000000000..f5e7608779b63ad20746fd75d465ab9a2e0402e7 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isJSDocProtectedTag.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isJSDocProtectedTag + +# Function: isJSDocProtectedTag() + +> **isJSDocProtectedTag**(`node`): `node is JSDocProtectedTag` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5194 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is JSDocProtectedTag` diff --git a/docs/api_docs/namespaces/ts/functions/isJSDocPublicTag.md b/docs/api_docs/namespaces/ts/functions/isJSDocPublicTag.md new file mode 100644 index 0000000000000000000000000000000000000000..32609162ea49ba4c3b4a8dd2b829f350f1f03d13 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isJSDocPublicTag.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isJSDocPublicTag + +# Function: isJSDocPublicTag() + +> **isJSDocPublicTag**(`node`): `node is JSDocPublicTag` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5192 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is JSDocPublicTag` diff --git a/docs/api_docs/namespaces/ts/functions/isJSDocReadonlyTag.md b/docs/api_docs/namespaces/ts/functions/isJSDocReadonlyTag.md new file mode 100644 index 0000000000000000000000000000000000000000..e1bada94d69158cd0be04c8b36b35aec0bcb4967 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isJSDocReadonlyTag.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isJSDocReadonlyTag + +# Function: isJSDocReadonlyTag() + +> **isJSDocReadonlyTag**(`node`): `node is JSDocReadonlyTag` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5195 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is JSDocReadonlyTag` diff --git a/docs/api_docs/namespaces/ts/functions/isJSDocReturnTag.md b/docs/api_docs/namespaces/ts/functions/isJSDocReturnTag.md new file mode 100644 index 0000000000000000000000000000000000000000..2174f5e32dc0000a119a1c6d37ac9a34ee5610a4 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isJSDocReturnTag.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isJSDocReturnTag + +# Function: isJSDocReturnTag() + +> **isJSDocReturnTag**(`node`): `node is JSDocReturnTag` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5201 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is JSDocReturnTag` diff --git a/docs/api_docs/namespaces/ts/functions/isJSDocSeeTag.md b/docs/api_docs/namespaces/ts/functions/isJSDocSeeTag.md new file mode 100644 index 0000000000000000000000000000000000000000..b79e06adfc4d059528590e358879d98e2b0c7732 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isJSDocSeeTag.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isJSDocSeeTag + +# Function: isJSDocSeeTag() + +> **isJSDocSeeTag**(`node`): `node is JSDocSeeTag` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5198 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is JSDocSeeTag` diff --git a/docs/api_docs/namespaces/ts/functions/isJSDocSignature.md b/docs/api_docs/namespaces/ts/functions/isJSDocSignature.md new file mode 100644 index 0000000000000000000000000000000000000000..90d580203f7731cb07a16720e03f63a7333cec4d --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isJSDocSignature.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isJSDocSignature + +# Function: isJSDocSignature() + +> **isJSDocSignature**(`node`): `node is JSDocSignature` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5187 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is JSDocSignature` diff --git a/docs/api_docs/namespaces/ts/functions/isJSDocTemplateTag.md b/docs/api_docs/namespaces/ts/functions/isJSDocTemplateTag.md new file mode 100644 index 0000000000000000000000000000000000000000..0fd1931dd485740f7431c425f1366536ba706508 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isJSDocTemplateTag.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isJSDocTemplateTag + +# Function: isJSDocTemplateTag() + +> **isJSDocTemplateTag**(`node`): `node is JSDocTemplateTag` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5204 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is JSDocTemplateTag` diff --git a/docs/api_docs/namespaces/ts/functions/isJSDocThisTag.md b/docs/api_docs/namespaces/ts/functions/isJSDocThisTag.md new file mode 100644 index 0000000000000000000000000000000000000000..301845609b391973c6f4713eba5568bc8cd5418d --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isJSDocThisTag.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isJSDocThisTag + +# Function: isJSDocThisTag() + +> **isJSDocThisTag**(`node`): `node is JSDocThisTag` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5202 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is JSDocThisTag` diff --git a/docs/api_docs/namespaces/ts/functions/isJSDocTypeExpression.md b/docs/api_docs/namespaces/ts/functions/isJSDocTypeExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..6dde672c93bb25cf6f12a982fbf3d494e10e69ba --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isJSDocTypeExpression.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isJSDocTypeExpression + +# Function: isJSDocTypeExpression() + +> **isJSDocTypeExpression**(`node`): `node is JSDocTypeExpression` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5171 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is JSDocTypeExpression` diff --git a/docs/api_docs/namespaces/ts/functions/isJSDocTypeLiteral.md b/docs/api_docs/namespaces/ts/functions/isJSDocTypeLiteral.md new file mode 100644 index 0000000000000000000000000000000000000000..2c42657f1321d64c090f7112468589a326d3f41d --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isJSDocTypeLiteral.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isJSDocTypeLiteral + +# Function: isJSDocTypeLiteral() + +> **isJSDocTypeLiteral**(`node`): `node is JSDocTypeLiteral` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5186 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is JSDocTypeLiteral` diff --git a/docs/api_docs/namespaces/ts/functions/isJSDocTypeTag.md b/docs/api_docs/namespaces/ts/functions/isJSDocTypeTag.md new file mode 100644 index 0000000000000000000000000000000000000000..e457cff2c54504d3f7641e05a25154735719032a --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isJSDocTypeTag.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isJSDocTypeTag + +# Function: isJSDocTypeTag() + +> **isJSDocTypeTag**(`node`): `node is JSDocTypeTag` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5203 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is JSDocTypeTag` diff --git a/docs/api_docs/namespaces/ts/functions/isJSDocTypedefTag.md b/docs/api_docs/namespaces/ts/functions/isJSDocTypedefTag.md new file mode 100644 index 0000000000000000000000000000000000000000..7b674c2991f4173bb724a7da0ef69a00b6aca1ea --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isJSDocTypedefTag.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isJSDocTypedefTag + +# Function: isJSDocTypedefTag() + +> **isJSDocTypedefTag**(`node`): `node is JSDocTypedefTag` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5205 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is JSDocTypedefTag` diff --git a/docs/api_docs/namespaces/ts/functions/isJSDocUnknownTag.md b/docs/api_docs/namespaces/ts/functions/isJSDocUnknownTag.md new file mode 100644 index 0000000000000000000000000000000000000000..c36232c6c52feccd0198496c48d8ab37e1e541ca --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isJSDocUnknownTag.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isJSDocUnknownTag + +# Function: isJSDocUnknownTag() + +> **isJSDocUnknownTag**(`node`): `node is JSDocUnknownTag` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5206 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is JSDocUnknownTag` diff --git a/docs/api_docs/namespaces/ts/functions/isJSDocUnknownType.md b/docs/api_docs/namespaces/ts/functions/isJSDocUnknownType.md new file mode 100644 index 0000000000000000000000000000000000000000..948ed166624fceaf26303f527a22b726932905ea --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isJSDocUnknownType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isJSDocUnknownType + +# Function: isJSDocUnknownType() + +> **isJSDocUnknownType**(`node`): `node is JSDocUnknownType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5178 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is JSDocUnknownType` diff --git a/docs/api_docs/namespaces/ts/functions/isJSDocVariadicType.md b/docs/api_docs/namespaces/ts/functions/isJSDocVariadicType.md new file mode 100644 index 0000000000000000000000000000000000000000..9c660ec1b529231de91f33b111d345426240f6a5 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isJSDocVariadicType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isJSDocVariadicType + +# Function: isJSDocVariadicType() + +> **isJSDocVariadicType**(`node`): `node is JSDocVariadicType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5183 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is JSDocVariadicType` diff --git a/docs/api_docs/namespaces/ts/functions/isJsxAttribute.md b/docs/api_docs/namespaces/ts/functions/isJsxAttribute.md new file mode 100644 index 0000000000000000000000000000000000000000..5020da8e35fa5f5507feeca1dda7581a476ce737 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isJsxAttribute.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isJsxAttribute + +# Function: isJsxAttribute() + +> **isJsxAttribute**(`node`): `node is JsxAttribute` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5155 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is JsxAttribute` diff --git a/docs/api_docs/namespaces/ts/functions/isJsxAttributes.md b/docs/api_docs/namespaces/ts/functions/isJsxAttributes.md new file mode 100644 index 0000000000000000000000000000000000000000..e5a4ff2840d5f64fc609cb0ef9b6ad82538c92af --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isJsxAttributes.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isJsxAttributes + +# Function: isJsxAttributes() + +> **isJsxAttributes**(`node`): `node is JsxAttributes` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5156 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is JsxAttributes` diff --git a/docs/api_docs/namespaces/ts/functions/isJsxClosingElement.md b/docs/api_docs/namespaces/ts/functions/isJsxClosingElement.md new file mode 100644 index 0000000000000000000000000000000000000000..8687370ff3c60098cecff19dbecca0fc06c331a1 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isJsxClosingElement.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isJsxClosingElement + +# Function: isJsxClosingElement() + +> **isJsxClosingElement**(`node`): `node is JsxClosingElement` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5151 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is JsxClosingElement` diff --git a/docs/api_docs/namespaces/ts/functions/isJsxClosingFragment.md b/docs/api_docs/namespaces/ts/functions/isJsxClosingFragment.md new file mode 100644 index 0000000000000000000000000000000000000000..46ddf00588652ad08f59f67d444458f5d2265092 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isJsxClosingFragment.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isJsxClosingFragment + +# Function: isJsxClosingFragment() + +> **isJsxClosingFragment**(`node`): `node is JsxClosingFragment` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5154 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is JsxClosingFragment` diff --git a/docs/api_docs/namespaces/ts/functions/isJsxElement.md b/docs/api_docs/namespaces/ts/functions/isJsxElement.md new file mode 100644 index 0000000000000000000000000000000000000000..91614d3cc6c42040592ede3f11ed491f3a85c543 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isJsxElement.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isJsxElement + +# Function: isJsxElement() + +> **isJsxElement**(`node`): `node is JsxElement` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5148 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is JsxElement` diff --git a/docs/api_docs/namespaces/ts/functions/isJsxExpression.md b/docs/api_docs/namespaces/ts/functions/isJsxExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..6523ac603ee7501bcdd538e2c6a8c1d3f203a169 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isJsxExpression.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isJsxExpression + +# Function: isJsxExpression() + +> **isJsxExpression**(`node`): `node is JsxExpression` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5158 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is JsxExpression` diff --git a/docs/api_docs/namespaces/ts/functions/isJsxFragment.md b/docs/api_docs/namespaces/ts/functions/isJsxFragment.md new file mode 100644 index 0000000000000000000000000000000000000000..25c2d10818ff15ed11e8b8f3748d178de73723ce --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isJsxFragment.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isJsxFragment + +# Function: isJsxFragment() + +> **isJsxFragment**(`node`): `node is JsxFragment` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5152 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is JsxFragment` diff --git a/docs/api_docs/namespaces/ts/functions/isJsxOpeningElement.md b/docs/api_docs/namespaces/ts/functions/isJsxOpeningElement.md new file mode 100644 index 0000000000000000000000000000000000000000..b326e47be6709343ddd4e7b72e5a33a93b16d7a8 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isJsxOpeningElement.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isJsxOpeningElement + +# Function: isJsxOpeningElement() + +> **isJsxOpeningElement**(`node`): `node is JsxOpeningElement` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5150 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is JsxOpeningElement` diff --git a/docs/api_docs/namespaces/ts/functions/isJsxOpeningFragment.md b/docs/api_docs/namespaces/ts/functions/isJsxOpeningFragment.md new file mode 100644 index 0000000000000000000000000000000000000000..f9f338a3ee165c33e9fac21fabe89780c9075f65 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isJsxOpeningFragment.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isJsxOpeningFragment + +# Function: isJsxOpeningFragment() + +> **isJsxOpeningFragment**(`node`): `node is JsxOpeningFragment` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5153 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is JsxOpeningFragment` diff --git a/docs/api_docs/namespaces/ts/functions/isJsxOpeningLikeElement.md b/docs/api_docs/namespaces/ts/functions/isJsxOpeningLikeElement.md new file mode 100644 index 0000000000000000000000000000000000000000..1dfb4570e11829b3366da0aabc56f457d4d163db --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isJsxOpeningLikeElement.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isJsxOpeningLikeElement + +# Function: isJsxOpeningLikeElement() + +> **isJsxOpeningLikeElement**(`node`): `node is JsxOpeningLikeElement` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4896 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is JsxOpeningLikeElement` diff --git a/docs/api_docs/namespaces/ts/functions/isJsxSelfClosingElement.md b/docs/api_docs/namespaces/ts/functions/isJsxSelfClosingElement.md new file mode 100644 index 0000000000000000000000000000000000000000..8fb5c529c4ca9100055da558ac470245b5f45eef --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isJsxSelfClosingElement.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isJsxSelfClosingElement + +# Function: isJsxSelfClosingElement() + +> **isJsxSelfClosingElement**(`node`): `node is JsxSelfClosingElement` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5149 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is JsxSelfClosingElement` diff --git a/docs/api_docs/namespaces/ts/functions/isJsxSpreadAttribute.md b/docs/api_docs/namespaces/ts/functions/isJsxSpreadAttribute.md new file mode 100644 index 0000000000000000000000000000000000000000..e36eccb14a540ba68d292378417e9312f28d1a15 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isJsxSpreadAttribute.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isJsxSpreadAttribute + +# Function: isJsxSpreadAttribute() + +> **isJsxSpreadAttribute**(`node`): `node is JsxSpreadAttribute` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5157 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is JsxSpreadAttribute` diff --git a/docs/api_docs/namespaces/ts/functions/isJsxText.md b/docs/api_docs/namespaces/ts/functions/isJsxText.md new file mode 100644 index 0000000000000000000000000000000000000000..4ffbe3481c3d5dce3157783a641859f24ba2852f --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isJsxText.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isJsxText + +# Function: isJsxText() + +> **isJsxText**(`node`): `node is JsxText` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5010 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is JsxText` diff --git a/docs/api_docs/namespaces/ts/functions/isLabeledStatement.md b/docs/api_docs/namespaces/ts/functions/isLabeledStatement.md new file mode 100644 index 0000000000000000000000000000000000000000..6bf8234a166b98ae01c3bc026289324343b7fed2 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isLabeledStatement.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isLabeledStatement + +# Function: isLabeledStatement() + +> **isLabeledStatement**(`node`): `node is LabeledStatement` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5115 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is LabeledStatement` diff --git a/docs/api_docs/namespaces/ts/functions/isLineBreak.md b/docs/api_docs/namespaces/ts/functions/isLineBreak.md new file mode 100644 index 0000000000000000000000000000000000000000..52f4b5ec1557eb73b05a5a1e7f657ff07e35ae72 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isLineBreak.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isLineBreak + +# Function: isLineBreak() + +> **isLineBreak**(`ch`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4620 + +## Parameters + +### ch + +`number` + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/functions/isLiteralExpression.md b/docs/api_docs/namespaces/ts/functions/isLiteralExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..fcd7a9c162a8f587a1ef8e65a0550e30e0166ad1 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isLiteralExpression.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isLiteralExpression + +# Function: isLiteralExpression() + +> **isLiteralExpression**(`node`): `node is LiteralExpression` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4861 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is LiteralExpression` diff --git a/docs/api_docs/namespaces/ts/functions/isLiteralTypeNode.md b/docs/api_docs/namespaces/ts/functions/isLiteralTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..844ca4724b8825a5e56d031ca91fa170b576b398 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isLiteralTypeNode.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isLiteralTypeNode + +# Function: isLiteralTypeNode() + +> **isLiteralTypeNode**(`node`): `node is LiteralTypeNode` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5058 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is LiteralTypeNode` diff --git a/docs/api_docs/namespaces/ts/functions/isMappedTypeNode.md b/docs/api_docs/namespaces/ts/functions/isMappedTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..1262671f4b7c5bb3213ce698262b2349c928714b --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isMappedTypeNode.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isMappedTypeNode + +# Function: isMappedTypeNode() + +> **isMappedTypeNode**(`node`): `node is MappedTypeNode` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5057 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is MappedTypeNode` diff --git a/docs/api_docs/namespaces/ts/functions/isMemberName.md b/docs/api_docs/namespaces/ts/functions/isMemberName.md new file mode 100644 index 0000000000000000000000000000000000000000..481e50c8a19b90df5a0a1e39e0a8b90f6d7055da --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isMemberName.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isMemberName + +# Function: isMemberName() + +> **isMemberName**(`node`): `node is MemberName` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4834 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is MemberName` diff --git a/docs/api_docs/namespaces/ts/functions/isMetaProperty.md b/docs/api_docs/namespaces/ts/functions/isMetaProperty.md new file mode 100644 index 0000000000000000000000000000000000000000..7643aa1518adb6762c30186e355b48845cb901ad --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isMetaProperty.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isMetaProperty + +# Function: isMetaProperty() + +> **isMetaProperty**(`node`): `node is MetaProperty` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5094 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is MetaProperty` diff --git a/docs/api_docs/namespaces/ts/functions/isMethodDeclaration.md b/docs/api_docs/namespaces/ts/functions/isMethodDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..d48abf743fee0368280721a01bcfe0f86ad74fc1 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isMethodDeclaration.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isMethodDeclaration + +# Function: isMethodDeclaration() + +> **isMethodDeclaration**(`node`): `node is MethodDeclaration` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5030 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is MethodDeclaration` diff --git a/docs/api_docs/namespaces/ts/functions/isMethodSignature.md b/docs/api_docs/namespaces/ts/functions/isMethodSignature.md new file mode 100644 index 0000000000000000000000000000000000000000..9ac431afa7255e801e32e0ed55f82666e3767dc0 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isMethodSignature.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isMethodSignature + +# Function: isMethodSignature() + +> **isMethodSignature**(`node`): `node is MethodSignature` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5029 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is MethodSignature` diff --git a/docs/api_docs/namespaces/ts/functions/isMinusToken.md b/docs/api_docs/namespaces/ts/functions/isMinusToken.md new file mode 100644 index 0000000000000000000000000000000000000000..24f5d02015153eda783483e25e4b28a3a43daae5 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isMinusToken.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isMinusToken + +# Function: isMinusToken() + +> **isMinusToken**(`node`): `node is MinusToken` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5018 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is MinusToken` diff --git a/docs/api_docs/namespaces/ts/functions/isMissingDeclaration.md b/docs/api_docs/namespaces/ts/functions/isMissingDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..b2f7f251edabaab7a6c30abef971889a1a39f44f --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isMissingDeclaration.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isMissingDeclaration + +# Function: isMissingDeclaration() + +> **isMissingDeclaration**(`node`): `node is MissingDeclaration` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5145 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is MissingDeclaration` diff --git a/docs/api_docs/namespaces/ts/functions/isModifier.md b/docs/api_docs/namespaces/ts/functions/isModifier.md new file mode 100644 index 0000000000000000000000000000000000000000..a9cf8fa6d8e7779902995ae1908da5e65d8bd2cc --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isModifier.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isModifier + +# Function: isModifier() + +> **isModifier**(`node`): `node is Modifier` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4868 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is Modifier` diff --git a/docs/api_docs/namespaces/ts/functions/isModifierLike.md b/docs/api_docs/namespaces/ts/functions/isModifierLike.md new file mode 100644 index 0000000000000000000000000000000000000000..38648fddef766a6ddc42a4699ab299813a61a032 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isModifierLike.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isModifierLike + +# Function: isModifierLike() + +> **isModifierLike**(`node`): `node is ModifierLike` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4878 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is ModifierLike` diff --git a/docs/api_docs/namespaces/ts/functions/isModuleBlock.md b/docs/api_docs/namespaces/ts/functions/isModuleBlock.md new file mode 100644 index 0000000000000000000000000000000000000000..2273b2b4d5fe46f1e92dcf3add7d270a4d589fcd --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isModuleBlock.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isModuleBlock + +# Function: isModuleBlock() + +> **isModuleBlock**(`node`): `node is ModuleBlock` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5128 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is ModuleBlock` diff --git a/docs/api_docs/namespaces/ts/functions/isModuleDeclaration.md b/docs/api_docs/namespaces/ts/functions/isModuleDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..37abcd1f1cb2b6849dfb0cc94e47343b01dca447 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isModuleDeclaration.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isModuleDeclaration + +# Function: isModuleDeclaration() + +> **isModuleDeclaration**(`node`): `node is ModuleDeclaration` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5127 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is ModuleDeclaration` diff --git a/docs/api_docs/namespaces/ts/functions/isNamedExportBindings.md b/docs/api_docs/namespaces/ts/functions/isNamedExportBindings.md new file mode 100644 index 0000000000000000000000000000000000000000..57cb20f9500a96ddee2dd6bba454529b94757032 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isNamedExportBindings.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isNamedExportBindings + +# Function: isNamedExportBindings() + +> **isNamedExportBindings**(`node`): `node is NamedExportBindings` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4845 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is NamedExportBindings` diff --git a/docs/api_docs/namespaces/ts/functions/isNamedExports.md b/docs/api_docs/namespaces/ts/functions/isNamedExports.md new file mode 100644 index 0000000000000000000000000000000000000000..9b466eb65f6b95f4b09c7eec48b3d22269ecbd63 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isNamedExports.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isNamedExports + +# Function: isNamedExports() + +> **isNamedExports**(`node`): `node is NamedExports` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5143 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is NamedExports` diff --git a/docs/api_docs/namespaces/ts/functions/isNamedImports.md b/docs/api_docs/namespaces/ts/functions/isNamedImports.md new file mode 100644 index 0000000000000000000000000000000000000000..8e3bcdf833069a7cbfd04e5238558b2a4039deb5 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isNamedImports.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isNamedImports + +# Function: isNamedImports() + +> **isNamedImports**(`node`): `node is NamedImports` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5139 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is NamedImports` diff --git a/docs/api_docs/namespaces/ts/functions/isNamedTupleMember.md b/docs/api_docs/namespaces/ts/functions/isNamedTupleMember.md new file mode 100644 index 0000000000000000000000000000000000000000..9fdd6778d07b5827eafa818c9ae7f546b25d1377 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isNamedTupleMember.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isNamedTupleMember + +# Function: isNamedTupleMember() + +> **isNamedTupleMember**(`node`): `node is NamedTupleMember` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5046 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is NamedTupleMember` diff --git a/docs/api_docs/namespaces/ts/functions/isNamespaceExport.md b/docs/api_docs/namespaces/ts/functions/isNamespaceExport.md new file mode 100644 index 0000000000000000000000000000000000000000..f5350f1fd29f3a6f90168f5e4c1c9b55691eb409 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isNamespaceExport.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isNamespaceExport + +# Function: isNamespaceExport() + +> **isNamespaceExport**(`node`): `node is NamespaceExport` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5138 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is NamespaceExport` diff --git a/docs/api_docs/namespaces/ts/functions/isNamespaceExportDeclaration.md b/docs/api_docs/namespaces/ts/functions/isNamespaceExportDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..959642428dbc56b8331606b627eb8e352eadb5f4 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isNamespaceExportDeclaration.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isNamespaceExportDeclaration + +# Function: isNamespaceExportDeclaration() + +> **isNamespaceExportDeclaration**(`node`): `node is NamespaceExportDeclaration` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5130 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is NamespaceExportDeclaration` diff --git a/docs/api_docs/namespaces/ts/functions/isNamespaceImport.md b/docs/api_docs/namespaces/ts/functions/isNamespaceImport.md new file mode 100644 index 0000000000000000000000000000000000000000..09e110a5ed91a6c19b4a0cce5e13c82f55ca7d47 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isNamespaceImport.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isNamespaceImport + +# Function: isNamespaceImport() + +> **isNamespaceImport**(`node`): `node is NamespaceImport` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5137 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is NamespaceImport` diff --git a/docs/api_docs/namespaces/ts/functions/isNewExpression.md b/docs/api_docs/namespaces/ts/functions/isNewExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..93130410daa78eabe4c5cffbd6ac54561c3cc3d2 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isNewExpression.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isNewExpression + +# Function: isNewExpression() + +> **isNewExpression**(`node`): `node is NewExpression` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5070 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is NewExpression` diff --git a/docs/api_docs/namespaces/ts/functions/isNoSubstitutionTemplateLiteral.md b/docs/api_docs/namespaces/ts/functions/isNoSubstitutionTemplateLiteral.md new file mode 100644 index 0000000000000000000000000000000000000000..2512364e1be5a6b20b00a93faecd2fa13e58e858 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isNoSubstitutionTemplateLiteral.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isNoSubstitutionTemplateLiteral + +# Function: isNoSubstitutionTemplateLiteral() + +> **isNoSubstitutionTemplateLiteral**(`node`): `node is NoSubstitutionTemplateLiteral` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5012 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is NoSubstitutionTemplateLiteral` diff --git a/docs/api_docs/namespaces/ts/functions/isNonNullChain.md b/docs/api_docs/namespaces/ts/functions/isNonNullChain.md new file mode 100644 index 0000000000000000000000000000000000000000..4d96e5cd45ef6bd6bfa85bbf2a1d351cbb0cb3b4 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isNonNullChain.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isNonNullChain + +# Function: isNonNullChain() + +> **isNonNullChain**(`node`): `node is NonNullChain` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4843 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is NonNullChain` diff --git a/docs/api_docs/namespaces/ts/functions/isNonNullExpression.md b/docs/api_docs/namespaces/ts/functions/isNonNullExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..81d50d712d386ac39f1cb2ca0f09f9b85d9dd84c --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isNonNullExpression.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isNonNullExpression + +# Function: isNonNullExpression() + +> **isNonNullExpression**(`node`): `node is NonNullExpression` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5093 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is NonNullExpression` diff --git a/docs/api_docs/namespaces/ts/functions/isNotEmittedStatement.md b/docs/api_docs/namespaces/ts/functions/isNotEmittedStatement.md new file mode 100644 index 0000000000000000000000000000000000000000..b8c2d8827931d8a78d86b098bb63b77a54fa7c7c --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isNotEmittedStatement.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isNotEmittedStatement + +# Function: isNotEmittedStatement() + +> **isNotEmittedStatement**(`node`): `node is NotEmittedStatement` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5146 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is NotEmittedStatement` diff --git a/docs/api_docs/namespaces/ts/functions/isNullishCoalesce.md b/docs/api_docs/namespaces/ts/functions/isNullishCoalesce.md new file mode 100644 index 0000000000000000000000000000000000000000..e5352302d553a3f368686f355338aa8a139ce7cc --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isNullishCoalesce.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isNullishCoalesce + +# Function: isNullishCoalesce() + +> **isNullishCoalesce**(`node`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4839 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/functions/isNumericLiteral.md b/docs/api_docs/namespaces/ts/functions/isNumericLiteral.md new file mode 100644 index 0000000000000000000000000000000000000000..95bbf071a662fd1c1725fab9982a97a4f802ad1a --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isNumericLiteral.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isNumericLiteral + +# Function: isNumericLiteral() + +> **isNumericLiteral**(`node`): `node is NumericLiteral` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5007 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is NumericLiteral` diff --git a/docs/api_docs/namespaces/ts/functions/isOHModules.md b/docs/api_docs/namespaces/ts/functions/isOHModules.md new file mode 100644 index 0000000000000000000000000000000000000000..e71413974d5140e2c5eb4513d1ffec42e91ddb91 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isOHModules.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isOHModules + +# Function: isOHModules() + +> **isOHModules**(`modulePath`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5426 + +## Parameters + +### modulePath + +`string` + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/functions/isOHModulesDirectory.md b/docs/api_docs/namespaces/ts/functions/isOHModulesDirectory.md new file mode 100644 index 0000000000000000000000000000000000000000..58f54c5cff5104a195b2d1f8775c5f4b477a6115 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isOHModulesDirectory.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isOHModulesDirectory + +# Function: isOHModulesDirectory() + +> **isOHModulesDirectory**(`dirPath`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5431 + +## Parameters + +### dirPath + +[`Path`](../type-aliases/Path.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/functions/isObjectBindingPattern.md b/docs/api_docs/namespaces/ts/functions/isObjectBindingPattern.md new file mode 100644 index 0000000000000000000000000000000000000000..11410f94ee6f17707e2c938daed6b5b827471b91 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isObjectBindingPattern.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isObjectBindingPattern + +# Function: isObjectBindingPattern() + +> **isObjectBindingPattern**(`node`): `node is ObjectBindingPattern` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5062 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is ObjectBindingPattern` diff --git a/docs/api_docs/namespaces/ts/functions/isObjectLiteralElement.md b/docs/api_docs/namespaces/ts/functions/isObjectLiteralElement.md new file mode 100644 index 0000000000000000000000000000000000000000..dbf33737da2a255d700611a7da71cc99be696d60 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isObjectLiteralElement.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isObjectLiteralElement + +# Function: isObjectLiteralElement() + +> **isObjectLiteralElement**(`node`): `node is ObjectLiteralElement` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4904 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is ObjectLiteralElement` diff --git a/docs/api_docs/namespaces/ts/functions/isObjectLiteralElementLike.md b/docs/api_docs/namespaces/ts/functions/isObjectLiteralElementLike.md new file mode 100644 index 0000000000000000000000000000000000000000..2e850670dfeb5cdfaec12c16dd96b4e6cab36c2c --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isObjectLiteralElementLike.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isObjectLiteralElementLike + +# Function: isObjectLiteralElementLike() + +> **isObjectLiteralElementLike**(`node`): `node is ObjectLiteralElementLike` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4881 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is ObjectLiteralElementLike` diff --git a/docs/api_docs/namespaces/ts/functions/isObjectLiteralExpression.md b/docs/api_docs/namespaces/ts/functions/isObjectLiteralExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..97bafa33b87d4a296d56fac311a387880d6b6916 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isObjectLiteralExpression.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isObjectLiteralExpression + +# Function: isObjectLiteralExpression() + +> **isObjectLiteralExpression**(`node`): `node is ObjectLiteralExpression` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5066 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is ObjectLiteralExpression` diff --git a/docs/api_docs/namespaces/ts/functions/isOhpm.md b/docs/api_docs/namespaces/ts/functions/isOhpm.md new file mode 100644 index 0000000000000000000000000000000000000000..75d8be01360fc2f68c9a6704a043e630fb2f2be2 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isOhpm.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isOhpm + +# Function: isOhpm() + +> **isOhpm**(`packageManagerType`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5424 + +## Parameters + +### packageManagerType + +`undefined` | `string` + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/functions/isOhpmAndOhModules.md b/docs/api_docs/namespaces/ts/functions/isOhpmAndOhModules.md new file mode 100644 index 0000000000000000000000000000000000000000..faa13c8c9e50c19375461636989110eec8ab36e0 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isOhpmAndOhModules.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isOhpmAndOhModules + +# Function: isOhpmAndOhModules() + +> **isOhpmAndOhModules**(`packageManagerType`, `modulePath`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5427 + +## Parameters + +### packageManagerType + +`undefined` | `string` + +### modulePath + +`string` + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/functions/isOmittedExpression.md b/docs/api_docs/namespaces/ts/functions/isOmittedExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..39dfbb414dff58a794b03f3f584ab67e939412d6 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isOmittedExpression.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isOmittedExpression + +# Function: isOmittedExpression() + +> **isOmittedExpression**(`node`): `node is OmittedExpression` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5089 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is OmittedExpression` diff --git a/docs/api_docs/namespaces/ts/functions/isOptionalChain.md b/docs/api_docs/namespaces/ts/functions/isOptionalChain.md new file mode 100644 index 0000000000000000000000000000000000000000..017152348f231b7dee1bce0a22dca989e81ba782 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isOptionalChain.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isOptionalChain + +# Function: isOptionalChain() + +> **isOptionalChain**(`node`): node is PropertyAccessChain \| ElementAccessChain \| CallChain \| NonNullChain + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4838 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +node is PropertyAccessChain \| ElementAccessChain \| CallChain \| NonNullChain diff --git a/docs/api_docs/namespaces/ts/functions/isOptionalTypeNode.md b/docs/api_docs/namespaces/ts/functions/isOptionalTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..e50a1d36ea855da3ac5979c8d1ace1a5c94db5cd --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isOptionalTypeNode.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isOptionalTypeNode + +# Function: isOptionalTypeNode() + +> **isOptionalTypeNode**(`node`): `node is OptionalTypeNode` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5047 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is OptionalTypeNode` diff --git a/docs/api_docs/namespaces/ts/functions/isParameter.md b/docs/api_docs/namespaces/ts/functions/isParameter.md new file mode 100644 index 0000000000000000000000000000000000000000..dfa5500a4084a3b5299be858980df7d5ac5dfb57 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isParameter.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isParameter + +# Function: isParameter() + +> **isParameter**(`node`): `node is ParameterDeclaration` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5025 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is ParameterDeclaration` diff --git a/docs/api_docs/namespaces/ts/functions/isParameterPropertyDeclaration.md b/docs/api_docs/namespaces/ts/functions/isParameterPropertyDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..075368d942ab13cbcb8f6ed21f1890b6ac3ce5a7 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isParameterPropertyDeclaration.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isParameterPropertyDeclaration + +# Function: isParameterPropertyDeclaration() + +> **isParameterPropertyDeclaration**(`node`, `parent`): `node is ParameterPropertyDeclaration` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4671 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +### parent + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is ParameterPropertyDeclaration` diff --git a/docs/api_docs/namespaces/ts/functions/isParenthesizedExpression.md b/docs/api_docs/namespaces/ts/functions/isParenthesizedExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..71c1f2c0b5a383cd7e3a3c5631e17c0ee0b3e62a --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isParenthesizedExpression.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isParenthesizedExpression + +# Function: isParenthesizedExpression() + +> **isParenthesizedExpression**(`node`): `node is ParenthesizedExpression` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5073 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is ParenthesizedExpression` diff --git a/docs/api_docs/namespaces/ts/functions/isParenthesizedTypeNode.md b/docs/api_docs/namespaces/ts/functions/isParenthesizedTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..e8a0b9749416c7b24fbb6c28f6891a858676059a --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isParenthesizedTypeNode.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isParenthesizedTypeNode + +# Function: isParenthesizedTypeNode() + +> **isParenthesizedTypeNode**(`node`): `node is ParenthesizedTypeNode` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5053 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is ParenthesizedTypeNode` diff --git a/docs/api_docs/namespaces/ts/functions/isParseTreeNode.md b/docs/api_docs/namespaces/ts/functions/isParseTreeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..05fe29f24b531338294b9b7a249f62d542d39e28 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isParseTreeNode.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isParseTreeNode + +# Function: isParseTreeNode() + +> **isParseTreeNode**(`node`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4704 + +Gets a value indicating whether a node originated in the parse tree. + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +The node to test. + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/functions/isPartiallyEmittedExpression.md b/docs/api_docs/namespaces/ts/functions/isPartiallyEmittedExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..34385a502b71f8fef2999520b8d3d724ea74352f --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isPartiallyEmittedExpression.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isPartiallyEmittedExpression + +# Function: isPartiallyEmittedExpression() + +> **isPartiallyEmittedExpression**(`node`): `node is PartiallyEmittedExpression` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5096 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is PartiallyEmittedExpression` diff --git a/docs/api_docs/namespaces/ts/functions/isPlusToken.md b/docs/api_docs/namespaces/ts/functions/isPlusToken.md new file mode 100644 index 0000000000000000000000000000000000000000..32ad95f2ed0076cffc888923e177af21807c60dd --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isPlusToken.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isPlusToken + +# Function: isPlusToken() + +> **isPlusToken**(`node`): `node is PlusToken` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5017 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is PlusToken` diff --git a/docs/api_docs/namespaces/ts/functions/isPostfixUnaryExpression.md b/docs/api_docs/namespaces/ts/functions/isPostfixUnaryExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..7ce042c3b2f61a3a5edeca84272545c82a4a20ed --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isPostfixUnaryExpression.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isPostfixUnaryExpression + +# Function: isPostfixUnaryExpression() + +> **isPostfixUnaryExpression**(`node`): `node is PostfixUnaryExpression` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5082 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is PostfixUnaryExpression` diff --git a/docs/api_docs/namespaces/ts/functions/isPrefixUnaryExpression.md b/docs/api_docs/namespaces/ts/functions/isPrefixUnaryExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..71ff78e135d44404cb909ca532e037797f6a67cf --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isPrefixUnaryExpression.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isPrefixUnaryExpression + +# Function: isPrefixUnaryExpression() + +> **isPrefixUnaryExpression**(`node`): `node is PrefixUnaryExpression` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5081 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is PrefixUnaryExpression` diff --git a/docs/api_docs/namespaces/ts/functions/isPrivateIdentifier.md b/docs/api_docs/namespaces/ts/functions/isPrivateIdentifier.md new file mode 100644 index 0000000000000000000000000000000000000000..558a8e895f061ae26fd2efd141ef5c72b3d860b0 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isPrivateIdentifier.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isPrivateIdentifier + +# Function: isPrivateIdentifier() + +> **isPrivateIdentifier**(`node`): `node is PrivateIdentifier` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5021 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is PrivateIdentifier` diff --git a/docs/api_docs/namespaces/ts/functions/isPropertyAccessChain.md b/docs/api_docs/namespaces/ts/functions/isPropertyAccessChain.md new file mode 100644 index 0000000000000000000000000000000000000000..e4bdb82f36a44a73e70eb5b562976e327428663c --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isPropertyAccessChain.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isPropertyAccessChain + +# Function: isPropertyAccessChain() + +> **isPropertyAccessChain**(`node`): `node is PropertyAccessChain` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4835 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is PropertyAccessChain` diff --git a/docs/api_docs/namespaces/ts/functions/isPropertyAccessExpression.md b/docs/api_docs/namespaces/ts/functions/isPropertyAccessExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..07a15da6f0b39eff367f83c8ba0055e1ecd34b89 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isPropertyAccessExpression.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isPropertyAccessExpression + +# Function: isPropertyAccessExpression() + +> **isPropertyAccessExpression**(`node`): `node is PropertyAccessExpression` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5067 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is PropertyAccessExpression` diff --git a/docs/api_docs/namespaces/ts/functions/isPropertyAccessOrQualifiedName.md b/docs/api_docs/namespaces/ts/functions/isPropertyAccessOrQualifiedName.md new file mode 100644 index 0000000000000000000000000000000000000000..d398971752c4d312dc62454c016834ce7779ea0e --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isPropertyAccessOrQualifiedName.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isPropertyAccessOrQualifiedName + +# Function: isPropertyAccessOrQualifiedName() + +> **isPropertyAccessOrQualifiedName**(`node`): node is PropertyAccessExpression \| QualifiedName + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4889 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +node is PropertyAccessExpression \| QualifiedName diff --git a/docs/api_docs/namespaces/ts/functions/isPropertyAssignment.md b/docs/api_docs/namespaces/ts/functions/isPropertyAssignment.md new file mode 100644 index 0000000000000000000000000000000000000000..cdaef35095194bbc6d3b7b94acbbbf7cd868ef26 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isPropertyAssignment.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isPropertyAssignment + +# Function: isPropertyAssignment() + +> **isPropertyAssignment**(`node`): `node is PropertyAssignment` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5163 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is PropertyAssignment` diff --git a/docs/api_docs/namespaces/ts/functions/isPropertyDeclaration.md b/docs/api_docs/namespaces/ts/functions/isPropertyDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..a16a9dceab3e6af02e71eca35ae877ffd73784ac --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isPropertyDeclaration.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isPropertyDeclaration + +# Function: isPropertyDeclaration() + +> **isPropertyDeclaration**(`node`): `node is PropertyDeclaration` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5028 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is PropertyDeclaration` diff --git a/docs/api_docs/namespaces/ts/functions/isPropertyName.md b/docs/api_docs/namespaces/ts/functions/isPropertyName.md new file mode 100644 index 0000000000000000000000000000000000000000..0ee212a87121e6106ddcd253c723cf8809d3f404 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isPropertyName.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isPropertyName + +# Function: isPropertyName() + +> **isPropertyName**(`node`): `node is PropertyName` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4870 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is PropertyName` diff --git a/docs/api_docs/namespaces/ts/functions/isPropertySignature.md b/docs/api_docs/namespaces/ts/functions/isPropertySignature.md new file mode 100644 index 0000000000000000000000000000000000000000..e4870bb12d58047f1f09b9ae6337a0160df1b14f --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isPropertySignature.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isPropertySignature + +# Function: isPropertySignature() + +> **isPropertySignature**(`node`): `node is PropertySignature` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5027 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is PropertySignature` diff --git a/docs/api_docs/namespaces/ts/functions/isQualifiedName.md b/docs/api_docs/namespaces/ts/functions/isQualifiedName.md new file mode 100644 index 0000000000000000000000000000000000000000..7bd1e200725dba908d2b3a1730716d8169cf7fe0 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isQualifiedName.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isQualifiedName + +# Function: isQualifiedName() + +> **isQualifiedName**(`node`): `node is QualifiedName` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5022 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is QualifiedName` diff --git a/docs/api_docs/namespaces/ts/functions/isRegularExpressionLiteral.md b/docs/api_docs/namespaces/ts/functions/isRegularExpressionLiteral.md new file mode 100644 index 0000000000000000000000000000000000000000..38af70ed5e02821ecf0740a3db4c8f44fa29ffb8 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isRegularExpressionLiteral.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isRegularExpressionLiteral + +# Function: isRegularExpressionLiteral() + +> **isRegularExpressionLiteral**(`node`): `node is RegularExpressionLiteral` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5011 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is RegularExpressionLiteral` diff --git a/docs/api_docs/namespaces/ts/functions/isRestParameter.md b/docs/api_docs/namespaces/ts/functions/isRestParameter.md new file mode 100644 index 0000000000000000000000000000000000000000..ceca81e72c0d4e4c0b32ce22a390135405a28a3c --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isRestParameter.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isRestParameter + +# Function: isRestParameter() + +> **isRestParameter**(`node`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4908 + +## Parameters + +### node + +[`ParameterDeclaration`](../interfaces/ParameterDeclaration.md) | [`JSDocParameterTag`](../interfaces/JSDocParameterTag.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/functions/isRestTypeNode.md b/docs/api_docs/namespaces/ts/functions/isRestTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..61f879e637dd12c05aa778f98f0e1134e0f329fc --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isRestTypeNode.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isRestTypeNode + +# Function: isRestTypeNode() + +> **isRestTypeNode**(`node`): `node is RestTypeNode` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5048 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is RestTypeNode` diff --git a/docs/api_docs/namespaces/ts/functions/isReturnStatement.md b/docs/api_docs/namespaces/ts/functions/isReturnStatement.md new file mode 100644 index 0000000000000000000000000000000000000000..ef697fe4da170d79971c0b8ebe11755218e28d99 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isReturnStatement.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isReturnStatement + +# Function: isReturnStatement() + +> **isReturnStatement**(`node`): `node is ReturnStatement` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5112 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is ReturnStatement` diff --git a/docs/api_docs/namespaces/ts/functions/isSatisfiesExpression.md b/docs/api_docs/namespaces/ts/functions/isSatisfiesExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..ee1cc8804454341711e0c89de865188557372e4c --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isSatisfiesExpression.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isSatisfiesExpression + +# Function: isSatisfiesExpression() + +> **isSatisfiesExpression**(`node`): `node is SatisfiesExpression` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5092 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is SatisfiesExpression` diff --git a/docs/api_docs/namespaces/ts/functions/isSemicolonClassElement.md b/docs/api_docs/namespaces/ts/functions/isSemicolonClassElement.md new file mode 100644 index 0000000000000000000000000000000000000000..6d33b3caba78b46c2eaaa3881bcf62406b0ab11d --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isSemicolonClassElement.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isSemicolonClassElement + +# Function: isSemicolonClassElement() + +> **isSemicolonClassElement**(`node`): `node is SemicolonClassElement` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5099 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is SemicolonClassElement` diff --git a/docs/api_docs/namespaces/ts/functions/isSetAccessor.md b/docs/api_docs/namespaces/ts/functions/isSetAccessor.md new file mode 100644 index 0000000000000000000000000000000000000000..b2d1c3e09113a814b296b27ca4bacb724e499544 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isSetAccessor.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isSetAccessor + +# Function: isSetAccessor() + +> **isSetAccessor**(`node`): `node is SetAccessorDeclaration` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4900 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is SetAccessorDeclaration` diff --git a/docs/api_docs/namespaces/ts/functions/isSetAccessorDeclaration.md b/docs/api_docs/namespaces/ts/functions/isSetAccessorDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..55fb2678c61f04de8db69d6bfc4d80e23817df05 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isSetAccessorDeclaration.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isSetAccessorDeclaration + +# Function: isSetAccessorDeclaration() + +> **isSetAccessorDeclaration**(`node`): `node is SetAccessorDeclaration` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5034 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is SetAccessorDeclaration` diff --git a/docs/api_docs/namespaces/ts/functions/isShorthandPropertyAssignment.md b/docs/api_docs/namespaces/ts/functions/isShorthandPropertyAssignment.md new file mode 100644 index 0000000000000000000000000000000000000000..2d86505be896da4964fcd5a52cddc4c23f13bce5 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isShorthandPropertyAssignment.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isShorthandPropertyAssignment + +# Function: isShorthandPropertyAssignment() + +> **isShorthandPropertyAssignment**(`node`): `node is ShorthandPropertyAssignment` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5164 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is ShorthandPropertyAssignment` diff --git a/docs/api_docs/namespaces/ts/functions/isSourceFile.md b/docs/api_docs/namespaces/ts/functions/isSourceFile.md new file mode 100644 index 0000000000000000000000000000000000000000..26ca9190151417191842a5d3003faa47804a9527 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isSourceFile.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isSourceFile + +# Function: isSourceFile() + +> **isSourceFile**(`node`): `node is SourceFile` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5168 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is SourceFile` diff --git a/docs/api_docs/namespaces/ts/functions/isSpreadAssignment.md b/docs/api_docs/namespaces/ts/functions/isSpreadAssignment.md new file mode 100644 index 0000000000000000000000000000000000000000..031b6735bcadd1d0d5130ba531cf9804afebfd16 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isSpreadAssignment.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isSpreadAssignment + +# Function: isSpreadAssignment() + +> **isSpreadAssignment**(`node`): `node is SpreadAssignment` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5165 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is SpreadAssignment` diff --git a/docs/api_docs/namespaces/ts/functions/isSpreadElement.md b/docs/api_docs/namespaces/ts/functions/isSpreadElement.md new file mode 100644 index 0000000000000000000000000000000000000000..1e8c6ae8b3845466efe03bdbbff47fd92bc62dc5 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isSpreadElement.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isSpreadElement + +# Function: isSpreadElement() + +> **isSpreadElement**(`node`): `node is SpreadElement` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5087 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is SpreadElement` diff --git a/docs/api_docs/namespaces/ts/functions/isStringLiteral.md b/docs/api_docs/namespaces/ts/functions/isStringLiteral.md new file mode 100644 index 0000000000000000000000000000000000000000..f99c3db06e40cacc198e11c3318f09a030b28ad9 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isStringLiteral.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isStringLiteral + +# Function: isStringLiteral() + +> **isStringLiteral**(`node`): `node is StringLiteral` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5009 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is StringLiteral` diff --git a/docs/api_docs/namespaces/ts/functions/isStringLiteralLike.md b/docs/api_docs/namespaces/ts/functions/isStringLiteralLike.md new file mode 100644 index 0000000000000000000000000000000000000000..51e009edc0c646e9dea191d02ce0ef41fa147316 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isStringLiteralLike.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isStringLiteralLike + +# Function: isStringLiteralLike() + +> **isStringLiteralLike**(`node`): `node is StringLiteralLike` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4905 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is StringLiteralLike` diff --git a/docs/api_docs/namespaces/ts/functions/isStringTextContainingNode.md b/docs/api_docs/namespaces/ts/functions/isStringTextContainingNode.md new file mode 100644 index 0000000000000000000000000000000000000000..5661fc769d735072e3d75864bc9b197e8905f3b2 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isStringTextContainingNode.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isStringTextContainingNode + +# Function: isStringTextContainingNode() + +> **isStringTextContainingNode**(`node`): node is StringLiteral \| TemplateLiteralToken + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4867 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +node is StringLiteral \| TemplateLiteralToken diff --git a/docs/api_docs/namespaces/ts/functions/isStruct.md b/docs/api_docs/namespaces/ts/functions/isStruct.md new file mode 100644 index 0000000000000000000000000000000000000000..75e9a2ea2a76f95c88707fffcb3804cfa78bb2b8 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isStruct.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isStruct + +# Function: isStruct() + +> **isStruct**(`node`): `node is StructDeclaration` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4875 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is StructDeclaration` diff --git a/docs/api_docs/namespaces/ts/functions/isStructDeclaration.md b/docs/api_docs/namespaces/ts/functions/isStructDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..b570cf623eb89ea37e23dfc9f650a8a689f25db9 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isStructDeclaration.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isStructDeclaration + +# Function: isStructDeclaration() + +> **isStructDeclaration**(`node`): `node is StructDeclaration` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5123 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is StructDeclaration` diff --git a/docs/api_docs/namespaces/ts/functions/isSwitchStatement.md b/docs/api_docs/namespaces/ts/functions/isSwitchStatement.md new file mode 100644 index 0000000000000000000000000000000000000000..46061d8074085f3f7fdff3f8ac323cd4de0d7d65 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isSwitchStatement.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isSwitchStatement + +# Function: isSwitchStatement() + +> **isSwitchStatement**(`node`): `node is SwitchStatement` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5114 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is SwitchStatement` diff --git a/docs/api_docs/namespaces/ts/functions/isSyntheticExpression.md b/docs/api_docs/namespaces/ts/functions/isSyntheticExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..1ba7fad6f56512930369d4f00c4c34c89508eb72 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isSyntheticExpression.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isSyntheticExpression + +# Function: isSyntheticExpression() + +> **isSyntheticExpression**(`node`): `node is SyntheticExpression` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5095 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is SyntheticExpression` diff --git a/docs/api_docs/namespaces/ts/functions/isTaggedTemplateExpression.md b/docs/api_docs/namespaces/ts/functions/isTaggedTemplateExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..27525c18a37bef0be5a15d3d6c100727ad293586 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isTaggedTemplateExpression.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isTaggedTemplateExpression + +# Function: isTaggedTemplateExpression() + +> **isTaggedTemplateExpression**(`node`): `node is TaggedTemplateExpression` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5071 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is TaggedTemplateExpression` diff --git a/docs/api_docs/namespaces/ts/functions/isTargetModulesDerectory.md b/docs/api_docs/namespaces/ts/functions/isTargetModulesDerectory.md new file mode 100644 index 0000000000000000000000000000000000000000..904d92af4c4f5f26474e2e2e23218bc0f9ef0c01 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isTargetModulesDerectory.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isTargetModulesDerectory + +# Function: isTargetModulesDerectory() + +> **isTargetModulesDerectory**(`dirPath`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5432 + +## Parameters + +### dirPath + +[`Path`](../type-aliases/Path.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/functions/isTemplateExpression.md b/docs/api_docs/namespaces/ts/functions/isTemplateExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..5cb90670b84c80336fb2c18e67aeb32f2ac8cf83 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isTemplateExpression.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isTemplateExpression + +# Function: isTemplateExpression() + +> **isTemplateExpression**(`node`): `node is TemplateExpression` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5085 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is TemplateExpression` diff --git a/docs/api_docs/namespaces/ts/functions/isTemplateHead.md b/docs/api_docs/namespaces/ts/functions/isTemplateHead.md new file mode 100644 index 0000000000000000000000000000000000000000..101653dc3dc665b1c8b12fad28d0441d766a7e8a --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isTemplateHead.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isTemplateHead + +# Function: isTemplateHead() + +> **isTemplateHead**(`node`): `node is TemplateHead` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5013 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is TemplateHead` diff --git a/docs/api_docs/namespaces/ts/functions/isTemplateLiteral.md b/docs/api_docs/namespaces/ts/functions/isTemplateLiteral.md new file mode 100644 index 0000000000000000000000000000000000000000..a5277c24a58dd61224c19e3eab2846eff2177bec --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isTemplateLiteral.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isTemplateLiteral + +# Function: isTemplateLiteral() + +> **isTemplateLiteral**(`node`): `node is TemplateLiteral` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4892 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is TemplateLiteral` diff --git a/docs/api_docs/namespaces/ts/functions/isTemplateLiteralToken.md b/docs/api_docs/namespaces/ts/functions/isTemplateLiteralToken.md new file mode 100644 index 0000000000000000000000000000000000000000..2085700c0bf58696105f7e64ca73d72c63f02550 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isTemplateLiteralToken.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isTemplateLiteralToken + +# Function: isTemplateLiteralToken() + +> **isTemplateLiteralToken**(`node`): `node is TemplateLiteralToken` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4862 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is TemplateLiteralToken` diff --git a/docs/api_docs/namespaces/ts/functions/isTemplateLiteralTypeNode.md b/docs/api_docs/namespaces/ts/functions/isTemplateLiteralTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..a97db4739ad41accef236b1cbdde3b3acf76d00e --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isTemplateLiteralTypeNode.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isTemplateLiteralTypeNode + +# Function: isTemplateLiteralTypeNode() + +> **isTemplateLiteralTypeNode**(`node`): `node is TemplateLiteralTypeNode` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5061 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is TemplateLiteralTypeNode` diff --git a/docs/api_docs/namespaces/ts/functions/isTemplateLiteralTypeSpan.md b/docs/api_docs/namespaces/ts/functions/isTemplateLiteralTypeSpan.md new file mode 100644 index 0000000000000000000000000000000000000000..d88552301a006d8277c2bcbcc363b9bde8af658e --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isTemplateLiteralTypeSpan.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isTemplateLiteralTypeSpan + +# Function: isTemplateLiteralTypeSpan() + +> **isTemplateLiteralTypeSpan**(`node`): `node is TemplateLiteralTypeSpan` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5060 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is TemplateLiteralTypeSpan` diff --git a/docs/api_docs/namespaces/ts/functions/isTemplateMiddle.md b/docs/api_docs/namespaces/ts/functions/isTemplateMiddle.md new file mode 100644 index 0000000000000000000000000000000000000000..ce232e5449428d952a49b0e9bebbc5eb3da2c12f --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isTemplateMiddle.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isTemplateMiddle + +# Function: isTemplateMiddle() + +> **isTemplateMiddle**(`node`): `node is TemplateMiddle` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5014 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is TemplateMiddle` diff --git a/docs/api_docs/namespaces/ts/functions/isTemplateMiddleOrTemplateTail.md b/docs/api_docs/namespaces/ts/functions/isTemplateMiddleOrTemplateTail.md new file mode 100644 index 0000000000000000000000000000000000000000..d3130c20e5e4a898a42913e26d9d7fbc5477dafd --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isTemplateMiddleOrTemplateTail.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isTemplateMiddleOrTemplateTail + +# Function: isTemplateMiddleOrTemplateTail() + +> **isTemplateMiddleOrTemplateTail**(`node`): node is TemplateMiddle \| TemplateTail + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4863 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +node is TemplateMiddle \| TemplateTail diff --git a/docs/api_docs/namespaces/ts/functions/isTemplateSpan.md b/docs/api_docs/namespaces/ts/functions/isTemplateSpan.md new file mode 100644 index 0000000000000000000000000000000000000000..1791dea1fc6fca126ca03f8818dbd8097843868c --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isTemplateSpan.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isTemplateSpan + +# Function: isTemplateSpan() + +> **isTemplateSpan**(`node`): `node is TemplateSpan` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5098 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is TemplateSpan` diff --git a/docs/api_docs/namespaces/ts/functions/isTemplateTail.md b/docs/api_docs/namespaces/ts/functions/isTemplateTail.md new file mode 100644 index 0000000000000000000000000000000000000000..c64cf9b66e8c0b8bc8ce3f61e8635f0ec1d2441a --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isTemplateTail.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isTemplateTail + +# Function: isTemplateTail() + +> **isTemplateTail**(`node`): `node is TemplateTail` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5015 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is TemplateTail` diff --git a/docs/api_docs/namespaces/ts/functions/isThisTypeNode.md b/docs/api_docs/namespaces/ts/functions/isThisTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..4add1154742cbc267940d40bd39ee05d16db7e9a --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isThisTypeNode.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isThisTypeNode + +# Function: isThisTypeNode() + +> **isThisTypeNode**(`node`): `node is ThisTypeNode` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5054 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is ThisTypeNode` diff --git a/docs/api_docs/namespaces/ts/functions/isThrowStatement.md b/docs/api_docs/namespaces/ts/functions/isThrowStatement.md new file mode 100644 index 0000000000000000000000000000000000000000..bdf966ac557e8feea45eaf24cfd6d134b5be7849 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isThrowStatement.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isThrowStatement + +# Function: isThrowStatement() + +> **isThrowStatement**(`node`): `node is ThrowStatement` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5116 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is ThrowStatement` diff --git a/docs/api_docs/namespaces/ts/functions/isToken.md b/docs/api_docs/namespaces/ts/functions/isToken.md new file mode 100644 index 0000000000000000000000000000000000000000..9bc7055793dfeaf1cc7e901c461d2050b367ec82 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isToken.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isToken + +# Function: isToken() + +> **isToken**(`n`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4860 + +True if node is of some token syntax kind. +For example, this is true for an IfKeyword but not for an IfStatement. +Literals are considered tokens, except TemplateLiteral, but does include TemplateHead/Middle/Tail. + +## Parameters + +### n + +[`Node`](../interfaces/Node.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/functions/isTokenKind.md b/docs/api_docs/namespaces/ts/functions/isTokenKind.md new file mode 100644 index 0000000000000000000000000000000000000000..447881e40a2cb35944ffd60846669ed366abee42 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isTokenKind.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isTokenKind + +# Function: isTokenKind() + +> **isTokenKind**(`kind`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4854 + +True if kind is of some token syntax kind. +For example, this is true for an IfKeyword but not for an IfStatement. +Literals are considered tokens, except TemplateLiteral, but does include TemplateHead/Middle/Tail. + +## Parameters + +### kind + +[`SyntaxKind`](../enumerations/SyntaxKind.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/functions/isTryStatement.md b/docs/api_docs/namespaces/ts/functions/isTryStatement.md new file mode 100644 index 0000000000000000000000000000000000000000..0403427937074117cf0ac9a303ae9d5379d7b21b --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isTryStatement.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isTryStatement + +# Function: isTryStatement() + +> **isTryStatement**(`node`): `node is TryStatement` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5117 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is TryStatement` diff --git a/docs/api_docs/namespaces/ts/functions/isTupleTypeNode.md b/docs/api_docs/namespaces/ts/functions/isTupleTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..46acfdab099fbf5c554edceecb3e0cd8d4375dbc --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isTupleTypeNode.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isTupleTypeNode + +# Function: isTupleTypeNode() + +> **isTupleTypeNode**(`node`): `node is TupleTypeNode` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5045 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is TupleTypeNode` diff --git a/docs/api_docs/namespaces/ts/functions/isTypeAliasDeclaration.md b/docs/api_docs/namespaces/ts/functions/isTypeAliasDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..de706e5e217918427cdbc12297d2d457d5dc0c78 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isTypeAliasDeclaration.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isTypeAliasDeclaration + +# Function: isTypeAliasDeclaration() + +> **isTypeAliasDeclaration**(`node`): `node is TypeAliasDeclaration` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5125 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is TypeAliasDeclaration` diff --git a/docs/api_docs/namespaces/ts/functions/isTypeAssertion.md b/docs/api_docs/namespaces/ts/functions/isTypeAssertion.md new file mode 100644 index 0000000000000000000000000000000000000000..bce7ad698ace2d80814dfb434b67b908bcb4a53a --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isTypeAssertion.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isTypeAssertion + +# Function: ~~isTypeAssertion()~~ + +> **isTypeAssertion**(`node`): `node is TypeAssertion` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8318 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is TypeAssertion` + +## Deprecated + +Use `isTypeAssertionExpression` instead. diff --git a/docs/api_docs/namespaces/ts/functions/isTypeAssertionExpression.md b/docs/api_docs/namespaces/ts/functions/isTypeAssertionExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..0047fbbe7dfce7eb00c7a3100ab9fbb350878377 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isTypeAssertionExpression.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isTypeAssertionExpression + +# Function: isTypeAssertionExpression() + +> **isTypeAssertionExpression**(`node`): `node is TypeAssertion` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5072 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is TypeAssertion` diff --git a/docs/api_docs/namespaces/ts/functions/isTypeElement.md b/docs/api_docs/namespaces/ts/functions/isTypeElement.md new file mode 100644 index 0000000000000000000000000000000000000000..4cb01a7ad6b2cef9fc14d6b6878529e5f84b2f63 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isTypeElement.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isTypeElement + +# Function: isTypeElement() + +> **isTypeElement**(`node`): `node is TypeElement` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4879 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is TypeElement` diff --git a/docs/api_docs/namespaces/ts/functions/isTypeLiteralNode.md b/docs/api_docs/namespaces/ts/functions/isTypeLiteralNode.md new file mode 100644 index 0000000000000000000000000000000000000000..0c87ec10447e7292f171d0693b2cd733065a1d45 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isTypeLiteralNode.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isTypeLiteralNode + +# Function: isTypeLiteralNode() + +> **isTypeLiteralNode**(`node`): `node is TypeLiteralNode` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5043 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is TypeLiteralNode` diff --git a/docs/api_docs/namespaces/ts/functions/isTypeNode.md b/docs/api_docs/namespaces/ts/functions/isTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..84ee3ddcebe7ff213679492f1cc45bd584b60b78 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isTypeNode.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isTypeNode + +# Function: isTypeNode() + +> **isTypeNode**(`node`): `node is TypeNode` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4887 + +Node test that determines whether a node is a valid type node. +This differs from the `isPartOfTypeNode` function which determines whether a node is *part* +of a TypeNode. + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is TypeNode` diff --git a/docs/api_docs/namespaces/ts/functions/isTypeOfExpression.md b/docs/api_docs/namespaces/ts/functions/isTypeOfExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..06d428f1e0f97ff81356c64703098802871207d3 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isTypeOfExpression.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isTypeOfExpression + +# Function: isTypeOfExpression() + +> **isTypeOfExpression**(`node`): `node is TypeOfExpression` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5078 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is TypeOfExpression` diff --git a/docs/api_docs/namespaces/ts/functions/isTypeOnlyImportOrExportDeclaration.md b/docs/api_docs/namespaces/ts/functions/isTypeOnlyImportOrExportDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..2ee6320d9f4bea32c7b2646018b6e28f02000b15 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isTypeOnlyImportOrExportDeclaration.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isTypeOnlyImportOrExportDeclaration + +# Function: isTypeOnlyImportOrExportDeclaration() + +> **isTypeOnlyImportOrExportDeclaration**(`node`): `node is TypeOnlyAliasDeclaration` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4865 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is TypeOnlyAliasDeclaration` diff --git a/docs/api_docs/namespaces/ts/functions/isTypeOperatorNode.md b/docs/api_docs/namespaces/ts/functions/isTypeOperatorNode.md new file mode 100644 index 0000000000000000000000000000000000000000..84de0c47ac9725faf27b5a8617a512148e43e266 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isTypeOperatorNode.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isTypeOperatorNode + +# Function: isTypeOperatorNode() + +> **isTypeOperatorNode**(`node`): `node is TypeOperatorNode` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5055 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is TypeOperatorNode` diff --git a/docs/api_docs/namespaces/ts/functions/isTypeParameterDeclaration.md b/docs/api_docs/namespaces/ts/functions/isTypeParameterDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..e5bdaf556d7490dca97cb8c3bc32877cb5953fad --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isTypeParameterDeclaration.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isTypeParameterDeclaration + +# Function: isTypeParameterDeclaration() + +> **isTypeParameterDeclaration**(`node`): `node is TypeParameterDeclaration` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5024 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is TypeParameterDeclaration` diff --git a/docs/api_docs/namespaces/ts/functions/isTypePredicateNode.md b/docs/api_docs/namespaces/ts/functions/isTypePredicateNode.md new file mode 100644 index 0000000000000000000000000000000000000000..7341c1cea0d665d08bc7402dc23830e9213803c2 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isTypePredicateNode.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isTypePredicateNode + +# Function: isTypePredicateNode() + +> **isTypePredicateNode**(`node`): `node is TypePredicateNode` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5038 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is TypePredicateNode` diff --git a/docs/api_docs/namespaces/ts/functions/isTypeQueryNode.md b/docs/api_docs/namespaces/ts/functions/isTypeQueryNode.md new file mode 100644 index 0000000000000000000000000000000000000000..26d3de77bd1a01566256e08f1d0bae27af1ffffa --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isTypeQueryNode.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isTypeQueryNode + +# Function: isTypeQueryNode() + +> **isTypeQueryNode**(`node`): `node is TypeQueryNode` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5042 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is TypeQueryNode` diff --git a/docs/api_docs/namespaces/ts/functions/isTypeReferenceNode.md b/docs/api_docs/namespaces/ts/functions/isTypeReferenceNode.md new file mode 100644 index 0000000000000000000000000000000000000000..c9c0ee23a2a79fedd901f467f945ee5f55d48fc4 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isTypeReferenceNode.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isTypeReferenceNode + +# Function: isTypeReferenceNode() + +> **isTypeReferenceNode**(`node`): `node is TypeReferenceNode` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5039 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is TypeReferenceNode` diff --git a/docs/api_docs/namespaces/ts/functions/isUnionTypeNode.md b/docs/api_docs/namespaces/ts/functions/isUnionTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..620ca1aebe09f92624b0e332b3276fac9ccb9361 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isUnionTypeNode.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isUnionTypeNode + +# Function: isUnionTypeNode() + +> **isUnionTypeNode**(`node`): `node is UnionTypeNode` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5049 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is UnionTypeNode` diff --git a/docs/api_docs/namespaces/ts/functions/isUnparsedNode.md b/docs/api_docs/namespaces/ts/functions/isUnparsedNode.md new file mode 100644 index 0000000000000000000000000000000000000000..87396165b0b8dd05f627c95cfade737597e8aeab --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isUnparsedNode.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isUnparsedNode + +# Function: isUnparsedNode() + +> **isUnparsedNode**(`node`): `node is UnparsedNode` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4847 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is UnparsedNode` diff --git a/docs/api_docs/namespaces/ts/functions/isUnparsedPrepend.md b/docs/api_docs/namespaces/ts/functions/isUnparsedPrepend.md new file mode 100644 index 0000000000000000000000000000000000000000..ef7f49b40f98da4cf20baad7d6e9a0a92cf003c4 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isUnparsedPrepend.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isUnparsedPrepend + +# Function: isUnparsedPrepend() + +> **isUnparsedPrepend**(`node`): `node is UnparsedPrepend` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5167 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is UnparsedPrepend` diff --git a/docs/api_docs/namespaces/ts/functions/isUnparsedSource.md b/docs/api_docs/namespaces/ts/functions/isUnparsedSource.md new file mode 100644 index 0000000000000000000000000000000000000000..0679ee0d6c44a443641f9490af957e2ce44c0a17 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isUnparsedSource.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isUnparsedSource + +# Function: isUnparsedSource() + +> **isUnparsedSource**(`node`): `node is UnparsedSource` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5170 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is UnparsedSource` diff --git a/docs/api_docs/namespaces/ts/functions/isUnparsedTextLike.md b/docs/api_docs/namespaces/ts/functions/isUnparsedTextLike.md new file mode 100644 index 0000000000000000000000000000000000000000..9c1043f9b0c892ab19a8cc5d9aa7c55ad8b9f7f5 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isUnparsedTextLike.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isUnparsedTextLike + +# Function: isUnparsedTextLike() + +> **isUnparsedTextLike**(`node`): `node is UnparsedTextLike` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4846 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is UnparsedTextLike` diff --git a/docs/api_docs/namespaces/ts/functions/isVariableDeclaration.md b/docs/api_docs/namespaces/ts/functions/isVariableDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..c146471572ecebda3b7d1d9b394120117f708b36 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isVariableDeclaration.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isVariableDeclaration + +# Function: isVariableDeclaration() + +> **isVariableDeclaration**(`node`): `node is VariableDeclaration` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5119 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is VariableDeclaration` diff --git a/docs/api_docs/namespaces/ts/functions/isVariableDeclarationList.md b/docs/api_docs/namespaces/ts/functions/isVariableDeclarationList.md new file mode 100644 index 0000000000000000000000000000000000000000..1097437a2aaa78a2f228fa09902123072417a152 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isVariableDeclarationList.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isVariableDeclarationList + +# Function: isVariableDeclarationList() + +> **isVariableDeclarationList**(`node`): `node is VariableDeclarationList` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5120 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is VariableDeclarationList` diff --git a/docs/api_docs/namespaces/ts/functions/isVariableStatement.md b/docs/api_docs/namespaces/ts/functions/isVariableStatement.md new file mode 100644 index 0000000000000000000000000000000000000000..f646a79c7385a5d549678c73e5d01a6c44c58b56 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isVariableStatement.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isVariableStatement + +# Function: isVariableStatement() + +> **isVariableStatement**(`node`): `node is VariableStatement` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5101 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is VariableStatement` diff --git a/docs/api_docs/namespaces/ts/functions/isVoidExpression.md b/docs/api_docs/namespaces/ts/functions/isVoidExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..fe95a83cddf5d6955e8b3eb49675415ff36516db --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isVoidExpression.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isVoidExpression + +# Function: isVoidExpression() + +> **isVoidExpression**(`node`): `node is VoidExpression` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5079 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is VoidExpression` diff --git a/docs/api_docs/namespaces/ts/functions/isWhileStatement.md b/docs/api_docs/namespaces/ts/functions/isWhileStatement.md new file mode 100644 index 0000000000000000000000000000000000000000..98a7dcddd0e82204911aef68d5b94b6bdaee8dde --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isWhileStatement.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isWhileStatement + +# Function: isWhileStatement() + +> **isWhileStatement**(`node`): `node is WhileStatement` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5106 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is WhileStatement` diff --git a/docs/api_docs/namespaces/ts/functions/isWhiteSpaceLike.md b/docs/api_docs/namespaces/ts/functions/isWhiteSpaceLike.md new file mode 100644 index 0000000000000000000000000000000000000000..c047704efe3599610decb1bf9196deac9cd27915 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isWhiteSpaceLike.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isWhiteSpaceLike + +# Function: isWhiteSpaceLike() + +> **isWhiteSpaceLike**(`ch`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4617 + +## Parameters + +### ch + +`number` + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/functions/isWhiteSpaceSingleLine.md b/docs/api_docs/namespaces/ts/functions/isWhiteSpaceSingleLine.md new file mode 100644 index 0000000000000000000000000000000000000000..899f6433ce6e2a73b987939a8dda45035875714c --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isWhiteSpaceSingleLine.md @@ -0,0 +1,23 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isWhiteSpaceSingleLine + +# Function: isWhiteSpaceSingleLine() + +> **isWhiteSpaceSingleLine**(`ch`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4619 + +Does not include line breaks. For that, see isWhiteSpaceLike. + +## Parameters + +### ch + +`number` + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/functions/isWithStatement.md b/docs/api_docs/namespaces/ts/functions/isWithStatement.md new file mode 100644 index 0000000000000000000000000000000000000000..bb33b96e2202320643079f1b149630a88a7867a2 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isWithStatement.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isWithStatement + +# Function: isWithStatement() + +> **isWithStatement**(`node`): `node is WithStatement` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5113 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is WithStatement` diff --git a/docs/api_docs/namespaces/ts/functions/isYieldExpression.md b/docs/api_docs/namespaces/ts/functions/isYieldExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..972220127b2c3081b77db012bb992d8329a136f1 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/isYieldExpression.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / isYieldExpression + +# Function: isYieldExpression() + +> **isYieldExpression**(`node`): `node is YieldExpression` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5086 + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +`node is YieldExpression` diff --git a/docs/api_docs/namespaces/ts/functions/moveEmitHelpers.md b/docs/api_docs/namespaces/ts/functions/moveEmitHelpers.md new file mode 100644 index 0000000000000000000000000000000000000000..cc462b8d2545e987daa03fa9fd1f200ddf9d232d --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/moveEmitHelpers.md @@ -0,0 +1,31 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / moveEmitHelpers + +# Function: moveEmitHelpers() + +> **moveEmitHelpers**(`source`, `target`, `predicate`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5004 + +Moves matching emit helpers from a source node to a target node. + +## Parameters + +### source + +[`Node`](../interfaces/Node.md) + +### target + +[`Node`](../interfaces/Node.md) + +### predicate + +(`helper`) => `boolean` + +## Returns + +`void` diff --git a/docs/api_docs/namespaces/ts/functions/moveSyntheticComments.md b/docs/api_docs/namespaces/ts/functions/moveSyntheticComments.md new file mode 100644 index 0000000000000000000000000000000000000000..22713ac63b0e7f68d6bb3d54a844fd8d2c2780f3 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/moveSyntheticComments.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / moveSyntheticComments + +# Function: moveSyntheticComments() + +> **moveSyntheticComments**\<`T`\>(`node`, `original`): `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4976 + +## Type Parameters + +• **T** *extends* [`Node`](../interfaces/Node.md) + +## Parameters + +### node + +`T` + +### original + +[`Node`](../interfaces/Node.md) + +## Returns + +`T` diff --git a/docs/api_docs/namespaces/ts/functions/nodeModuleNameResolver.md b/docs/api_docs/namespaces/ts/functions/nodeModuleNameResolver.md new file mode 100644 index 0000000000000000000000000000000000000000..6b90f7e8860e221f466c6ca9c82b89e0ca644943 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/nodeModuleNameResolver.md @@ -0,0 +1,41 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / nodeModuleNameResolver + +# Function: nodeModuleNameResolver() + +> **nodeModuleNameResolver**(`moduleName`, `containingFile`, `compilerOptions`, `host`, `cache`?, `redirectedReference`?): [`ResolvedModuleWithFailedLookupLocations`](../interfaces/ResolvedModuleWithFailedLookupLocations.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5406 + +## Parameters + +### moduleName + +`string` + +### containingFile + +`string` + +### compilerOptions + +[`CompilerOptions`](../interfaces/CompilerOptions.md) + +### host + +[`ModuleResolutionHost`](../interfaces/ModuleResolutionHost.md) + +### cache? + +[`ModuleResolutionCache`](../interfaces/ModuleResolutionCache.md) + +### redirectedReference? + +[`ResolvedProjectReference`](../interfaces/ResolvedProjectReference.md) + +## Returns + +[`ResolvedModuleWithFailedLookupLocations`](../interfaces/ResolvedModuleWithFailedLookupLocations.md) diff --git a/docs/api_docs/namespaces/ts/functions/parseCommandLine.md b/docs/api_docs/namespaces/ts/functions/parseCommandLine.md new file mode 100644 index 0000000000000000000000000000000000000000..1aa3ee5564130810b2fe893d9c2f5e313e1559df --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/parseCommandLine.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / parseCommandLine + +# Function: parseCommandLine() + +> **parseCommandLine**(`commandLine`, `readFile`?): [`ParsedCommandLine`](../interfaces/ParsedCommandLine.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5258 + +## Parameters + +### commandLine + +readonly `string`[] + +### readFile? + +(`path`) => `undefined` \| `string` + +## Returns + +[`ParsedCommandLine`](../interfaces/ParsedCommandLine.md) diff --git a/docs/api_docs/namespaces/ts/functions/parseConfigFileTextToJson.md b/docs/api_docs/namespaces/ts/functions/parseConfigFileTextToJson.md new file mode 100644 index 0000000000000000000000000000000000000000..6955a071553284afe64415702055a6edf66c6ea3 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/parseConfigFileTextToJson.md @@ -0,0 +1,39 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / parseConfigFileTextToJson + +# Function: parseConfigFileTextToJson() + +> **parseConfigFileTextToJson**(`fileName`, `jsonText`): `object` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5292 + +Parse the text of the tsconfig.json file + +## Parameters + +### fileName + +`string` + +The path to the config file + +### jsonText + +`string` + +The text of the config file + +## Returns + +`object` + +### config? + +> `optional` **config**: `any` + +### error? + +> `optional` **error**: [`Diagnostic`](../interfaces/Diagnostic.md) diff --git a/docs/api_docs/namespaces/ts/functions/parseIsolatedEntityName.md b/docs/api_docs/namespaces/ts/functions/parseIsolatedEntityName.md new file mode 100644 index 0000000000000000000000000000000000000000..b564060a8df21b4f1e13d0187a4ce0df41c13472 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/parseIsolatedEntityName.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / parseIsolatedEntityName + +# Function: parseIsolatedEntityName() + +> **parseIsolatedEntityName**(`text`, `languageVersion`): `undefined` \| [`EntityName`](../type-aliases/EntityName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5246 + +## Parameters + +### text + +`string` + +### languageVersion + +[`ScriptTarget`](../enumerations/ScriptTarget.md) + +## Returns + +`undefined` \| [`EntityName`](../type-aliases/EntityName.md) diff --git a/docs/api_docs/namespaces/ts/functions/parseJsonConfigFileContent.md b/docs/api_docs/namespaces/ts/functions/parseJsonConfigFileContent.md new file mode 100644 index 0000000000000000000000000000000000000000..b7288ddbb84c90b16bb830be8689ad146d3cc4df --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/parseJsonConfigFileContent.md @@ -0,0 +1,62 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / parseJsonConfigFileContent + +# Function: parseJsonConfigFileContent() + +> **parseJsonConfigFileContent**(`json`, `host`, `basePath`, `existingOptions`?, `configFileName`?, `resolutionStack`?, `extraFileExtensions`?, `extendedConfigCache`?, `existingWatchOptions`?): [`ParsedCommandLine`](../interfaces/ParsedCommandLine.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5312 + +Parse the contents of a config file (tsconfig.json). + +## Parameters + +### json + +`any` + +The contents of the config file to parse + +### host + +[`ParseConfigHost`](../interfaces/ParseConfigHost.md) + +Instance of ParseConfigHost used to enumerate files in folder. + +### basePath + +`string` + +A root directory to resolve relative path entries in the config + file to. e.g. outDir + +### existingOptions? + +[`CompilerOptions`](../interfaces/CompilerOptions.md) + +### configFileName? + +`string` + +### resolutionStack? + +[`Path`](../type-aliases/Path.md)[] + +### extraFileExtensions? + +readonly [`FileExtensionInfo`](../interfaces/FileExtensionInfo.md)[] + +### extendedConfigCache? + +[`Map`](../interfaces/Map.md)\<[`ExtendedConfigCacheEntry`](../interfaces/ExtendedConfigCacheEntry.md)\> + +### existingWatchOptions? + +[`WatchOptions`](../interfaces/WatchOptions.md) + +## Returns + +[`ParsedCommandLine`](../interfaces/ParsedCommandLine.md) diff --git a/docs/api_docs/namespaces/ts/functions/parseJsonSourceFileConfigFileContent.md b/docs/api_docs/namespaces/ts/functions/parseJsonSourceFileConfigFileContent.md new file mode 100644 index 0000000000000000000000000000000000000000..16a95bd1acd0fc58e177006ce284bff3e02ff9de --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/parseJsonSourceFileConfigFileContent.md @@ -0,0 +1,60 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / parseJsonSourceFileConfigFileContent + +# Function: parseJsonSourceFileConfigFileContent() + +> **parseJsonSourceFileConfigFileContent**(`sourceFile`, `host`, `basePath`, `existingOptions`?, `configFileName`?, `resolutionStack`?, `extraFileExtensions`?, `extendedConfigCache`?, `existingWatchOptions`?): [`ParsedCommandLine`](../interfaces/ParsedCommandLine.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5320 + +Parse the contents of a config file (tsconfig.json). + +## Parameters + +### sourceFile + +[`TsConfigSourceFile`](../interfaces/TsConfigSourceFile.md) + +### host + +[`ParseConfigHost`](../interfaces/ParseConfigHost.md) + +Instance of ParseConfigHost used to enumerate files in folder. + +### basePath + +`string` + +A root directory to resolve relative path entries in the config + file to. e.g. outDir + +### existingOptions? + +[`CompilerOptions`](../interfaces/CompilerOptions.md) + +### configFileName? + +`string` + +### resolutionStack? + +[`Path`](../type-aliases/Path.md)[] + +### extraFileExtensions? + +readonly [`FileExtensionInfo`](../interfaces/FileExtensionInfo.md)[] + +### extendedConfigCache? + +[`Map`](../interfaces/Map.md)\<[`ExtendedConfigCacheEntry`](../interfaces/ExtendedConfigCacheEntry.md)\> + +### existingWatchOptions? + +[`WatchOptions`](../interfaces/WatchOptions.md) + +## Returns + +[`ParsedCommandLine`](../interfaces/ParsedCommandLine.md) diff --git a/docs/api_docs/namespaces/ts/functions/parseJsonText.md b/docs/api_docs/namespaces/ts/functions/parseJsonText.md new file mode 100644 index 0000000000000000000000000000000000000000..9fa76ce2f1e5962a90b76abdecd6ba2b303a1d9f --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/parseJsonText.md @@ -0,0 +1,27 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / parseJsonText + +# Function: parseJsonText() + +> **parseJsonText**(`fileName`, `sourceText`): [`JsonSourceFile`](../interfaces/JsonSourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5252 + +Parse json text into SyntaxTree and return node and parse errors if any + +## Parameters + +### fileName + +`string` + +### sourceText + +`string` + +## Returns + +[`JsonSourceFile`](../interfaces/JsonSourceFile.md) diff --git a/docs/api_docs/namespaces/ts/functions/parseModuleFromPath.md b/docs/api_docs/namespaces/ts/functions/parseModuleFromPath.md new file mode 100644 index 0000000000000000000000000000000000000000..7d26cea6400aca4d94c544e422586806bdf4f6c8 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/parseModuleFromPath.md @@ -0,0 +1,34 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / parseModuleFromPath + +# Function: parseModuleFromPath() + +> **parseModuleFromPath**(`resolved`, `packageManagerType`?): `undefined` \| `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5417 + +This will be called on the successfully resolved path from `loadModuleFromFile`. +(Not needed for `loadModuleFromNodeModules` as that looks up the `package.json` or `oh-package.json5` as part of resolution.) + +packageDirectory is the directory of the package itself. + For `blah/node_modules/foo/index.d.ts` this is packageDirectory: "foo" + For `/node_modules/foo/bar.d.ts` this is packageDirectory: "foo" + For `/node_modules/@types/foo/bar/index.d.ts` this is packageDirectory: "@types/foo" + For `/node_modules/foo/bar/index.d.ts` this is packageDirectory: "foo" + +## Parameters + +### resolved + +`string` + +### packageManagerType? + +`string` + +## Returns + +`undefined` \| `string` diff --git a/docs/api_docs/namespaces/ts/functions/pathContainsOHModules.md b/docs/api_docs/namespaces/ts/functions/pathContainsOHModules.md new file mode 100644 index 0000000000000000000000000000000000000000..9df68d316567f08f00b31662b0f6f9e1d1711c19 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/pathContainsOHModules.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / pathContainsOHModules + +# Function: pathContainsOHModules() + +> **pathContainsOHModules**(`path`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5433 + +## Parameters + +### path + +`string` + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/functions/preProcessFile.md b/docs/api_docs/namespaces/ts/functions/preProcessFile.md new file mode 100644 index 0000000000000000000000000000000000000000..c875dbd4d851ec9264d8480355bee8101601fa0b --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/preProcessFile.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / preProcessFile + +# Function: preProcessFile() + +> **preProcessFile**(`sourceText`, `readImportFiles`?, `detectJavaScriptImports`?): [`PreProcessedFileInfo`](../interfaces/PreProcessedFileInfo.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7411 + +## Parameters + +### sourceText + +`string` + +### readImportFiles? + +`boolean` + +### detectJavaScriptImports? + +`boolean` + +## Returns + +[`PreProcessedFileInfo`](../interfaces/PreProcessedFileInfo.md) diff --git a/docs/api_docs/namespaces/ts/functions/readBuilderProgram.md b/docs/api_docs/namespaces/ts/functions/readBuilderProgram.md new file mode 100644 index 0000000000000000000000000000000000000000..2082c670fb80daeaadafec06d62e8f9bbfd89c6b --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/readBuilderProgram.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / readBuilderProgram + +# Function: readBuilderProgram() + +> **readBuilderProgram**(`compilerOptions`, `host`, `isForLinter`?): `undefined` \| [`EmitAndSemanticDiagnosticsBuilderProgram`](../interfaces/EmitAndSemanticDiagnosticsBuilderProgram.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5780 + +## Parameters + +### compilerOptions + +[`CompilerOptions`](../interfaces/CompilerOptions.md) + +### host + +[`ReadBuildProgramHost`](../interfaces/ReadBuildProgramHost.md) + +### isForLinter? + +`boolean` + +## Returns + +`undefined` \| [`EmitAndSemanticDiagnosticsBuilderProgram`](../interfaces/EmitAndSemanticDiagnosticsBuilderProgram.md) diff --git a/docs/api_docs/namespaces/ts/functions/readConfigFile.md b/docs/api_docs/namespaces/ts/functions/readConfigFile.md new file mode 100644 index 0000000000000000000000000000000000000000..8e863a596f24cad2fabc4cb81ef0f6bb2c7e2568 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/readConfigFile.md @@ -0,0 +1,37 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / readConfigFile + +# Function: readConfigFile() + +> **readConfigFile**(`fileName`, `readFile`): `object` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5283 + +Read tsconfig.json file + +## Parameters + +### fileName + +`string` + +The path to the config file + +### readFile + +(`path`) => `undefined` \| `string` + +## Returns + +`object` + +### config? + +> `optional` **config**: `any` + +### error? + +> `optional` **error**: [`Diagnostic`](../interfaces/Diagnostic.md) diff --git a/docs/api_docs/namespaces/ts/functions/readJsonConfigFile.md b/docs/api_docs/namespaces/ts/functions/readJsonConfigFile.md new file mode 100644 index 0000000000000000000000000000000000000000..eca6478c4736fb803873d055a0e0be95ba0b56f2 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/readJsonConfigFile.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / readJsonConfigFile + +# Function: readJsonConfigFile() + +> **readJsonConfigFile**(`fileName`, `readFile`): [`TsConfigSourceFile`](../interfaces/TsConfigSourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5300 + +Read tsconfig.json file + +## Parameters + +### fileName + +`string` + +The path to the config file + +### readFile + +(`path`) => `undefined` \| `string` + +## Returns + +[`TsConfigSourceFile`](../interfaces/TsConfigSourceFile.md) diff --git a/docs/api_docs/namespaces/ts/functions/reduceEachLeadingCommentRange.md b/docs/api_docs/namespaces/ts/functions/reduceEachLeadingCommentRange.md new file mode 100644 index 0000000000000000000000000000000000000000..37e70c9d774711a897a7af8d6ce43f60eb70e332 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/reduceEachLeadingCommentRange.md @@ -0,0 +1,43 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / reduceEachLeadingCommentRange + +# Function: reduceEachLeadingCommentRange() + +> **reduceEachLeadingCommentRange**\<`T`, `U`\>(`text`, `pos`, `cb`, `state`, `initial`): `undefined` \| `U` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4626 + +## Type Parameters + +• **T** + +• **U** + +## Parameters + +### text + +`string` + +### pos + +`number` + +### cb + +(`pos`, `end`, `kind`, `hasTrailingNewLine`, `state`, `memo`) => `U` + +### state + +`T` + +### initial + +`U` + +## Returns + +`undefined` \| `U` diff --git a/docs/api_docs/namespaces/ts/functions/reduceEachTrailingCommentRange.md b/docs/api_docs/namespaces/ts/functions/reduceEachTrailingCommentRange.md new file mode 100644 index 0000000000000000000000000000000000000000..9e37a3fc995ae537c15eb4161f8eb021a1c43e52 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/reduceEachTrailingCommentRange.md @@ -0,0 +1,43 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / reduceEachTrailingCommentRange + +# Function: reduceEachTrailingCommentRange() + +> **reduceEachTrailingCommentRange**\<`T`, `U`\>(`text`, `pos`, `cb`, `state`, `initial`): `undefined` \| `U` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4627 + +## Type Parameters + +• **T** + +• **U** + +## Parameters + +### text + +`string` + +### pos + +`number` + +### cb + +(`pos`, `end`, `kind`, `hasTrailingNewLine`, `state`, `memo`) => `U` + +### state + +`T` + +### initial + +`U` + +## Returns + +`undefined` \| `U` diff --git a/docs/api_docs/namespaces/ts/functions/removeEmitHelper.md b/docs/api_docs/namespaces/ts/functions/removeEmitHelper.md new file mode 100644 index 0000000000000000000000000000000000000000..959a711009caaedd27104989ae54296ac6900969 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/removeEmitHelper.md @@ -0,0 +1,27 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / removeEmitHelper + +# Function: removeEmitHelper() + +> **removeEmitHelper**(`node`, `helper`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4996 + +Removes an EmitHelper from a node. + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +### helper + +[`EmitHelper`](../type-aliases/EmitHelper.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/functions/resolveModuleName.md b/docs/api_docs/namespaces/ts/functions/resolveModuleName.md new file mode 100644 index 0000000000000000000000000000000000000000..562324bfa97b15ca58e595a8602055bb8b29a706 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/resolveModuleName.md @@ -0,0 +1,45 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / resolveModuleName + +# Function: resolveModuleName() + +> **resolveModuleName**(`moduleName`, `containingFile`, `compilerOptions`, `host`, `cache`?, `redirectedReference`?, `resolutionMode`?): [`ResolvedModuleWithFailedLookupLocations`](../interfaces/ResolvedModuleWithFailedLookupLocations.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5405 + +## Parameters + +### moduleName + +`string` + +### containingFile + +`string` + +### compilerOptions + +[`CompilerOptions`](../interfaces/CompilerOptions.md) + +### host + +[`ModuleResolutionHost`](../interfaces/ModuleResolutionHost.md) + +### cache? + +[`ModuleResolutionCache`](../interfaces/ModuleResolutionCache.md) + +### redirectedReference? + +[`ResolvedProjectReference`](../interfaces/ResolvedProjectReference.md) + +### resolutionMode? + +[`CommonJS`](../enumerations/ModuleKind.md#commonjs) | [`ESNext`](../enumerations/ModuleKind.md#esnext) + +## Returns + +[`ResolvedModuleWithFailedLookupLocations`](../interfaces/ResolvedModuleWithFailedLookupLocations.md) diff --git a/docs/api_docs/namespaces/ts/functions/resolveModuleNameFromCache.md b/docs/api_docs/namespaces/ts/functions/resolveModuleNameFromCache.md new file mode 100644 index 0000000000000000000000000000000000000000..c52bfccfd6cd233e2a7da90c4dbcbb8e4455d787 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/resolveModuleNameFromCache.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / resolveModuleNameFromCache + +# Function: resolveModuleNameFromCache() + +> **resolveModuleNameFromCache**(`moduleName`, `containingFile`, `cache`, `mode`?): `undefined` \| [`ResolvedModuleWithFailedLookupLocations`](../interfaces/ResolvedModuleWithFailedLookupLocations.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5404 + +## Parameters + +### moduleName + +`string` + +### containingFile + +`string` + +### cache + +[`ModuleResolutionCache`](../interfaces/ModuleResolutionCache.md) + +### mode? + +[`CommonJS`](../enumerations/ModuleKind.md#commonjs) | [`ESNext`](../enumerations/ModuleKind.md#esnext) + +## Returns + +`undefined` \| [`ResolvedModuleWithFailedLookupLocations`](../interfaces/ResolvedModuleWithFailedLookupLocations.md) diff --git a/docs/api_docs/namespaces/ts/functions/resolveProjectReferencePath.md b/docs/api_docs/namespaces/ts/functions/resolveProjectReferencePath.md new file mode 100644 index 0000000000000000000000000000000000000000..5d522fbc93be127c6a0b7920da51cf2677194665 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/resolveProjectReferencePath.md @@ -0,0 +1,48 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / resolveProjectReferencePath + +# Function: resolveProjectReferencePath() + +## Call Signature + +> **resolveProjectReferencePath**(`ref`): [`ResolvedConfigFileName`](../type-aliases/ResolvedConfigFileName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5626 + +Returns the target config filename of a project reference. +Note: The file might not exist. + +### Parameters + +#### ref + +[`ProjectReference`](../interfaces/ProjectReference.md) + +### Returns + +[`ResolvedConfigFileName`](../type-aliases/ResolvedConfigFileName.md) + +## Call Signature + +> **resolveProjectReferencePath**(`host`, `ref`): [`ResolvedConfigFileName`](../type-aliases/ResolvedConfigFileName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5627 + +### Parameters + +#### host + +[`ResolveProjectReferencePathHost`](../interfaces/ResolveProjectReferencePathHost.md) + +#### ref + +[`ProjectReference`](../interfaces/ProjectReference.md) + +### Returns + +[`ResolvedConfigFileName`](../type-aliases/ResolvedConfigFileName.md) + +### Deprecated diff --git a/docs/api_docs/namespaces/ts/functions/resolveTripleslashReference.md b/docs/api_docs/namespaces/ts/functions/resolveTripleslashReference.md new file mode 100644 index 0000000000000000000000000000000000000000..a71ed130c1a3bc73e2f17214ea930d1645f515bb --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/resolveTripleslashReference.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / resolveTripleslashReference + +# Function: resolveTripleslashReference() + +> **resolveTripleslashReference**(`moduleName`, `containingFile`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5544 + +## Parameters + +### moduleName + +`string` + +### containingFile + +`string` + +## Returns + +`string` diff --git a/docs/api_docs/namespaces/ts/functions/resolveTypeReferenceDirective.md b/docs/api_docs/namespaces/ts/functions/resolveTypeReferenceDirective.md new file mode 100644 index 0000000000000000000000000000000000000000..81a84e8c05094dd8d218157bb4e0f994b2f8d726 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/resolveTypeReferenceDirective.md @@ -0,0 +1,49 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / resolveTypeReferenceDirective + +# Function: resolveTypeReferenceDirective() + +> **resolveTypeReferenceDirective**(`typeReferenceDirectiveName`, `containingFile`, `options`, `host`, `redirectedReference`?, `cache`?, `resolutionMode`?): [`ResolvedTypeReferenceDirectiveWithFailedLookupLocations`](../interfaces/ResolvedTypeReferenceDirectiveWithFailedLookupLocations.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5352 + +## Parameters + +### typeReferenceDirectiveName + +`string` + +### containingFile + +file that contains type reference directive, can be undefined if containing file is unknown. +This is possible in case if resolution is performed for directives specified via 'types' parameter. In this case initial path for secondary lookups +is assumed to be the same as root directory of the project. + +`undefined` | `string` + +### options + +[`CompilerOptions`](../interfaces/CompilerOptions.md) + +### host + +[`ModuleResolutionHost`](../interfaces/ModuleResolutionHost.md) + +### redirectedReference? + +[`ResolvedProjectReference`](../interfaces/ResolvedProjectReference.md) + +### cache? + +[`TypeReferenceDirectiveResolutionCache`](../interfaces/TypeReferenceDirectiveResolutionCache.md) + +### resolutionMode? + +[`CommonJS`](../enumerations/ModuleKind.md#commonjs) | [`ESNext`](../enumerations/ModuleKind.md#esnext) + +## Returns + +[`ResolvedTypeReferenceDirectiveWithFailedLookupLocations`](../interfaces/ResolvedTypeReferenceDirectiveWithFailedLookupLocations.md) diff --git a/docs/api_docs/namespaces/ts/functions/setCommentRange.md b/docs/api_docs/namespaces/ts/functions/setCommentRange.md new file mode 100644 index 0000000000000000000000000000000000000000..88104da588ae9e53700c2557e0d4317b52318e05 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/setCommentRange.md @@ -0,0 +1,31 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / setCommentRange + +# Function: setCommentRange() + +> **setCommentRange**\<`T`\>(`node`, `range`): `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4969 + +Sets a custom text range to use when emitting comments. + +## Type Parameters + +• **T** *extends* [`Node`](../interfaces/Node.md) + +## Parameters + +### node + +`T` + +### range + +[`TextRange`](../interfaces/TextRange.md) + +## Returns + +`T` diff --git a/docs/api_docs/namespaces/ts/functions/setConstantValue.md b/docs/api_docs/namespaces/ts/functions/setConstantValue.md new file mode 100644 index 0000000000000000000000000000000000000000..87946a182c7251ae307a8a101d1f2d246787b1cb --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/setConstantValue.md @@ -0,0 +1,27 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / setConstantValue + +# Function: setConstantValue() + +> **setConstantValue**(`node`, `value`): [`AccessExpression`](../type-aliases/AccessExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4984 + +Sets the constant value to emit for an expression. + +## Parameters + +### node + +[`AccessExpression`](../type-aliases/AccessExpression.md) + +### value + +`string` | `number` + +## Returns + +[`AccessExpression`](../type-aliases/AccessExpression.md) diff --git a/docs/api_docs/namespaces/ts/functions/setEmitFlags.md b/docs/api_docs/namespaces/ts/functions/setEmitFlags.md new file mode 100644 index 0000000000000000000000000000000000000000..9ea3fff73debced7c2292c318edc6c2cbc615fbb --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/setEmitFlags.md @@ -0,0 +1,31 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / setEmitFlags + +# Function: setEmitFlags() + +> **setEmitFlags**\<`T`\>(`node`, `emitFlags`): `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4945 + +Sets flags that control emit behavior of a node. + +## Type Parameters + +• **T** *extends* [`Node`](../interfaces/Node.md) + +## Parameters + +### node + +`T` + +### emitFlags + +[`EmitFlags`](../enumerations/EmitFlags.md) + +## Returns + +`T` diff --git a/docs/api_docs/namespaces/ts/functions/setOriginalNode.md b/docs/api_docs/namespaces/ts/functions/setOriginalNode.md new file mode 100644 index 0000000000000000000000000000000000000000..b1d8539f1d5a130c7d998f8d6b56687a43a45a95 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/setOriginalNode.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / setOriginalNode + +# Function: setOriginalNode() + +> **setOriginalNode**\<`T`\>(`node`, `original`): `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4934 + +## Type Parameters + +• **T** *extends* [`Node`](../interfaces/Node.md) + +## Parameters + +### node + +`T` + +### original + +`undefined` | [`Node`](../interfaces/Node.md) + +## Returns + +`T` diff --git a/docs/api_docs/namespaces/ts/functions/setParentRecursive.md b/docs/api_docs/namespaces/ts/functions/setParentRecursive.md new file mode 100644 index 0000000000000000000000000000000000000000..be2411f4e24e381e3a631d3df753fd6f5c5da36f --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/setParentRecursive.md @@ -0,0 +1,69 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / setParentRecursive + +# Function: setParentRecursive() + +## Call Signature + +> **setParentRecursive**\<`T`\>(`rootNode`, `incremental`): `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4919 + +Bypasses immutability and directly sets the `parent` property of each `Node` recursively. + +### Type Parameters + +• **T** *extends* [`Node`](../interfaces/Node.md) + +### Parameters + +#### rootNode + +`T` + +The root node from which to start the recursion. + +#### incremental + +`boolean` + +When `true`, only recursively descends through nodes whose `parent` pointers are incorrect. +This allows us to quickly bail out of setting `parent` for subtrees during incremental parsing. + +### Returns + +`T` + +## Call Signature + +> **setParentRecursive**\<`T`\>(`rootNode`, `incremental`): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4920 + +Bypasses immutability and directly sets the `parent` property of each `Node` recursively. + +### Type Parameters + +• **T** *extends* [`Node`](../interfaces/Node.md) + +### Parameters + +#### rootNode + +The root node from which to start the recursion. + +`undefined` | `T` + +#### incremental + +`boolean` + +When `true`, only recursively descends through nodes whose `parent` pointers are incorrect. +This allows us to quickly bail out of setting `parent` for subtrees during incremental parsing. + +### Returns + +`undefined` \| `T` diff --git a/docs/api_docs/namespaces/ts/functions/setSourceMapRange.md b/docs/api_docs/namespaces/ts/functions/setSourceMapRange.md new file mode 100644 index 0000000000000000000000000000000000000000..8e80e12ed44713114691bce1206e117c45cc7dc4 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/setSourceMapRange.md @@ -0,0 +1,31 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / setSourceMapRange + +# Function: setSourceMapRange() + +> **setSourceMapRange**\<`T`\>(`node`, `range`): `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4953 + +Sets a custom text range to use when emitting source maps. + +## Type Parameters + +• **T** *extends* [`Node`](../interfaces/Node.md) + +## Parameters + +### node + +`T` + +### range + +`undefined` | [`SourceMapRange`](../interfaces/SourceMapRange.md) + +## Returns + +`T` diff --git a/docs/api_docs/namespaces/ts/functions/setSyntheticLeadingComments.md b/docs/api_docs/namespaces/ts/functions/setSyntheticLeadingComments.md new file mode 100644 index 0000000000000000000000000000000000000000..be6d7694a0a809d055fdbe84cd116acf37a55803 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/setSyntheticLeadingComments.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / setSyntheticLeadingComments + +# Function: setSyntheticLeadingComments() + +> **setSyntheticLeadingComments**\<`T`\>(`node`, `comments`): `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4971 + +## Type Parameters + +• **T** *extends* [`Node`](../interfaces/Node.md) + +## Parameters + +### node + +`T` + +### comments + +`undefined` | [`SynthesizedComment`](../interfaces/SynthesizedComment.md)[] + +## Returns + +`T` diff --git a/docs/api_docs/namespaces/ts/functions/setSyntheticTrailingComments.md b/docs/api_docs/namespaces/ts/functions/setSyntheticTrailingComments.md new file mode 100644 index 0000000000000000000000000000000000000000..355de7fc5003238cbfd04a56b7f3eb1dcaf2b600 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/setSyntheticTrailingComments.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / setSyntheticTrailingComments + +# Function: setSyntheticTrailingComments() + +> **setSyntheticTrailingComments**\<`T`\>(`node`, `comments`): `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4974 + +## Type Parameters + +• **T** *extends* [`Node`](../interfaces/Node.md) + +## Parameters + +### node + +`T` + +### comments + +`undefined` | [`SynthesizedComment`](../interfaces/SynthesizedComment.md)[] + +## Returns + +`T` diff --git a/docs/api_docs/namespaces/ts/functions/setTextRange.md b/docs/api_docs/namespaces/ts/functions/setTextRange.md new file mode 100644 index 0000000000000000000000000000000000000000..8b4f5a775579dbd0b8338c6debcd3d67cdae7349 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/setTextRange.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / setTextRange + +# Function: setTextRange() + +> **setTextRange**\<`T`\>(`range`, `location`): `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5211 + +## Type Parameters + +• **T** *extends* [`TextRange`](../interfaces/TextRange.md) + +## Parameters + +### range + +`T` + +### location + +`undefined` | [`TextRange`](../interfaces/TextRange.md) + +## Returns + +`T` diff --git a/docs/api_docs/namespaces/ts/functions/setTokenSourceMapRange.md b/docs/api_docs/namespaces/ts/functions/setTokenSourceMapRange.md new file mode 100644 index 0000000000000000000000000000000000000000..12a431029cf7d6f5c9f6b5a1f838fbe87b018099 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/setTokenSourceMapRange.md @@ -0,0 +1,35 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / setTokenSourceMapRange + +# Function: setTokenSourceMapRange() + +> **setTokenSourceMapRange**\<`T`\>(`node`, `token`, `range`): `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4961 + +Sets the TextRange to use for source maps for a token of a node. + +## Type Parameters + +• **T** *extends* [`Node`](../interfaces/Node.md) + +## Parameters + +### node + +`T` + +### token + +[`SyntaxKind`](../enumerations/SyntaxKind.md) + +### range + +`undefined` | [`SourceMapRange`](../interfaces/SourceMapRange.md) + +## Returns + +`T` diff --git a/docs/api_docs/namespaces/ts/functions/skipPartiallyEmittedExpressions.md b/docs/api_docs/namespaces/ts/functions/skipPartiallyEmittedExpressions.md new file mode 100644 index 0000000000000000000000000000000000000000..2015a771f4fe153d5487a2637df6f86ac3d6252f --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/skipPartiallyEmittedExpressions.md @@ -0,0 +1,39 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / skipPartiallyEmittedExpressions + +# Function: skipPartiallyEmittedExpressions() + +## Call Signature + +> **skipPartiallyEmittedExpressions**(`node`): [`Expression`](../interfaces/Expression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4841 + +### Parameters + +#### node + +[`Expression`](../interfaces/Expression.md) + +### Returns + +[`Expression`](../interfaces/Expression.md) + +## Call Signature + +> **skipPartiallyEmittedExpressions**(`node`): [`Node`](../interfaces/Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4842 + +### Parameters + +#### node + +[`Node`](../interfaces/Node.md) + +### Returns + +[`Node`](../interfaces/Node.md) diff --git a/docs/api_docs/namespaces/ts/functions/sortAndDeduplicateDiagnostics.md b/docs/api_docs/namespaces/ts/functions/sortAndDeduplicateDiagnostics.md new file mode 100644 index 0000000000000000000000000000000000000000..1c8ca346ae970d48f3c84b32a140090bb0a5f795 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/sortAndDeduplicateDiagnostics.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / sortAndDeduplicateDiagnostics + +# Function: sortAndDeduplicateDiagnostics() + +> **sortAndDeduplicateDiagnostics**\<`T`\>(`diagnostics`): [`SortedReadonlyArray`](../interfaces/SortedReadonlyArray.md)\<`T`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4638 + +## Type Parameters + +• **T** *extends* [`Diagnostic`](../interfaces/Diagnostic.md) + +## Parameters + +### diagnostics + +readonly `T`[] + +## Returns + +[`SortedReadonlyArray`](../interfaces/SortedReadonlyArray.md)\<`T`\> diff --git a/docs/api_docs/namespaces/ts/functions/symbolName.md b/docs/api_docs/namespaces/ts/functions/symbolName.md new file mode 100644 index 0000000000000000000000000000000000000000..448bf47e848abd22728c0244f942650c64687a1e --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/symbolName.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / symbolName + +# Function: symbolName() + +> **symbolName**(`symbol`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4730 + +## Parameters + +### symbol + +[`Symbol`](../interfaces/Symbol.md) + +## Returns + +`string` diff --git a/docs/api_docs/namespaces/ts/functions/textChangeRangeIsUnchanged.md b/docs/api_docs/namespaces/ts/functions/textChangeRangeIsUnchanged.md new file mode 100644 index 0000000000000000000000000000000000000000..33000212ccef848d642feef4e93d587cf8b110e6 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/textChangeRangeIsUnchanged.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / textChangeRangeIsUnchanged + +# Function: textChangeRangeIsUnchanged() + +> **textChangeRangeIsUnchanged**(`range`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4654 + +## Parameters + +### range + +[`TextChangeRange`](../interfaces/TextChangeRange.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/functions/textChangeRangeNewSpan.md b/docs/api_docs/namespaces/ts/functions/textChangeRangeNewSpan.md new file mode 100644 index 0000000000000000000000000000000000000000..c13ec3b5b1be416b81d235750734f00ea2595c52 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/textChangeRangeNewSpan.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / textChangeRangeNewSpan + +# Function: textChangeRangeNewSpan() + +> **textChangeRangeNewSpan**(`range`): [`TextSpan`](../interfaces/TextSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4653 + +## Parameters + +### range + +[`TextChangeRange`](../interfaces/TextChangeRange.md) + +## Returns + +[`TextSpan`](../interfaces/TextSpan.md) diff --git a/docs/api_docs/namespaces/ts/functions/textSpanContainsPosition.md b/docs/api_docs/namespaces/ts/functions/textSpanContainsPosition.md new file mode 100644 index 0000000000000000000000000000000000000000..5aac6f441a6172bf0db356c4f22e7558e2cf5ba8 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/textSpanContainsPosition.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / textSpanContainsPosition + +# Function: textSpanContainsPosition() + +> **textSpanContainsPosition**(`span`, `position`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4642 + +## Parameters + +### span + +[`TextSpan`](../interfaces/TextSpan.md) + +### position + +`number` + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/functions/textSpanContainsTextSpan.md b/docs/api_docs/namespaces/ts/functions/textSpanContainsTextSpan.md new file mode 100644 index 0000000000000000000000000000000000000000..63694238802c539fa936497654f82ca45c4d5cee --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/textSpanContainsTextSpan.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / textSpanContainsTextSpan + +# Function: textSpanContainsTextSpan() + +> **textSpanContainsTextSpan**(`span`, `other`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4643 + +## Parameters + +### span + +[`TextSpan`](../interfaces/TextSpan.md) + +### other + +[`TextSpan`](../interfaces/TextSpan.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/functions/textSpanEnd.md b/docs/api_docs/namespaces/ts/functions/textSpanEnd.md new file mode 100644 index 0000000000000000000000000000000000000000..c1eaea8b0dbbffee923de1af83e9662f0c96f7eb --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/textSpanEnd.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / textSpanEnd + +# Function: textSpanEnd() + +> **textSpanEnd**(`span`): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4640 + +## Parameters + +### span + +[`TextSpan`](../interfaces/TextSpan.md) + +## Returns + +`number` diff --git a/docs/api_docs/namespaces/ts/functions/textSpanIntersection.md b/docs/api_docs/namespaces/ts/functions/textSpanIntersection.md new file mode 100644 index 0000000000000000000000000000000000000000..720f21031c9c77bcdad1cfcb2cf9c6d85de7ad71 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/textSpanIntersection.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / textSpanIntersection + +# Function: textSpanIntersection() + +> **textSpanIntersection**(`span1`, `span2`): `undefined` \| [`TextSpan`](../interfaces/TextSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4650 + +## Parameters + +### span1 + +[`TextSpan`](../interfaces/TextSpan.md) + +### span2 + +[`TextSpan`](../interfaces/TextSpan.md) + +## Returns + +`undefined` \| [`TextSpan`](../interfaces/TextSpan.md) diff --git a/docs/api_docs/namespaces/ts/functions/textSpanIntersectsWith.md b/docs/api_docs/namespaces/ts/functions/textSpanIntersectsWith.md new file mode 100644 index 0000000000000000000000000000000000000000..f4162a3d00812ad7ebb0a686c00bd35b3f58336d --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/textSpanIntersectsWith.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / textSpanIntersectsWith + +# Function: textSpanIntersectsWith() + +> **textSpanIntersectsWith**(`span`, `start`, `length`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4647 + +## Parameters + +### span + +[`TextSpan`](../interfaces/TextSpan.md) + +### start + +`number` + +### length + +`number` + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/functions/textSpanIntersectsWithPosition.md b/docs/api_docs/namespaces/ts/functions/textSpanIntersectsWithPosition.md new file mode 100644 index 0000000000000000000000000000000000000000..9dfe35658d750a96ab8d32ef65f5131c911837a4 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/textSpanIntersectsWithPosition.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / textSpanIntersectsWithPosition + +# Function: textSpanIntersectsWithPosition() + +> **textSpanIntersectsWithPosition**(`span`, `position`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4649 + +## Parameters + +### span + +[`TextSpan`](../interfaces/TextSpan.md) + +### position + +`number` + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/functions/textSpanIntersectsWithTextSpan.md b/docs/api_docs/namespaces/ts/functions/textSpanIntersectsWithTextSpan.md new file mode 100644 index 0000000000000000000000000000000000000000..8d938cc34ac2fc173915c3af747384012552a3f8 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/textSpanIntersectsWithTextSpan.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / textSpanIntersectsWithTextSpan + +# Function: textSpanIntersectsWithTextSpan() + +> **textSpanIntersectsWithTextSpan**(`span`, `other`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4646 + +## Parameters + +### span + +[`TextSpan`](../interfaces/TextSpan.md) + +### other + +[`TextSpan`](../interfaces/TextSpan.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/functions/textSpanIsEmpty.md b/docs/api_docs/namespaces/ts/functions/textSpanIsEmpty.md new file mode 100644 index 0000000000000000000000000000000000000000..e8367b474769261ad2f73c95dda11d45f0ed329a --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/textSpanIsEmpty.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / textSpanIsEmpty + +# Function: textSpanIsEmpty() + +> **textSpanIsEmpty**(`span`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4641 + +## Parameters + +### span + +[`TextSpan`](../interfaces/TextSpan.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/functions/textSpanOverlap.md b/docs/api_docs/namespaces/ts/functions/textSpanOverlap.md new file mode 100644 index 0000000000000000000000000000000000000000..b8db515e3eec7919d2fca62da48a9fcffb68ef5c --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/textSpanOverlap.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / textSpanOverlap + +# Function: textSpanOverlap() + +> **textSpanOverlap**(`span1`, `span2`): `undefined` \| [`TextSpan`](../interfaces/TextSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4645 + +## Parameters + +### span1 + +[`TextSpan`](../interfaces/TextSpan.md) + +### span2 + +[`TextSpan`](../interfaces/TextSpan.md) + +## Returns + +`undefined` \| [`TextSpan`](../interfaces/TextSpan.md) diff --git a/docs/api_docs/namespaces/ts/functions/textSpanOverlapsWith.md b/docs/api_docs/namespaces/ts/functions/textSpanOverlapsWith.md new file mode 100644 index 0000000000000000000000000000000000000000..18f245493ee065dbdd198de4cd0de970e87e5353 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/textSpanOverlapsWith.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / textSpanOverlapsWith + +# Function: textSpanOverlapsWith() + +> **textSpanOverlapsWith**(`span`, `other`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4644 + +## Parameters + +### span + +[`TextSpan`](../interfaces/TextSpan.md) + +### other + +[`TextSpan`](../interfaces/TextSpan.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/functions/toEditorSettings.md b/docs/api_docs/namespaces/ts/functions/toEditorSettings.md new file mode 100644 index 0000000000000000000000000000000000000000..8660f14f84a3a6ee8385c66e7c051346c8eadd8c --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/toEditorSettings.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / toEditorSettings + +# Function: toEditorSettings() + +> **toEditorSettings**(`options`): [`EditorSettings`](../interfaces/EditorSettings.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7433 + +## Parameters + +### options + +[`EditorSettings`](../interfaces/EditorSettings.md) | [`EditorOptions`](../interfaces/EditorOptions.md) + +## Returns + +[`EditorSettings`](../interfaces/EditorSettings.md) diff --git a/docs/api_docs/namespaces/ts/functions/tokenToString.md b/docs/api_docs/namespaces/ts/functions/tokenToString.md new file mode 100644 index 0000000000000000000000000000000000000000..8fc842a83d1a83c3dad2386a9692fc979e60fe2e --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/tokenToString.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / tokenToString + +# Function: tokenToString() + +> **tokenToString**(`t`): `undefined` \| `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4614 + +## Parameters + +### t + +[`SyntaxKind`](../enumerations/SyntaxKind.md) + +## Returns + +`undefined` \| `string` diff --git a/docs/api_docs/namespaces/ts/functions/transform.md b/docs/api_docs/namespaces/ts/functions/transform.md new file mode 100644 index 0000000000000000000000000000000000000000..b4c1646a0c11396a0591cb360a669159e568cac1 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/transform.md @@ -0,0 +1,41 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / transform + +# Function: transform() + +> **transform**\<`T`\>(`source`, `transformers`, `compilerOptions`?): [`TransformationResult`](../interfaces/TransformationResult.md)\<`T`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7454 + +Transform one or more nodes using the supplied transformers. + +## Type Parameters + +• **T** *extends* [`Node`](../interfaces/Node.md) + +## Parameters + +### source + +A single `Node` or an array of `Node` objects. + +`T` | `T`[] + +### transformers + +[`TransformerFactory`](../type-aliases/TransformerFactory.md)\<`T`\>[] + +An array of `TransformerFactory` callbacks used to process the transformation. + +### compilerOptions? + +[`CompilerOptions`](../interfaces/CompilerOptions.md) + +Optional compiler options. + +## Returns + +[`TransformationResult`](../interfaces/TransformationResult.md)\<`T`\> diff --git a/docs/api_docs/namespaces/ts/functions/transformTypeExportImportAndConstEnumInTypeScript.md b/docs/api_docs/namespaces/ts/functions/transformTypeExportImportAndConstEnumInTypeScript.md new file mode 100644 index 0000000000000000000000000000000000000000..1473aa5edb845b1e09d066f350eb290acfd61156 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/transformTypeExportImportAndConstEnumInTypeScript.md @@ -0,0 +1,34 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / transformTypeExportImportAndConstEnumInTypeScript + +# Function: transformTypeExportImportAndConstEnumInTypeScript() + +> **transformTypeExportImportAndConstEnumInTypeScript**(`context`): (`node`) => [`SourceFile`](../interfaces/SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5440 + +Add 'type' flag to import/export when import/export an type member. +Replace const enum with number and string literal. + +## Parameters + +### context + +[`TransformationContext`](../interfaces/TransformationContext.md) + +## Returns + +`Function` + +### Parameters + +#### node + +[`SourceFile`](../interfaces/SourceFile.md) + +### Returns + +[`SourceFile`](../interfaces/SourceFile.md) diff --git a/docs/api_docs/namespaces/ts/functions/transpile.md b/docs/api_docs/namespaces/ts/functions/transpile.md new file mode 100644 index 0000000000000000000000000000000000000000..c0f9763b4379bc20c0f9e5a0cd05bd4a8fe44efd --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/transpile.md @@ -0,0 +1,37 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / transpile + +# Function: transpile() + +> **transpile**(`input`, `compilerOptions`?, `fileName`?, `diagnostics`?, `moduleName`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7428 + +## Parameters + +### input + +`string` + +### compilerOptions? + +[`CompilerOptions`](../interfaces/CompilerOptions.md) + +### fileName? + +`string` + +### diagnostics? + +[`Diagnostic`](../interfaces/Diagnostic.md)[] + +### moduleName? + +`string` + +## Returns + +`string` diff --git a/docs/api_docs/namespaces/ts/functions/transpileModule.md b/docs/api_docs/namespaces/ts/functions/transpileModule.md new file mode 100644 index 0000000000000000000000000000000000000000..e8a2d8aca4de11ebd9ee00ea175650746ad37535 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/transpileModule.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / transpileModule + +# Function: transpileModule() + +> **transpileModule**(`input`, `transpileOptions`): [`TranspileOutput`](../interfaces/TranspileOutput.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7427 + +## Parameters + +### input + +`string` + +### transpileOptions + +[`TranspileOptions`](../interfaces/TranspileOptions.md) + +## Returns + +[`TranspileOutput`](../interfaces/TranspileOutput.md) diff --git a/docs/api_docs/namespaces/ts/functions/unescapeLeadingUnderscores.md b/docs/api_docs/namespaces/ts/functions/unescapeLeadingUnderscores.md new file mode 100644 index 0000000000000000000000000000000000000000..55b6d0ff8f8d635c4bd3fb2e8f7dbd5596b1ca3b --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/unescapeLeadingUnderscores.md @@ -0,0 +1,27 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / unescapeLeadingUnderscores + +# Function: unescapeLeadingUnderscores() + +> **unescapeLeadingUnderscores**(`identifier`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4728 + +Remove extra underscore from escaped identifier text content. + +## Parameters + +### identifier + +[`__String`](../type-aliases/String.md) + +The escaped identifier text. + +## Returns + +`string` + +The unescaped identifier text. diff --git a/docs/api_docs/namespaces/ts/functions/updateArrayBindingPattern.md b/docs/api_docs/namespaces/ts/functions/updateArrayBindingPattern.md new file mode 100644 index 0000000000000000000000000000000000000000..2cf6a206075dcb402152a5013121e23bd0f38bfe --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateArrayBindingPattern.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateArrayBindingPattern + +# Function: ~~updateArrayBindingPattern()~~ + +> **updateArrayBindingPattern**(`node`, `elements`): [`ArrayBindingPattern`](../interfaces/ArrayBindingPattern.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7683 + +## Parameters + +### node + +[`ArrayBindingPattern`](../interfaces/ArrayBindingPattern.md) + +### elements + +readonly [`ArrayBindingElement`](../type-aliases/ArrayBindingElement.md)[] + +## Returns + +[`ArrayBindingPattern`](../interfaces/ArrayBindingPattern.md) + +## Deprecated + +Use `factory.updateArrayBindingPattern` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateArrayLiteral.md b/docs/api_docs/namespaces/ts/functions/updateArrayLiteral.md new file mode 100644 index 0000000000000000000000000000000000000000..7ff9e36ec963ace93b5229187fd2387a344864e2 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateArrayLiteral.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateArrayLiteral + +# Function: ~~updateArrayLiteral()~~ + +> **updateArrayLiteral**(`node`, `elements`): [`ArrayLiteralExpression`](../interfaces/ArrayLiteralExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7691 + +## Parameters + +### node + +[`ArrayLiteralExpression`](../interfaces/ArrayLiteralExpression.md) + +### elements + +readonly [`Expression`](../interfaces/Expression.md)[] + +## Returns + +[`ArrayLiteralExpression`](../interfaces/ArrayLiteralExpression.md) + +## Deprecated + +Use `factory.updateArrayLiteralExpression` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateArrayTypeNode.md b/docs/api_docs/namespaces/ts/functions/updateArrayTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..912a7036a13c8810710f00a0ffb4f3b3843fd82c --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateArrayTypeNode.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateArrayTypeNode + +# Function: ~~updateArrayTypeNode()~~ + +> **updateArrayTypeNode**(`node`, `elementType`): [`ArrayTypeNode`](../interfaces/ArrayTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7616 + +## Parameters + +### node + +[`ArrayTypeNode`](../interfaces/ArrayTypeNode.md) + +### elementType + +[`TypeNode`](../interfaces/TypeNode.md) + +## Returns + +[`ArrayTypeNode`](../interfaces/ArrayTypeNode.md) + +## Deprecated + +Use `factory.updateArrayTypeNode` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateArrowFunction.md b/docs/api_docs/namespaces/ts/functions/updateArrowFunction.md new file mode 100644 index 0000000000000000000000000000000000000000..3897c612ea048800003bbe2ee3eab5aa1bbda6a8 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateArrowFunction.md @@ -0,0 +1,87 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateArrowFunction + +# Function: ~~updateArrowFunction()~~ + +## Deprecated + +Use `factory.updateArrowFunction` or the factory supplied by your transformation context instead. + +## Call Signature + +> **updateArrowFunction**(`node`, `modifiers`, `typeParameters`, `parameters`, `type`, `equalsGreaterThanToken`, `body`): [`ArrowFunction`](../interfaces/ArrowFunction.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8259 + +### Parameters + +#### node + +[`ArrowFunction`](../interfaces/ArrowFunction.md) + +#### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +#### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](../interfaces/TypeParameterDeclaration.md)[] + +#### parameters + +readonly [`ParameterDeclaration`](../interfaces/ParameterDeclaration.md)[] + +#### type + +`undefined` | [`TypeNode`](../interfaces/TypeNode.md) + +#### equalsGreaterThanToken + +[`EqualsGreaterThanToken`](../type-aliases/EqualsGreaterThanToken.md) + +#### body + +[`ConciseBody`](../type-aliases/ConciseBody.md) + +### Returns + +[`ArrowFunction`](../interfaces/ArrowFunction.md) + +## Call Signature + +> **updateArrowFunction**(`node`, `modifiers`, `typeParameters`, `parameters`, `type`, `body`): [`ArrowFunction`](../interfaces/ArrowFunction.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8260 + +### Parameters + +#### node + +[`ArrowFunction`](../interfaces/ArrowFunction.md) + +#### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +#### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](../interfaces/TypeParameterDeclaration.md)[] + +#### parameters + +readonly [`ParameterDeclaration`](../interfaces/ParameterDeclaration.md)[] + +#### type + +`undefined` | [`TypeNode`](../interfaces/TypeNode.md) + +#### body + +[`ConciseBody`](../type-aliases/ConciseBody.md) + +### Returns + +[`ArrowFunction`](../interfaces/ArrowFunction.md) diff --git a/docs/api_docs/namespaces/ts/functions/updateAsExpression.md b/docs/api_docs/namespaces/ts/functions/updateAsExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..58b1b940e9d5ff656b4274e65503e0968d7ebf90 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateAsExpression.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateAsExpression + +# Function: ~~updateAsExpression()~~ + +> **updateAsExpression**(`node`, `expression`, `type`): [`AsExpression`](../interfaces/AsExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7799 + +## Parameters + +### node + +[`AsExpression`](../interfaces/AsExpression.md) + +### expression + +[`Expression`](../interfaces/Expression.md) + +### type + +[`TypeNode`](../interfaces/TypeNode.md) + +## Returns + +[`AsExpression`](../interfaces/AsExpression.md) + +## Deprecated + +Use `factory.updateAsExpression` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateAwait.md b/docs/api_docs/namespaces/ts/functions/updateAwait.md new file mode 100644 index 0000000000000000000000000000000000000000..ae126a802adbd537288b46129bad10f06ea48d7d --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateAwait.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateAwait + +# Function: ~~updateAwait()~~ + +> **updateAwait**(`node`, `expression`): [`AwaitExpression`](../interfaces/AwaitExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7751 + +## Parameters + +### node + +[`AwaitExpression`](../interfaces/AwaitExpression.md) + +### expression + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`AwaitExpression`](../interfaces/AwaitExpression.md) + +## Deprecated + +Use `factory.updateAwaitExpression` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateBinary.md b/docs/api_docs/namespaces/ts/functions/updateBinary.md new file mode 100644 index 0000000000000000000000000000000000000000..7632db8a08c6c2bce586a9a33ef056693d7929ec --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateBinary.md @@ -0,0 +1,37 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateBinary + +# Function: ~~updateBinary()~~ + +> **updateBinary**(`node`, `left`, `right`, `operator`?): [`BinaryExpression`](../interfaces/BinaryExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8229 + +## Parameters + +### node + +[`BinaryExpression`](../interfaces/BinaryExpression.md) + +### left + +[`Expression`](../interfaces/Expression.md) + +### right + +[`Expression`](../interfaces/Expression.md) + +### operator? + +[`BinaryOperatorToken`](../type-aliases/BinaryOperatorToken.md) | [`BinaryOperator`](../type-aliases/BinaryOperator.md) + +## Returns + +[`BinaryExpression`](../interfaces/BinaryExpression.md) + +## Deprecated + +Use `factory.updateBinary` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateBindingElement.md b/docs/api_docs/namespaces/ts/functions/updateBindingElement.md new file mode 100644 index 0000000000000000000000000000000000000000..16c8cd6e872b3c373ca40433de6783e2e92078b4 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateBindingElement.md @@ -0,0 +1,41 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateBindingElement + +# Function: ~~updateBindingElement()~~ + +> **updateBindingElement**(`node`, `dotDotDotToken`, `propertyName`, `name`, `initializer`): [`BindingElement`](../interfaces/BindingElement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7687 + +## Parameters + +### node + +[`BindingElement`](../interfaces/BindingElement.md) + +### dotDotDotToken + +`undefined` | [`DotDotDotToken`](../type-aliases/DotDotDotToken.md) + +### propertyName + +`undefined` | [`PropertyName`](../type-aliases/PropertyName.md) + +### name + +[`BindingName`](../type-aliases/BindingName.md) + +### initializer + +`undefined` | [`Expression`](../interfaces/Expression.md) + +## Returns + +[`BindingElement`](../interfaces/BindingElement.md) + +## Deprecated + +Use `factory.updateBindingElement` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateBlock.md b/docs/api_docs/namespaces/ts/functions/updateBlock.md new file mode 100644 index 0000000000000000000000000000000000000000..96796978d5c64a4dbf43cfcf907a49a9514c9956 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateBlock.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateBlock + +# Function: ~~updateBlock()~~ + +> **updateBlock**(`node`, `statements`): [`Block`](../interfaces/Block.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7821 + +## Parameters + +### node + +[`Block`](../interfaces/Block.md) + +### statements + +readonly [`Statement`](../interfaces/Statement.md)[] + +## Returns + +[`Block`](../interfaces/Block.md) + +## Deprecated + +Use `factory.updateBlock` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateBreak.md b/docs/api_docs/namespaces/ts/functions/updateBreak.md new file mode 100644 index 0000000000000000000000000000000000000000..ae1754695a47d102702453ed7fd7222888c82afe --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateBreak.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateBreak + +# Function: ~~updateBreak()~~ + +> **updateBreak**(`node`, `label`): [`BreakStatement`](../interfaces/BreakStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7867 + +## Parameters + +### node + +[`BreakStatement`](../interfaces/BreakStatement.md) + +### label + +`undefined` | [`Identifier`](../interfaces/Identifier.md) + +## Returns + +[`BreakStatement`](../interfaces/BreakStatement.md) + +## Deprecated + +Use `factory.updateBreakStatement` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateBundle.md b/docs/api_docs/namespaces/ts/functions/updateBundle.md new file mode 100644 index 0000000000000000000000000000000000000000..71a39e5a98d240bfa5ffe1ae86bb9245a4422f4d --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateBundle.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateBundle + +# Function: ~~updateBundle()~~ + +> **updateBundle**(`node`, `sourceFiles`, `prepends`?): [`Bundle`](../interfaces/Bundle.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8163 + +## Parameters + +### node + +[`Bundle`](../interfaces/Bundle.md) + +### sourceFiles + +readonly [`SourceFile`](../interfaces/SourceFile.md)[] + +### prepends? + +readonly ([`InputFiles`](../interfaces/InputFiles.md) \| [`UnparsedSource`](../interfaces/UnparsedSource.md))[] + +## Returns + +[`Bundle`](../interfaces/Bundle.md) + +## Deprecated + +Use `factory.updateBundle` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateCall.md b/docs/api_docs/namespaces/ts/functions/updateCall.md new file mode 100644 index 0000000000000000000000000000000000000000..8ec2dc925ac707c59cdce20c89f51b6f0555ef08 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateCall.md @@ -0,0 +1,37 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateCall + +# Function: ~~updateCall()~~ + +> **updateCall**(`node`, `expression`, `typeArguments`, `argumentsArray`): [`CallExpression`](../interfaces/CallExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7715 + +## Parameters + +### node + +[`CallExpression`](../interfaces/CallExpression.md) + +### expression + +[`Expression`](../interfaces/Expression.md) + +### typeArguments + +`undefined` | readonly [`TypeNode`](../interfaces/TypeNode.md)[] + +### argumentsArray + +readonly [`Expression`](../interfaces/Expression.md)[] + +## Returns + +[`CallExpression`](../interfaces/CallExpression.md) + +## Deprecated + +Use `factory.updateCallExpression` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateCallChain.md b/docs/api_docs/namespaces/ts/functions/updateCallChain.md new file mode 100644 index 0000000000000000000000000000000000000000..e1dc42841ea16f27ccac993dc5f1fb4feecb4884 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateCallChain.md @@ -0,0 +1,41 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateCallChain + +# Function: ~~updateCallChain()~~ + +> **updateCallChain**(`node`, `expression`, `questionDotToken`, `typeArguments`, `argumentsArray`): [`CallChain`](../interfaces/CallChain.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7719 + +## Parameters + +### node + +[`CallChain`](../interfaces/CallChain.md) + +### expression + +[`Expression`](../interfaces/Expression.md) + +### questionDotToken + +`undefined` | [`QuestionDotToken`](../type-aliases/QuestionDotToken.md) + +### typeArguments + +`undefined` | readonly [`TypeNode`](../interfaces/TypeNode.md)[] + +### argumentsArray + +readonly [`Expression`](../interfaces/Expression.md)[] + +## Returns + +[`CallChain`](../interfaces/CallChain.md) + +## Deprecated + +Use `factory.updateCallChain` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateCallSignature.md b/docs/api_docs/namespaces/ts/functions/updateCallSignature.md new file mode 100644 index 0000000000000000000000000000000000000000..eb935b0506b596e9f1e8276514e5e55f1deb5696 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateCallSignature.md @@ -0,0 +1,37 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateCallSignature + +# Function: ~~updateCallSignature()~~ + +> **updateCallSignature**(`node`, `typeParameters`, `parameters`, `type`): [`CallSignatureDeclaration`](../interfaces/CallSignatureDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7577 + +## Parameters + +### node + +[`CallSignatureDeclaration`](../interfaces/CallSignatureDeclaration.md) + +### typeParameters + +`undefined` | [`NodeArray`](../interfaces/NodeArray.md)\<[`TypeParameterDeclaration`](../interfaces/TypeParameterDeclaration.md)\> + +### parameters + +[`NodeArray`](../interfaces/NodeArray.md)\<[`ParameterDeclaration`](../interfaces/ParameterDeclaration.md)\> + +### type + +`undefined` | [`TypeNode`](../interfaces/TypeNode.md) + +## Returns + +[`CallSignatureDeclaration`](../interfaces/CallSignatureDeclaration.md) + +## Deprecated + +Use `factory.updateCallSignature` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateCaseBlock.md b/docs/api_docs/namespaces/ts/functions/updateCaseBlock.md new file mode 100644 index 0000000000000000000000000000000000000000..093990de636fee906236527408ff225c2d1f302a --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateCaseBlock.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateCaseBlock + +# Function: ~~updateCaseBlock()~~ + +> **updateCaseBlock**(`node`, `clauses`): [`CaseBlock`](../interfaces/CaseBlock.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7965 + +## Parameters + +### node + +[`CaseBlock`](../interfaces/CaseBlock.md) + +### clauses + +readonly [`CaseOrDefaultClause`](../type-aliases/CaseOrDefaultClause.md)[] + +## Returns + +[`CaseBlock`](../interfaces/CaseBlock.md) + +## Deprecated + +Use `factory.updateCaseBlock` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateCaseClause.md b/docs/api_docs/namespaces/ts/functions/updateCaseClause.md new file mode 100644 index 0000000000000000000000000000000000000000..032598ebfe37e77af52d4a608b388bcba2a4b264 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateCaseClause.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateCaseClause + +# Function: ~~updateCaseClause()~~ + +> **updateCaseClause**(`node`, `expression`, `statements`): [`CaseClause`](../interfaces/CaseClause.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8119 + +## Parameters + +### node + +[`CaseClause`](../interfaces/CaseClause.md) + +### expression + +[`Expression`](../interfaces/Expression.md) + +### statements + +readonly [`Statement`](../interfaces/Statement.md)[] + +## Returns + +[`CaseClause`](../interfaces/CaseClause.md) + +## Deprecated + +Use `factory.updateCaseClause` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateCatchClause.md b/docs/api_docs/namespaces/ts/functions/updateCatchClause.md new file mode 100644 index 0000000000000000000000000000000000000000..0e645589ca257512a948f125e2dce254ebeb4e59 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateCatchClause.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateCatchClause + +# Function: ~~updateCatchClause()~~ + +> **updateCatchClause**(`node`, `variableDeclaration`, `block`): [`CatchClause`](../interfaces/CatchClause.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8131 + +## Parameters + +### node + +[`CatchClause`](../interfaces/CatchClause.md) + +### variableDeclaration + +`undefined` | [`VariableDeclaration`](../interfaces/VariableDeclaration.md) + +### block + +[`Block`](../interfaces/Block.md) + +## Returns + +[`CatchClause`](../interfaces/CatchClause.md) + +## Deprecated + +Use `factory.updateCatchClause` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateClassDeclaration.md b/docs/api_docs/namespaces/ts/functions/updateClassDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..97141877cc4cfe65db03f0e2ad5e4bb33c7d55c2 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateClassDeclaration.md @@ -0,0 +1,87 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateClassDeclaration + +# Function: ~~updateClassDeclaration()~~ + +## Deprecated + +Use `factory.updateClassDeclaration` or the factory supplied by your transformation context instead. + +## Call Signature + +> **updateClassDeclaration**(`node`, `modifiers`, `name`, `typeParameters`, `heritageClauses`, `members`): [`ClassDeclaration`](../interfaces/ClassDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7915 + +### Parameters + +#### node + +[`ClassDeclaration`](../interfaces/ClassDeclaration.md) + +#### modifiers + +`undefined` | readonly [`ModifierLike`](../type-aliases/ModifierLike.md)[] + +#### name + +`undefined` | [`Identifier`](../interfaces/Identifier.md) + +#### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](../interfaces/TypeParameterDeclaration.md)[] + +#### heritageClauses + +`undefined` | readonly [`HeritageClause`](../interfaces/HeritageClause.md)[] + +#### members + +readonly [`ClassElement`](../interfaces/ClassElement.md)[] + +### Returns + +[`ClassDeclaration`](../interfaces/ClassDeclaration.md) + +## Call Signature + +> **updateClassDeclaration**(`node`, `decorators`, `modifiers`, `name`, `typeParameters`, `heritageClauses`, `members`): [`ClassDeclaration`](../interfaces/ClassDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7916 + +### Parameters + +#### node + +[`ClassDeclaration`](../interfaces/ClassDeclaration.md) + +#### decorators + +`undefined` | readonly [`Decorator`](../interfaces/Decorator.md)[] + +#### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +#### name + +`undefined` | [`Identifier`](../interfaces/Identifier.md) + +#### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](../interfaces/TypeParameterDeclaration.md)[] + +#### heritageClauses + +`undefined` | readonly [`HeritageClause`](../interfaces/HeritageClause.md)[] + +#### members + +readonly [`ClassElement`](../interfaces/ClassElement.md)[] + +### Returns + +[`ClassDeclaration`](../interfaces/ClassDeclaration.md) diff --git a/docs/api_docs/namespaces/ts/functions/updateClassExpression.md b/docs/api_docs/namespaces/ts/functions/updateClassExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..25d65b23940366ded745f5c69bfd703de1388f84 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateClassExpression.md @@ -0,0 +1,45 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateClassExpression + +# Function: ~~updateClassExpression()~~ + +> **updateClassExpression**(`node`, `modifiers`, `name`, `typeParameters`, `heritageClauses`, `members`): [`ClassExpression`](../interfaces/ClassExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8243 + +## Parameters + +### node + +[`ClassExpression`](../interfaces/ClassExpression.md) + +### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +### name + +`undefined` | [`Identifier`](../interfaces/Identifier.md) + +### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](../interfaces/TypeParameterDeclaration.md)[] + +### heritageClauses + +`undefined` | readonly [`HeritageClause`](../interfaces/HeritageClause.md)[] + +### members + +readonly [`ClassElement`](../interfaces/ClassElement.md)[] + +## Returns + +[`ClassExpression`](../interfaces/ClassExpression.md) + +## Deprecated + +Use `factory.updateClassExpression` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateCommaList.md b/docs/api_docs/namespaces/ts/functions/updateCommaList.md new file mode 100644 index 0000000000000000000000000000000000000000..a8da5b67ddd5944ee1a4f4beceff39479aa5caa7 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateCommaList.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateCommaList + +# Function: ~~updateCommaList()~~ + +> **updateCommaList**(`node`, `elements`): [`CommaListExpression`](../interfaces/CommaListExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8159 + +## Parameters + +### node + +[`CommaListExpression`](../interfaces/CommaListExpression.md) + +### elements + +readonly [`Expression`](../interfaces/Expression.md)[] + +## Returns + +[`CommaListExpression`](../interfaces/CommaListExpression.md) + +## Deprecated + +Use `factory.updateCommaListExpression` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateComputedPropertyName.md b/docs/api_docs/namespaces/ts/functions/updateComputedPropertyName.md new file mode 100644 index 0000000000000000000000000000000000000000..3e76f9db74328b3e7bb9d1139288fe0154d71071 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateComputedPropertyName.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateComputedPropertyName + +# Function: ~~updateComputedPropertyName()~~ + +> **updateComputedPropertyName**(`node`, `expression`): [`ComputedPropertyName`](../interfaces/ComputedPropertyName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7499 + +## Parameters + +### node + +[`ComputedPropertyName`](../interfaces/ComputedPropertyName.md) + +### expression + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`ComputedPropertyName`](../interfaces/ComputedPropertyName.md) + +## Deprecated + +Use `factory.updateComputedPropertyName` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateConditional.md b/docs/api_docs/namespaces/ts/functions/updateConditional.md new file mode 100644 index 0000000000000000000000000000000000000000..acbc34d1ed4ba0b8ebf5216d0de6bb38dfd1915b --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateConditional.md @@ -0,0 +1,45 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateConditional + +# Function: ~~updateConditional()~~ + +> **updateConditional**(`node`, `condition`, `questionToken`, `whenTrue`, `colonToken`, `whenFalse`): [`ConditionalExpression`](../interfaces/ConditionalExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7763 + +## Parameters + +### node + +[`ConditionalExpression`](../interfaces/ConditionalExpression.md) + +### condition + +[`Expression`](../interfaces/Expression.md) + +### questionToken + +[`QuestionToken`](../type-aliases/QuestionToken.md) + +### whenTrue + +[`Expression`](../interfaces/Expression.md) + +### colonToken + +[`ColonToken`](../type-aliases/ColonToken.md) + +### whenFalse + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`ConditionalExpression`](../interfaces/ConditionalExpression.md) + +## Deprecated + +Use `factory.updateConditionalExpression` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateConditionalTypeNode.md b/docs/api_docs/namespaces/ts/functions/updateConditionalTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..8011f20e46f683f719f3608b1c70ae149923191e --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateConditionalTypeNode.md @@ -0,0 +1,41 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateConditionalTypeNode + +# Function: ~~updateConditionalTypeNode()~~ + +> **updateConditionalTypeNode**(`node`, `checkType`, `extendsType`, `trueType`, `falseType`): [`ConditionalTypeNode`](../interfaces/ConditionalTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7640 + +## Parameters + +### node + +[`ConditionalTypeNode`](../interfaces/ConditionalTypeNode.md) + +### checkType + +[`TypeNode`](../interfaces/TypeNode.md) + +### extendsType + +[`TypeNode`](../interfaces/TypeNode.md) + +### trueType + +[`TypeNode`](../interfaces/TypeNode.md) + +### falseType + +[`TypeNode`](../interfaces/TypeNode.md) + +## Returns + +[`ConditionalTypeNode`](../interfaces/ConditionalTypeNode.md) + +## Deprecated + +Use `factory.updateConditionalTypeNode` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateConstructSignature.md b/docs/api_docs/namespaces/ts/functions/updateConstructSignature.md new file mode 100644 index 0000000000000000000000000000000000000000..d0ac53e06b1e896ab6562b8a935208cb5780a2fc --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateConstructSignature.md @@ -0,0 +1,37 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateConstructSignature + +# Function: ~~updateConstructSignature()~~ + +> **updateConstructSignature**(`node`, `typeParameters`, `parameters`, `type`): [`ConstructSignatureDeclaration`](../interfaces/ConstructSignatureDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7581 + +## Parameters + +### node + +[`ConstructSignatureDeclaration`](../interfaces/ConstructSignatureDeclaration.md) + +### typeParameters + +`undefined` | [`NodeArray`](../interfaces/NodeArray.md)\<[`TypeParameterDeclaration`](../interfaces/TypeParameterDeclaration.md)\> + +### parameters + +[`NodeArray`](../interfaces/NodeArray.md)\<[`ParameterDeclaration`](../interfaces/ParameterDeclaration.md)\> + +### type + +`undefined` | [`TypeNode`](../interfaces/TypeNode.md) + +## Returns + +[`ConstructSignatureDeclaration`](../interfaces/ConstructSignatureDeclaration.md) + +## Deprecated + +Use `factory.updateConstructSignature` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateConstructor.md b/docs/api_docs/namespaces/ts/functions/updateConstructor.md new file mode 100644 index 0000000000000000000000000000000000000000..1fe4a8543f10b2d26fd3f21d38cca542e9834940 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateConstructor.md @@ -0,0 +1,71 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateConstructor + +# Function: ~~updateConstructor()~~ + +## Deprecated + +Use `factory.updateConstructorDeclaration` or the factory supplied by your transformation context instead. + +## Call Signature + +> **updateConstructor**(`node`, `modifiers`, `parameters`, `body`): [`ConstructorDeclaration`](../interfaces/ConstructorDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7551 + +### Parameters + +#### node + +[`ConstructorDeclaration`](../interfaces/ConstructorDeclaration.md) + +#### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +#### parameters + +readonly [`ParameterDeclaration`](../interfaces/ParameterDeclaration.md)[] + +#### body + +`undefined` | [`Block`](../interfaces/Block.md) + +### Returns + +[`ConstructorDeclaration`](../interfaces/ConstructorDeclaration.md) + +## Call Signature + +> **updateConstructor**(`node`, `decorators`, `modifiers`, `parameters`, `body`): [`ConstructorDeclaration`](../interfaces/ConstructorDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7552 + +### Parameters + +#### node + +[`ConstructorDeclaration`](../interfaces/ConstructorDeclaration.md) + +#### decorators + +`undefined` | readonly [`Decorator`](../interfaces/Decorator.md)[] + +#### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +#### parameters + +readonly [`ParameterDeclaration`](../interfaces/ParameterDeclaration.md)[] + +#### body + +`undefined` | [`Block`](../interfaces/Block.md) + +### Returns + +[`ConstructorDeclaration`](../interfaces/ConstructorDeclaration.md) diff --git a/docs/api_docs/namespaces/ts/functions/updateConstructorTypeNode.md b/docs/api_docs/namespaces/ts/functions/updateConstructorTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..c40d25ad194af68b5ff3d12fd8fef7ca7cb09c6e --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateConstructorTypeNode.md @@ -0,0 +1,37 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateConstructorTypeNode + +# Function: ~~updateConstructorTypeNode()~~ + +> **updateConstructorTypeNode**(`node`, `typeParameters`, `parameters`, `type`): [`ConstructorTypeNode`](../interfaces/ConstructorTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7604 + +## Parameters + +### node + +[`ConstructorTypeNode`](../interfaces/ConstructorTypeNode.md) + +### typeParameters + +`undefined` | [`NodeArray`](../interfaces/NodeArray.md)\<[`TypeParameterDeclaration`](../interfaces/TypeParameterDeclaration.md)\> + +### parameters + +[`NodeArray`](../interfaces/NodeArray.md)\<[`ParameterDeclaration`](../interfaces/ParameterDeclaration.md)\> + +### type + +[`TypeNode`](../interfaces/TypeNode.md) + +## Returns + +[`ConstructorTypeNode`](../interfaces/ConstructorTypeNode.md) + +## Deprecated + +Use `factory.updateConstructorTypeNode` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateContinue.md b/docs/api_docs/namespaces/ts/functions/updateContinue.md new file mode 100644 index 0000000000000000000000000000000000000000..15dd8703dcfaa173d073ae27332ff3c9bc90569b --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateContinue.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateContinue + +# Function: ~~updateContinue()~~ + +> **updateContinue**(`node`, `label`): [`ContinueStatement`](../interfaces/ContinueStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7863 + +## Parameters + +### node + +[`ContinueStatement`](../interfaces/ContinueStatement.md) + +### label + +`undefined` | [`Identifier`](../interfaces/Identifier.md) + +## Returns + +[`ContinueStatement`](../interfaces/ContinueStatement.md) + +## Deprecated + +Use `factory.updateContinueStatement` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateDecorator.md b/docs/api_docs/namespaces/ts/functions/updateDecorator.md new file mode 100644 index 0000000000000000000000000000000000000000..1dcbadd1ea38be7ebb9b4528d55e35bb49763ae3 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateDecorator.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateDecorator + +# Function: ~~updateDecorator()~~ + +> **updateDecorator**(`node`, `expression`): [`Decorator`](../interfaces/Decorator.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7523 + +## Parameters + +### node + +[`Decorator`](../interfaces/Decorator.md) + +### expression + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`Decorator`](../interfaces/Decorator.md) + +## Deprecated + +Use `factory.updateDecorator` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateDefaultClause.md b/docs/api_docs/namespaces/ts/functions/updateDefaultClause.md new file mode 100644 index 0000000000000000000000000000000000000000..0a1b1c324d30f254d96ba2b46c773ddd87589791 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateDefaultClause.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateDefaultClause + +# Function: ~~updateDefaultClause()~~ + +> **updateDefaultClause**(`node`, `statements`): [`DefaultClause`](../interfaces/DefaultClause.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8123 + +## Parameters + +### node + +[`DefaultClause`](../interfaces/DefaultClause.md) + +### statements + +readonly [`Statement`](../interfaces/Statement.md)[] + +## Returns + +[`DefaultClause`](../interfaces/DefaultClause.md) + +## Deprecated + +Use `factory.updateDefaultClause` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateDelete.md b/docs/api_docs/namespaces/ts/functions/updateDelete.md new file mode 100644 index 0000000000000000000000000000000000000000..0aa4f73233b7204d527f684179ea33f08a565ff2 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateDelete.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateDelete + +# Function: ~~updateDelete()~~ + +> **updateDelete**(`node`, `expression`): [`DeleteExpression`](../interfaces/DeleteExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7739 + +## Parameters + +### node + +[`DeleteExpression`](../interfaces/DeleteExpression.md) + +### expression + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`DeleteExpression`](../interfaces/DeleteExpression.md) + +## Deprecated + +Use `factory.updateDeleteExpression` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateDo.md b/docs/api_docs/namespaces/ts/functions/updateDo.md new file mode 100644 index 0000000000000000000000000000000000000000..af0fdd4642c4850eea221d89348a4267631564e6 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateDo.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateDo + +# Function: ~~updateDo()~~ + +> **updateDo**(`node`, `statement`, `expression`): [`DoStatement`](../interfaces/DoStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7843 + +## Parameters + +### node + +[`DoStatement`](../interfaces/DoStatement.md) + +### statement + +[`Statement`](../interfaces/Statement.md) + +### expression + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`DoStatement`](../interfaces/DoStatement.md) + +## Deprecated + +Use `factory.updateDoStatement` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateElementAccess.md b/docs/api_docs/namespaces/ts/functions/updateElementAccess.md new file mode 100644 index 0000000000000000000000000000000000000000..b6d5a24232f2e8cc83a979a4e50033123e0e2888 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateElementAccess.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateElementAccess + +# Function: ~~updateElementAccess()~~ + +> **updateElementAccess**(`node`, `expression`, `argumentExpression`): [`ElementAccessExpression`](../interfaces/ElementAccessExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7707 + +## Parameters + +### node + +[`ElementAccessExpression`](../interfaces/ElementAccessExpression.md) + +### expression + +[`Expression`](../interfaces/Expression.md) + +### argumentExpression + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`ElementAccessExpression`](../interfaces/ElementAccessExpression.md) + +## Deprecated + +Use `factory.updateElementAccessExpression` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateElementAccessChain.md b/docs/api_docs/namespaces/ts/functions/updateElementAccessChain.md new file mode 100644 index 0000000000000000000000000000000000000000..1928bf9dd9f09770aad71bf4387b51c6444db11e --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateElementAccessChain.md @@ -0,0 +1,37 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateElementAccessChain + +# Function: ~~updateElementAccessChain()~~ + +> **updateElementAccessChain**(`node`, `expression`, `questionDotToken`, `argumentExpression`): [`ElementAccessChain`](../interfaces/ElementAccessChain.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7711 + +## Parameters + +### node + +[`ElementAccessChain`](../interfaces/ElementAccessChain.md) + +### expression + +[`Expression`](../interfaces/Expression.md) + +### questionDotToken + +`undefined` | [`QuestionDotToken`](../type-aliases/QuestionDotToken.md) + +### argumentExpression + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`ElementAccessChain`](../interfaces/ElementAccessChain.md) + +## Deprecated + +Use `factory.updateElementAccessChain` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateEnumDeclaration.md b/docs/api_docs/namespaces/ts/functions/updateEnumDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..50d105eb425f5cd756b2a6b0ee22d23694a794b0 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateEnumDeclaration.md @@ -0,0 +1,71 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateEnumDeclaration + +# Function: ~~updateEnumDeclaration()~~ + +## Deprecated + +Use `factory.updateEnumDeclaration` or the factory supplied by your transformation context instead. + +## Call Signature + +> **updateEnumDeclaration**(`node`, `modifiers`, `name`, `members`): [`EnumDeclaration`](../interfaces/EnumDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7945 + +### Parameters + +#### node + +[`EnumDeclaration`](../interfaces/EnumDeclaration.md) + +#### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +#### name + +[`Identifier`](../interfaces/Identifier.md) + +#### members + +readonly [`EnumMember`](../interfaces/EnumMember.md)[] + +### Returns + +[`EnumDeclaration`](../interfaces/EnumDeclaration.md) + +## Call Signature + +> **updateEnumDeclaration**(`node`, `decorators`, `modifiers`, `name`, `members`): [`EnumDeclaration`](../interfaces/EnumDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7946 + +### Parameters + +#### node + +[`EnumDeclaration`](../interfaces/EnumDeclaration.md) + +#### decorators + +`undefined` | readonly [`Decorator`](../interfaces/Decorator.md)[] + +#### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +#### name + +[`Identifier`](../interfaces/Identifier.md) + +#### members + +readonly [`EnumMember`](../interfaces/EnumMember.md)[] + +### Returns + +[`EnumDeclaration`](../interfaces/EnumDeclaration.md) diff --git a/docs/api_docs/namespaces/ts/functions/updateEnumMember.md b/docs/api_docs/namespaces/ts/functions/updateEnumMember.md new file mode 100644 index 0000000000000000000000000000000000000000..20352c8d9a1b387efd65c1f7eab8921b3c023a0e --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateEnumMember.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateEnumMember + +# Function: ~~updateEnumMember()~~ + +> **updateEnumMember**(`node`, `name`, `initializer`): [`EnumMember`](../interfaces/EnumMember.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8147 + +## Parameters + +### node + +[`EnumMember`](../interfaces/EnumMember.md) + +### name + +[`PropertyName`](../type-aliases/PropertyName.md) + +### initializer + +`undefined` | [`Expression`](../interfaces/Expression.md) + +## Returns + +[`EnumMember`](../interfaces/EnumMember.md) + +## Deprecated + +Use `factory.updateEnumMember` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateExportAssignment.md b/docs/api_docs/namespaces/ts/functions/updateExportAssignment.md new file mode 100644 index 0000000000000000000000000000000000000000..e69e4ef385a6fb87f67bcf0b4b4beb53cdfb5fff --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateExportAssignment.md @@ -0,0 +1,63 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateExportAssignment + +# Function: ~~updateExportAssignment()~~ + +## Deprecated + +Use `factory.updateExportAssignment` or the factory supplied by your transformation context instead. + +## Call Signature + +> **updateExportAssignment**(`node`, `modifiers`, `expression`): [`ExportAssignment`](../interfaces/ExportAssignment.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8009 + +### Parameters + +#### node + +[`ExportAssignment`](../interfaces/ExportAssignment.md) + +#### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +#### expression + +[`Expression`](../interfaces/Expression.md) + +### Returns + +[`ExportAssignment`](../interfaces/ExportAssignment.md) + +## Call Signature + +> **updateExportAssignment**(`node`, `decorators`, `modifiers`, `expression`): [`ExportAssignment`](../interfaces/ExportAssignment.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8010 + +### Parameters + +#### node + +[`ExportAssignment`](../interfaces/ExportAssignment.md) + +#### decorators + +`undefined` | readonly [`Decorator`](../interfaces/Decorator.md)[] + +#### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +#### expression + +[`Expression`](../interfaces/Expression.md) + +### Returns + +[`ExportAssignment`](../interfaces/ExportAssignment.md) diff --git a/docs/api_docs/namespaces/ts/functions/updateExportDeclaration.md b/docs/api_docs/namespaces/ts/functions/updateExportDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..5658c3524ac854e6e446552f02ae329ba6fb7262 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateExportDeclaration.md @@ -0,0 +1,45 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateExportDeclaration + +# Function: ~~updateExportDeclaration()~~ + +> **updateExportDeclaration**(`node`, `decorators`, `modifiers`, `exportClause`, `moduleSpecifier`, `isTypeOnly`): [`ExportDeclaration`](../interfaces/ExportDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8279 + +## Parameters + +### node + +[`ExportDeclaration`](../interfaces/ExportDeclaration.md) + +### decorators + +`undefined` | readonly [`Decorator`](../interfaces/Decorator.md)[] + +### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +### exportClause + +`undefined` | [`NamedExportBindings`](../type-aliases/NamedExportBindings.md) + +### moduleSpecifier + +`undefined` | [`Expression`](../interfaces/Expression.md) + +### isTypeOnly + +`boolean` + +## Returns + +[`ExportDeclaration`](../interfaces/ExportDeclaration.md) + +## Deprecated + +Use `factory.updateExportDeclaration` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateExportSpecifier.md b/docs/api_docs/namespaces/ts/functions/updateExportSpecifier.md new file mode 100644 index 0000000000000000000000000000000000000000..e8ec8c748f42ba7d9afaec6aeb631c1da92be4d9 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateExportSpecifier.md @@ -0,0 +1,37 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateExportSpecifier + +# Function: ~~updateExportSpecifier()~~ + +> **updateExportSpecifier**(`node`, `isTypeOnly`, `propertyName`, `name`): [`ExportSpecifier`](../interfaces/ExportSpecifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8019 + +## Parameters + +### node + +[`ExportSpecifier`](../interfaces/ExportSpecifier.md) + +### isTypeOnly + +`boolean` + +### propertyName + +`undefined` | [`Identifier`](../interfaces/Identifier.md) + +### name + +[`Identifier`](../interfaces/Identifier.md) + +## Returns + +[`ExportSpecifier`](../interfaces/ExportSpecifier.md) + +## Deprecated + +Use `factory.updateExportSpecifier` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateExpressionStatement.md b/docs/api_docs/namespaces/ts/functions/updateExpressionStatement.md new file mode 100644 index 0000000000000000000000000000000000000000..aaa4de0f3b25a1e85443c1617f6ba6bb324da9ea --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateExpressionStatement.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateExpressionStatement + +# Function: ~~updateExpressionStatement()~~ + +> **updateExpressionStatement**(`node`, `expression`): [`ExpressionStatement`](../interfaces/ExpressionStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7831 + +## Parameters + +### node + +[`ExpressionStatement`](../interfaces/ExpressionStatement.md) + +### expression + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`ExpressionStatement`](../interfaces/ExpressionStatement.md) + +## Deprecated + +Use `factory.updateExpressionStatement` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateExpressionWithTypeArguments.md b/docs/api_docs/namespaces/ts/functions/updateExpressionWithTypeArguments.md new file mode 100644 index 0000000000000000000000000000000000000000..c3b110407cbfc8779e962e34e19e15358231748f --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateExpressionWithTypeArguments.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateExpressionWithTypeArguments + +# Function: ~~updateExpressionWithTypeArguments()~~ + +> **updateExpressionWithTypeArguments**(`node`, `typeArguments`, `expression`): [`ExpressionWithTypeArguments`](../interfaces/ExpressionWithTypeArguments.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8251 + +## Parameters + +### node + +[`ExpressionWithTypeArguments`](../interfaces/ExpressionWithTypeArguments.md) + +### typeArguments + +`undefined` | readonly [`TypeNode`](../interfaces/TypeNode.md)[] + +### expression + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`ExpressionWithTypeArguments`](../interfaces/ExpressionWithTypeArguments.md) + +## Deprecated + +Use `factory.updateExpressionWithTypeArguments` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateExternalModuleReference.md b/docs/api_docs/namespaces/ts/functions/updateExternalModuleReference.md new file mode 100644 index 0000000000000000000000000000000000000000..1aafe62ebea06dc04f2b03bc9970ec585d7afa4b --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateExternalModuleReference.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateExternalModuleReference + +# Function: ~~updateExternalModuleReference()~~ + +> **updateExternalModuleReference**(`node`, `expression`): [`ExternalModuleReference`](../interfaces/ExternalModuleReference.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8023 + +## Parameters + +### node + +[`ExternalModuleReference`](../interfaces/ExternalModuleReference.md) + +### expression + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`ExternalModuleReference`](../interfaces/ExternalModuleReference.md) + +## Deprecated + +Use `factory.updateExternalModuleReference` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateFor.md b/docs/api_docs/namespaces/ts/functions/updateFor.md new file mode 100644 index 0000000000000000000000000000000000000000..5cd19c2357a21970bf8acaa2bc49ffc0c0b16b52 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateFor.md @@ -0,0 +1,41 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateFor + +# Function: ~~updateFor()~~ + +> **updateFor**(`node`, `initializer`, `condition`, `incrementor`, `statement`): [`ForStatement`](../interfaces/ForStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7851 + +## Parameters + +### node + +[`ForStatement`](../interfaces/ForStatement.md) + +### initializer + +`undefined` | [`ForInitializer`](../type-aliases/ForInitializer.md) + +### condition + +`undefined` | [`Expression`](../interfaces/Expression.md) + +### incrementor + +`undefined` | [`Expression`](../interfaces/Expression.md) + +### statement + +[`Statement`](../interfaces/Statement.md) + +## Returns + +[`ForStatement`](../interfaces/ForStatement.md) + +## Deprecated + +Use `factory.updateForStatement` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateForIn.md b/docs/api_docs/namespaces/ts/functions/updateForIn.md new file mode 100644 index 0000000000000000000000000000000000000000..8f3798eb81839100636774f8f53ecbcd48ebdd25 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateForIn.md @@ -0,0 +1,37 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateForIn + +# Function: ~~updateForIn()~~ + +> **updateForIn**(`node`, `initializer`, `expression`, `statement`): [`ForInStatement`](../interfaces/ForInStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7855 + +## Parameters + +### node + +[`ForInStatement`](../interfaces/ForInStatement.md) + +### initializer + +[`ForInitializer`](../type-aliases/ForInitializer.md) + +### expression + +[`Expression`](../interfaces/Expression.md) + +### statement + +[`Statement`](../interfaces/Statement.md) + +## Returns + +[`ForInStatement`](../interfaces/ForInStatement.md) + +## Deprecated + +Use `factory.updateForInStatement` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateForOf.md b/docs/api_docs/namespaces/ts/functions/updateForOf.md new file mode 100644 index 0000000000000000000000000000000000000000..f9e82f3b24234133da1cb3a4f06e414460a3a8a8 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateForOf.md @@ -0,0 +1,41 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateForOf + +# Function: ~~updateForOf()~~ + +> **updateForOf**(`node`, `awaitModifier`, `initializer`, `expression`, `statement`): [`ForOfStatement`](../interfaces/ForOfStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7859 + +## Parameters + +### node + +[`ForOfStatement`](../interfaces/ForOfStatement.md) + +### awaitModifier + +`undefined` | [`AwaitKeyword`](../type-aliases/AwaitKeyword.md) + +### initializer + +[`ForInitializer`](../type-aliases/ForInitializer.md) + +### expression + +[`Expression`](../interfaces/Expression.md) + +### statement + +[`Statement`](../interfaces/Statement.md) + +## Returns + +[`ForOfStatement`](../interfaces/ForOfStatement.md) + +## Deprecated + +Use `factory.updateForOfStatement` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateFunctionDeclaration.md b/docs/api_docs/namespaces/ts/functions/updateFunctionDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..676cb5fdad5d646acfb358076521e5b0af035113 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateFunctionDeclaration.md @@ -0,0 +1,103 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateFunctionDeclaration + +# Function: ~~updateFunctionDeclaration()~~ + +## Deprecated + +Use `factory.updateFunctionDeclaration` or the factory supplied by your transformation context instead. + +## Call Signature + +> **updateFunctionDeclaration**(`node`, `modifiers`, `asteriskToken`, `name`, `typeParameters`, `parameters`, `type`, `body`): [`FunctionDeclaration`](../interfaces/FunctionDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7905 + +### Parameters + +#### node + +[`FunctionDeclaration`](../interfaces/FunctionDeclaration.md) + +#### modifiers + +`undefined` | readonly [`ModifierLike`](../type-aliases/ModifierLike.md)[] + +#### asteriskToken + +`undefined` | [`AsteriskToken`](../type-aliases/AsteriskToken.md) + +#### name + +`undefined` | [`Identifier`](../interfaces/Identifier.md) + +#### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](../interfaces/TypeParameterDeclaration.md)[] + +#### parameters + +readonly [`ParameterDeclaration`](../interfaces/ParameterDeclaration.md)[] + +#### type + +`undefined` | [`TypeNode`](../interfaces/TypeNode.md) + +#### body + +`undefined` | [`Block`](../interfaces/Block.md) + +### Returns + +[`FunctionDeclaration`](../interfaces/FunctionDeclaration.md) + +## Call Signature + +> **updateFunctionDeclaration**(`node`, `decorators`, `modifiers`, `asteriskToken`, `name`, `typeParameters`, `parameters`, `type`, `body`): [`FunctionDeclaration`](../interfaces/FunctionDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7906 + +### Parameters + +#### node + +[`FunctionDeclaration`](../interfaces/FunctionDeclaration.md) + +#### decorators + +`undefined` | readonly [`Decorator`](../interfaces/Decorator.md)[] + +#### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +#### asteriskToken + +`undefined` | [`AsteriskToken`](../type-aliases/AsteriskToken.md) + +#### name + +`undefined` | [`Identifier`](../interfaces/Identifier.md) + +#### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](../interfaces/TypeParameterDeclaration.md)[] + +#### parameters + +readonly [`ParameterDeclaration`](../interfaces/ParameterDeclaration.md)[] + +#### type + +`undefined` | [`TypeNode`](../interfaces/TypeNode.md) + +#### body + +`undefined` | [`Block`](../interfaces/Block.md) + +### Returns + +[`FunctionDeclaration`](../interfaces/FunctionDeclaration.md) diff --git a/docs/api_docs/namespaces/ts/functions/updateFunctionExpression.md b/docs/api_docs/namespaces/ts/functions/updateFunctionExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..8c7b1b0e7f66d30965ccdf533dea41ebe7ad8d5b --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateFunctionExpression.md @@ -0,0 +1,53 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateFunctionExpression + +# Function: ~~updateFunctionExpression()~~ + +> **updateFunctionExpression**(`node`, `modifiers`, `asteriskToken`, `name`, `typeParameters`, `parameters`, `type`, `body`): [`FunctionExpression`](../interfaces/FunctionExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7735 + +## Parameters + +### node + +[`FunctionExpression`](../interfaces/FunctionExpression.md) + +### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +### asteriskToken + +`undefined` | [`AsteriskToken`](../type-aliases/AsteriskToken.md) + +### name + +`undefined` | [`Identifier`](../interfaces/Identifier.md) + +### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](../interfaces/TypeParameterDeclaration.md)[] + +### parameters + +readonly [`ParameterDeclaration`](../interfaces/ParameterDeclaration.md)[] + +### type + +`undefined` | [`TypeNode`](../interfaces/TypeNode.md) + +### body + +[`Block`](../interfaces/Block.md) + +## Returns + +[`FunctionExpression`](../interfaces/FunctionExpression.md) + +## Deprecated + +Use `factory.updateFunctionExpression` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateFunctionTypeNode.md b/docs/api_docs/namespaces/ts/functions/updateFunctionTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..58213820530e87b16bd878279200ecb2aced7900 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateFunctionTypeNode.md @@ -0,0 +1,37 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateFunctionTypeNode + +# Function: ~~updateFunctionTypeNode()~~ + +> **updateFunctionTypeNode**(`node`, `typeParameters`, `parameters`, `type`): [`FunctionTypeNode`](../interfaces/FunctionTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7600 + +## Parameters + +### node + +[`FunctionTypeNode`](../interfaces/FunctionTypeNode.md) + +### typeParameters + +`undefined` | [`NodeArray`](../interfaces/NodeArray.md)\<[`TypeParameterDeclaration`](../interfaces/TypeParameterDeclaration.md)\> + +### parameters + +[`NodeArray`](../interfaces/NodeArray.md)\<[`ParameterDeclaration`](../interfaces/ParameterDeclaration.md)\> + +### type + +[`TypeNode`](../interfaces/TypeNode.md) + +## Returns + +[`FunctionTypeNode`](../interfaces/FunctionTypeNode.md) + +## Deprecated + +Use `factory.updateFunctionTypeNode` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateGetAccessor.md b/docs/api_docs/namespaces/ts/functions/updateGetAccessor.md new file mode 100644 index 0000000000000000000000000000000000000000..9a85b41fcd45879d95b11ed05e5ad05f37e5dda6 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateGetAccessor.md @@ -0,0 +1,87 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateGetAccessor + +# Function: ~~updateGetAccessor()~~ + +## Deprecated + +Use `factory.updateGetAccessorDeclaration` or the factory supplied by your transformation context instead. + +## Call Signature + +> **updateGetAccessor**(`node`, `modifiers`, `name`, `parameters`, `type`, `body`): [`GetAccessorDeclaration`](../interfaces/GetAccessorDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7561 + +### Parameters + +#### node + +[`GetAccessorDeclaration`](../interfaces/GetAccessorDeclaration.md) + +#### modifiers + +`undefined` | readonly [`ModifierLike`](../type-aliases/ModifierLike.md)[] + +#### name + +[`PropertyName`](../type-aliases/PropertyName.md) + +#### parameters + +readonly [`ParameterDeclaration`](../interfaces/ParameterDeclaration.md)[] + +#### type + +`undefined` | [`TypeNode`](../interfaces/TypeNode.md) + +#### body + +`undefined` | [`Block`](../interfaces/Block.md) + +### Returns + +[`GetAccessorDeclaration`](../interfaces/GetAccessorDeclaration.md) + +## Call Signature + +> **updateGetAccessor**(`node`, `decorators`, `modifiers`, `name`, `parameters`, `type`, `body`): [`GetAccessorDeclaration`](../interfaces/GetAccessorDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7562 + +### Parameters + +#### node + +[`GetAccessorDeclaration`](../interfaces/GetAccessorDeclaration.md) + +#### decorators + +`undefined` | readonly [`Decorator`](../interfaces/Decorator.md)[] + +#### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +#### name + +[`PropertyName`](../type-aliases/PropertyName.md) + +#### parameters + +readonly [`ParameterDeclaration`](../interfaces/ParameterDeclaration.md)[] + +#### type + +`undefined` | [`TypeNode`](../interfaces/TypeNode.md) + +#### body + +`undefined` | [`Block`](../interfaces/Block.md) + +### Returns + +[`GetAccessorDeclaration`](../interfaces/GetAccessorDeclaration.md) diff --git a/docs/api_docs/namespaces/ts/functions/updateHeritageClause.md b/docs/api_docs/namespaces/ts/functions/updateHeritageClause.md new file mode 100644 index 0000000000000000000000000000000000000000..67f18740fa3ab65b918ab95b7439ae0e33f5f7ba --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateHeritageClause.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateHeritageClause + +# Function: ~~updateHeritageClause()~~ + +> **updateHeritageClause**(`node`, `types`): [`HeritageClause`](../interfaces/HeritageClause.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8127 + +## Parameters + +### node + +[`HeritageClause`](../interfaces/HeritageClause.md) + +### types + +readonly [`ExpressionWithTypeArguments`](../interfaces/ExpressionWithTypeArguments.md)[] + +## Returns + +[`HeritageClause`](../interfaces/HeritageClause.md) + +## Deprecated + +Use `factory.updateHeritageClause` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateIf.md b/docs/api_docs/namespaces/ts/functions/updateIf.md new file mode 100644 index 0000000000000000000000000000000000000000..47fc23b73b064a04ecd60436fa6656c5122514be --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateIf.md @@ -0,0 +1,37 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateIf + +# Function: ~~updateIf()~~ + +> **updateIf**(`node`, `expression`, `thenStatement`, `elseStatement`): [`IfStatement`](../interfaces/IfStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7839 + +## Parameters + +### node + +[`IfStatement`](../interfaces/IfStatement.md) + +### expression + +[`Expression`](../interfaces/Expression.md) + +### thenStatement + +[`Statement`](../interfaces/Statement.md) + +### elseStatement + +`undefined` | [`Statement`](../interfaces/Statement.md) + +## Returns + +[`IfStatement`](../interfaces/IfStatement.md) + +## Deprecated + +Use `factory.updateIfStatement` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateImportClause.md b/docs/api_docs/namespaces/ts/functions/updateImportClause.md new file mode 100644 index 0000000000000000000000000000000000000000..1771be3baeb4af56b18d135fa31ecfe8002ac025 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateImportClause.md @@ -0,0 +1,37 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateImportClause + +# Function: ~~updateImportClause()~~ + +> **updateImportClause**(`node`, `name`, `namedBindings`, `isTypeOnly`): [`ImportClause`](../interfaces/ImportClause.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8275 + +## Parameters + +### node + +[`ImportClause`](../interfaces/ImportClause.md) + +### name + +`undefined` | [`Identifier`](../interfaces/Identifier.md) + +### namedBindings + +`undefined` | [`NamedImportBindings`](../type-aliases/NamedImportBindings.md) + +### isTypeOnly + +`boolean` + +## Returns + +[`ImportClause`](../interfaces/ImportClause.md) + +## Deprecated + +Use `factory.updateImportClause` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateImportDeclaration.md b/docs/api_docs/namespaces/ts/functions/updateImportDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..2b971aa4998a5b3b2224a1da8dde0544678d7cf4 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateImportDeclaration.md @@ -0,0 +1,79 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateImportDeclaration + +# Function: ~~updateImportDeclaration()~~ + +## Deprecated + +Use `factory.updateImportDeclaration` or the factory supplied by your transformation context instead. + +## Call Signature + +> **updateImportDeclaration**(`node`, `modifiers`, `importClause`, `moduleSpecifier`, `assertClause`): [`ImportDeclaration`](../interfaces/ImportDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7987 + +### Parameters + +#### node + +[`ImportDeclaration`](../interfaces/ImportDeclaration.md) + +#### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +#### importClause + +`undefined` | [`ImportClause`](../interfaces/ImportClause.md) + +#### moduleSpecifier + +[`Expression`](../interfaces/Expression.md) + +#### assertClause + +`undefined` | [`AssertClause`](../interfaces/AssertClause.md) + +### Returns + +[`ImportDeclaration`](../interfaces/ImportDeclaration.md) + +## Call Signature + +> **updateImportDeclaration**(`node`, `decorators`, `modifiers`, `importClause`, `moduleSpecifier`, `assertClause`): [`ImportDeclaration`](../interfaces/ImportDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7988 + +### Parameters + +#### node + +[`ImportDeclaration`](../interfaces/ImportDeclaration.md) + +#### decorators + +`undefined` | readonly [`Decorator`](../interfaces/Decorator.md)[] + +#### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +#### importClause + +`undefined` | [`ImportClause`](../interfaces/ImportClause.md) + +#### moduleSpecifier + +[`Expression`](../interfaces/Expression.md) + +#### assertClause + +`undefined` | [`AssertClause`](../interfaces/AssertClause.md) + +### Returns + +[`ImportDeclaration`](../interfaces/ImportDeclaration.md) diff --git a/docs/api_docs/namespaces/ts/functions/updateImportEqualsDeclaration.md b/docs/api_docs/namespaces/ts/functions/updateImportEqualsDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..480cf9dedb3330bb0c090ddd804bca89c4cb3000 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateImportEqualsDeclaration.md @@ -0,0 +1,79 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateImportEqualsDeclaration + +# Function: ~~updateImportEqualsDeclaration()~~ + +## Deprecated + +Use `factory.updateImportEqualsDeclaration` or the factory supplied by your transformation context instead. + +## Call Signature + +> **updateImportEqualsDeclaration**(`node`, `modifiers`, `isTypeOnly`, `name`, `moduleReference`): [`ImportEqualsDeclaration`](../interfaces/ImportEqualsDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7977 + +### Parameters + +#### node + +[`ImportEqualsDeclaration`](../interfaces/ImportEqualsDeclaration.md) + +#### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +#### isTypeOnly + +`boolean` + +#### name + +[`Identifier`](../interfaces/Identifier.md) + +#### moduleReference + +[`ModuleReference`](../type-aliases/ModuleReference.md) + +### Returns + +[`ImportEqualsDeclaration`](../interfaces/ImportEqualsDeclaration.md) + +## Call Signature + +> **updateImportEqualsDeclaration**(`node`, `decorators`, `modifiers`, `isTypeOnly`, `name`, `moduleReference`): [`ImportEqualsDeclaration`](../interfaces/ImportEqualsDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7978 + +### Parameters + +#### node + +[`ImportEqualsDeclaration`](../interfaces/ImportEqualsDeclaration.md) + +#### decorators + +`undefined` | readonly [`Decorator`](../interfaces/Decorator.md)[] + +#### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +#### isTypeOnly + +`boolean` + +#### name + +[`Identifier`](../interfaces/Identifier.md) + +#### moduleReference + +[`ModuleReference`](../type-aliases/ModuleReference.md) + +### Returns + +[`ImportEqualsDeclaration`](../interfaces/ImportEqualsDeclaration.md) diff --git a/docs/api_docs/namespaces/ts/functions/updateImportSpecifier.md b/docs/api_docs/namespaces/ts/functions/updateImportSpecifier.md new file mode 100644 index 0000000000000000000000000000000000000000..a5ad67d32eedfecd1c6438ecc5f9468e6e9ebf61 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateImportSpecifier.md @@ -0,0 +1,37 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateImportSpecifier + +# Function: ~~updateImportSpecifier()~~ + +> **updateImportSpecifier**(`node`, `isTypeOnly`, `propertyName`, `name`): [`ImportSpecifier`](../interfaces/ImportSpecifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8001 + +## Parameters + +### node + +[`ImportSpecifier`](../interfaces/ImportSpecifier.md) + +### isTypeOnly + +`boolean` + +### propertyName + +`undefined` | [`Identifier`](../interfaces/Identifier.md) + +### name + +[`Identifier`](../interfaces/Identifier.md) + +## Returns + +[`ImportSpecifier`](../interfaces/ImportSpecifier.md) + +## Deprecated + +Use `factory.updateImportSpecifier` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateImportTypeNode.md b/docs/api_docs/namespaces/ts/functions/updateImportTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..161095f342c7e0dbe3b5a45b45caede1e83ca1cf --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateImportTypeNode.md @@ -0,0 +1,79 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateImportTypeNode + +# Function: ~~updateImportTypeNode()~~ + +## Deprecated + +Use `factory.updateImportTypeNode` or the factory supplied by your transformation context instead. + +## Call Signature + +> **updateImportTypeNode**(`node`, `argument`, `assertions`, `qualifier`, `typeArguments`, `isTypeOf`?): [`ImportTypeNode`](../interfaces/ImportTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7653 + +### Parameters + +#### node + +[`ImportTypeNode`](../interfaces/ImportTypeNode.md) + +#### argument + +[`TypeNode`](../interfaces/TypeNode.md) + +#### assertions + +`undefined` | [`ImportTypeAssertionContainer`](../interfaces/ImportTypeAssertionContainer.md) + +#### qualifier + +`undefined` | [`EntityName`](../type-aliases/EntityName.md) + +#### typeArguments + +`undefined` | readonly [`TypeNode`](../interfaces/TypeNode.md)[] + +#### isTypeOf? + +`boolean` + +### Returns + +[`ImportTypeNode`](../interfaces/ImportTypeNode.md) + +## Call Signature + +> **updateImportTypeNode**(`node`, `argument`, `qualifier`, `typeArguments`, `isTypeOf`?): [`ImportTypeNode`](../interfaces/ImportTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7654 + +### Parameters + +#### node + +[`ImportTypeNode`](../interfaces/ImportTypeNode.md) + +#### argument + +[`TypeNode`](../interfaces/TypeNode.md) + +#### qualifier + +`undefined` | [`EntityName`](../type-aliases/EntityName.md) + +#### typeArguments + +`undefined` | readonly [`TypeNode`](../interfaces/TypeNode.md)[] + +#### isTypeOf? + +`boolean` + +### Returns + +[`ImportTypeNode`](../interfaces/ImportTypeNode.md) diff --git a/docs/api_docs/namespaces/ts/functions/updateIndexSignature.md b/docs/api_docs/namespaces/ts/functions/updateIndexSignature.md new file mode 100644 index 0000000000000000000000000000000000000000..8484aaefc2944dfcb0a8a9af76cfbb8378ec9f6f --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateIndexSignature.md @@ -0,0 +1,71 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateIndexSignature + +# Function: ~~updateIndexSignature()~~ + +## Deprecated + +Use `factory.updateIndexSignature` or the factory supplied by your transformation context instead. + +## Call Signature + +> **updateIndexSignature**(`node`, `modifiers`, `parameters`, `type`): [`IndexSignatureDeclaration`](../interfaces/IndexSignatureDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7584 + +### Parameters + +#### node + +[`IndexSignatureDeclaration`](../interfaces/IndexSignatureDeclaration.md) + +#### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +#### parameters + +readonly [`ParameterDeclaration`](../interfaces/ParameterDeclaration.md)[] + +#### type + +[`TypeNode`](../interfaces/TypeNode.md) + +### Returns + +[`IndexSignatureDeclaration`](../interfaces/IndexSignatureDeclaration.md) + +## Call Signature + +> **updateIndexSignature**(`node`, `decorators`, `modifiers`, `parameters`, `type`): [`IndexSignatureDeclaration`](../interfaces/IndexSignatureDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7585 + +### Parameters + +#### node + +[`IndexSignatureDeclaration`](../interfaces/IndexSignatureDeclaration.md) + +#### decorators + +`undefined` | readonly [`Decorator`](../interfaces/Decorator.md)[] + +#### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +#### parameters + +readonly [`ParameterDeclaration`](../interfaces/ParameterDeclaration.md)[] + +#### type + +[`TypeNode`](../interfaces/TypeNode.md) + +### Returns + +[`IndexSignatureDeclaration`](../interfaces/IndexSignatureDeclaration.md) diff --git a/docs/api_docs/namespaces/ts/functions/updateIndexedAccessTypeNode.md b/docs/api_docs/namespaces/ts/functions/updateIndexedAccessTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..0ec6cd6ef8040e9d2478b783f5f4eff91d6ff986 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateIndexedAccessTypeNode.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateIndexedAccessTypeNode + +# Function: ~~updateIndexedAccessTypeNode()~~ + +> **updateIndexedAccessTypeNode**(`node`, `objectType`, `indexType`): [`IndexedAccessTypeNode`](../interfaces/IndexedAccessTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7667 + +## Parameters + +### node + +[`IndexedAccessTypeNode`](../interfaces/IndexedAccessTypeNode.md) + +### objectType + +[`TypeNode`](../interfaces/TypeNode.md) + +### indexType + +[`TypeNode`](../interfaces/TypeNode.md) + +## Returns + +[`IndexedAccessTypeNode`](../interfaces/IndexedAccessTypeNode.md) + +## Deprecated + +Use `factory.updateIndexedAccessTypeNode` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateInferTypeNode.md b/docs/api_docs/namespaces/ts/functions/updateInferTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..b2b798df5a182f1b7957d2c9d22c84ada95e7b93 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateInferTypeNode.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateInferTypeNode + +# Function: ~~updateInferTypeNode()~~ + +> **updateInferTypeNode**(`node`, `typeParameter`): [`InferTypeNode`](../interfaces/InferTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7644 + +## Parameters + +### node + +[`InferTypeNode`](../interfaces/InferTypeNode.md) + +### typeParameter + +[`TypeParameterDeclaration`](../interfaces/TypeParameterDeclaration.md) + +## Returns + +[`InferTypeNode`](../interfaces/InferTypeNode.md) + +## Deprecated + +Use `factory.updateInferTypeNode` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateInterfaceDeclaration.md b/docs/api_docs/namespaces/ts/functions/updateInterfaceDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..bb2349ad815ecc48fa449842e6bb332fe59c41cf --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateInterfaceDeclaration.md @@ -0,0 +1,87 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateInterfaceDeclaration + +# Function: ~~updateInterfaceDeclaration()~~ + +## Deprecated + +Use `factory.updateInterfaceDeclaration` or the factory supplied by your transformation context instead. + +## Call Signature + +> **updateInterfaceDeclaration**(`node`, `modifiers`, `name`, `typeParameters`, `heritageClauses`, `members`): [`InterfaceDeclaration`](../interfaces/InterfaceDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7925 + +### Parameters + +#### node + +[`InterfaceDeclaration`](../interfaces/InterfaceDeclaration.md) + +#### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +#### name + +[`Identifier`](../interfaces/Identifier.md) + +#### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](../interfaces/TypeParameterDeclaration.md)[] + +#### heritageClauses + +`undefined` | readonly [`HeritageClause`](../interfaces/HeritageClause.md)[] + +#### members + +readonly [`TypeElement`](../interfaces/TypeElement.md)[] + +### Returns + +[`InterfaceDeclaration`](../interfaces/InterfaceDeclaration.md) + +## Call Signature + +> **updateInterfaceDeclaration**(`node`, `decorators`, `modifiers`, `name`, `typeParameters`, `heritageClauses`, `members`): [`InterfaceDeclaration`](../interfaces/InterfaceDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7926 + +### Parameters + +#### node + +[`InterfaceDeclaration`](../interfaces/InterfaceDeclaration.md) + +#### decorators + +`undefined` | readonly [`Decorator`](../interfaces/Decorator.md)[] + +#### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +#### name + +[`Identifier`](../interfaces/Identifier.md) + +#### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](../interfaces/TypeParameterDeclaration.md)[] + +#### heritageClauses + +`undefined` | readonly [`HeritageClause`](../interfaces/HeritageClause.md)[] + +#### members + +readonly [`TypeElement`](../interfaces/TypeElement.md)[] + +### Returns + +[`InterfaceDeclaration`](../interfaces/InterfaceDeclaration.md) diff --git a/docs/api_docs/namespaces/ts/functions/updateIntersectionTypeNode.md b/docs/api_docs/namespaces/ts/functions/updateIntersectionTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..fe329824756662cbcdedd5fbbd21332b9b28a045 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateIntersectionTypeNode.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateIntersectionTypeNode + +# Function: ~~updateIntersectionTypeNode()~~ + +> **updateIntersectionTypeNode**(`node`, `types`): [`IntersectionTypeNode`](../interfaces/IntersectionTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7636 + +## Parameters + +### node + +[`IntersectionTypeNode`](../interfaces/IntersectionTypeNode.md) + +### types + +[`NodeArray`](../interfaces/NodeArray.md)\<[`TypeNode`](../interfaces/TypeNode.md)\> + +## Returns + +[`IntersectionTypeNode`](../interfaces/IntersectionTypeNode.md) + +## Deprecated + +Use `factory.updateIntersectionTypeNode` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateJsxAttribute.md b/docs/api_docs/namespaces/ts/functions/updateJsxAttribute.md new file mode 100644 index 0000000000000000000000000000000000000000..d56c6735b11dd6fc84a779d743708d35ecfbda5a --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateJsxAttribute.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateJsxAttribute + +# Function: ~~updateJsxAttribute()~~ + +> **updateJsxAttribute**(`node`, `name`, `initializer`): [`JsxAttribute`](../interfaces/JsxAttribute.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8103 + +## Parameters + +### node + +[`JsxAttribute`](../interfaces/JsxAttribute.md) + +### name + +[`Identifier`](../interfaces/Identifier.md) + +### initializer + +`undefined` | [`JsxAttributeValue`](../type-aliases/JsxAttributeValue.md) + +## Returns + +[`JsxAttribute`](../interfaces/JsxAttribute.md) + +## Deprecated + +Use `factory.updateJsxAttribute` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateJsxAttributes.md b/docs/api_docs/namespaces/ts/functions/updateJsxAttributes.md new file mode 100644 index 0000000000000000000000000000000000000000..dd2ae186a00e3f6b775d920f03d965f43cfe2b70 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateJsxAttributes.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateJsxAttributes + +# Function: ~~updateJsxAttributes()~~ + +> **updateJsxAttributes**(`node`, `properties`): [`JsxAttributes`](../interfaces/JsxAttributes.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8107 + +## Parameters + +### node + +[`JsxAttributes`](../interfaces/JsxAttributes.md) + +### properties + +readonly [`JsxAttributeLike`](../type-aliases/JsxAttributeLike.md)[] + +## Returns + +[`JsxAttributes`](../interfaces/JsxAttributes.md) + +## Deprecated + +Use `factory.updateJsxAttributes` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateJsxClosingElement.md b/docs/api_docs/namespaces/ts/functions/updateJsxClosingElement.md new file mode 100644 index 0000000000000000000000000000000000000000..ae2e90d7f654588d25f610f1c40a725b31b7d6d6 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateJsxClosingElement.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateJsxClosingElement + +# Function: ~~updateJsxClosingElement()~~ + +> **updateJsxClosingElement**(`node`, `tagName`): [`JsxClosingElement`](../interfaces/JsxClosingElement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8087 + +## Parameters + +### node + +[`JsxClosingElement`](../interfaces/JsxClosingElement.md) + +### tagName + +[`JsxTagNameExpression`](../type-aliases/JsxTagNameExpression.md) + +## Returns + +[`JsxClosingElement`](../interfaces/JsxClosingElement.md) + +## Deprecated + +Use `factory.updateJsxClosingElement` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateJsxElement.md b/docs/api_docs/namespaces/ts/functions/updateJsxElement.md new file mode 100644 index 0000000000000000000000000000000000000000..10fc92051ce20f2b28bd0f0b909503aa956ac723 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateJsxElement.md @@ -0,0 +1,37 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateJsxElement + +# Function: ~~updateJsxElement()~~ + +> **updateJsxElement**(`node`, `openingElement`, `children`, `closingElement`): [`JsxElement`](../interfaces/JsxElement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8075 + +## Parameters + +### node + +[`JsxElement`](../interfaces/JsxElement.md) + +### openingElement + +[`JsxOpeningElement`](../interfaces/JsxOpeningElement.md) + +### children + +readonly [`JsxChild`](../type-aliases/JsxChild.md)[] + +### closingElement + +[`JsxClosingElement`](../interfaces/JsxClosingElement.md) + +## Returns + +[`JsxElement`](../interfaces/JsxElement.md) + +## Deprecated + +Use `factory.updateJsxElement` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateJsxExpression.md b/docs/api_docs/namespaces/ts/functions/updateJsxExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..171a18d13be3c3b2d77fe01988ebd9226f6051d6 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateJsxExpression.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateJsxExpression + +# Function: ~~updateJsxExpression()~~ + +> **updateJsxExpression**(`node`, `expression`): [`JsxExpression`](../interfaces/JsxExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8115 + +## Parameters + +### node + +[`JsxExpression`](../interfaces/JsxExpression.md) + +### expression + +`undefined` | [`Expression`](../interfaces/Expression.md) + +## Returns + +[`JsxExpression`](../interfaces/JsxExpression.md) + +## Deprecated + +Use `factory.updateJsxExpression` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateJsxFragment.md b/docs/api_docs/namespaces/ts/functions/updateJsxFragment.md new file mode 100644 index 0000000000000000000000000000000000000000..fcdb903194ff9d7bbf108a2e69b0c07664723df3 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateJsxFragment.md @@ -0,0 +1,37 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateJsxFragment + +# Function: ~~updateJsxFragment()~~ + +> **updateJsxFragment**(`node`, `openingFragment`, `children`, `closingFragment`): [`JsxFragment`](../interfaces/JsxFragment.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8099 + +## Parameters + +### node + +[`JsxFragment`](../interfaces/JsxFragment.md) + +### openingFragment + +[`JsxOpeningFragment`](../interfaces/JsxOpeningFragment.md) + +### children + +readonly [`JsxChild`](../type-aliases/JsxChild.md)[] + +### closingFragment + +[`JsxClosingFragment`](../interfaces/JsxClosingFragment.md) + +## Returns + +[`JsxFragment`](../interfaces/JsxFragment.md) + +## Deprecated + +Use `factory.updateJsxFragment` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateJsxOpeningElement.md b/docs/api_docs/namespaces/ts/functions/updateJsxOpeningElement.md new file mode 100644 index 0000000000000000000000000000000000000000..720dbe0e767e65ba09fd3d6d15835beb42133255 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateJsxOpeningElement.md @@ -0,0 +1,37 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateJsxOpeningElement + +# Function: ~~updateJsxOpeningElement()~~ + +> **updateJsxOpeningElement**(`node`, `tagName`, `typeArguments`, `attributes`): [`JsxOpeningElement`](../interfaces/JsxOpeningElement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8083 + +## Parameters + +### node + +[`JsxOpeningElement`](../interfaces/JsxOpeningElement.md) + +### tagName + +[`JsxTagNameExpression`](../type-aliases/JsxTagNameExpression.md) + +### typeArguments + +`undefined` | readonly [`TypeNode`](../interfaces/TypeNode.md)[] + +### attributes + +[`JsxAttributes`](../interfaces/JsxAttributes.md) + +## Returns + +[`JsxOpeningElement`](../interfaces/JsxOpeningElement.md) + +## Deprecated + +Use `factory.updateJsxOpeningElement` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateJsxSelfClosingElement.md b/docs/api_docs/namespaces/ts/functions/updateJsxSelfClosingElement.md new file mode 100644 index 0000000000000000000000000000000000000000..dfac61475e308373cc7e775a2921d1e9466f6f8f --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateJsxSelfClosingElement.md @@ -0,0 +1,37 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateJsxSelfClosingElement + +# Function: ~~updateJsxSelfClosingElement()~~ + +> **updateJsxSelfClosingElement**(`node`, `tagName`, `typeArguments`, `attributes`): [`JsxSelfClosingElement`](../interfaces/JsxSelfClosingElement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8079 + +## Parameters + +### node + +[`JsxSelfClosingElement`](../interfaces/JsxSelfClosingElement.md) + +### tagName + +[`JsxTagNameExpression`](../type-aliases/JsxTagNameExpression.md) + +### typeArguments + +`undefined` | readonly [`TypeNode`](../interfaces/TypeNode.md)[] + +### attributes + +[`JsxAttributes`](../interfaces/JsxAttributes.md) + +## Returns + +[`JsxSelfClosingElement`](../interfaces/JsxSelfClosingElement.md) + +## Deprecated + +Use `factory.updateJsxSelfClosingElement` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateJsxSpreadAttribute.md b/docs/api_docs/namespaces/ts/functions/updateJsxSpreadAttribute.md new file mode 100644 index 0000000000000000000000000000000000000000..8a6331b263b994b62410734b1c58556e00dc8cd1 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateJsxSpreadAttribute.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateJsxSpreadAttribute + +# Function: ~~updateJsxSpreadAttribute()~~ + +> **updateJsxSpreadAttribute**(`node`, `expression`): [`JsxSpreadAttribute`](../interfaces/JsxSpreadAttribute.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8111 + +## Parameters + +### node + +[`JsxSpreadAttribute`](../interfaces/JsxSpreadAttribute.md) + +### expression + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`JsxSpreadAttribute`](../interfaces/JsxSpreadAttribute.md) + +## Deprecated + +Use `factory.updateJsxSpreadAttribute` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateJsxText.md b/docs/api_docs/namespaces/ts/functions/updateJsxText.md new file mode 100644 index 0000000000000000000000000000000000000000..f40613e4366a7b5abb0b5bbe3766ed0f3682f579 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateJsxText.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateJsxText + +# Function: ~~updateJsxText()~~ + +> **updateJsxText**(`node`, `text`, `containsOnlyTriviaWhiteSpaces`?): [`JsxText`](../interfaces/JsxText.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8093 + +## Parameters + +### node + +[`JsxText`](../interfaces/JsxText.md) + +### text + +`string` + +### containsOnlyTriviaWhiteSpaces? + +`boolean` + +## Returns + +[`JsxText`](../interfaces/JsxText.md) + +## Deprecated + +Use `factory.updateJsxText` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateLabel.md b/docs/api_docs/namespaces/ts/functions/updateLabel.md new file mode 100644 index 0000000000000000000000000000000000000000..3064a7b334b6d431722a5a38a017406fbe8cc23a --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateLabel.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateLabel + +# Function: ~~updateLabel()~~ + +> **updateLabel**(`node`, `label`, `statement`): [`LabeledStatement`](../interfaces/LabeledStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7883 + +## Parameters + +### node + +[`LabeledStatement`](../interfaces/LabeledStatement.md) + +### label + +[`Identifier`](../interfaces/Identifier.md) + +### statement + +[`Statement`](../interfaces/Statement.md) + +## Returns + +[`LabeledStatement`](../interfaces/LabeledStatement.md) + +## Deprecated + +Use `factory.updateLabelStatement` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateLanguageServiceSourceFile.md b/docs/api_docs/namespaces/ts/functions/updateLanguageServiceSourceFile.md new file mode 100644 index 0000000000000000000000000000000000000000..b91f9da472fbfb2bf1633051c4a50a4c9e48d151 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateLanguageServiceSourceFile.md @@ -0,0 +1,41 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateLanguageServiceSourceFile + +# Function: updateLanguageServiceSourceFile() + +> **updateLanguageServiceSourceFile**(`sourceFile`, `scriptSnapshot`, `version`, `textChangeRange`, `aggressiveChecks`?, `option`?): [`SourceFile`](../interfaces/SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7438 + +## Parameters + +### sourceFile + +[`SourceFile`](../interfaces/SourceFile.md) + +### scriptSnapshot + +[`IScriptSnapshot`](../interfaces/IScriptSnapshot.md) + +### version + +`string` + +### textChangeRange + +`undefined` | [`TextChangeRange`](../interfaces/TextChangeRange.md) + +### aggressiveChecks? + +`boolean` + +### option? + +[`CompilerOptions`](../interfaces/CompilerOptions.md) + +## Returns + +[`SourceFile`](../interfaces/SourceFile.md) diff --git a/docs/api_docs/namespaces/ts/functions/updateLiteralTypeNode.md b/docs/api_docs/namespaces/ts/functions/updateLiteralTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..17539e3ce78e39b8a278a0ab08a1a676bf767110 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateLiteralTypeNode.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateLiteralTypeNode + +# Function: ~~updateLiteralTypeNode()~~ + +> **updateLiteralTypeNode**(`node`, `literal`): [`LiteralTypeNode`](../interfaces/LiteralTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7675 + +## Parameters + +### node + +[`LiteralTypeNode`](../interfaces/LiteralTypeNode.md) + +### literal + +[`LiteralExpression`](../interfaces/LiteralExpression.md) | [`PrefixUnaryExpression`](../interfaces/PrefixUnaryExpression.md) | [`NullLiteral`](../interfaces/NullLiteral.md) | [`BooleanLiteral`](../type-aliases/BooleanLiteral.md) + +## Returns + +[`LiteralTypeNode`](../interfaces/LiteralTypeNode.md) + +## Deprecated + +Use `factory.updateLiteralTypeNode` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateMappedTypeNode.md b/docs/api_docs/namespaces/ts/functions/updateMappedTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..c99e204376d2d666aa49d0a22824018e22eed461 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateMappedTypeNode.md @@ -0,0 +1,49 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateMappedTypeNode + +# Function: ~~updateMappedTypeNode()~~ + +> **updateMappedTypeNode**(`node`, `readonlyToken`, `typeParameter`, `nameType`, `questionToken`, `type`, `members`): [`MappedTypeNode`](../interfaces/MappedTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7671 + +## Parameters + +### node + +[`MappedTypeNode`](../interfaces/MappedTypeNode.md) + +### readonlyToken + +`undefined` | [`ReadonlyKeyword`](../type-aliases/ReadonlyKeyword.md) | [`PlusToken`](../type-aliases/PlusToken.md) | [`MinusToken`](../type-aliases/MinusToken.md) + +### typeParameter + +[`TypeParameterDeclaration`](../interfaces/TypeParameterDeclaration.md) + +### nameType + +`undefined` | [`TypeNode`](../interfaces/TypeNode.md) + +### questionToken + +`undefined` | [`QuestionToken`](../type-aliases/QuestionToken.md) | [`PlusToken`](../type-aliases/PlusToken.md) | [`MinusToken`](../type-aliases/MinusToken.md) + +### type + +`undefined` | [`TypeNode`](../interfaces/TypeNode.md) + +### members + +`undefined` | [`NodeArray`](../interfaces/NodeArray.md)\<[`TypeElement`](../interfaces/TypeElement.md)\> + +## Returns + +[`MappedTypeNode`](../interfaces/MappedTypeNode.md) + +## Deprecated + +Use `factory.updateMappedTypeNode` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateMetaProperty.md b/docs/api_docs/namespaces/ts/functions/updateMetaProperty.md new file mode 100644 index 0000000000000000000000000000000000000000..22ef97e0ec78886c584b8f4d7bf40a053d4a4605 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateMetaProperty.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateMetaProperty + +# Function: ~~updateMetaProperty()~~ + +> **updateMetaProperty**(`node`, `name`): [`MetaProperty`](../interfaces/MetaProperty.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7811 + +## Parameters + +### node + +[`MetaProperty`](../interfaces/MetaProperty.md) + +### name + +[`Identifier`](../interfaces/Identifier.md) + +## Returns + +[`MetaProperty`](../interfaces/MetaProperty.md) + +## Deprecated + +Use `factory.updateMetaProperty` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateMethod.md b/docs/api_docs/namespaces/ts/functions/updateMethod.md new file mode 100644 index 0000000000000000000000000000000000000000..45b6560bddd83edc578c22d5b9a1a1404938ac2c --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateMethod.md @@ -0,0 +1,111 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateMethod + +# Function: ~~updateMethod()~~ + +## Deprecated + +Use `factory.updateMethodDeclaration` or the factory supplied by your transformation context instead. + +## Call Signature + +> **updateMethod**(`node`, `modifiers`, `asteriskToken`, `name`, `questionToken`, `typeParameters`, `parameters`, `type`, `body`): [`MethodDeclaration`](../interfaces/MethodDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7541 + +### Parameters + +#### node + +[`MethodDeclaration`](../interfaces/MethodDeclaration.md) + +#### modifiers + +`undefined` | readonly [`ModifierLike`](../type-aliases/ModifierLike.md)[] + +#### asteriskToken + +`undefined` | [`AsteriskToken`](../type-aliases/AsteriskToken.md) + +#### name + +[`PropertyName`](../type-aliases/PropertyName.md) + +#### questionToken + +`undefined` | [`QuestionToken`](../type-aliases/QuestionToken.md) + +#### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](../interfaces/TypeParameterDeclaration.md)[] + +#### parameters + +readonly [`ParameterDeclaration`](../interfaces/ParameterDeclaration.md)[] + +#### type + +`undefined` | [`TypeNode`](../interfaces/TypeNode.md) + +#### body + +`undefined` | [`Block`](../interfaces/Block.md) + +### Returns + +[`MethodDeclaration`](../interfaces/MethodDeclaration.md) + +## Call Signature + +> **updateMethod**(`node`, `decorators`, `modifiers`, `asteriskToken`, `name`, `questionToken`, `typeParameters`, `parameters`, `type`, `body`): [`MethodDeclaration`](../interfaces/MethodDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7542 + +### Parameters + +#### node + +[`MethodDeclaration`](../interfaces/MethodDeclaration.md) + +#### decorators + +`undefined` | readonly [`Decorator`](../interfaces/Decorator.md)[] + +#### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +#### asteriskToken + +`undefined` | [`AsteriskToken`](../type-aliases/AsteriskToken.md) + +#### name + +[`PropertyName`](../type-aliases/PropertyName.md) + +#### questionToken + +`undefined` | [`QuestionToken`](../type-aliases/QuestionToken.md) + +#### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](../interfaces/TypeParameterDeclaration.md)[] + +#### parameters + +readonly [`ParameterDeclaration`](../interfaces/ParameterDeclaration.md)[] + +#### type + +`undefined` | [`TypeNode`](../interfaces/TypeNode.md) + +#### body + +`undefined` | [`Block`](../interfaces/Block.md) + +### Returns + +[`MethodDeclaration`](../interfaces/MethodDeclaration.md) diff --git a/docs/api_docs/namespaces/ts/functions/updateMethodSignature.md b/docs/api_docs/namespaces/ts/functions/updateMethodSignature.md new file mode 100644 index 0000000000000000000000000000000000000000..777b5ceefd2f07b51aeb0bde5af59e005b726e40 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateMethodSignature.md @@ -0,0 +1,45 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateMethodSignature + +# Function: ~~updateMethodSignature()~~ + +> **updateMethodSignature**(`node`, `typeParameters`, `parameters`, `type`, `name`, `questionToken`): [`MethodSignature`](../interfaces/MethodSignature.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8212 + +## Parameters + +### node + +[`MethodSignature`](../interfaces/MethodSignature.md) + +### typeParameters + +`undefined` | [`NodeArray`](../interfaces/NodeArray.md)\<[`TypeParameterDeclaration`](../interfaces/TypeParameterDeclaration.md)\> + +### parameters + +[`NodeArray`](../interfaces/NodeArray.md)\<[`ParameterDeclaration`](../interfaces/ParameterDeclaration.md)\> + +### type + +`undefined` | [`TypeNode`](../interfaces/TypeNode.md) + +### name + +[`PropertyName`](../type-aliases/PropertyName.md) + +### questionToken + +`undefined` | [`QuestionToken`](../type-aliases/QuestionToken.md) + +## Returns + +[`MethodSignature`](../interfaces/MethodSignature.md) + +## Deprecated + +Use `factory.updateMethodSignature` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateModuleBlock.md b/docs/api_docs/namespaces/ts/functions/updateModuleBlock.md new file mode 100644 index 0000000000000000000000000000000000000000..b3559f6caa071671079a91620a6b8bcfb1e71b52 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateModuleBlock.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateModuleBlock + +# Function: ~~updateModuleBlock()~~ + +> **updateModuleBlock**(`node`, `statements`): [`ModuleBlock`](../interfaces/ModuleBlock.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7961 + +## Parameters + +### node + +[`ModuleBlock`](../interfaces/ModuleBlock.md) + +### statements + +readonly [`Statement`](../interfaces/Statement.md)[] + +## Returns + +[`ModuleBlock`](../interfaces/ModuleBlock.md) + +## Deprecated + +Use `factory.updateModuleBlock` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateModuleDeclaration.md b/docs/api_docs/namespaces/ts/functions/updateModuleDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..95f9aac198f9cec1fcdb8197cfc9a0b3acd9bc53 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateModuleDeclaration.md @@ -0,0 +1,71 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateModuleDeclaration + +# Function: ~~updateModuleDeclaration()~~ + +## Deprecated + +Use `factory.updateModuleDeclaration` or the factory supplied by your transformation context instead. + +## Call Signature + +> **updateModuleDeclaration**(`node`, `modifiers`, `name`, `body`): [`ModuleDeclaration`](../interfaces/ModuleDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7955 + +### Parameters + +#### node + +[`ModuleDeclaration`](../interfaces/ModuleDeclaration.md) + +#### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +#### name + +[`ModuleName`](../type-aliases/ModuleName.md) + +#### body + +`undefined` | [`ModuleBody`](../type-aliases/ModuleBody.md) + +### Returns + +[`ModuleDeclaration`](../interfaces/ModuleDeclaration.md) + +## Call Signature + +> **updateModuleDeclaration**(`node`, `decorators`, `modifiers`, `name`, `body`): [`ModuleDeclaration`](../interfaces/ModuleDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7956 + +### Parameters + +#### node + +[`ModuleDeclaration`](../interfaces/ModuleDeclaration.md) + +#### decorators + +`undefined` | readonly [`Decorator`](../interfaces/Decorator.md)[] + +#### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +#### name + +[`ModuleName`](../type-aliases/ModuleName.md) + +#### body + +`undefined` | [`ModuleBody`](../type-aliases/ModuleBody.md) + +### Returns + +[`ModuleDeclaration`](../interfaces/ModuleDeclaration.md) diff --git a/docs/api_docs/namespaces/ts/functions/updateNamedExports.md b/docs/api_docs/namespaces/ts/functions/updateNamedExports.md new file mode 100644 index 0000000000000000000000000000000000000000..f917205333d3e3dc90d3689835879f85b612ef3b --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateNamedExports.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateNamedExports + +# Function: ~~updateNamedExports()~~ + +> **updateNamedExports**(`node`, `elements`): [`NamedExports`](../interfaces/NamedExports.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8015 + +## Parameters + +### node + +[`NamedExports`](../interfaces/NamedExports.md) + +### elements + +readonly [`ExportSpecifier`](../interfaces/ExportSpecifier.md)[] + +## Returns + +[`NamedExports`](../interfaces/NamedExports.md) + +## Deprecated + +Use `factory.updateNamedExports` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateNamedImports.md b/docs/api_docs/namespaces/ts/functions/updateNamedImports.md new file mode 100644 index 0000000000000000000000000000000000000000..c89c13a0fd4a25d73646ecb94798376da693f6e7 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateNamedImports.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateNamedImports + +# Function: ~~updateNamedImports()~~ + +> **updateNamedImports**(`node`, `elements`): [`NamedImports`](../interfaces/NamedImports.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7997 + +## Parameters + +### node + +[`NamedImports`](../interfaces/NamedImports.md) + +### elements + +readonly [`ImportSpecifier`](../interfaces/ImportSpecifier.md)[] + +## Returns + +[`NamedImports`](../interfaces/NamedImports.md) + +## Deprecated + +Use `factory.updateNamedImports` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateNamespaceExport.md b/docs/api_docs/namespaces/ts/functions/updateNamespaceExport.md new file mode 100644 index 0000000000000000000000000000000000000000..6d82bd0864afa30735a30f68693d387506c6eb81 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateNamespaceExport.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateNamespaceExport + +# Function: ~~updateNamespaceExport()~~ + +> **updateNamespaceExport**(`node`, `name`): [`NamespaceExport`](../interfaces/NamespaceExport.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8183 + +## Parameters + +### node + +[`NamespaceExport`](../interfaces/NamespaceExport.md) + +### name + +[`Identifier`](../interfaces/Identifier.md) + +## Returns + +[`NamespaceExport`](../interfaces/NamespaceExport.md) + +## Deprecated + +Use `factory.updateNamespaceExport` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateNamespaceExportDeclaration.md b/docs/api_docs/namespaces/ts/functions/updateNamespaceExportDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..f66f97e5d929fd0212d80d18000eaaaf5446558c --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateNamespaceExportDeclaration.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateNamespaceExportDeclaration + +# Function: ~~updateNamespaceExportDeclaration()~~ + +> **updateNamespaceExportDeclaration**(`node`, `name`): [`NamespaceExportDeclaration`](../interfaces/NamespaceExportDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7969 + +## Parameters + +### node + +[`NamespaceExportDeclaration`](../interfaces/NamespaceExportDeclaration.md) + +### name + +[`Identifier`](../interfaces/Identifier.md) + +## Returns + +[`NamespaceExportDeclaration`](../interfaces/NamespaceExportDeclaration.md) + +## Deprecated + +Use `factory.updateNamespaceExportDeclaration` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateNamespaceImport.md b/docs/api_docs/namespaces/ts/functions/updateNamespaceImport.md new file mode 100644 index 0000000000000000000000000000000000000000..5876c47a5d500b30e2bc7b9644d533e9cd2b78d8 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateNamespaceImport.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateNamespaceImport + +# Function: ~~updateNamespaceImport()~~ + +> **updateNamespaceImport**(`node`, `name`): [`NamespaceImport`](../interfaces/NamespaceImport.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7993 + +## Parameters + +### node + +[`NamespaceImport`](../interfaces/NamespaceImport.md) + +### name + +[`Identifier`](../interfaces/Identifier.md) + +## Returns + +[`NamespaceImport`](../interfaces/NamespaceImport.md) + +## Deprecated + +Use `factory.updateNamespaceImport` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateNew.md b/docs/api_docs/namespaces/ts/functions/updateNew.md new file mode 100644 index 0000000000000000000000000000000000000000..29eb6b872c8a36de1e865d886379c85218ba2dbb --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateNew.md @@ -0,0 +1,37 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateNew + +# Function: ~~updateNew()~~ + +> **updateNew**(`node`, `expression`, `typeArguments`, `argumentsArray`): [`NewExpression`](../interfaces/NewExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7723 + +## Parameters + +### node + +[`NewExpression`](../interfaces/NewExpression.md) + +### expression + +[`Expression`](../interfaces/Expression.md) + +### typeArguments + +`undefined` | readonly [`TypeNode`](../interfaces/TypeNode.md)[] + +### argumentsArray + +`undefined` | readonly [`Expression`](../interfaces/Expression.md)[] + +## Returns + +[`NewExpression`](../interfaces/NewExpression.md) + +## Deprecated + +Use `factory.updateNewExpression` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateNonNullChain.md b/docs/api_docs/namespaces/ts/functions/updateNonNullChain.md new file mode 100644 index 0000000000000000000000000000000000000000..c6d10b3a44cd5f8cc4e2cd33ea3501370ddccc9d --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateNonNullChain.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateNonNullChain + +# Function: ~~updateNonNullChain()~~ + +> **updateNonNullChain**(`node`, `expression`): [`NonNullChain`](../interfaces/NonNullChain.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7807 + +## Parameters + +### node + +[`NonNullChain`](../interfaces/NonNullChain.md) + +### expression + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`NonNullChain`](../interfaces/NonNullChain.md) + +## Deprecated + +Use `factory.updateNonNullChain` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateNonNullExpression.md b/docs/api_docs/namespaces/ts/functions/updateNonNullExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..6ce204e008497e99d6f337d49cc11e0fc7b03185 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateNonNullExpression.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateNonNullExpression + +# Function: ~~updateNonNullExpression()~~ + +> **updateNonNullExpression**(`node`, `expression`): [`NonNullExpression`](../interfaces/NonNullExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7803 + +## Parameters + +### node + +[`NonNullExpression`](../interfaces/NonNullExpression.md) + +### expression + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`NonNullExpression`](../interfaces/NonNullExpression.md) + +## Deprecated + +Use `factory.updateNonNullExpression` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateObjectBindingPattern.md b/docs/api_docs/namespaces/ts/functions/updateObjectBindingPattern.md new file mode 100644 index 0000000000000000000000000000000000000000..2de76c3dedcec35c889c4fff2da669e77591aad3 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateObjectBindingPattern.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateObjectBindingPattern + +# Function: ~~updateObjectBindingPattern()~~ + +> **updateObjectBindingPattern**(`node`, `elements`): [`ObjectBindingPattern`](../interfaces/ObjectBindingPattern.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7679 + +## Parameters + +### node + +[`ObjectBindingPattern`](../interfaces/ObjectBindingPattern.md) + +### elements + +readonly [`BindingElement`](../interfaces/BindingElement.md)[] + +## Returns + +[`ObjectBindingPattern`](../interfaces/ObjectBindingPattern.md) + +## Deprecated + +Use `factory.updateObjectBindingPattern` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateObjectLiteral.md b/docs/api_docs/namespaces/ts/functions/updateObjectLiteral.md new file mode 100644 index 0000000000000000000000000000000000000000..b97e8dbb0eca708a1c7b816f66c71f6c074e2845 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateObjectLiteral.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateObjectLiteral + +# Function: ~~updateObjectLiteral()~~ + +> **updateObjectLiteral**(`node`, `properties`): [`ObjectLiteralExpression`](../interfaces/ObjectLiteralExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7695 + +## Parameters + +### node + +[`ObjectLiteralExpression`](../interfaces/ObjectLiteralExpression.md) + +### properties + +readonly [`ObjectLiteralElementLike`](../type-aliases/ObjectLiteralElementLike.md)[] + +## Returns + +[`ObjectLiteralExpression`](../interfaces/ObjectLiteralExpression.md) + +## Deprecated + +Use `factory.updateObjectLiteralExpression` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateOptionalTypeNode.md b/docs/api_docs/namespaces/ts/functions/updateOptionalTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..7bdb13ca12b390281fb8d331721d16a632e21b0e --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateOptionalTypeNode.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateOptionalTypeNode + +# Function: ~~updateOptionalTypeNode()~~ + +> **updateOptionalTypeNode**(`node`, `type`): [`OptionalTypeNode`](../interfaces/OptionalTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7624 + +## Parameters + +### node + +[`OptionalTypeNode`](../interfaces/OptionalTypeNode.md) + +### type + +[`TypeNode`](../interfaces/TypeNode.md) + +## Returns + +[`OptionalTypeNode`](../interfaces/OptionalTypeNode.md) + +## Deprecated + +Use `factory.updateOptionalTypeNode` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateParameter.md b/docs/api_docs/namespaces/ts/functions/updateParameter.md new file mode 100644 index 0000000000000000000000000000000000000000..0fc92196155bcc1acb3efdf76d3e1404c21c4b42 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateParameter.md @@ -0,0 +1,95 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateParameter + +# Function: ~~updateParameter()~~ + +## Deprecated + +Use `factory.updateParameterDeclaration` or the factory supplied by your transformation context instead. + +## Call Signature + +> **updateParameter**(`node`, `modifiers`, `dotDotDotToken`, `name`, `questionToken`, `type`, `initializer`): [`ParameterDeclaration`](../interfaces/ParameterDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7517 + +### Parameters + +#### node + +[`ParameterDeclaration`](../interfaces/ParameterDeclaration.md) + +#### modifiers + +`undefined` | readonly [`ModifierLike`](../type-aliases/ModifierLike.md)[] + +#### dotDotDotToken + +`undefined` | [`DotDotDotToken`](../type-aliases/DotDotDotToken.md) + +#### name + +`string` | [`BindingName`](../type-aliases/BindingName.md) + +#### questionToken + +`undefined` | [`QuestionToken`](../type-aliases/QuestionToken.md) + +#### type + +`undefined` | [`TypeNode`](../interfaces/TypeNode.md) + +#### initializer + +`undefined` | [`Expression`](../interfaces/Expression.md) + +### Returns + +[`ParameterDeclaration`](../interfaces/ParameterDeclaration.md) + +## Call Signature + +> **updateParameter**(`node`, `decorators`, `modifiers`, `dotDotDotToken`, `name`, `questionToken`, `type`, `initializer`): [`ParameterDeclaration`](../interfaces/ParameterDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7518 + +### Parameters + +#### node + +[`ParameterDeclaration`](../interfaces/ParameterDeclaration.md) + +#### decorators + +`undefined` | readonly [`Decorator`](../interfaces/Decorator.md)[] + +#### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +#### dotDotDotToken + +`undefined` | [`DotDotDotToken`](../type-aliases/DotDotDotToken.md) + +#### name + +`string` | [`BindingName`](../type-aliases/BindingName.md) + +#### questionToken + +`undefined` | [`QuestionToken`](../type-aliases/QuestionToken.md) + +#### type + +`undefined` | [`TypeNode`](../interfaces/TypeNode.md) + +#### initializer + +`undefined` | [`Expression`](../interfaces/Expression.md) + +### Returns + +[`ParameterDeclaration`](../interfaces/ParameterDeclaration.md) diff --git a/docs/api_docs/namespaces/ts/functions/updateParen.md b/docs/api_docs/namespaces/ts/functions/updateParen.md new file mode 100644 index 0000000000000000000000000000000000000000..35268deeb1f948f4c6cb725e053083127fa3167e --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateParen.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateParen + +# Function: ~~updateParen()~~ + +> **updateParen**(`node`, `expression`): [`ParenthesizedExpression`](../interfaces/ParenthesizedExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7731 + +## Parameters + +### node + +[`ParenthesizedExpression`](../interfaces/ParenthesizedExpression.md) + +### expression + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`ParenthesizedExpression`](../interfaces/ParenthesizedExpression.md) + +## Deprecated + +Use `factory.updateParenthesizedExpression` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateParenthesizedType.md b/docs/api_docs/namespaces/ts/functions/updateParenthesizedType.md new file mode 100644 index 0000000000000000000000000000000000000000..c9126cb2997d65c49b9d9f13d9b27313fb44ef36 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateParenthesizedType.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateParenthesizedType + +# Function: ~~updateParenthesizedType()~~ + +> **updateParenthesizedType**(`node`, `type`): [`ParenthesizedTypeNode`](../interfaces/ParenthesizedTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7659 + +## Parameters + +### node + +[`ParenthesizedTypeNode`](../interfaces/ParenthesizedTypeNode.md) + +### type + +[`TypeNode`](../interfaces/TypeNode.md) + +## Returns + +[`ParenthesizedTypeNode`](../interfaces/ParenthesizedTypeNode.md) + +## Deprecated + +Use `factory.updateParenthesizedType` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updatePartiallyEmittedExpression.md b/docs/api_docs/namespaces/ts/functions/updatePartiallyEmittedExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..72838d6e5ec7f6b0e0138304a8dfaae83550e72a --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updatePartiallyEmittedExpression.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updatePartiallyEmittedExpression + +# Function: ~~updatePartiallyEmittedExpression()~~ + +> **updatePartiallyEmittedExpression**(`node`, `expression`): [`PartiallyEmittedExpression`](../interfaces/PartiallyEmittedExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8155 + +## Parameters + +### node + +[`PartiallyEmittedExpression`](../interfaces/PartiallyEmittedExpression.md) + +### expression + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`PartiallyEmittedExpression`](../interfaces/PartiallyEmittedExpression.md) + +## Deprecated + +Use `factory.updatePartiallyEmittedExpression` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updatePostfix.md b/docs/api_docs/namespaces/ts/functions/updatePostfix.md new file mode 100644 index 0000000000000000000000000000000000000000..4966362566f652519d6b64db63b4314c3acde6eb --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updatePostfix.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updatePostfix + +# Function: ~~updatePostfix()~~ + +> **updatePostfix**(`node`, `operand`): [`PostfixUnaryExpression`](../interfaces/PostfixUnaryExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7759 + +## Parameters + +### node + +[`PostfixUnaryExpression`](../interfaces/PostfixUnaryExpression.md) + +### operand + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`PostfixUnaryExpression`](../interfaces/PostfixUnaryExpression.md) + +## Deprecated + +Use `factory.updatePostfixUnaryExpression` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updatePrefix.md b/docs/api_docs/namespaces/ts/functions/updatePrefix.md new file mode 100644 index 0000000000000000000000000000000000000000..62b20ea03ed977dd721cb3e7b7421ab416461db8 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updatePrefix.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updatePrefix + +# Function: ~~updatePrefix()~~ + +> **updatePrefix**(`node`, `operand`): [`PrefixUnaryExpression`](../interfaces/PrefixUnaryExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7755 + +## Parameters + +### node + +[`PrefixUnaryExpression`](../interfaces/PrefixUnaryExpression.md) + +### operand + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`PrefixUnaryExpression`](../interfaces/PrefixUnaryExpression.md) + +## Deprecated + +Use `factory.updatePrefixExpression` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateProperty.md b/docs/api_docs/namespaces/ts/functions/updateProperty.md new file mode 100644 index 0000000000000000000000000000000000000000..b57d22c486c9352591120bd1d2e02dfb36e4c2f6 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateProperty.md @@ -0,0 +1,87 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateProperty + +# Function: ~~updateProperty()~~ + +## Deprecated + +Use `factory.updatePropertyDeclaration` or the factory supplied by your transformation context instead. + +## Call Signature + +> **updateProperty**(`node`, `modifiers`, `name`, `questionOrExclamationToken`, `type`, `initializer`): [`PropertyDeclaration`](../interfaces/PropertyDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7531 + +### Parameters + +#### node + +[`PropertyDeclaration`](../interfaces/PropertyDeclaration.md) + +#### modifiers + +`undefined` | readonly [`ModifierLike`](../type-aliases/ModifierLike.md)[] + +#### name + +`string` | [`PropertyName`](../type-aliases/PropertyName.md) + +#### questionOrExclamationToken + +`undefined` | [`QuestionToken`](../type-aliases/QuestionToken.md) | [`ExclamationToken`](../type-aliases/ExclamationToken.md) + +#### type + +`undefined` | [`TypeNode`](../interfaces/TypeNode.md) + +#### initializer + +`undefined` | [`Expression`](../interfaces/Expression.md) + +### Returns + +[`PropertyDeclaration`](../interfaces/PropertyDeclaration.md) + +## Call Signature + +> **updateProperty**(`node`, `decorators`, `modifiers`, `name`, `questionOrExclamationToken`, `type`, `initializer`): [`PropertyDeclaration`](../interfaces/PropertyDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7532 + +### Parameters + +#### node + +[`PropertyDeclaration`](../interfaces/PropertyDeclaration.md) + +#### decorators + +`undefined` | readonly [`Decorator`](../interfaces/Decorator.md)[] + +#### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +#### name + +`string` | [`PropertyName`](../type-aliases/PropertyName.md) + +#### questionOrExclamationToken + +`undefined` | [`QuestionToken`](../type-aliases/QuestionToken.md) | [`ExclamationToken`](../type-aliases/ExclamationToken.md) + +#### type + +`undefined` | [`TypeNode`](../interfaces/TypeNode.md) + +#### initializer + +`undefined` | [`Expression`](../interfaces/Expression.md) + +### Returns + +[`PropertyDeclaration`](../interfaces/PropertyDeclaration.md) diff --git a/docs/api_docs/namespaces/ts/functions/updatePropertyAccess.md b/docs/api_docs/namespaces/ts/functions/updatePropertyAccess.md new file mode 100644 index 0000000000000000000000000000000000000000..d5cf601b6247be67065b126a7648db6e461350a7 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updatePropertyAccess.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updatePropertyAccess + +# Function: ~~updatePropertyAccess()~~ + +> **updatePropertyAccess**(`node`, `expression`, `name`): [`PropertyAccessExpression`](../interfaces/PropertyAccessExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7699 + +## Parameters + +### node + +[`PropertyAccessExpression`](../interfaces/PropertyAccessExpression.md) + +### expression + +[`Expression`](../interfaces/Expression.md) + +### name + +[`MemberName`](../type-aliases/MemberName.md) + +## Returns + +[`PropertyAccessExpression`](../interfaces/PropertyAccessExpression.md) + +## Deprecated + +Use `factory.updatePropertyAccessExpression` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updatePropertyAccessChain.md b/docs/api_docs/namespaces/ts/functions/updatePropertyAccessChain.md new file mode 100644 index 0000000000000000000000000000000000000000..9d4c2fc75f000cfb73b1d07b73c342e0ca0f2982 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updatePropertyAccessChain.md @@ -0,0 +1,37 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updatePropertyAccessChain + +# Function: ~~updatePropertyAccessChain()~~ + +> **updatePropertyAccessChain**(`node`, `expression`, `questionDotToken`, `name`): [`PropertyAccessChain`](../interfaces/PropertyAccessChain.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7703 + +## Parameters + +### node + +[`PropertyAccessChain`](../interfaces/PropertyAccessChain.md) + +### expression + +[`Expression`](../interfaces/Expression.md) + +### questionDotToken + +`undefined` | [`QuestionDotToken`](../type-aliases/QuestionDotToken.md) + +### name + +[`MemberName`](../type-aliases/MemberName.md) + +## Returns + +[`PropertyAccessChain`](../interfaces/PropertyAccessChain.md) + +## Deprecated + +Use `factory.updatePropertyAccessChain` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updatePropertyAssignment.md b/docs/api_docs/namespaces/ts/functions/updatePropertyAssignment.md new file mode 100644 index 0000000000000000000000000000000000000000..ae8421984d866b7398e12fb91f58bdbedee59b28 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updatePropertyAssignment.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updatePropertyAssignment + +# Function: ~~updatePropertyAssignment()~~ + +> **updatePropertyAssignment**(`node`, `name`, `initializer`): [`PropertyAssignment`](../interfaces/PropertyAssignment.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8135 + +## Parameters + +### node + +[`PropertyAssignment`](../interfaces/PropertyAssignment.md) + +### name + +[`PropertyName`](../type-aliases/PropertyName.md) + +### initializer + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`PropertyAssignment`](../interfaces/PropertyAssignment.md) + +## Deprecated + +Use `factory.updatePropertyAssignment` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updatePropertySignature.md b/docs/api_docs/namespaces/ts/functions/updatePropertySignature.md new file mode 100644 index 0000000000000000000000000000000000000000..ed6de0be4639ca4627ddbda9d19e9c31d2750a4b --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updatePropertySignature.md @@ -0,0 +1,45 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updatePropertySignature + +# Function: ~~updatePropertySignature()~~ + +> **updatePropertySignature**(`node`, `modifiers`, `name`, `questionToken`, `type`, `initializer`): [`PropertySignature`](../interfaces/PropertySignature.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8247 + +## Parameters + +### node + +[`PropertySignature`](../interfaces/PropertySignature.md) + +### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +### name + +[`PropertyName`](../type-aliases/PropertyName.md) + +### questionToken + +`undefined` | [`QuestionToken`](../type-aliases/QuestionToken.md) + +### type + +`undefined` | [`TypeNode`](../interfaces/TypeNode.md) + +### initializer + +`undefined` | [`Expression`](../interfaces/Expression.md) + +## Returns + +[`PropertySignature`](../interfaces/PropertySignature.md) + +## Deprecated + +Use `factory.updatePropertySignature` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateQualifiedName.md b/docs/api_docs/namespaces/ts/functions/updateQualifiedName.md new file mode 100644 index 0000000000000000000000000000000000000000..e24e5519e03065ea755770cab9343b8b36593067 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateQualifiedName.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateQualifiedName + +# Function: ~~updateQualifiedName()~~ + +> **updateQualifiedName**(`node`, `left`, `right`): [`QualifiedName`](../interfaces/QualifiedName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7495 + +## Parameters + +### node + +[`QualifiedName`](../interfaces/QualifiedName.md) + +### left + +[`EntityName`](../type-aliases/EntityName.md) + +### right + +[`Identifier`](../interfaces/Identifier.md) + +## Returns + +[`QualifiedName`](../interfaces/QualifiedName.md) + +## Deprecated + +Use `factory.updateQualifiedName` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateRestTypeNode.md b/docs/api_docs/namespaces/ts/functions/updateRestTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..3c9ad52e93f323873b9147bdaa8718fb635500d3 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateRestTypeNode.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateRestTypeNode + +# Function: ~~updateRestTypeNode()~~ + +> **updateRestTypeNode**(`node`, `type`): [`RestTypeNode`](../interfaces/RestTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7628 + +## Parameters + +### node + +[`RestTypeNode`](../interfaces/RestTypeNode.md) + +### type + +[`TypeNode`](../interfaces/TypeNode.md) + +## Returns + +[`RestTypeNode`](../interfaces/RestTypeNode.md) + +## Deprecated + +Use `factory.updateRestTypeNode` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateReturn.md b/docs/api_docs/namespaces/ts/functions/updateReturn.md new file mode 100644 index 0000000000000000000000000000000000000000..ff4fa23d1e6ebe0e9ea3cf6639521aca17f8e0e4 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateReturn.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateReturn + +# Function: ~~updateReturn()~~ + +> **updateReturn**(`node`, `expression`): [`ReturnStatement`](../interfaces/ReturnStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7871 + +## Parameters + +### node + +[`ReturnStatement`](../interfaces/ReturnStatement.md) + +### expression + +`undefined` | [`Expression`](../interfaces/Expression.md) + +## Returns + +[`ReturnStatement`](../interfaces/ReturnStatement.md) + +## Deprecated + +Use `factory.updateReturnStatement` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateSetAccessor.md b/docs/api_docs/namespaces/ts/functions/updateSetAccessor.md new file mode 100644 index 0000000000000000000000000000000000000000..370fe85c5e327f981440a0776ba4135b5f21108f --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateSetAccessor.md @@ -0,0 +1,79 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateSetAccessor + +# Function: ~~updateSetAccessor()~~ + +## Deprecated + +Use `factory.updateSetAccessorDeclaration` or the factory supplied by your transformation context instead. + +## Call Signature + +> **updateSetAccessor**(`node`, `modifiers`, `name`, `parameters`, `body`): [`SetAccessorDeclaration`](../interfaces/SetAccessorDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7571 + +### Parameters + +#### node + +[`SetAccessorDeclaration`](../interfaces/SetAccessorDeclaration.md) + +#### modifiers + +`undefined` | readonly [`ModifierLike`](../type-aliases/ModifierLike.md)[] + +#### name + +[`PropertyName`](../type-aliases/PropertyName.md) + +#### parameters + +readonly [`ParameterDeclaration`](../interfaces/ParameterDeclaration.md)[] + +#### body + +`undefined` | [`Block`](../interfaces/Block.md) + +### Returns + +[`SetAccessorDeclaration`](../interfaces/SetAccessorDeclaration.md) + +## Call Signature + +> **updateSetAccessor**(`node`, `decorators`, `modifiers`, `name`, `parameters`, `body`): [`SetAccessorDeclaration`](../interfaces/SetAccessorDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7572 + +### Parameters + +#### node + +[`SetAccessorDeclaration`](../interfaces/SetAccessorDeclaration.md) + +#### decorators + +`undefined` | readonly [`Decorator`](../interfaces/Decorator.md)[] + +#### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +#### name + +[`PropertyName`](../type-aliases/PropertyName.md) + +#### parameters + +readonly [`ParameterDeclaration`](../interfaces/ParameterDeclaration.md)[] + +#### body + +`undefined` | [`Block`](../interfaces/Block.md) + +### Returns + +[`SetAccessorDeclaration`](../interfaces/SetAccessorDeclaration.md) diff --git a/docs/api_docs/namespaces/ts/functions/updateShorthandPropertyAssignment.md b/docs/api_docs/namespaces/ts/functions/updateShorthandPropertyAssignment.md new file mode 100644 index 0000000000000000000000000000000000000000..30e24b6648457bc8312eb86824c67091867594f1 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateShorthandPropertyAssignment.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateShorthandPropertyAssignment + +# Function: ~~updateShorthandPropertyAssignment()~~ + +> **updateShorthandPropertyAssignment**(`node`, `name`, `objectAssignmentInitializer`): [`ShorthandPropertyAssignment`](../interfaces/ShorthandPropertyAssignment.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8139 + +## Parameters + +### node + +[`ShorthandPropertyAssignment`](../interfaces/ShorthandPropertyAssignment.md) + +### name + +[`Identifier`](../interfaces/Identifier.md) + +### objectAssignmentInitializer + +`undefined` | [`Expression`](../interfaces/Expression.md) + +## Returns + +[`ShorthandPropertyAssignment`](../interfaces/ShorthandPropertyAssignment.md) + +## Deprecated + +Use `factory.updateShorthandPropertyAssignment` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateSourceFile.md b/docs/api_docs/namespaces/ts/functions/updateSourceFile.md new file mode 100644 index 0000000000000000000000000000000000000000..554424034b1c8ea65002c22fb7ede28ca1f0aa3f --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateSourceFile.md @@ -0,0 +1,37 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateSourceFile + +# Function: updateSourceFile() + +> **updateSourceFile**(`sourceFile`, `newText`, `textChangeRange`, `aggressiveChecks`?, `option`?): [`SourceFile`](../interfaces/SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5254 + +## Parameters + +### sourceFile + +[`SourceFile`](../interfaces/SourceFile.md) + +### newText + +`string` + +### textChangeRange + +[`TextChangeRange`](../interfaces/TextChangeRange.md) + +### aggressiveChecks? + +`boolean` + +### option? + +[`CompilerOptions`](../interfaces/CompilerOptions.md) + +## Returns + +[`SourceFile`](../interfaces/SourceFile.md) diff --git a/docs/api_docs/namespaces/ts/functions/updateSourceFileNode.md b/docs/api_docs/namespaces/ts/functions/updateSourceFileNode.md new file mode 100644 index 0000000000000000000000000000000000000000..162c2f3417e289edbcbbd18861e9ea6adf0d0e93 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateSourceFileNode.md @@ -0,0 +1,49 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateSourceFileNode + +# Function: ~~updateSourceFileNode()~~ + +> **updateSourceFileNode**(`node`, `statements`, `isDeclarationFile`?, `referencedFiles`?, `typeReferences`?, `hasNoDefaultLib`?, `libReferences`?): [`SourceFile`](../interfaces/SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8149 + +## Parameters + +### node + +[`SourceFile`](../interfaces/SourceFile.md) + +### statements + +readonly [`Statement`](../interfaces/Statement.md)[] + +### isDeclarationFile? + +`boolean` + +### referencedFiles? + +readonly [`FileReference`](../interfaces/FileReference.md)[] + +### typeReferences? + +readonly [`FileReference`](../interfaces/FileReference.md)[] + +### hasNoDefaultLib? + +`boolean` + +### libReferences? + +readonly [`FileReference`](../interfaces/FileReference.md)[] + +## Returns + +[`SourceFile`](../interfaces/SourceFile.md) + +## Deprecated + +Use `factory.updateSourceFile` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateSpread.md b/docs/api_docs/namespaces/ts/functions/updateSpread.md new file mode 100644 index 0000000000000000000000000000000000000000..4a98cd90286f0d104b8b3e0b7986ae4c45b8a9f7 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateSpread.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateSpread + +# Function: ~~updateSpread()~~ + +> **updateSpread**(`node`, `expression`): [`SpreadElement`](../interfaces/SpreadElement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7793 + +## Parameters + +### node + +[`SpreadElement`](../interfaces/SpreadElement.md) + +### expression + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`SpreadElement`](../interfaces/SpreadElement.md) + +## Deprecated + +Use `factory.updateSpreadExpression` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateSpreadAssignment.md b/docs/api_docs/namespaces/ts/functions/updateSpreadAssignment.md new file mode 100644 index 0000000000000000000000000000000000000000..eec27e9fb9b894b397e202f58f8fedea0c431c58 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateSpreadAssignment.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateSpreadAssignment + +# Function: ~~updateSpreadAssignment()~~ + +> **updateSpreadAssignment**(`node`, `expression`): [`SpreadAssignment`](../interfaces/SpreadAssignment.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8143 + +## Parameters + +### node + +[`SpreadAssignment`](../interfaces/SpreadAssignment.md) + +### expression + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`SpreadAssignment`](../interfaces/SpreadAssignment.md) + +## Deprecated + +Use `factory.updateSpreadAssignment` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateStatement.md b/docs/api_docs/namespaces/ts/functions/updateStatement.md new file mode 100644 index 0000000000000000000000000000000000000000..a499ee09d22d288a177ede7b9ddd4cf92f5ecf6a --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateStatement.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateStatement + +# Function: ~~updateStatement()~~ + +> **updateStatement**(`node`, `expression`): [`ExpressionStatement`](../interfaces/ExpressionStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7835 + +## Parameters + +### node + +[`ExpressionStatement`](../interfaces/ExpressionStatement.md) + +### expression + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`ExpressionStatement`](../interfaces/ExpressionStatement.md) + +## Deprecated + +Use `factory.updateExpressionStatement` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateSwitch.md b/docs/api_docs/namespaces/ts/functions/updateSwitch.md new file mode 100644 index 0000000000000000000000000000000000000000..7cc6f2974e98e9b77c45de8cc1427ca6381f7699 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateSwitch.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateSwitch + +# Function: ~~updateSwitch()~~ + +> **updateSwitch**(`node`, `expression`, `caseBlock`): [`SwitchStatement`](../interfaces/SwitchStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7879 + +## Parameters + +### node + +[`SwitchStatement`](../interfaces/SwitchStatement.md) + +### expression + +[`Expression`](../interfaces/Expression.md) + +### caseBlock + +[`CaseBlock`](../interfaces/CaseBlock.md) + +## Returns + +[`SwitchStatement`](../interfaces/SwitchStatement.md) + +## Deprecated + +Use `factory.updateSwitchStatement` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateTaggedTemplate.md b/docs/api_docs/namespaces/ts/functions/updateTaggedTemplate.md new file mode 100644 index 0000000000000000000000000000000000000000..e1c667957460ffadd293a522fa1ce219f0fb1392 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateTaggedTemplate.md @@ -0,0 +1,63 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateTaggedTemplate + +# Function: ~~updateTaggedTemplate()~~ + +## Deprecated + +Use `factory.updateTaggedTemplate` or the factory supplied by your transformation context instead. + +## Call Signature + +> **updateTaggedTemplate**(`node`, `tag`, `template`): [`TaggedTemplateExpression`](../interfaces/TaggedTemplateExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8225 + +### Parameters + +#### node + +[`TaggedTemplateExpression`](../interfaces/TaggedTemplateExpression.md) + +#### tag + +[`Expression`](../interfaces/Expression.md) + +#### template + +[`TemplateLiteral`](../type-aliases/TemplateLiteral.md) + +### Returns + +[`TaggedTemplateExpression`](../interfaces/TaggedTemplateExpression.md) + +## Call Signature + +> **updateTaggedTemplate**(`node`, `tag`, `typeArguments`, `template`): [`TaggedTemplateExpression`](../interfaces/TaggedTemplateExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8226 + +### Parameters + +#### node + +[`TaggedTemplateExpression`](../interfaces/TaggedTemplateExpression.md) + +#### tag + +[`Expression`](../interfaces/Expression.md) + +#### typeArguments + +`undefined` | readonly [`TypeNode`](../interfaces/TypeNode.md)[] + +#### template + +[`TemplateLiteral`](../type-aliases/TemplateLiteral.md) + +### Returns + +[`TaggedTemplateExpression`](../interfaces/TaggedTemplateExpression.md) diff --git a/docs/api_docs/namespaces/ts/functions/updateTemplateExpression.md b/docs/api_docs/namespaces/ts/functions/updateTemplateExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..0d2e63513d0264e862914124365e6665eb3660fb --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateTemplateExpression.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateTemplateExpression + +# Function: ~~updateTemplateExpression()~~ + +> **updateTemplateExpression**(`node`, `head`, `templateSpans`): [`TemplateExpression`](../interfaces/TemplateExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7767 + +## Parameters + +### node + +[`TemplateExpression`](../interfaces/TemplateExpression.md) + +### head + +[`TemplateHead`](../interfaces/TemplateHead.md) + +### templateSpans + +readonly [`TemplateSpan`](../interfaces/TemplateSpan.md)[] + +## Returns + +[`TemplateExpression`](../interfaces/TemplateExpression.md) + +## Deprecated + +Use `factory.updateTemplateExpression` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateTemplateSpan.md b/docs/api_docs/namespaces/ts/functions/updateTemplateSpan.md new file mode 100644 index 0000000000000000000000000000000000000000..2455e01b7f97a69907d9df7ed7d30f8407b2b497 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateTemplateSpan.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateTemplateSpan + +# Function: ~~updateTemplateSpan()~~ + +> **updateTemplateSpan**(`node`, `expression`, `literal`): [`TemplateSpan`](../interfaces/TemplateSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7815 + +## Parameters + +### node + +[`TemplateSpan`](../interfaces/TemplateSpan.md) + +### expression + +[`Expression`](../interfaces/Expression.md) + +### literal + +[`TemplateMiddle`](../interfaces/TemplateMiddle.md) | [`TemplateTail`](../interfaces/TemplateTail.md) + +## Returns + +[`TemplateSpan`](../interfaces/TemplateSpan.md) + +## Deprecated + +Use `factory.updateTemplateSpan` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateThrow.md b/docs/api_docs/namespaces/ts/functions/updateThrow.md new file mode 100644 index 0000000000000000000000000000000000000000..f190a8bc7c75d34063a094b9fa40398a5b744bfa --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateThrow.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateThrow + +# Function: ~~updateThrow()~~ + +> **updateThrow**(`node`, `expression`): [`ThrowStatement`](../interfaces/ThrowStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7887 + +## Parameters + +### node + +[`ThrowStatement`](../interfaces/ThrowStatement.md) + +### expression + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`ThrowStatement`](../interfaces/ThrowStatement.md) + +## Deprecated + +Use `factory.updateThrowStatement` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateTry.md b/docs/api_docs/namespaces/ts/functions/updateTry.md new file mode 100644 index 0000000000000000000000000000000000000000..46942ab0cf92441843bd46c7370ba5aa741bbe0b --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateTry.md @@ -0,0 +1,37 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateTry + +# Function: ~~updateTry()~~ + +> **updateTry**(`node`, `tryBlock`, `catchClause`, `finallyBlock`): [`TryStatement`](../interfaces/TryStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7891 + +## Parameters + +### node + +[`TryStatement`](../interfaces/TryStatement.md) + +### tryBlock + +[`Block`](../interfaces/Block.md) + +### catchClause + +`undefined` | [`CatchClause`](../interfaces/CatchClause.md) + +### finallyBlock + +`undefined` | [`Block`](../interfaces/Block.md) + +## Returns + +[`TryStatement`](../interfaces/TryStatement.md) + +## Deprecated + +Use `factory.updateTryStatement` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateTupleTypeNode.md b/docs/api_docs/namespaces/ts/functions/updateTupleTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..c88e3dbb5540f5cd06bb2dcca012b231eca7ebaf --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateTupleTypeNode.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateTupleTypeNode + +# Function: ~~updateTupleTypeNode()~~ + +> **updateTupleTypeNode**(`node`, `elements`): [`TupleTypeNode`](../interfaces/TupleTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7620 + +## Parameters + +### node + +[`TupleTypeNode`](../interfaces/TupleTypeNode.md) + +### elements + +readonly ([`TypeNode`](../interfaces/TypeNode.md) \| [`NamedTupleMember`](../interfaces/NamedTupleMember.md))[] + +## Returns + +[`TupleTypeNode`](../interfaces/TupleTypeNode.md) + +## Deprecated + +Use `factory.updateTupleTypeNode` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateTypeAliasDeclaration.md b/docs/api_docs/namespaces/ts/functions/updateTypeAliasDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..ea2dc7c6975d7fe7befdbee6c199086bd73c5d1a --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateTypeAliasDeclaration.md @@ -0,0 +1,79 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateTypeAliasDeclaration + +# Function: ~~updateTypeAliasDeclaration()~~ + +## Deprecated + +Use `factory.updateTypeAliasDeclaration` or the factory supplied by your transformation context instead. + +## Call Signature + +> **updateTypeAliasDeclaration**(`node`, `modifiers`, `name`, `typeParameters`, `type`): [`TypeAliasDeclaration`](../interfaces/TypeAliasDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7935 + +### Parameters + +#### node + +[`TypeAliasDeclaration`](../interfaces/TypeAliasDeclaration.md) + +#### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +#### name + +[`Identifier`](../interfaces/Identifier.md) + +#### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](../interfaces/TypeParameterDeclaration.md)[] + +#### type + +[`TypeNode`](../interfaces/TypeNode.md) + +### Returns + +[`TypeAliasDeclaration`](../interfaces/TypeAliasDeclaration.md) + +## Call Signature + +> **updateTypeAliasDeclaration**(`node`, `decorators`, `modifiers`, `name`, `typeParameters`, `type`): [`TypeAliasDeclaration`](../interfaces/TypeAliasDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7936 + +### Parameters + +#### node + +[`TypeAliasDeclaration`](../interfaces/TypeAliasDeclaration.md) + +#### decorators + +`undefined` | readonly [`Decorator`](../interfaces/Decorator.md)[] + +#### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +#### name + +[`Identifier`](../interfaces/Identifier.md) + +#### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](../interfaces/TypeParameterDeclaration.md)[] + +#### type + +[`TypeNode`](../interfaces/TypeNode.md) + +### Returns + +[`TypeAliasDeclaration`](../interfaces/TypeAliasDeclaration.md) diff --git a/docs/api_docs/namespaces/ts/functions/updateTypeAssertion.md b/docs/api_docs/namespaces/ts/functions/updateTypeAssertion.md new file mode 100644 index 0000000000000000000000000000000000000000..c590e43fbd00b2ee42e03f32b972b168baf46e61 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateTypeAssertion.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateTypeAssertion + +# Function: ~~updateTypeAssertion()~~ + +> **updateTypeAssertion**(`node`, `type`, `expression`): [`TypeAssertion`](../interfaces/TypeAssertion.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7727 + +## Parameters + +### node + +[`TypeAssertion`](../interfaces/TypeAssertion.md) + +### type + +[`TypeNode`](../interfaces/TypeNode.md) + +### expression + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`TypeAssertion`](../interfaces/TypeAssertion.md) + +## Deprecated + +Use `factory.updateTypeAssertion` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateTypeLiteralNode.md b/docs/api_docs/namespaces/ts/functions/updateTypeLiteralNode.md new file mode 100644 index 0000000000000000000000000000000000000000..1e4711cb2a3c90d3a866ef6093baa85a86a8b0fd --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateTypeLiteralNode.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateTypeLiteralNode + +# Function: ~~updateTypeLiteralNode()~~ + +> **updateTypeLiteralNode**(`node`, `members`): [`TypeLiteralNode`](../interfaces/TypeLiteralNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7612 + +## Parameters + +### node + +[`TypeLiteralNode`](../interfaces/TypeLiteralNode.md) + +### members + +[`NodeArray`](../interfaces/NodeArray.md)\<[`TypeElement`](../interfaces/TypeElement.md)\> + +## Returns + +[`TypeLiteralNode`](../interfaces/TypeLiteralNode.md) + +## Deprecated + +Use `factory.updateTypeLiteralNode` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateTypeOf.md b/docs/api_docs/namespaces/ts/functions/updateTypeOf.md new file mode 100644 index 0000000000000000000000000000000000000000..e7e4272674567653de3419a951d531771457c8be --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateTypeOf.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateTypeOf + +# Function: ~~updateTypeOf()~~ + +> **updateTypeOf**(`node`, `expression`): [`TypeOfExpression`](../interfaces/TypeOfExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7743 + +## Parameters + +### node + +[`TypeOfExpression`](../interfaces/TypeOfExpression.md) + +### expression + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`TypeOfExpression`](../interfaces/TypeOfExpression.md) + +## Deprecated + +Use `factory.updateTypeOfExpression` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateTypeOperatorNode.md b/docs/api_docs/namespaces/ts/functions/updateTypeOperatorNode.md new file mode 100644 index 0000000000000000000000000000000000000000..dc606d2edda899583832585279ce58f2f8ec4064 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateTypeOperatorNode.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateTypeOperatorNode + +# Function: ~~updateTypeOperatorNode()~~ + +> **updateTypeOperatorNode**(`node`, `type`): [`TypeOperatorNode`](../interfaces/TypeOperatorNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7663 + +## Parameters + +### node + +[`TypeOperatorNode`](../interfaces/TypeOperatorNode.md) + +### type + +[`TypeNode`](../interfaces/TypeNode.md) + +## Returns + +[`TypeOperatorNode`](../interfaces/TypeOperatorNode.md) + +## Deprecated + +Use `factory.updateTypeOperatorNode` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateTypeParameterDeclaration.md b/docs/api_docs/namespaces/ts/functions/updateTypeParameterDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..b4ec7700155697f337aec8851c73c4588fa5ddb4 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateTypeParameterDeclaration.md @@ -0,0 +1,71 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateTypeParameterDeclaration + +# Function: ~~updateTypeParameterDeclaration()~~ + +## Deprecated + +Use `factory.updateTypeParameterDeclaration` or the factory supplied by your transformation context instead. + +## Call Signature + +> **updateTypeParameterDeclaration**(`node`, `modifiers`, `name`, `constraint`, `defaultType`): [`TypeParameterDeclaration`](../interfaces/TypeParameterDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7507 + +### Parameters + +#### node + +[`TypeParameterDeclaration`](../interfaces/TypeParameterDeclaration.md) + +#### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +#### name + +[`Identifier`](../interfaces/Identifier.md) + +#### constraint + +`undefined` | [`TypeNode`](../interfaces/TypeNode.md) + +#### defaultType + +`undefined` | [`TypeNode`](../interfaces/TypeNode.md) + +### Returns + +[`TypeParameterDeclaration`](../interfaces/TypeParameterDeclaration.md) + +## Call Signature + +> **updateTypeParameterDeclaration**(`node`, `name`, `constraint`, `defaultType`): [`TypeParameterDeclaration`](../interfaces/TypeParameterDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7508 + +### Parameters + +#### node + +[`TypeParameterDeclaration`](../interfaces/TypeParameterDeclaration.md) + +#### name + +[`Identifier`](../interfaces/Identifier.md) + +#### constraint + +`undefined` | [`TypeNode`](../interfaces/TypeNode.md) + +#### defaultType + +`undefined` | [`TypeNode`](../interfaces/TypeNode.md) + +### Returns + +[`TypeParameterDeclaration`](../interfaces/TypeParameterDeclaration.md) diff --git a/docs/api_docs/namespaces/ts/functions/updateTypePredicateNode.md b/docs/api_docs/namespaces/ts/functions/updateTypePredicateNode.md new file mode 100644 index 0000000000000000000000000000000000000000..489c5b6236ee5c407b5d2343d2b8e7107b8a8e87 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateTypePredicateNode.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateTypePredicateNode + +# Function: ~~updateTypePredicateNode()~~ + +> **updateTypePredicateNode**(`node`, `parameterName`, `type`): [`TypePredicateNode`](../interfaces/TypePredicateNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8201 + +## Parameters + +### node + +[`TypePredicateNode`](../interfaces/TypePredicateNode.md) + +### parameterName + +[`Identifier`](../interfaces/Identifier.md) | [`ThisTypeNode`](../interfaces/ThisTypeNode.md) + +### type + +[`TypeNode`](../interfaces/TypeNode.md) + +## Returns + +[`TypePredicateNode`](../interfaces/TypePredicateNode.md) + +## Deprecated + +Use `factory.updateTypePredicateNode` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateTypePredicateNodeWithModifier.md b/docs/api_docs/namespaces/ts/functions/updateTypePredicateNodeWithModifier.md new file mode 100644 index 0000000000000000000000000000000000000000..63568a8007d8f4b039aa0249b10d30b64679be49 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateTypePredicateNodeWithModifier.md @@ -0,0 +1,37 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateTypePredicateNodeWithModifier + +# Function: ~~updateTypePredicateNodeWithModifier()~~ + +> **updateTypePredicateNodeWithModifier**(`node`, `assertsModifier`, `parameterName`, `type`): [`TypePredicateNode`](../interfaces/TypePredicateNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7592 + +## Parameters + +### node + +[`TypePredicateNode`](../interfaces/TypePredicateNode.md) + +### assertsModifier + +`undefined` | [`AssertsKeyword`](../type-aliases/AssertsKeyword.md) + +### parameterName + +[`Identifier`](../interfaces/Identifier.md) | [`ThisTypeNode`](../interfaces/ThisTypeNode.md) + +### type + +`undefined` | [`TypeNode`](../interfaces/TypeNode.md) + +## Returns + +[`TypePredicateNode`](../interfaces/TypePredicateNode.md) + +## Deprecated + +Use `factory.updateTypePredicateNode` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateTypeQueryNode.md b/docs/api_docs/namespaces/ts/functions/updateTypeQueryNode.md new file mode 100644 index 0000000000000000000000000000000000000000..3e0c1ba83f8ff8f77ea765dec8bb1b04584aa1d5 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateTypeQueryNode.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateTypeQueryNode + +# Function: ~~updateTypeQueryNode()~~ + +> **updateTypeQueryNode**(`node`, `exprName`, `typeArguments`?): [`TypeQueryNode`](../interfaces/TypeQueryNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7608 + +## Parameters + +### node + +[`TypeQueryNode`](../interfaces/TypeQueryNode.md) + +### exprName + +[`EntityName`](../type-aliases/EntityName.md) + +### typeArguments? + +readonly [`TypeNode`](../interfaces/TypeNode.md)[] + +## Returns + +[`TypeQueryNode`](../interfaces/TypeQueryNode.md) + +## Deprecated + +Use `factory.updateTypeQueryNode` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateTypeReferenceNode.md b/docs/api_docs/namespaces/ts/functions/updateTypeReferenceNode.md new file mode 100644 index 0000000000000000000000000000000000000000..f0eab0e54c866343bf5709735619a5cb49b90298 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateTypeReferenceNode.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateTypeReferenceNode + +# Function: ~~updateTypeReferenceNode()~~ + +> **updateTypeReferenceNode**(`node`, `typeName`, `typeArguments`): [`TypeReferenceNode`](../interfaces/TypeReferenceNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7596 + +## Parameters + +### node + +[`TypeReferenceNode`](../interfaces/TypeReferenceNode.md) + +### typeName + +[`EntityName`](../type-aliases/EntityName.md) + +### typeArguments + +`undefined` | [`NodeArray`](../interfaces/NodeArray.md)\<[`TypeNode`](../interfaces/TypeNode.md)\> + +## Returns + +[`TypeReferenceNode`](../interfaces/TypeReferenceNode.md) + +## Deprecated + +Use `factory.updateTypeReferenceNode` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateUnionTypeNode.md b/docs/api_docs/namespaces/ts/functions/updateUnionTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..de24d6b3e4b42aa82a916e7c6263e3ce25390438 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateUnionTypeNode.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateUnionTypeNode + +# Function: ~~updateUnionTypeNode()~~ + +> **updateUnionTypeNode**(`node`, `types`): [`UnionTypeNode`](../interfaces/UnionTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7632 + +## Parameters + +### node + +[`UnionTypeNode`](../interfaces/UnionTypeNode.md) + +### types + +[`NodeArray`](../interfaces/NodeArray.md)\<[`TypeNode`](../interfaces/TypeNode.md)\> + +## Returns + +[`UnionTypeNode`](../interfaces/UnionTypeNode.md) + +## Deprecated + +Use `factory.updateUnionTypeNode` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateVariableDeclaration.md b/docs/api_docs/namespaces/ts/functions/updateVariableDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..cf74ed54ab028b6ac91bfc8a2e524509f561d995 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateVariableDeclaration.md @@ -0,0 +1,71 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateVariableDeclaration + +# Function: ~~updateVariableDeclaration()~~ + +## Deprecated + +Use `factory.updateVariableDeclaration` or the factory supplied by your transformation context instead. + +## Call Signature + +> **updateVariableDeclaration**(`node`, `name`, `type`, `initializer`): [`VariableDeclaration`](../interfaces/VariableDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8269 + +### Parameters + +#### node + +[`VariableDeclaration`](../interfaces/VariableDeclaration.md) + +#### name + +[`BindingName`](../type-aliases/BindingName.md) + +#### type + +`undefined` | [`TypeNode`](../interfaces/TypeNode.md) + +#### initializer + +`undefined` | [`Expression`](../interfaces/Expression.md) + +### Returns + +[`VariableDeclaration`](../interfaces/VariableDeclaration.md) + +## Call Signature + +> **updateVariableDeclaration**(`node`, `name`, `exclamationToken`, `type`, `initializer`): [`VariableDeclaration`](../interfaces/VariableDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8270 + +### Parameters + +#### node + +[`VariableDeclaration`](../interfaces/VariableDeclaration.md) + +#### name + +[`BindingName`](../type-aliases/BindingName.md) + +#### exclamationToken + +`undefined` | [`ExclamationToken`](../type-aliases/ExclamationToken.md) + +#### type + +`undefined` | [`TypeNode`](../interfaces/TypeNode.md) + +#### initializer + +`undefined` | [`Expression`](../interfaces/Expression.md) + +### Returns + +[`VariableDeclaration`](../interfaces/VariableDeclaration.md) diff --git a/docs/api_docs/namespaces/ts/functions/updateVariableDeclarationList.md b/docs/api_docs/namespaces/ts/functions/updateVariableDeclarationList.md new file mode 100644 index 0000000000000000000000000000000000000000..db0b399f4ddb84fda327405845c1d934c75ab10c --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateVariableDeclarationList.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateVariableDeclarationList + +# Function: ~~updateVariableDeclarationList()~~ + +> **updateVariableDeclarationList**(`node`, `declarations`): [`VariableDeclarationList`](../interfaces/VariableDeclarationList.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7897 + +## Parameters + +### node + +[`VariableDeclarationList`](../interfaces/VariableDeclarationList.md) + +### declarations + +readonly [`VariableDeclaration`](../interfaces/VariableDeclaration.md)[] + +## Returns + +[`VariableDeclarationList`](../interfaces/VariableDeclarationList.md) + +## Deprecated + +Use `factory.updateVariableDeclarationList` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateVariableStatement.md b/docs/api_docs/namespaces/ts/functions/updateVariableStatement.md new file mode 100644 index 0000000000000000000000000000000000000000..35f4b86178e27d3731d3a198648345357d924036 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateVariableStatement.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateVariableStatement + +# Function: ~~updateVariableStatement()~~ + +> **updateVariableStatement**(`node`, `modifiers`, `declarationList`): [`VariableStatement`](../interfaces/VariableStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7825 + +## Parameters + +### node + +[`VariableStatement`](../interfaces/VariableStatement.md) + +### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +### declarationList + +[`VariableDeclarationList`](../interfaces/VariableDeclarationList.md) + +## Returns + +[`VariableStatement`](../interfaces/VariableStatement.md) + +## Deprecated + +Use `factory.updateVariableStatement` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateVoid.md b/docs/api_docs/namespaces/ts/functions/updateVoid.md new file mode 100644 index 0000000000000000000000000000000000000000..e4f6ecb54b8492fdd0e1c85232c55c54b0042dbe --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateVoid.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateVoid + +# Function: ~~updateVoid()~~ + +> **updateVoid**(`node`, `expression`): [`VoidExpression`](../interfaces/VoidExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7747 + +## Parameters + +### node + +[`VoidExpression`](../interfaces/VoidExpression.md) + +### expression + +[`Expression`](../interfaces/Expression.md) + +## Returns + +[`VoidExpression`](../interfaces/VoidExpression.md) + +## Deprecated + +Use `factory.updateVoidExpression` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateWhile.md b/docs/api_docs/namespaces/ts/functions/updateWhile.md new file mode 100644 index 0000000000000000000000000000000000000000..8ef46315b5c9bdf47405fa02a4b0f8d47f38efa2 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateWhile.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateWhile + +# Function: ~~updateWhile()~~ + +> **updateWhile**(`node`, `expression`, `statement`): [`WhileStatement`](../interfaces/WhileStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7847 + +## Parameters + +### node + +[`WhileStatement`](../interfaces/WhileStatement.md) + +### expression + +[`Expression`](../interfaces/Expression.md) + +### statement + +[`Statement`](../interfaces/Statement.md) + +## Returns + +[`WhileStatement`](../interfaces/WhileStatement.md) + +## Deprecated + +Use `factory.updateWhileStatement` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateWith.md b/docs/api_docs/namespaces/ts/functions/updateWith.md new file mode 100644 index 0000000000000000000000000000000000000000..683cdcdf29581aa57a6be81ff5ff7fc2e9a9295f --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateWith.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateWith + +# Function: ~~updateWith()~~ + +> **updateWith**(`node`, `expression`, `statement`): [`WithStatement`](../interfaces/WithStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7875 + +## Parameters + +### node + +[`WithStatement`](../interfaces/WithStatement.md) + +### expression + +[`Expression`](../interfaces/Expression.md) + +### statement + +[`Statement`](../interfaces/Statement.md) + +## Returns + +[`WithStatement`](../interfaces/WithStatement.md) + +## Deprecated + +Use `factory.updateWithStatement` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/updateYield.md b/docs/api_docs/namespaces/ts/functions/updateYield.md new file mode 100644 index 0000000000000000000000000000000000000000..a0b8d7a2f9ef0a896c76f050fa96e6d8c737bd8f --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/updateYield.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / updateYield + +# Function: ~~updateYield()~~ + +> **updateYield**(`node`, `asteriskToken`, `expression`): [`YieldExpression`](../interfaces/YieldExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7789 + +## Parameters + +### node + +[`YieldExpression`](../interfaces/YieldExpression.md) + +### asteriskToken + +`undefined` | [`AsteriskToken`](../type-aliases/AsteriskToken.md) + +### expression + +`undefined` | [`Expression`](../interfaces/Expression.md) + +## Returns + +[`YieldExpression`](../interfaces/YieldExpression.md) + +## Deprecated + +Use `factory.updateYieldExpression` or the factory supplied by your transformation context instead. diff --git a/docs/api_docs/namespaces/ts/functions/validateLocaleAndSetLanguage.md b/docs/api_docs/namespaces/ts/functions/validateLocaleAndSetLanguage.md new file mode 100644 index 0000000000000000000000000000000000000000..d98135c0865321ea7771e90edac42a2af15da366 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/validateLocaleAndSetLanguage.md @@ -0,0 +1,38 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / validateLocaleAndSetLanguage + +# Function: validateLocaleAndSetLanguage() + +> **validateLocaleAndSetLanguage**(`locale`, `sys`, `errors`?): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4681 + +Checks to see if the locale is in the appropriate format, +and if it is, attempts to set the appropriate language. + +## Parameters + +### locale + +`string` + +### sys + +#### fileExists + +#### getExecutingFilePath + +#### readFile + +#### resolvePath + +### errors? + +[`Push`](../interfaces/Push.md)\<[`Diagnostic`](../interfaces/Diagnostic.md)\> + +## Returns + +`void` diff --git a/docs/api_docs/namespaces/ts/functions/visitEachChild.md b/docs/api_docs/namespaces/ts/functions/visitEachChild.md new file mode 100644 index 0000000000000000000000000000000000000000..fee5a09a8e0548ae07daa9a4e202c1f8bfed626f --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/visitEachChild.md @@ -0,0 +1,87 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / visitEachChild + +# Function: visitEachChild() + +## Call Signature + +> **visitEachChild**\<`T`\>(`node`, `visitor`, `context`): `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5520 + +Visits each child of a Node using the supplied visitor, possibly returning a new Node of the same kind in its place. + +### Type Parameters + +• **T** *extends* [`Node`](../interfaces/Node.md) + +### Parameters + +#### node + +`T` + +The Node whose children will be visited. + +#### visitor + +[`Visitor`](../type-aliases/Visitor.md) + +The callback used to visit each child. + +#### context + +[`TransformationContext`](../interfaces/TransformationContext.md) + +A lexical environment context for the visitor. + +### Returns + +`T` + +## Call Signature + +> **visitEachChild**\<`T`\>(`node`, `visitor`, `context`, `nodesVisitor`?, `tokenVisitor`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5528 + +Visits each child of a Node using the supplied visitor, possibly returning a new Node of the same kind in its place. + +### Type Parameters + +• **T** *extends* [`Node`](../interfaces/Node.md) + +### Parameters + +#### node + +The Node whose children will be visited. + +`undefined` | `T` + +#### visitor + +[`Visitor`](../type-aliases/Visitor.md) + +The callback used to visit each child. + +#### context + +[`TransformationContext`](../interfaces/TransformationContext.md) + +A lexical environment context for the visitor. + +#### nodesVisitor? + +\<`T`\>(`nodes`, `visitor`, `test`?, `start`?, `count`?) => [`NodeArray`](../interfaces/NodeArray.md)\<`T`\>\<`T`\>(`nodes`, `visitor`, `test`?, `start`?, `count`?) => `undefined` \| [`NodeArray`](../interfaces/NodeArray.md)\<`T`\> + +#### tokenVisitor? + +[`Visitor`](../type-aliases/Visitor.md) + +### Returns + +`undefined` \| `T` diff --git a/docs/api_docs/namespaces/ts/functions/visitFunctionBody.md b/docs/api_docs/namespaces/ts/functions/visitFunctionBody.md new file mode 100644 index 0000000000000000000000000000000000000000..b3c19ccae56bfe60d90e7f73f188e01c3129b1b7 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/visitFunctionBody.md @@ -0,0 +1,88 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / visitFunctionBody + +# Function: visitFunctionBody() + +## Call Signature + +> **visitFunctionBody**(`node`, `visitor`, `context`): [`Block`](../interfaces/Block.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5498 + +Resumes a suspended lexical environment and visits a function body, ending the lexical +environment and merging hoisted declarations upon completion. + +### Parameters + +#### node + +[`Block`](../interfaces/Block.md) + +#### visitor + +[`Visitor`](../type-aliases/Visitor.md) + +#### context + +[`TransformationContext`](../interfaces/TransformationContext.md) + +### Returns + +[`Block`](../interfaces/Block.md) + +## Call Signature + +> **visitFunctionBody**(`node`, `visitor`, `context`): `undefined` \| [`Block`](../interfaces/Block.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5503 + +Resumes a suspended lexical environment and visits a function body, ending the lexical +environment and merging hoisted declarations upon completion. + +### Parameters + +#### node + +`undefined` | [`Block`](../interfaces/Block.md) + +#### visitor + +[`Visitor`](../type-aliases/Visitor.md) + +#### context + +[`TransformationContext`](../interfaces/TransformationContext.md) + +### Returns + +`undefined` \| [`Block`](../interfaces/Block.md) + +## Call Signature + +> **visitFunctionBody**(`node`, `visitor`, `context`): [`ConciseBody`](../type-aliases/ConciseBody.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5508 + +Resumes a suspended lexical environment and visits a concise body, ending the lexical +environment and merging hoisted declarations upon completion. + +### Parameters + +#### node + +[`ConciseBody`](../type-aliases/ConciseBody.md) + +#### visitor + +[`Visitor`](../type-aliases/Visitor.md) + +#### context + +[`TransformationContext`](../interfaces/TransformationContext.md) + +### Returns + +[`ConciseBody`](../type-aliases/ConciseBody.md) diff --git a/docs/api_docs/namespaces/ts/functions/visitIterationBody.md b/docs/api_docs/namespaces/ts/functions/visitIterationBody.md new file mode 100644 index 0000000000000000000000000000000000000000..4df86afa2a9298954941ebfa147324fa9db738a8 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/visitIterationBody.md @@ -0,0 +1,31 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / visitIterationBody + +# Function: visitIterationBody() + +> **visitIterationBody**(`body`, `visitor`, `context`): [`Statement`](../interfaces/Statement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5512 + +Visits an iteration body, adding any block-scoped variables required by the transformation. + +## Parameters + +### body + +[`Statement`](../interfaces/Statement.md) + +### visitor + +[`Visitor`](../type-aliases/Visitor.md) + +### context + +[`TransformationContext`](../interfaces/TransformationContext.md) + +## Returns + +[`Statement`](../interfaces/Statement.md) diff --git a/docs/api_docs/namespaces/ts/functions/visitLexicalEnvironment.md b/docs/api_docs/namespaces/ts/functions/visitLexicalEnvironment.md new file mode 100644 index 0000000000000000000000000000000000000000..88a59b5d83289c2077d59f3c38f06293c1a21a14 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/visitLexicalEnvironment.md @@ -0,0 +1,44 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / visitLexicalEnvironment + +# Function: visitLexicalEnvironment() + +> **visitLexicalEnvironment**(`statements`, `visitor`, `context`, `start`?, `ensureUseStrict`?, `nodesVisitor`?): [`NodeArray`](../interfaces/NodeArray.md)\<[`Statement`](../interfaces/Statement.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5487 + +Starts a new lexical environment and visits a statement list, ending the lexical environment +and merging hoisted declarations upon completion. + +## Parameters + +### statements + +[`NodeArray`](../interfaces/NodeArray.md)\<[`Statement`](../interfaces/Statement.md)\> + +### visitor + +[`Visitor`](../type-aliases/Visitor.md) + +### context + +[`TransformationContext`](../interfaces/TransformationContext.md) + +### start? + +`number` + +### ensureUseStrict? + +`boolean` + +### nodesVisitor? + +[`NodesVisitor`](../interfaces/NodesVisitor.md) + +## Returns + +[`NodeArray`](../interfaces/NodeArray.md)\<[`Statement`](../interfaces/Statement.md)\> diff --git a/docs/api_docs/namespaces/ts/functions/visitNode.md b/docs/api_docs/namespaces/ts/functions/visitNode.md new file mode 100644 index 0000000000000000000000000000000000000000..f7b550bf8cd02ef89283a2caa8fae9cb2235e1a9 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/visitNode.md @@ -0,0 +1,91 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / visitNode + +# Function: visitNode() + +## Call Signature + +> **visitNode**\<`T`\>(`node`, `visitor`, `test`?, `lift`?): `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5453 + +Visits a Node using the supplied visitor, possibly returning a new Node in its place. + +### Type Parameters + +• **T** *extends* [`Node`](../interfaces/Node.md) + +### Parameters + +#### node + +`T` + +The Node to visit. + +#### visitor + +The callback used to visit the Node. + +`undefined` | [`Visitor`](../type-aliases/Visitor.md) + +#### test? + +(`node`) => `boolean` + +A callback to execute to verify the Node is valid. + +#### lift? + +(`node`) => `T` + +An optional callback to execute to lift a NodeArray into a valid Node. + +### Returns + +`T` + +## Call Signature + +> **visitNode**\<`T`\>(`node`, `visitor`, `test`?, `lift`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5462 + +Visits a Node using the supplied visitor, possibly returning a new Node in its place. + +### Type Parameters + +• **T** *extends* [`Node`](../interfaces/Node.md) + +### Parameters + +#### node + +The Node to visit. + +`undefined` | `T` + +#### visitor + +The callback used to visit the Node. + +`undefined` | [`Visitor`](../type-aliases/Visitor.md) + +#### test? + +(`node`) => `boolean` + +A callback to execute to verify the Node is valid. + +#### lift? + +(`node`) => `T` + +An optional callback to execute to lift a NodeArray into a valid Node. + +### Returns + +`undefined` \| `T` diff --git a/docs/api_docs/namespaces/ts/functions/visitNodes.md b/docs/api_docs/namespaces/ts/functions/visitNodes.md new file mode 100644 index 0000000000000000000000000000000000000000..41e0f17554ddafe5f95814a98de4f5e2c5535c1a --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/visitNodes.md @@ -0,0 +1,103 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / visitNodes + +# Function: visitNodes() + +## Call Signature + +> **visitNodes**\<`T`\>(`nodes`, `visitor`, `test`?, `start`?, `count`?): [`NodeArray`](../interfaces/NodeArray.md)\<`T`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5472 + +Visits a NodeArray using the supplied visitor, possibly returning a new NodeArray in its place. + +### Type Parameters + +• **T** *extends* [`Node`](../interfaces/Node.md) + +### Parameters + +#### nodes + +[`NodeArray`](../interfaces/NodeArray.md)\<`T`\> + +The NodeArray to visit. + +#### visitor + +The callback used to visit a Node. + +`undefined` | [`Visitor`](../type-aliases/Visitor.md) + +#### test? + +(`node`) => `boolean` + +A node test to execute for each node. + +#### start? + +`number` + +An optional value indicating the starting offset at which to start visiting. + +#### count? + +`number` + +An optional value indicating the maximum number of nodes to visit. + +### Returns + +[`NodeArray`](../interfaces/NodeArray.md)\<`T`\> + +## Call Signature + +> **visitNodes**\<`T`\>(`nodes`, `visitor`, `test`?, `start`?, `count`?): `undefined` \| [`NodeArray`](../interfaces/NodeArray.md)\<`T`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5482 + +Visits a NodeArray using the supplied visitor, possibly returning a new NodeArray in its place. + +### Type Parameters + +• **T** *extends* [`Node`](../interfaces/Node.md) + +### Parameters + +#### nodes + +The NodeArray to visit. + +`undefined` | [`NodeArray`](../interfaces/NodeArray.md)\<`T`\> + +#### visitor + +The callback used to visit a Node. + +`undefined` | [`Visitor`](../type-aliases/Visitor.md) + +#### test? + +(`node`) => `boolean` + +A node test to execute for each node. + +#### start? + +`number` + +An optional value indicating the starting offset at which to start visiting. + +#### count? + +`number` + +An optional value indicating the maximum number of nodes to visit. + +### Returns + +`undefined` \| [`NodeArray`](../interfaces/NodeArray.md)\<`T`\> diff --git a/docs/api_docs/namespaces/ts/functions/visitParameterList.md b/docs/api_docs/namespaces/ts/functions/visitParameterList.md new file mode 100644 index 0000000000000000000000000000000000000000..fe310604fbb1931de00d24e7739c09d2ecff5846 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/visitParameterList.md @@ -0,0 +1,69 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / visitParameterList + +# Function: visitParameterList() + +## Call Signature + +> **visitParameterList**(`nodes`, `visitor`, `context`, `nodesVisitor`?): [`NodeArray`](../interfaces/NodeArray.md)\<[`ParameterDeclaration`](../interfaces/ParameterDeclaration.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5492 + +Starts a new lexical environment and visits a parameter list, suspending the lexical +environment upon completion. + +### Parameters + +#### nodes + +[`NodeArray`](../interfaces/NodeArray.md)\<[`ParameterDeclaration`](../interfaces/ParameterDeclaration.md)\> + +#### visitor + +[`Visitor`](../type-aliases/Visitor.md) + +#### context + +[`TransformationContext`](../interfaces/TransformationContext.md) + +#### nodesVisitor? + +[`NodesVisitor`](../interfaces/NodesVisitor.md) + +### Returns + +[`NodeArray`](../interfaces/NodeArray.md)\<[`ParameterDeclaration`](../interfaces/ParameterDeclaration.md)\> + +## Call Signature + +> **visitParameterList**(`nodes`, `visitor`, `context`, `nodesVisitor`?): `undefined` \| [`NodeArray`](../interfaces/NodeArray.md)\<[`ParameterDeclaration`](../interfaces/ParameterDeclaration.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5493 + +Starts a new lexical environment and visits a parameter list, suspending the lexical +environment upon completion. + +### Parameters + +#### nodes + +`undefined` | [`NodeArray`](../interfaces/NodeArray.md)\<[`ParameterDeclaration`](../interfaces/ParameterDeclaration.md)\> + +#### visitor + +[`Visitor`](../type-aliases/Visitor.md) + +#### context + +[`TransformationContext`](../interfaces/TransformationContext.md) + +#### nodesVisitor? + +[`NodesVisitor`](../interfaces/NodesVisitor.md) + +### Returns + +`undefined` \| [`NodeArray`](../interfaces/NodeArray.md)\<[`ParameterDeclaration`](../interfaces/ParameterDeclaration.md)\> diff --git a/docs/api_docs/namespaces/ts/functions/walkUpBindingElementsAndPatterns.md b/docs/api_docs/namespaces/ts/functions/walkUpBindingElementsAndPatterns.md new file mode 100644 index 0000000000000000000000000000000000000000..47300019ea12fe2cc2bfa636306fd3033b128a97 --- /dev/null +++ b/docs/api_docs/namespaces/ts/functions/walkUpBindingElementsAndPatterns.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / walkUpBindingElementsAndPatterns + +# Function: walkUpBindingElementsAndPatterns() + +> **walkUpBindingElementsAndPatterns**(`binding`): [`ParameterDeclaration`](../interfaces/ParameterDeclaration.md) \| [`VariableDeclaration`](../interfaces/VariableDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4674 + +## Parameters + +### binding + +[`BindingElement`](../interfaces/BindingElement.md) + +## Returns + +[`ParameterDeclaration`](../interfaces/ParameterDeclaration.md) \| [`VariableDeclaration`](../interfaces/VariableDeclaration.md) diff --git a/docs/api_docs/namespaces/ts/interfaces/AmdDependency.md b/docs/api_docs/namespaces/ts/interfaces/AmdDependency.md new file mode 100644 index 0000000000000000000000000000000000000000..0cb4957e8398771780d640de8a942476d090d796 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/AmdDependency.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / AmdDependency + +# Interface: AmdDependency + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2105 + +## Properties + +### name? + +> `optional` **name**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2107 + +*** + +### path + +> **path**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2106 diff --git a/docs/api_docs/namespaces/ts/interfaces/ApplicableRefactorInfo.md b/docs/api_docs/namespaces/ts/interfaces/ApplicableRefactorInfo.md new file mode 100644 index 0000000000000000000000000000000000000000..2e22bd71875ed421dd1c457dadf7301f45fe8254 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ApplicableRefactorInfo.md @@ -0,0 +1,54 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ApplicableRefactorInfo + +# Interface: ApplicableRefactorInfo + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6639 + +A set of one or more available refactoring actions, grouped under a parent refactoring. + +## Properties + +### actions + +> **actions**: [`RefactorActionInfo`](RefactorActionInfo.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6657 + +*** + +### description + +> **description**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6648 + +A description of this refactoring category to show to the user. +If the refactoring gets inlined (see below), this text will not be visible. + +*** + +### inlineable? + +> `optional` **inlineable**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6656 + +Inlineable refactorings can have their actions hoisted out to the top level +of a context menu. Non-inlineanable refactorings should always be shown inside +their parent grouping. + +If not specified, this value is assumed to be 'true' + +*** + +### name + +> **name**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6643 + +The programmatic name of the refactoring diff --git a/docs/api_docs/namespaces/ts/interfaces/ApplyCodeActionCommandResult.md b/docs/api_docs/namespaces/ts/interfaces/ApplyCodeActionCommandResult.md new file mode 100644 index 0000000000000000000000000000000000000000..bff5d3e29de1113bf7af1130ae9c93fd77896d1d --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ApplyCodeActionCommandResult.md @@ -0,0 +1,17 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ApplyCodeActionCommandResult + +# Interface: ApplyCodeActionCommandResult + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6511 + +## Properties + +### successMessage + +> **successMessage**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6512 diff --git a/docs/api_docs/namespaces/ts/interfaces/ArrayBindingPattern.md b/docs/api_docs/namespaces/ts/interfaces/ArrayBindingPattern.md new file mode 100644 index 0000000000000000000000000000000000000000..ce83eb4c7cee337729523311b3a8d90588b46117 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ArrayBindingPattern.md @@ -0,0 +1,485 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ArrayBindingPattern + +# Interface: ArrayBindingPattern + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:830 + +## Extends + +- [`Node`](Node.md) + +## Properties + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`decorators`](Node.md#decorators) + +*** + +### elements + +> `readonly` **elements**: [`NodeArray`](NodeArray.md)\<[`ArrayBindingElement`](../type-aliases/ArrayBindingElement.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:833 + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Node`](Node.md).[`end`](Node.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Node`](Node.md).[`flags`](Node.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`ArrayBindingPattern`](../enumerations/SyntaxKind.md#arraybindingpattern) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:831 + +#### Overrides + +[`Node`](Node.md).[`kind`](Node.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Node`](Node.md).[`locals`](Node.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`modifiers`](Node.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`ParameterDeclaration`](ParameterDeclaration.md) \| [`VariableDeclaration`](VariableDeclaration.md) \| [`BindingElement`](BindingElement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:832 + +#### Overrides + +[`Node`](Node.md).[`parent`](Node.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Node`](Node.md).[`pos`](Node.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Node`](Node.md).[`skipCheck`](Node.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Node`](Node.md).[`symbol`](Node.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Node`](Node.md).[`forEachChild`](Node.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getChildAt`](Node.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getChildCount`](Node.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Node`](Node.md).[`getChildren`](Node.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getEnd`](Node.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getFirstToken`](Node.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullStart`](Node.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getFullText`](Node.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullWidth`](Node.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getLastToken`](Node.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getLeadingTriviaWidth`](Node.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Node`](Node.md).[`getSourceFile`](Node.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getStart`](Node.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getText`](Node.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getWidth`](Node.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/ArrayDestructuringAssignment.md b/docs/api_docs/namespaces/ts/interfaces/ArrayDestructuringAssignment.md new file mode 100644 index 0000000000000000000000000000000000000000..a7d3f6b5a5fc469db6b270f3724860cbe654f84f --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ArrayDestructuringAssignment.md @@ -0,0 +1,537 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ArrayDestructuringAssignment + +# Interface: ArrayDestructuringAssignment + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1175 + +## Extends + +- [`AssignmentExpression`](AssignmentExpression.md)\<[`EqualsToken`](../type-aliases/EqualsToken.md)\> + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`AssignmentExpression`](AssignmentExpression.md).[`_declarationBrand`](AssignmentExpression.md#_declarationbrand) + +*** + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`AssignmentExpression`](AssignmentExpression.md).[`_expressionBrand`](AssignmentExpression.md#_expressionbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`AssignmentExpression`](AssignmentExpression.md).[`decorators`](AssignmentExpression.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`AssignmentExpression`](AssignmentExpression.md).[`end`](AssignmentExpression.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`AssignmentExpression`](AssignmentExpression.md).[`flags`](AssignmentExpression.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`BinaryExpression`](../enumerations/SyntaxKind.md#binaryexpression) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1162 + +#### Inherited from + +[`AssignmentExpression`](AssignmentExpression.md).[`kind`](AssignmentExpression.md#kind) + +*** + +### left + +> `readonly` **left**: [`ArrayLiteralExpression`](ArrayLiteralExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1176 + +#### Overrides + +[`AssignmentExpression`](AssignmentExpression.md).[`left`](AssignmentExpression.md#left) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`AssignmentExpression`](AssignmentExpression.md).[`locals`](AssignmentExpression.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`AssignmentExpression`](AssignmentExpression.md).[`modifiers`](AssignmentExpression.md#modifiers) + +*** + +### operatorToken + +> `readonly` **operatorToken**: [`EqualsToken`](../type-aliases/EqualsToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1170 + +#### Inherited from + +[`AssignmentExpression`](AssignmentExpression.md).[`operatorToken`](AssignmentExpression.md#operatortoken) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`AssignmentExpression`](AssignmentExpression.md).[`parent`](AssignmentExpression.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`AssignmentExpression`](AssignmentExpression.md).[`pos`](AssignmentExpression.md#pos) + +*** + +### right + +> `readonly` **right**: [`Expression`](Expression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1165 + +#### Inherited from + +[`AssignmentExpression`](AssignmentExpression.md).[`right`](AssignmentExpression.md#right) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`AssignmentExpression`](AssignmentExpression.md).[`skipCheck`](AssignmentExpression.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`AssignmentExpression`](AssignmentExpression.md).[`symbol`](AssignmentExpression.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`AssignmentExpression`](AssignmentExpression.md).[`forEachChild`](AssignmentExpression.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`AssignmentExpression`](AssignmentExpression.md).[`getChildAt`](AssignmentExpression.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`AssignmentExpression`](AssignmentExpression.md).[`getChildCount`](AssignmentExpression.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`AssignmentExpression`](AssignmentExpression.md).[`getChildren`](AssignmentExpression.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`AssignmentExpression`](AssignmentExpression.md).[`getEnd`](AssignmentExpression.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`AssignmentExpression`](AssignmentExpression.md).[`getFirstToken`](AssignmentExpression.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`AssignmentExpression`](AssignmentExpression.md).[`getFullStart`](AssignmentExpression.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`AssignmentExpression`](AssignmentExpression.md).[`getFullText`](AssignmentExpression.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`AssignmentExpression`](AssignmentExpression.md).[`getFullWidth`](AssignmentExpression.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`AssignmentExpression`](AssignmentExpression.md).[`getLastToken`](AssignmentExpression.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`AssignmentExpression`](AssignmentExpression.md).[`getLeadingTriviaWidth`](AssignmentExpression.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`AssignmentExpression`](AssignmentExpression.md).[`getSourceFile`](AssignmentExpression.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`AssignmentExpression`](AssignmentExpression.md).[`getStart`](AssignmentExpression.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`AssignmentExpression`](AssignmentExpression.md).[`getText`](AssignmentExpression.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`AssignmentExpression`](AssignmentExpression.md).[`getWidth`](AssignmentExpression.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/ArrayLiteralExpression.md b/docs/api_docs/namespaces/ts/interfaces/ArrayLiteralExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..7805aa17408d71106a61fdc16d923035ffd50119 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ArrayLiteralExpression.md @@ -0,0 +1,557 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ArrayLiteralExpression + +# Interface: ArrayLiteralExpression + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1280 + +## Extends + +- [`PrimaryExpression`](PrimaryExpression.md) + +## Properties + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_expressionBrand`](PrimaryExpression.md#_expressionbrand) + +*** + +### \_leftHandSideExpressionBrand + +> **\_leftHandSideExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1086 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_leftHandSideExpressionBrand`](PrimaryExpression.md#_lefthandsideexpressionbrand) + +*** + +### \_memberExpressionBrand + +> **\_memberExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1089 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_memberExpressionBrand`](PrimaryExpression.md#_memberexpressionbrand) + +*** + +### \_primaryExpressionBrand + +> **\_primaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1092 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_primaryExpressionBrand`](PrimaryExpression.md#_primaryexpressionbrand) + +*** + +### \_unaryExpressionBrand + +> **\_unaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1066 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_unaryExpressionBrand`](PrimaryExpression.md#_unaryexpressionbrand) + +*** + +### \_updateExpressionBrand + +> **\_updateExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1071 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_updateExpressionBrand`](PrimaryExpression.md#_updateexpressionbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`decorators`](PrimaryExpression.md#decorators) + +*** + +### elements + +> `readonly` **elements**: [`NodeArray`](NodeArray.md)\<[`Expression`](Expression.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1282 + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`end`](PrimaryExpression.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`flags`](PrimaryExpression.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`ArrayLiteralExpression`](../enumerations/SyntaxKind.md#arrayliteralexpression) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1281 + +#### Overrides + +[`PrimaryExpression`](PrimaryExpression.md).[`kind`](PrimaryExpression.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`locals`](PrimaryExpression.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`modifiers`](PrimaryExpression.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`parent`](PrimaryExpression.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`pos`](PrimaryExpression.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`skipCheck`](PrimaryExpression.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`symbol`](PrimaryExpression.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`forEachChild`](PrimaryExpression.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getChildAt`](PrimaryExpression.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getChildCount`](PrimaryExpression.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getChildren`](PrimaryExpression.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getEnd`](PrimaryExpression.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFirstToken`](PrimaryExpression.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFullStart`](PrimaryExpression.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFullText`](PrimaryExpression.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFullWidth`](PrimaryExpression.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getLastToken`](PrimaryExpression.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getLeadingTriviaWidth`](PrimaryExpression.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getSourceFile`](PrimaryExpression.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getStart`](PrimaryExpression.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getText`](PrimaryExpression.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getWidth`](PrimaryExpression.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/ArrayTypeNode.md b/docs/api_docs/namespaces/ts/interfaces/ArrayTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..6ee0c74791ad3e93caa25a94ec9a6675464655ab --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ArrayTypeNode.md @@ -0,0 +1,497 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ArrayTypeNode + +# Interface: ArrayTypeNode + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:968 + +## Extends + +- [`TypeNode`](TypeNode.md) + +## Properties + +### \_typeNodeBrand + +> **\_typeNodeBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:912 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`_typeNodeBrand`](TypeNode.md#_typenodebrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`decorators`](TypeNode.md#decorators) + +*** + +### elementType + +> `readonly` **elementType**: [`TypeNode`](TypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:970 + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`end`](TypeNode.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`flags`](TypeNode.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`ArrayType`](../enumerations/SyntaxKind.md#arraytype) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:969 + +#### Overrides + +[`TypeNode`](TypeNode.md).[`kind`](TypeNode.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`locals`](TypeNode.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`modifiers`](TypeNode.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`parent`](TypeNode.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`pos`](TypeNode.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`skipCheck`](TypeNode.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`symbol`](TypeNode.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`forEachChild`](TypeNode.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getChildAt`](TypeNode.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getChildCount`](TypeNode.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getChildren`](TypeNode.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getEnd`](TypeNode.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFirstToken`](TypeNode.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFullStart`](TypeNode.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFullText`](TypeNode.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFullWidth`](TypeNode.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getLastToken`](TypeNode.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getLeadingTriviaWidth`](TypeNode.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getSourceFile`](TypeNode.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getStart`](TypeNode.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getText`](TypeNode.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getWidth`](TypeNode.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/ArrowFunction.md b/docs/api_docs/namespaces/ts/interfaces/ArrowFunction.md new file mode 100644 index 0000000000000000000000000000000000000000..417a9e09e4a6c6323aac60c77274e8b2ae0f62c6 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ArrowFunction.md @@ -0,0 +1,624 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ArrowFunction + +# Interface: ArrowFunction + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1211 + +Several node kinds share function-like features such as a signature, +a name, and a body. These nodes should extend FunctionLikeDeclarationBase. +Examples: +- FunctionDeclaration +- MethodDeclaration +- AccessorDeclaration + +## Extends + +- [`Expression`](Expression.md).[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`JSDocContainer`](JSDocContainer.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`_declarationBrand`](FunctionLikeDeclarationBase.md#_declarationbrand) + +*** + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`Expression`](Expression.md).[`_expressionBrand`](Expression.md#_expressionbrand) + +*** + +### \_functionLikeDeclarationBrand + +> **\_functionLikeDeclarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:846 + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`_functionLikeDeclarationBrand`](FunctionLikeDeclarationBase.md#_functionlikedeclarationbrand) + +*** + +### asteriskToken? + +> `readonly` `optional` **asteriskToken**: [`AsteriskToken`](../type-aliases/AsteriskToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:847 + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`asteriskToken`](FunctionLikeDeclarationBase.md#asterisktoken) + +*** + +### body + +> `readonly` **body**: [`ConciseBody`](../type-aliases/ConciseBody.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1215 + +#### Overrides + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`body`](FunctionLikeDeclarationBase.md#body) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`decorators`](FunctionLikeDeclarationBase.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`end`](FunctionLikeDeclarationBase.md#end) + +*** + +### equalsGreaterThanToken + +> `readonly` **equalsGreaterThanToken**: [`EqualsGreaterThanToken`](../type-aliases/EqualsGreaterThanToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1214 + +*** + +### exclamationToken? + +> `readonly` `optional` **exclamationToken**: [`ExclamationToken`](../type-aliases/ExclamationToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:849 + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`exclamationToken`](FunctionLikeDeclarationBase.md#exclamationtoken) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`flags`](FunctionLikeDeclarationBase.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`ArrowFunction`](../enumerations/SyntaxKind.md#arrowfunction) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1212 + +#### Overrides + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`kind`](FunctionLikeDeclarationBase.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`locals`](FunctionLikeDeclarationBase.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`Modifier`](../type-aliases/Modifier.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1213 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Overrides + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`modifiers`](FunctionLikeDeclarationBase.md#modifiers) + +*** + +### name + +> `readonly` **name**: `never` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1216 + +#### Overrides + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`name`](FunctionLikeDeclarationBase.md#name) + +*** + +### parameters + +> `readonly` **parameters**: [`NodeArray`](NodeArray.md)\<[`ParameterDeclaration`](ParameterDeclaration.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:735 + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`parameters`](FunctionLikeDeclarationBase.md#parameters) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`parent`](FunctionLikeDeclarationBase.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`pos`](FunctionLikeDeclarationBase.md#pos) + +*** + +### questionToken? + +> `readonly` `optional` **questionToken**: [`QuestionToken`](../type-aliases/QuestionToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:848 + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`questionToken`](FunctionLikeDeclarationBase.md#questiontoken) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`skipCheck`](FunctionLikeDeclarationBase.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`symbol`](FunctionLikeDeclarationBase.md#symbol) + +*** + +### type? + +> `readonly` `optional` **type**: [`TypeNode`](TypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:736 + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`type`](FunctionLikeDeclarationBase.md#type) + +*** + +### typeParameters? + +> `readonly` `optional` **typeParameters**: [`NodeArray`](NodeArray.md)\<[`TypeParameterDeclaration`](TypeParameterDeclaration.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:734 + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`typeParameters`](FunctionLikeDeclarationBase.md#typeparameters) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`forEachChild`](FunctionLikeDeclarationBase.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`getChildAt`](FunctionLikeDeclarationBase.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`getChildCount`](FunctionLikeDeclarationBase.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`getChildren`](FunctionLikeDeclarationBase.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`getEnd`](FunctionLikeDeclarationBase.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`getFirstToken`](FunctionLikeDeclarationBase.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`getFullStart`](FunctionLikeDeclarationBase.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`getFullText`](FunctionLikeDeclarationBase.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`getFullWidth`](FunctionLikeDeclarationBase.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`getLastToken`](FunctionLikeDeclarationBase.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`getLeadingTriviaWidth`](FunctionLikeDeclarationBase.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`getSourceFile`](FunctionLikeDeclarationBase.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`getStart`](FunctionLikeDeclarationBase.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`getText`](FunctionLikeDeclarationBase.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`getWidth`](FunctionLikeDeclarationBase.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/AsExpression.md b/docs/api_docs/namespaces/ts/interfaces/AsExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..46be3cf207c277f24dd8f3d37d10a6e0e751aae1 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/AsExpression.md @@ -0,0 +1,505 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / AsExpression + +# Interface: AsExpression + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1370 + +## Extends + +- [`Expression`](Expression.md) + +## Properties + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`Expression`](Expression.md).[`_expressionBrand`](Expression.md#_expressionbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Expression`](Expression.md).[`decorators`](Expression.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Expression`](Expression.md).[`end`](Expression.md#end) + +*** + +### expression + +> `readonly` **expression**: [`Expression`](Expression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1372 + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Expression`](Expression.md).[`flags`](Expression.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`AsExpression`](../enumerations/SyntaxKind.md#asexpression) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1371 + +#### Overrides + +[`Expression`](Expression.md).[`kind`](Expression.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Expression`](Expression.md).[`locals`](Expression.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Expression`](Expression.md).[`modifiers`](Expression.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`Expression`](Expression.md).[`parent`](Expression.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Expression`](Expression.md).[`pos`](Expression.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Expression`](Expression.md).[`skipCheck`](Expression.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Expression`](Expression.md).[`symbol`](Expression.md#symbol) + +*** + +### type + +> `readonly` **type**: [`TypeNode`](TypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1373 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Expression`](Expression.md).[`forEachChild`](Expression.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Expression`](Expression.md).[`getChildAt`](Expression.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getChildCount`](Expression.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Expression`](Expression.md).[`getChildren`](Expression.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getEnd`](Expression.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Expression`](Expression.md).[`getFirstToken`](Expression.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getFullStart`](Expression.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Expression`](Expression.md).[`getFullText`](Expression.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getFullWidth`](Expression.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Expression`](Expression.md).[`getLastToken`](Expression.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getLeadingTriviaWidth`](Expression.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Expression`](Expression.md).[`getSourceFile`](Expression.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getStart`](Expression.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Expression`](Expression.md).[`getText`](Expression.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getWidth`](Expression.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/AssertClause.md b/docs/api_docs/namespaces/ts/interfaces/AssertClause.md new file mode 100644 index 0000000000000000000000000000000000000000..754477691a445ff4691fbc2e2f40a1f7eed07440 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/AssertClause.md @@ -0,0 +1,493 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / AssertClause + +# Interface: AssertClause + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1743 + +## Extends + +- [`Node`](Node.md) + +## Properties + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`decorators`](Node.md#decorators) + +*** + +### elements + +> `readonly` **elements**: [`NodeArray`](NodeArray.md)\<[`AssertEntry`](AssertEntry.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1746 + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Node`](Node.md).[`end`](Node.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Node`](Node.md).[`flags`](Node.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`AssertClause`](../enumerations/SyntaxKind.md#assertclause) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1744 + +#### Overrides + +[`Node`](Node.md).[`kind`](Node.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Node`](Node.md).[`locals`](Node.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`modifiers`](Node.md#modifiers) + +*** + +### multiLine? + +> `readonly` `optional` **multiLine**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1747 + +*** + +### parent + +> `readonly` **parent**: [`ImportDeclaration`](ImportDeclaration.md) \| [`ExportDeclaration`](ExportDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1745 + +#### Overrides + +[`Node`](Node.md).[`parent`](Node.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Node`](Node.md).[`pos`](Node.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Node`](Node.md).[`skipCheck`](Node.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Node`](Node.md).[`symbol`](Node.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Node`](Node.md).[`forEachChild`](Node.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getChildAt`](Node.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getChildCount`](Node.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Node`](Node.md).[`getChildren`](Node.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getEnd`](Node.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getFirstToken`](Node.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullStart`](Node.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getFullText`](Node.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullWidth`](Node.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getLastToken`](Node.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getLeadingTriviaWidth`](Node.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Node`](Node.md).[`getSourceFile`](Node.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getStart`](Node.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getText`](Node.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getWidth`](Node.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/AssertEntry.md b/docs/api_docs/namespaces/ts/interfaces/AssertEntry.md new file mode 100644 index 0000000000000000000000000000000000000000..9d8ed453842eb071a16f0f1df66e4b388cde572a --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/AssertEntry.md @@ -0,0 +1,493 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / AssertEntry + +# Interface: AssertEntry + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1737 + +## Extends + +- [`Node`](Node.md) + +## Properties + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`decorators`](Node.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Node`](Node.md).[`end`](Node.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Node`](Node.md).[`flags`](Node.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`AssertEntry`](../enumerations/SyntaxKind.md#assertentry) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1738 + +#### Overrides + +[`Node`](Node.md).[`kind`](Node.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Node`](Node.md).[`locals`](Node.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`modifiers`](Node.md#modifiers) + +*** + +### name + +> `readonly` **name**: [`AssertionKey`](../type-aliases/AssertionKey.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1740 + +*** + +### parent + +> `readonly` **parent**: [`AssertClause`](AssertClause.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1739 + +#### Overrides + +[`Node`](Node.md).[`parent`](Node.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Node`](Node.md).[`pos`](Node.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Node`](Node.md).[`skipCheck`](Node.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Node`](Node.md).[`symbol`](Node.md#symbol) + +*** + +### value + +> `readonly` **value**: [`Expression`](Expression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1741 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Node`](Node.md).[`forEachChild`](Node.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getChildAt`](Node.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getChildCount`](Node.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Node`](Node.md).[`getChildren`](Node.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getEnd`](Node.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getFirstToken`](Node.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullStart`](Node.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getFullText`](Node.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullWidth`](Node.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getLastToken`](Node.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getLeadingTriviaWidth`](Node.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Node`](Node.md).[`getSourceFile`](Node.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getStart`](Node.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getText`](Node.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getWidth`](Node.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/AssertsIdentifierTypePredicate.md b/docs/api_docs/namespaces/ts/interfaces/AssertsIdentifierTypePredicate.md new file mode 100644 index 0000000000000000000000000000000000000000..50fcecfb62cba5f0e178edde97e4bb34ed73f78c --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/AssertsIdentifierTypePredicate.md @@ -0,0 +1,53 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / AssertsIdentifierTypePredicate + +# Interface: AssertsIdentifierTypePredicate + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2599 + +## Extends + +- [`TypePredicateBase`](TypePredicateBase.md) + +## Properties + +### kind + +> **kind**: [`AssertsIdentifier`](../enumerations/TypePredicateKind.md#assertsidentifier) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2600 + +#### Overrides + +[`TypePredicateBase`](TypePredicateBase.md).[`kind`](TypePredicateBase.md#kind) + +*** + +### parameterIndex + +> **parameterIndex**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2602 + +*** + +### parameterName + +> **parameterName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2601 + +*** + +### type + +> **type**: `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2603 + +#### Overrides + +[`TypePredicateBase`](TypePredicateBase.md).[`type`](TypePredicateBase.md#type) diff --git a/docs/api_docs/namespaces/ts/interfaces/AssertsThisTypePredicate.md b/docs/api_docs/namespaces/ts/interfaces/AssertsThisTypePredicate.md new file mode 100644 index 0000000000000000000000000000000000000000..4612fa2df64ae29a0a373af3c5bd9052b91bf3a8 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/AssertsThisTypePredicate.md @@ -0,0 +1,53 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / AssertsThisTypePredicate + +# Interface: AssertsThisTypePredicate + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2593 + +## Extends + +- [`TypePredicateBase`](TypePredicateBase.md) + +## Properties + +### kind + +> **kind**: [`AssertsThis`](../enumerations/TypePredicateKind.md#assertsthis) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2594 + +#### Overrides + +[`TypePredicateBase`](TypePredicateBase.md).[`kind`](TypePredicateBase.md#kind) + +*** + +### parameterIndex + +> **parameterIndex**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2596 + +*** + +### parameterName + +> **parameterName**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2595 + +*** + +### type + +> **type**: `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2597 + +#### Overrides + +[`TypePredicateBase`](TypePredicateBase.md).[`type`](TypePredicateBase.md#type) diff --git a/docs/api_docs/namespaces/ts/interfaces/AssignmentExpression.md b/docs/api_docs/namespaces/ts/interfaces/AssignmentExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..2d6e6ce7d22e3a8007d9d7b1cb6a5aeb10599be8 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/AssignmentExpression.md @@ -0,0 +1,546 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / AssignmentExpression + +# Interface: AssignmentExpression\ + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1168 + +## Extends + +- [`BinaryExpression`](BinaryExpression.md) + +## Extended by + +- [`ObjectDestructuringAssignment`](ObjectDestructuringAssignment.md) +- [`ArrayDestructuringAssignment`](ArrayDestructuringAssignment.md) + +## Type Parameters + +• **TOperator** *extends* [`AssignmentOperatorToken`](../type-aliases/AssignmentOperatorToken.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`BinaryExpression`](BinaryExpression.md).[`_declarationBrand`](BinaryExpression.md#_declarationbrand) + +*** + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`BinaryExpression`](BinaryExpression.md).[`_expressionBrand`](BinaryExpression.md#_expressionbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`BinaryExpression`](BinaryExpression.md).[`decorators`](BinaryExpression.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`BinaryExpression`](BinaryExpression.md).[`end`](BinaryExpression.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`BinaryExpression`](BinaryExpression.md).[`flags`](BinaryExpression.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`BinaryExpression`](../enumerations/SyntaxKind.md#binaryexpression) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1162 + +#### Inherited from + +[`BinaryExpression`](BinaryExpression.md).[`kind`](BinaryExpression.md#kind) + +*** + +### left + +> `readonly` **left**: [`LeftHandSideExpression`](LeftHandSideExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1169 + +#### Overrides + +[`BinaryExpression`](BinaryExpression.md).[`left`](BinaryExpression.md#left) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`BinaryExpression`](BinaryExpression.md).[`locals`](BinaryExpression.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`BinaryExpression`](BinaryExpression.md).[`modifiers`](BinaryExpression.md#modifiers) + +*** + +### operatorToken + +> `readonly` **operatorToken**: `TOperator` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1170 + +#### Overrides + +[`BinaryExpression`](BinaryExpression.md).[`operatorToken`](BinaryExpression.md#operatortoken) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`BinaryExpression`](BinaryExpression.md).[`parent`](BinaryExpression.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`BinaryExpression`](BinaryExpression.md).[`pos`](BinaryExpression.md#pos) + +*** + +### right + +> `readonly` **right**: [`Expression`](Expression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1165 + +#### Inherited from + +[`BinaryExpression`](BinaryExpression.md).[`right`](BinaryExpression.md#right) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`BinaryExpression`](BinaryExpression.md).[`skipCheck`](BinaryExpression.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`BinaryExpression`](BinaryExpression.md).[`symbol`](BinaryExpression.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`BinaryExpression`](BinaryExpression.md).[`forEachChild`](BinaryExpression.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`BinaryExpression`](BinaryExpression.md).[`getChildAt`](BinaryExpression.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`BinaryExpression`](BinaryExpression.md).[`getChildCount`](BinaryExpression.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`BinaryExpression`](BinaryExpression.md).[`getChildren`](BinaryExpression.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`BinaryExpression`](BinaryExpression.md).[`getEnd`](BinaryExpression.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`BinaryExpression`](BinaryExpression.md).[`getFirstToken`](BinaryExpression.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`BinaryExpression`](BinaryExpression.md).[`getFullStart`](BinaryExpression.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`BinaryExpression`](BinaryExpression.md).[`getFullText`](BinaryExpression.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`BinaryExpression`](BinaryExpression.md).[`getFullWidth`](BinaryExpression.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`BinaryExpression`](BinaryExpression.md).[`getLastToken`](BinaryExpression.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`BinaryExpression`](BinaryExpression.md).[`getLeadingTriviaWidth`](BinaryExpression.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`BinaryExpression`](BinaryExpression.md).[`getSourceFile`](BinaryExpression.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`BinaryExpression`](BinaryExpression.md).[`getStart`](BinaryExpression.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`BinaryExpression`](BinaryExpression.md).[`getText`](BinaryExpression.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`BinaryExpression`](BinaryExpression.md).[`getWidth`](BinaryExpression.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/AutoAccessorPropertyDeclaration.md b/docs/api_docs/namespaces/ts/interfaces/AutoAccessorPropertyDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..bf2e2bdb3eb78a62197b0b1aa46496fd4f2a9142 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/AutoAccessorPropertyDeclaration.md @@ -0,0 +1,569 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / AutoAccessorPropertyDeclaration + +# Interface: AutoAccessorPropertyDeclaration + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:794 + +## Extends + +- [`PropertyDeclaration`](PropertyDeclaration.md) + +## Properties + +### \_autoAccessorBrand + +> **\_autoAccessorBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:795 + +*** + +### \_classElementBrand + +> **\_classElementBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1633 + +#### Inherited from + +[`PropertyDeclaration`](PropertyDeclaration.md).[`_classElementBrand`](PropertyDeclaration.md#_classelementbrand) + +*** + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`PropertyDeclaration`](PropertyDeclaration.md).[`_declarationBrand`](PropertyDeclaration.md#_declarationbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`PropertyDeclaration`](PropertyDeclaration.md).[`decorators`](PropertyDeclaration.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`PropertyDeclaration`](PropertyDeclaration.md).[`end`](PropertyDeclaration.md#end) + +*** + +### exclamationToken? + +> `readonly` `optional` **exclamationToken**: [`ExclamationToken`](../type-aliases/ExclamationToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:790 + +#### Inherited from + +[`PropertyDeclaration`](PropertyDeclaration.md).[`exclamationToken`](PropertyDeclaration.md#exclamationtoken) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`PropertyDeclaration`](PropertyDeclaration.md).[`flags`](PropertyDeclaration.md#flags) + +*** + +### initializer? + +> `readonly` `optional` **initializer**: [`Expression`](Expression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:792 + +#### Inherited from + +[`PropertyDeclaration`](PropertyDeclaration.md).[`initializer`](PropertyDeclaration.md#initializer) + +*** + +### kind + +> `readonly` **kind**: [`PropertyDeclaration`](../enumerations/SyntaxKind.md#propertydeclaration) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:785 + +#### Inherited from + +[`PropertyDeclaration`](PropertyDeclaration.md).[`kind`](PropertyDeclaration.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`PropertyDeclaration`](PropertyDeclaration.md).[`locals`](PropertyDeclaration.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:787 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`PropertyDeclaration`](PropertyDeclaration.md).[`modifiers`](PropertyDeclaration.md#modifiers) + +*** + +### name + +> `readonly` **name**: [`PropertyName`](../type-aliases/PropertyName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:788 + +#### Inherited from + +[`PropertyDeclaration`](PropertyDeclaration.md).[`name`](PropertyDeclaration.md#name) + +*** + +### parent + +> `readonly` **parent**: [`ClassLikeDeclaration`](../type-aliases/ClassLikeDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:786 + +#### Inherited from + +[`PropertyDeclaration`](PropertyDeclaration.md).[`parent`](PropertyDeclaration.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`PropertyDeclaration`](PropertyDeclaration.md).[`pos`](PropertyDeclaration.md#pos) + +*** + +### questionToken? + +> `readonly` `optional` **questionToken**: [`QuestionToken`](../type-aliases/QuestionToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:789 + +#### Inherited from + +[`PropertyDeclaration`](PropertyDeclaration.md).[`questionToken`](PropertyDeclaration.md#questiontoken) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`PropertyDeclaration`](PropertyDeclaration.md).[`skipCheck`](PropertyDeclaration.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`PropertyDeclaration`](PropertyDeclaration.md).[`symbol`](PropertyDeclaration.md#symbol) + +*** + +### type? + +> `readonly` `optional` **type**: [`TypeNode`](TypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:791 + +#### Inherited from + +[`PropertyDeclaration`](PropertyDeclaration.md).[`type`](PropertyDeclaration.md#type) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`PropertyDeclaration`](PropertyDeclaration.md).[`forEachChild`](PropertyDeclaration.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`PropertyDeclaration`](PropertyDeclaration.md).[`getChildAt`](PropertyDeclaration.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`PropertyDeclaration`](PropertyDeclaration.md).[`getChildCount`](PropertyDeclaration.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`PropertyDeclaration`](PropertyDeclaration.md).[`getChildren`](PropertyDeclaration.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`PropertyDeclaration`](PropertyDeclaration.md).[`getEnd`](PropertyDeclaration.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`PropertyDeclaration`](PropertyDeclaration.md).[`getFirstToken`](PropertyDeclaration.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`PropertyDeclaration`](PropertyDeclaration.md).[`getFullStart`](PropertyDeclaration.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`PropertyDeclaration`](PropertyDeclaration.md).[`getFullText`](PropertyDeclaration.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`PropertyDeclaration`](PropertyDeclaration.md).[`getFullWidth`](PropertyDeclaration.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`PropertyDeclaration`](PropertyDeclaration.md).[`getLastToken`](PropertyDeclaration.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`PropertyDeclaration`](PropertyDeclaration.md).[`getLeadingTriviaWidth`](PropertyDeclaration.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`PropertyDeclaration`](PropertyDeclaration.md).[`getSourceFile`](PropertyDeclaration.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`PropertyDeclaration`](PropertyDeclaration.md).[`getStart`](PropertyDeclaration.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`PropertyDeclaration`](PropertyDeclaration.md).[`getText`](PropertyDeclaration.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`PropertyDeclaration`](PropertyDeclaration.md).[`getWidth`](PropertyDeclaration.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/AwaitExpression.md b/docs/api_docs/namespaces/ts/interfaces/AwaitExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..b89ac63e94920b5045b244c26165bf59c2003ace --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/AwaitExpression.md @@ -0,0 +1,509 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / AwaitExpression + +# Interface: AwaitExpression + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1125 + +## Extends + +- [`UnaryExpression`](UnaryExpression.md) + +## Properties + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`_expressionBrand`](UnaryExpression.md#_expressionbrand) + +*** + +### \_unaryExpressionBrand + +> **\_unaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1066 + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`_unaryExpressionBrand`](UnaryExpression.md#_unaryexpressionbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`decorators`](UnaryExpression.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`end`](UnaryExpression.md#end) + +*** + +### expression + +> `readonly` **expression**: [`UnaryExpression`](UnaryExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1127 + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`flags`](UnaryExpression.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`AwaitExpression`](../enumerations/SyntaxKind.md#awaitexpression) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1126 + +#### Overrides + +[`UnaryExpression`](UnaryExpression.md).[`kind`](UnaryExpression.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`locals`](UnaryExpression.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`modifiers`](UnaryExpression.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`parent`](UnaryExpression.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`pos`](UnaryExpression.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`skipCheck`](UnaryExpression.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`symbol`](UnaryExpression.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`forEachChild`](UnaryExpression.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getChildAt`](UnaryExpression.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getChildCount`](UnaryExpression.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getChildren`](UnaryExpression.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getEnd`](UnaryExpression.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getFirstToken`](UnaryExpression.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getFullStart`](UnaryExpression.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getFullText`](UnaryExpression.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getFullWidth`](UnaryExpression.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getLastToken`](UnaryExpression.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getLeadingTriviaWidth`](UnaryExpression.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getSourceFile`](UnaryExpression.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getStart`](UnaryExpression.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getText`](UnaryExpression.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getWidth`](UnaryExpression.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/BigIntLiteral.md b/docs/api_docs/namespaces/ts/interfaces/BigIntLiteral.md new file mode 100644 index 0000000000000000000000000000000000000000..8021d16f8cbf853a75f58339fbd39abde8c10422 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/BigIntLiteral.md @@ -0,0 +1,597 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / BigIntLiteral + +# Interface: BigIntLiteral + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1246 + +## Extends + +- [`LiteralExpression`](LiteralExpression.md) + +## Properties + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`_expressionBrand`](LiteralExpression.md#_expressionbrand) + +*** + +### \_leftHandSideExpressionBrand + +> **\_leftHandSideExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1086 + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`_leftHandSideExpressionBrand`](LiteralExpression.md#_lefthandsideexpressionbrand) + +*** + +### \_literalExpressionBrand + +> **\_literalExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1227 + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`_literalExpressionBrand`](LiteralExpression.md#_literalexpressionbrand) + +*** + +### \_memberExpressionBrand + +> **\_memberExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1089 + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`_memberExpressionBrand`](LiteralExpression.md#_memberexpressionbrand) + +*** + +### \_primaryExpressionBrand + +> **\_primaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1092 + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`_primaryExpressionBrand`](LiteralExpression.md#_primaryexpressionbrand) + +*** + +### \_unaryExpressionBrand + +> **\_unaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1066 + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`_unaryExpressionBrand`](LiteralExpression.md#_unaryexpressionbrand) + +*** + +### \_updateExpressionBrand + +> **\_updateExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1071 + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`_updateExpressionBrand`](LiteralExpression.md#_updateexpressionbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`decorators`](LiteralExpression.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`end`](LiteralExpression.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`flags`](LiteralExpression.md#flags) + +*** + +### hasExtendedUnicodeEscape? + +> `optional` **hasExtendedUnicodeEscape**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1221 + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`hasExtendedUnicodeEscape`](LiteralExpression.md#hasextendedunicodeescape) + +*** + +### isUnterminated? + +> `optional` **isUnterminated**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1220 + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`isUnterminated`](LiteralExpression.md#isunterminated) + +*** + +### kind + +> `readonly` **kind**: [`BigIntLiteral`](../enumerations/SyntaxKind.md#bigintliteral) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1247 + +#### Overrides + +[`LiteralExpression`](LiteralExpression.md).[`kind`](LiteralExpression.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`locals`](LiteralExpression.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`modifiers`](LiteralExpression.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`parent`](LiteralExpression.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`pos`](LiteralExpression.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`skipCheck`](LiteralExpression.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`symbol`](LiteralExpression.md#symbol) + +*** + +### text + +> **text**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1219 + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`text`](LiteralExpression.md#text) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`forEachChild`](LiteralExpression.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`getChildAt`](LiteralExpression.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`getChildCount`](LiteralExpression.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`getChildren`](LiteralExpression.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`getEnd`](LiteralExpression.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`getFirstToken`](LiteralExpression.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`getFullStart`](LiteralExpression.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`getFullText`](LiteralExpression.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`getFullWidth`](LiteralExpression.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`getLastToken`](LiteralExpression.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`getLeadingTriviaWidth`](LiteralExpression.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`getSourceFile`](LiteralExpression.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`getStart`](LiteralExpression.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`getText`](LiteralExpression.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`getWidth`](LiteralExpression.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/BigIntLiteralType.md b/docs/api_docs/namespaces/ts/interfaces/BigIntLiteralType.md new file mode 100644 index 0000000000000000000000000000000000000000..add122708f10fc3de436e1db8f52d9a2119432fa --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/BigIntLiteralType.md @@ -0,0 +1,483 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / BigIntLiteralType + +# Interface: BigIntLiteralType + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2791 + +## Extends + +- [`LiteralType`](LiteralType.md) + +## Properties + +### aliasSymbol? + +> `optional` **aliasSymbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2773 + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`aliasSymbol`](LiteralType.md#aliassymbol) + +*** + +### aliasTypeArguments? + +> `optional` **aliasTypeArguments**: readonly [`Type`](Type.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2774 + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`aliasTypeArguments`](LiteralType.md#aliastypearguments) + +*** + +### flags + +> **flags**: [`TypeFlags`](../enumerations/TypeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2770 + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`flags`](LiteralType.md#flags) + +*** + +### freshType + +> **freshType**: [`LiteralType`](LiteralType.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2778 + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`freshType`](LiteralType.md#freshtype) + +*** + +### pattern? + +> `optional` **pattern**: [`DestructuringPattern`](../type-aliases/DestructuringPattern.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2772 + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`pattern`](LiteralType.md#pattern) + +*** + +### regularType + +> **regularType**: [`LiteralType`](LiteralType.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2779 + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`regularType`](LiteralType.md#regulartype) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2771 + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`symbol`](LiteralType.md#symbol) + +*** + +### value + +> **value**: [`PseudoBigInt`](PseudoBigInt.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2792 + +#### Overrides + +[`LiteralType`](LiteralType.md).[`value`](LiteralType.md#value) + +## Methods + +### getApparentProperties() + +> **getApparentProperties**(): [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6124 + +#### Returns + +[`Symbol`](Symbol.md)[] + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`getApparentProperties`](LiteralType.md#getapparentproperties) + +*** + +### getBaseTypes() + +> **getBaseTypes**(): `undefined` \| [`BaseType`](../type-aliases/BaseType.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6129 + +#### Returns + +`undefined` \| [`BaseType`](../type-aliases/BaseType.md)[] + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`getBaseTypes`](LiteralType.md#getbasetypes) + +*** + +### getCallSignatures() + +> **getCallSignatures**(): readonly [`Signature`](Signature.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6125 + +#### Returns + +readonly [`Signature`](Signature.md)[] + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`getCallSignatures`](LiteralType.md#getcallsignatures) + +*** + +### getConstraint() + +> **getConstraint**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6131 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`getConstraint`](LiteralType.md#getconstraint) + +*** + +### getConstructSignatures() + +> **getConstructSignatures**(): readonly [`Signature`](Signature.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6126 + +#### Returns + +readonly [`Signature`](Signature.md)[] + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`getConstructSignatures`](LiteralType.md#getconstructsignatures) + +*** + +### getDefault() + +> **getDefault**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6132 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`getDefault`](LiteralType.md#getdefault) + +*** + +### getFlags() + +> **getFlags**(): [`TypeFlags`](../enumerations/TypeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6120 + +#### Returns + +[`TypeFlags`](../enumerations/TypeFlags.md) + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`getFlags`](LiteralType.md#getflags) + +*** + +### getNonNullableType() + +> **getNonNullableType**(): [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6130 + +#### Returns + +[`Type`](Type.md) + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`getNonNullableType`](LiteralType.md#getnonnullabletype) + +*** + +### getNumberIndexType() + +> **getNumberIndexType**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6128 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`getNumberIndexType`](LiteralType.md#getnumberindextype) + +*** + +### getProperties() + +> **getProperties**(): [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6122 + +#### Returns + +[`Symbol`](Symbol.md)[] + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`getProperties`](LiteralType.md#getproperties) + +*** + +### getProperty() + +> **getProperty**(`propertyName`): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6123 + +#### Parameters + +##### propertyName + +`string` + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`getProperty`](LiteralType.md#getproperty) + +*** + +### getStringIndexType() + +> **getStringIndexType**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6127 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`getStringIndexType`](LiteralType.md#getstringindextype) + +*** + +### getSymbol() + +> **getSymbol**(): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6121 + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`getSymbol`](LiteralType.md#getsymbol) + +*** + +### isClass() + +> **isClass**(): `this is InterfaceType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6141 + +#### Returns + +`this is InterfaceType` + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`isClass`](LiteralType.md#isclass) + +*** + +### isClassOrInterface() + +> **isClassOrInterface**(): `this is InterfaceType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6140 + +#### Returns + +`this is InterfaceType` + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`isClassOrInterface`](LiteralType.md#isclassorinterface) + +*** + +### isIndexType() + +> **isIndexType**(): `this is IndexType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6142 + +#### Returns + +`this is IndexType` + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`isIndexType`](LiteralType.md#isindextype) + +*** + +### isIntersection() + +> **isIntersection**(): `this is IntersectionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6134 + +#### Returns + +`this is IntersectionType` + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`isIntersection`](LiteralType.md#isintersection) + +*** + +### isLiteral() + +> **isLiteral**(): `this is LiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6136 + +#### Returns + +`this is LiteralType` + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`isLiteral`](LiteralType.md#isliteral) + +*** + +### isNumberLiteral() + +> **isNumberLiteral**(): `this is NumberLiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6138 + +#### Returns + +`this is NumberLiteralType` + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`isNumberLiteral`](LiteralType.md#isnumberliteral) + +*** + +### isStringLiteral() + +> **isStringLiteral**(): `this is StringLiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6137 + +#### Returns + +`this is StringLiteralType` + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`isStringLiteral`](LiteralType.md#isstringliteral) + +*** + +### isTypeParameter() + +> **isTypeParameter**(): `this is TypeParameter` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6139 + +#### Returns + +`this is TypeParameter` + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`isTypeParameter`](LiteralType.md#istypeparameter) + +*** + +### isUnion() + +> **isUnion**(): `this is UnionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6133 + +#### Returns + +`this is UnionType` + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`isUnion`](LiteralType.md#isunion) + +*** + +### isUnionOrIntersection() + +> **isUnionOrIntersection**(): `this is UnionOrIntersectionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6135 + +#### Returns + +`this is UnionOrIntersectionType` + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`isUnionOrIntersection`](LiteralType.md#isunionorintersection) diff --git a/docs/api_docs/namespaces/ts/interfaces/BinaryExpression.md b/docs/api_docs/namespaces/ts/interfaces/BinaryExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..9070bd684a9ce81232ce9115afa01cd6942e47a5 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/BinaryExpression.md @@ -0,0 +1,529 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / BinaryExpression + +# Interface: BinaryExpression + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1161 + +## Extends + +- [`Expression`](Expression.md).[`Declaration`](Declaration.md) + +## Extended by + +- [`AssignmentExpression`](AssignmentExpression.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`Declaration`](Declaration.md).[`_declarationBrand`](Declaration.md#_declarationbrand) + +*** + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`Expression`](Expression.md).[`_expressionBrand`](Expression.md#_expressionbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Declaration`](Declaration.md).[`decorators`](Declaration.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Declaration`](Declaration.md).[`end`](Declaration.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Declaration`](Declaration.md).[`flags`](Declaration.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`BinaryExpression`](../enumerations/SyntaxKind.md#binaryexpression) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1162 + +#### Overrides + +[`Declaration`](Declaration.md).[`kind`](Declaration.md#kind) + +*** + +### left + +> `readonly` **left**: [`Expression`](Expression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1163 + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Declaration`](Declaration.md).[`locals`](Declaration.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Declaration`](Declaration.md).[`modifiers`](Declaration.md#modifiers) + +*** + +### operatorToken + +> `readonly` **operatorToken**: [`BinaryOperatorToken`](../type-aliases/BinaryOperatorToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1164 + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`Declaration`](Declaration.md).[`parent`](Declaration.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Declaration`](Declaration.md).[`pos`](Declaration.md#pos) + +*** + +### right + +> `readonly` **right**: [`Expression`](Expression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1165 + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Declaration`](Declaration.md).[`skipCheck`](Declaration.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Declaration`](Declaration.md).[`symbol`](Declaration.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Declaration`](Declaration.md).[`forEachChild`](Declaration.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getChildAt`](Declaration.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getChildCount`](Declaration.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Declaration`](Declaration.md).[`getChildren`](Declaration.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getEnd`](Declaration.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFirstToken`](Declaration.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFullStart`](Declaration.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFullText`](Declaration.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFullWidth`](Declaration.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getLastToken`](Declaration.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getLeadingTriviaWidth`](Declaration.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getSourceFile`](Declaration.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getStart`](Declaration.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getText`](Declaration.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getWidth`](Declaration.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/BindingElement.md b/docs/api_docs/namespaces/ts/interfaces/BindingElement.md new file mode 100644 index 0000000000000000000000000000000000000000..3786090bb02f3d243e158d38b71154338f3b16a5 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/BindingElement.md @@ -0,0 +1,525 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / BindingElement + +# Interface: BindingElement + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:769 + +## Extends + +- [`NamedDeclaration`](NamedDeclaration.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`_declarationBrand`](NamedDeclaration.md#_declarationbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`decorators`](NamedDeclaration.md#decorators) + +*** + +### dotDotDotToken? + +> `readonly` `optional` **dotDotDotToken**: [`DotDotDotToken`](../type-aliases/DotDotDotToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:773 + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`end`](NamedDeclaration.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`flags`](NamedDeclaration.md#flags) + +*** + +### initializer? + +> `readonly` `optional` **initializer**: [`Expression`](Expression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:775 + +*** + +### kind + +> `readonly` **kind**: [`BindingElement`](../enumerations/SyntaxKind.md#bindingelement) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:770 + +#### Overrides + +[`NamedDeclaration`](NamedDeclaration.md).[`kind`](NamedDeclaration.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`locals`](NamedDeclaration.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`modifiers`](NamedDeclaration.md#modifiers) + +*** + +### name + +> `readonly` **name**: [`BindingName`](../type-aliases/BindingName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:774 + +#### Overrides + +[`NamedDeclaration`](NamedDeclaration.md).[`name`](NamedDeclaration.md#name) + +*** + +### parent + +> `readonly` **parent**: [`BindingPattern`](../type-aliases/BindingPattern.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:771 + +#### Overrides + +[`NamedDeclaration`](NamedDeclaration.md).[`parent`](NamedDeclaration.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`pos`](NamedDeclaration.md#pos) + +*** + +### propertyName? + +> `readonly` `optional` **propertyName**: [`PropertyName`](../type-aliases/PropertyName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:772 + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`skipCheck`](NamedDeclaration.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`symbol`](NamedDeclaration.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`forEachChild`](NamedDeclaration.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getChildAt`](NamedDeclaration.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getChildCount`](NamedDeclaration.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getChildren`](NamedDeclaration.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getEnd`](NamedDeclaration.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFirstToken`](NamedDeclaration.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFullStart`](NamedDeclaration.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFullText`](NamedDeclaration.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFullWidth`](NamedDeclaration.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getLastToken`](NamedDeclaration.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getLeadingTriviaWidth`](NamedDeclaration.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getSourceFile`](NamedDeclaration.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getStart`](NamedDeclaration.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getText`](NamedDeclaration.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getWidth`](NamedDeclaration.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/Block.md b/docs/api_docs/namespaces/ts/interfaces/Block.md new file mode 100644 index 0000000000000000000000000000000000000000..8427051292b61ec70993c8ca519224383f071869 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/Block.md @@ -0,0 +1,497 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / Block + +# Interface: Block + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1494 + +## Extends + +- [`Statement`](Statement.md) + +## Properties + +### \_statementBrand + +> **\_statementBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1471 + +#### Inherited from + +[`Statement`](Statement.md).[`_statementBrand`](Statement.md#_statementbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Statement`](Statement.md).[`decorators`](Statement.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Statement`](Statement.md).[`end`](Statement.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Statement`](Statement.md).[`flags`](Statement.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`Block`](../enumerations/SyntaxKind.md#block) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1495 + +#### Overrides + +[`Statement`](Statement.md).[`kind`](Statement.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Statement`](Statement.md).[`locals`](Statement.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Statement`](Statement.md).[`modifiers`](Statement.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`Statement`](Statement.md).[`parent`](Statement.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Statement`](Statement.md).[`pos`](Statement.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Statement`](Statement.md).[`skipCheck`](Statement.md#skipcheck) + +*** + +### statements + +> `readonly` **statements**: [`NodeArray`](NodeArray.md)\<[`Statement`](Statement.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1496 + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Statement`](Statement.md).[`symbol`](Statement.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Statement`](Statement.md).[`forEachChild`](Statement.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getChildAt`](Statement.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getChildCount`](Statement.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Statement`](Statement.md).[`getChildren`](Statement.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getEnd`](Statement.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getFirstToken`](Statement.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getFullStart`](Statement.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Statement`](Statement.md).[`getFullText`](Statement.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getFullWidth`](Statement.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getLastToken`](Statement.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getLeadingTriviaWidth`](Statement.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getSourceFile`](Statement.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getStart`](Statement.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Statement`](Statement.md).[`getText`](Statement.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getWidth`](Statement.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/BreakStatement.md b/docs/api_docs/namespaces/ts/interfaces/BreakStatement.md new file mode 100644 index 0000000000000000000000000000000000000000..915bb6bbcd3483b8aa1ebe1d70878feeba233818 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/BreakStatement.md @@ -0,0 +1,497 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / BreakStatement + +# Interface: BreakStatement + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1543 + +## Extends + +- [`Statement`](Statement.md) + +## Properties + +### \_statementBrand + +> **\_statementBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1471 + +#### Inherited from + +[`Statement`](Statement.md).[`_statementBrand`](Statement.md#_statementbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Statement`](Statement.md).[`decorators`](Statement.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Statement`](Statement.md).[`end`](Statement.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Statement`](Statement.md).[`flags`](Statement.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`BreakStatement`](../enumerations/SyntaxKind.md#breakstatement) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1544 + +#### Overrides + +[`Statement`](Statement.md).[`kind`](Statement.md#kind) + +*** + +### label? + +> `readonly` `optional` **label**: [`Identifier`](Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1545 + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Statement`](Statement.md).[`locals`](Statement.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Statement`](Statement.md).[`modifiers`](Statement.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`Statement`](Statement.md).[`parent`](Statement.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Statement`](Statement.md).[`pos`](Statement.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Statement`](Statement.md).[`skipCheck`](Statement.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Statement`](Statement.md).[`symbol`](Statement.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Statement`](Statement.md).[`forEachChild`](Statement.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getChildAt`](Statement.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getChildCount`](Statement.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Statement`](Statement.md).[`getChildren`](Statement.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getEnd`](Statement.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getFirstToken`](Statement.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getFullStart`](Statement.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Statement`](Statement.md).[`getFullText`](Statement.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getFullWidth`](Statement.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getLastToken`](Statement.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getLeadingTriviaWidth`](Statement.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getSourceFile`](Statement.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getStart`](Statement.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Statement`](Statement.md).[`getText`](Statement.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getWidth`](Statement.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/BuildInvalidedProject.md b/docs/api_docs/namespaces/ts/interfaces/BuildInvalidedProject.md new file mode 100644 index 0000000000000000000000000000000000000000..e6c3ab240441d4cf4d31f40fce799192853f3558 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/BuildInvalidedProject.md @@ -0,0 +1,325 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / BuildInvalidedProject + +# Interface: BuildInvalidedProject\ + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5990 + +## Extends + +- [`InvalidatedProjectBase`](InvalidatedProjectBase.md) + +## Type Parameters + +• **T** *extends* [`BuilderProgram`](BuilderProgram.md) + +## Properties + +### kind + +> `readonly` **kind**: [`Build`](../enumerations/InvalidatedProjectKind.md#build) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5991 + +#### Overrides + +[`InvalidatedProjectBase`](InvalidatedProjectBase.md).[`kind`](InvalidatedProjectBase.md#kind) + +*** + +### project + +> `readonly` **project**: [`ResolvedConfigFileName`](../type-aliases/ResolvedConfigFileName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5978 + +#### Inherited from + +[`InvalidatedProjectBase`](InvalidatedProjectBase.md).[`project`](InvalidatedProjectBase.md#project) + +## Methods + +### done() + +> **done**(`cancellationToken`?, `writeFile`?, `customTransformers`?): [`ExitStatus`](../enumerations/ExitStatus.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5982 + +To dispose this project and ensure that all the necessary actions are taken and state is updated accordingly + +#### Parameters + +##### cancellationToken? + +[`CancellationToken`](CancellationToken.md) + +##### writeFile? + +[`WriteFileCallback`](../type-aliases/WriteFileCallback.md) + +##### customTransformers? + +[`CustomTransformers`](CustomTransformers.md) + +#### Returns + +[`ExitStatus`](../enumerations/ExitStatus.md) + +#### Inherited from + +[`InvalidatedProjectBase`](InvalidatedProjectBase.md).[`done`](InvalidatedProjectBase.md#done) + +*** + +### emit() + +> **emit**(`targetSourceFile`?, `writeFile`?, `cancellationToken`?, `emitOnlyDtsFiles`?, `customTransformers`?): `undefined` \| [`EmitResult`](EmitResult.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6003 + +#### Parameters + +##### targetSourceFile? + +[`SourceFile`](SourceFile.md) + +##### writeFile? + +[`WriteFileCallback`](../type-aliases/WriteFileCallback.md) + +##### cancellationToken? + +[`CancellationToken`](CancellationToken.md) + +##### emitOnlyDtsFiles? + +`boolean` + +##### customTransformers? + +[`CustomTransformers`](CustomTransformers.md) + +#### Returns + +`undefined` \| [`EmitResult`](EmitResult.md) + +*** + +### getAllDependencies() + +> **getAllDependencies**(`sourceFile`): readonly `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6000 + +#### Parameters + +##### sourceFile + +[`SourceFile`](SourceFile.md) + +#### Returns + +readonly `string`[] + +*** + +### getBuilderProgram() + +> **getBuilderProgram**(): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5992 + +#### Returns + +`undefined` \| `T` + +*** + +### getCompilerOptions() + +> **getCompilerOptions**(): [`CompilerOptions`](CompilerOptions.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5983 + +#### Returns + +[`CompilerOptions`](CompilerOptions.md) + +#### Inherited from + +[`InvalidatedProjectBase`](InvalidatedProjectBase.md).[`getCompilerOptions`](InvalidatedProjectBase.md#getcompileroptions) + +*** + +### getConfigFileParsingDiagnostics() + +> **getConfigFileParsingDiagnostics**(): readonly [`Diagnostic`](Diagnostic.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5998 + +#### Returns + +readonly [`Diagnostic`](Diagnostic.md)[] + +*** + +### getCurrentDirectory() + +> **getCurrentDirectory**(): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5984 + +#### Returns + +`string` + +#### Inherited from + +[`InvalidatedProjectBase`](InvalidatedProjectBase.md).[`getCurrentDirectory`](InvalidatedProjectBase.md#getcurrentdirectory) + +*** + +### getGlobalDiagnostics() + +> **getGlobalDiagnostics**(`cancellationToken`?): readonly [`Diagnostic`](Diagnostic.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5997 + +#### Parameters + +##### cancellationToken? + +[`CancellationToken`](CancellationToken.md) + +#### Returns + +readonly [`Diagnostic`](Diagnostic.md)[] + +*** + +### getOptionsDiagnostics() + +> **getOptionsDiagnostics**(`cancellationToken`?): readonly [`Diagnostic`](Diagnostic.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5996 + +#### Parameters + +##### cancellationToken? + +[`CancellationToken`](CancellationToken.md) + +#### Returns + +readonly [`Diagnostic`](Diagnostic.md)[] + +*** + +### getProgram() + +> **getProgram**(): `undefined` \| [`Program`](Program.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5993 + +#### Returns + +`undefined` \| [`Program`](Program.md) + +*** + +### getSemanticDiagnostics() + +> **getSemanticDiagnostics**(`sourceFile`?, `cancellationToken`?): readonly [`Diagnostic`](Diagnostic.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6001 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### cancellationToken? + +[`CancellationToken`](CancellationToken.md) + +#### Returns + +readonly [`Diagnostic`](Diagnostic.md)[] + +*** + +### getSemanticDiagnosticsOfNextAffectedFile() + +> **getSemanticDiagnosticsOfNextAffectedFile**(`cancellationToken`?, `ignoreSourceFile`?): [`AffectedFileResult`](../type-aliases/AffectedFileResult.md)\ + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6002 + +#### Parameters + +##### cancellationToken? + +[`CancellationToken`](CancellationToken.md) + +##### ignoreSourceFile? + +(`sourceFile`) => `boolean` + +#### Returns + +[`AffectedFileResult`](../type-aliases/AffectedFileResult.md)\ + +*** + +### getSourceFile() + +> **getSourceFile**(`fileName`): `undefined` \| [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5994 + +#### Parameters + +##### fileName + +`string` + +#### Returns + +`undefined` \| [`SourceFile`](SourceFile.md) + +*** + +### getSourceFiles() + +> **getSourceFiles**(): readonly [`SourceFile`](SourceFile.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5995 + +#### Returns + +readonly [`SourceFile`](SourceFile.md)[] + +*** + +### getSyntacticDiagnostics() + +> **getSyntacticDiagnostics**(`sourceFile`?, `cancellationToken`?): readonly [`Diagnostic`](Diagnostic.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5999 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### cancellationToken? + +[`CancellationToken`](CancellationToken.md) + +#### Returns + +readonly [`Diagnostic`](Diagnostic.md)[] diff --git a/docs/api_docs/namespaces/ts/interfaces/BuildOptions.md b/docs/api_docs/namespaces/ts/interfaces/BuildOptions.md new file mode 100644 index 0000000000000000000000000000000000000000..fc5d7267c6c5b2b42dc0b6f87df6a7c916177659 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/BuildOptions.md @@ -0,0 +1,61 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / BuildOptions + +# Interface: BuildOptions + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5921 + +## Indexable + +\[`option`: `string`\]: [`CompilerOptionsValue`](../type-aliases/CompilerOptionsValue.md) + +## Properties + +### assumeChangesOnlyAffectDirectDependencies? + +> `optional` **assumeChangesOnlyAffectDirectDependencies**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5926 + +*** + +### dry? + +> `optional` **dry**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5922 + +*** + +### force? + +> `optional` **force**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5923 + +*** + +### incremental? + +> `optional` **incremental**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5925 + +*** + +### traceResolution? + +> `optional` **traceResolution**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5927 + +*** + +### verbose? + +> `optional` **verbose**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5924 diff --git a/docs/api_docs/namespaces/ts/interfaces/BuilderProgram.md b/docs/api_docs/namespaces/ts/interfaces/BuilderProgram.md new file mode 100644 index 0000000000000000000000000000000000000000..c084a075c825a4adac5332a7e4ea96a8fa1f23a8 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/BuilderProgram.md @@ -0,0 +1,312 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / BuilderProgram + +# Interface: BuilderProgram + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5664 + +Builder to manage the program state changes + +## Extended by + +- [`SemanticDiagnosticsBuilderProgram`](SemanticDiagnosticsBuilderProgram.md) + +## Properties + +### builderProgramForLinter? + +> `optional` **builderProgramForLinter**: [`EmitAndSemanticDiagnosticsBuilderProgram`](EmitAndSemanticDiagnosticsBuilderProgram.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5731 + +## Methods + +### emit() + +> **emit**(`targetSourceFile`?, `writeFile`?, `cancellationToken`?, `emitOnlyDtsFiles`?, `customTransformers`?): [`EmitResult`](EmitResult.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5725 + +Emits the JavaScript and declaration files. +When targetSource file is specified, emits the files corresponding to that source file, +otherwise for the whole program. +In case of EmitAndSemanticDiagnosticsBuilderProgram, when targetSourceFile is specified, +it is assumed that that file is handled from affected file list. If targetSourceFile is not specified, +it will only emit all the affected files instead of whole program + +The first of writeFile if provided, writeFile of BuilderProgramHost if provided, writeFile of compiler host +in that order would be used to write the files + +#### Parameters + +##### targetSourceFile? + +[`SourceFile`](SourceFile.md) + +##### writeFile? + +[`WriteFileCallback`](../type-aliases/WriteFileCallback.md) + +##### cancellationToken? + +[`CancellationToken`](CancellationToken.md) + +##### emitOnlyDtsFiles? + +`boolean` + +##### customTransformers? + +[`CustomTransformers`](CustomTransformers.md) + +#### Returns + +[`EmitResult`](EmitResult.md) + +*** + +### getAllDependencies() + +> **getAllDependencies**(`sourceFile`): readonly `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5704 + +Get all the dependencies of the file + +#### Parameters + +##### sourceFile + +[`SourceFile`](SourceFile.md) + +#### Returns + +readonly `string`[] + +*** + +### getCompilerOptions() + +> **getCompilerOptions**(): [`CompilerOptions`](CompilerOptions.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5672 + +Get compiler options of the program + +#### Returns + +[`CompilerOptions`](CompilerOptions.md) + +*** + +### getConfigFileParsingDiagnostics() + +> **getConfigFileParsingDiagnostics**(): readonly [`Diagnostic`](Diagnostic.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5692 + +Get the diagnostics from config file parsing + +#### Returns + +readonly [`Diagnostic`](Diagnostic.md)[] + +*** + +### getCurrentDirectory() + +> **getCurrentDirectory**(): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5729 + +Get the current directory of the program + +#### Returns + +`string` + +*** + +### getDeclarationDiagnostics() + +> **getDeclarationDiagnostics**(`sourceFile`?, `cancellationToken`?): readonly [`DiagnosticWithLocation`](DiagnosticWithLocation.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5700 + +Get the declaration diagnostics, for all source files if source file is not supplied + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### cancellationToken? + +[`CancellationToken`](CancellationToken.md) + +#### Returns + +readonly [`DiagnosticWithLocation`](DiagnosticWithLocation.md)[] + +*** + +### getGlobalDiagnostics() + +> **getGlobalDiagnostics**(`cancellationToken`?): readonly [`Diagnostic`](Diagnostic.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5688 + +Get the diagnostics that dont belong to any file + +#### Parameters + +##### cancellationToken? + +[`CancellationToken`](CancellationToken.md) + +#### Returns + +readonly [`Diagnostic`](Diagnostic.md)[] + +*** + +### getOptionsDiagnostics() + +> **getOptionsDiagnostics**(`cancellationToken`?): readonly [`Diagnostic`](Diagnostic.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5684 + +Get the diagnostics for compiler options + +#### Parameters + +##### cancellationToken? + +[`CancellationToken`](CancellationToken.md) + +#### Returns + +readonly [`Diagnostic`](Diagnostic.md)[] + +*** + +### getProgram() + +> **getProgram**(): [`Program`](Program.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5668 + +Returns current program + +#### Returns + +[`Program`](Program.md) + +*** + +### getSemanticDiagnostics() + +> **getSemanticDiagnostics**(`sourceFile`?, `cancellationToken`?): readonly [`Diagnostic`](Diagnostic.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5713 + +Gets the semantic diagnostics from the program corresponding to this state of file (if provided) or whole program +The semantic diagnostics are cached and managed here +Note that it is assumed that when asked about semantic diagnostics through this API, +the file has been taken out of affected files so it is safe to use cache or get from program and cache the diagnostics +In case of SemanticDiagnosticsBuilderProgram if the source file is not provided, +it will iterate through all the affected files, to ensure that cache stays valid and yet provide a way to get all semantic diagnostics + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### cancellationToken? + +[`CancellationToken`](CancellationToken.md) + +#### Returns + +readonly [`Diagnostic`](Diagnostic.md)[] + +*** + +### getSourceFile() + +> **getSourceFile**(`fileName`): `undefined` \| [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5676 + +Get the source file in the program with file name + +#### Parameters + +##### fileName + +`string` + +#### Returns + +`undefined` \| [`SourceFile`](SourceFile.md) + +*** + +### getSourceFiles() + +> **getSourceFiles**(): readonly [`SourceFile`](SourceFile.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5680 + +Get a list of files in the program + +#### Returns + +readonly [`SourceFile`](SourceFile.md)[] + +*** + +### getSyntacticDiagnostics() + +> **getSyntacticDiagnostics**(`sourceFile`?, `cancellationToken`?): readonly [`Diagnostic`](Diagnostic.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5696 + +Get the syntax diagnostics, for all source files if source file is not supplied + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### cancellationToken? + +[`CancellationToken`](CancellationToken.md) + +#### Returns + +readonly [`Diagnostic`](Diagnostic.md)[] + +*** + +### isFileUpdateInConstEnumCache()? + +> `optional` **isFileUpdateInConstEnumCache**(`sourceFile`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5730 + +#### Parameters + +##### sourceFile + +[`SourceFile`](SourceFile.md) + +#### Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/interfaces/BuilderProgramHost.md b/docs/api_docs/namespaces/ts/interfaces/BuilderProgramHost.md new file mode 100644 index 0000000000000000000000000000000000000000..4d35ed8c141c34e8d1168c3cb1d8f2c156a6a654 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/BuilderProgramHost.md @@ -0,0 +1,54 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / BuilderProgramHost + +# Interface: BuilderProgramHost + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5646 + +## Properties + +### createHash()? + +> `optional` **createHash**: (`data`) => `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5654 + +If provided this would be used this hash instead of actual file shape text for detecting changes + +#### Parameters + +##### data + +`string` + +#### Returns + +`string` + +*** + +### writeFile? + +> `optional` **writeFile**: [`WriteFileCallback`](../type-aliases/WriteFileCallback.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5659 + +When emit or emitNextAffectedFile are called without writeFile, +this callback if present would be used to write files + +## Methods + +### useCaseSensitiveFileNames() + +> **useCaseSensitiveFileNames**(): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5650 + +return true if file names are treated with case sensitivity + +#### Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/interfaces/Bundle.md b/docs/api_docs/namespaces/ts/interfaces/Bundle.md new file mode 100644 index 0000000000000000000000000000000000000000..e47cb7d43ee5d43f6918e9865b54331d65ea8bbe --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/Bundle.md @@ -0,0 +1,493 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / Bundle + +# Interface: Bundle + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2158 + +## Extends + +- [`Node`](Node.md) + +## Properties + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`decorators`](Node.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Node`](Node.md).[`end`](Node.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Node`](Node.md).[`flags`](Node.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`Bundle`](../enumerations/SyntaxKind.md#bundle) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2159 + +#### Overrides + +[`Node`](Node.md).[`kind`](Node.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Node`](Node.md).[`locals`](Node.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`modifiers`](Node.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`Node`](Node.md).[`parent`](Node.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Node`](Node.md).[`pos`](Node.md#pos) + +*** + +### prepends + +> `readonly` **prepends**: readonly ([`InputFiles`](InputFiles.md) \| [`UnparsedSource`](UnparsedSource.md))[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2160 + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Node`](Node.md).[`skipCheck`](Node.md#skipcheck) + +*** + +### sourceFiles + +> `readonly` **sourceFiles**: readonly [`SourceFile`](SourceFile.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2161 + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Node`](Node.md).[`symbol`](Node.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Node`](Node.md).[`forEachChild`](Node.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getChildAt`](Node.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getChildCount`](Node.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Node`](Node.md).[`getChildren`](Node.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getEnd`](Node.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getFirstToken`](Node.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullStart`](Node.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getFullText`](Node.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullWidth`](Node.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getLastToken`](Node.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getLeadingTriviaWidth`](Node.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Node`](Node.md).[`getSourceFile`](Node.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getStart`](Node.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getText`](Node.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getWidth`](Node.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/CallChain.md b/docs/api_docs/namespaces/ts/interfaces/CallChain.md new file mode 100644 index 0000000000000000000000000000000000000000..2d6e8e477342fef44b0f42b88dd7fdff4c32455a --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/CallChain.md @@ -0,0 +1,593 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / CallChain + +# Interface: CallChain + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1343 + +## Extends + +- [`CallExpression`](CallExpression.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`_declarationBrand`](CallExpression.md#_declarationbrand) + +*** + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`_expressionBrand`](CallExpression.md#_expressionbrand) + +*** + +### \_leftHandSideExpressionBrand + +> **\_leftHandSideExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1086 + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`_leftHandSideExpressionBrand`](CallExpression.md#_lefthandsideexpressionbrand) + +*** + +### \_optionalChainBrand + +> **\_optionalChainBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1344 + +*** + +### \_unaryExpressionBrand + +> **\_unaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1066 + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`_unaryExpressionBrand`](CallExpression.md#_unaryexpressionbrand) + +*** + +### \_updateExpressionBrand + +> **\_updateExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1071 + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`_updateExpressionBrand`](CallExpression.md#_updateexpressionbrand) + +*** + +### arguments + +> `readonly` **arguments**: [`NodeArray`](NodeArray.md)\<[`Expression`](Expression.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1341 + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`arguments`](CallExpression.md#arguments) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`decorators`](CallExpression.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`end`](CallExpression.md#end) + +*** + +### expression + +> `readonly` **expression**: [`LeftHandSideExpression`](LeftHandSideExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1338 + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`expression`](CallExpression.md#expression) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`flags`](CallExpression.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`CallExpression`](../enumerations/SyntaxKind.md#callexpression) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1337 + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`kind`](CallExpression.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`locals`](CallExpression.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`modifiers`](CallExpression.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`parent`](CallExpression.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`pos`](CallExpression.md#pos) + +*** + +### questionDotToken? + +> `readonly` `optional` **questionDotToken**: [`QuestionDotToken`](../type-aliases/QuestionDotToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1339 + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`questionDotToken`](CallExpression.md#questiondottoken) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`skipCheck`](CallExpression.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`symbol`](CallExpression.md#symbol) + +*** + +### typeArguments? + +> `readonly` `optional` **typeArguments**: [`NodeArray`](NodeArray.md)\<[`TypeNode`](TypeNode.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1340 + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`typeArguments`](CallExpression.md#typearguments) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`forEachChild`](CallExpression.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`getChildAt`](CallExpression.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`getChildCount`](CallExpression.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`getChildren`](CallExpression.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`getEnd`](CallExpression.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`getFirstToken`](CallExpression.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`getFullStart`](CallExpression.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`getFullText`](CallExpression.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`getFullWidth`](CallExpression.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`getLastToken`](CallExpression.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`getLeadingTriviaWidth`](CallExpression.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`getSourceFile`](CallExpression.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`getStart`](CallExpression.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`getText`](CallExpression.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`getWidth`](CallExpression.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/CallExpression.md b/docs/api_docs/namespaces/ts/interfaces/CallExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..984795102c3fc34d69056a5f0e8e4ad9c2cfb35a --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/CallExpression.md @@ -0,0 +1,575 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / CallExpression + +# Interface: CallExpression + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1336 + +## Extends + +- [`LeftHandSideExpression`](LeftHandSideExpression.md).[`Declaration`](Declaration.md) + +## Extended by + +- [`CallChain`](CallChain.md) +- [`SuperCall`](SuperCall.md) +- [`ImportCall`](ImportCall.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`Declaration`](Declaration.md).[`_declarationBrand`](Declaration.md#_declarationbrand) + +*** + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`_expressionBrand`](LeftHandSideExpression.md#_expressionbrand) + +*** + +### \_leftHandSideExpressionBrand + +> **\_leftHandSideExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1086 + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`_leftHandSideExpressionBrand`](LeftHandSideExpression.md#_lefthandsideexpressionbrand) + +*** + +### \_unaryExpressionBrand + +> **\_unaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1066 + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`_unaryExpressionBrand`](LeftHandSideExpression.md#_unaryexpressionbrand) + +*** + +### \_updateExpressionBrand + +> **\_updateExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1071 + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`_updateExpressionBrand`](LeftHandSideExpression.md#_updateexpressionbrand) + +*** + +### arguments + +> `readonly` **arguments**: [`NodeArray`](NodeArray.md)\<[`Expression`](Expression.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1341 + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Declaration`](Declaration.md).[`decorators`](Declaration.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Declaration`](Declaration.md).[`end`](Declaration.md#end) + +*** + +### expression + +> `readonly` **expression**: [`LeftHandSideExpression`](LeftHandSideExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1338 + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Declaration`](Declaration.md).[`flags`](Declaration.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`CallExpression`](../enumerations/SyntaxKind.md#callexpression) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1337 + +#### Overrides + +[`Declaration`](Declaration.md).[`kind`](Declaration.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Declaration`](Declaration.md).[`locals`](Declaration.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Declaration`](Declaration.md).[`modifiers`](Declaration.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`Declaration`](Declaration.md).[`parent`](Declaration.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Declaration`](Declaration.md).[`pos`](Declaration.md#pos) + +*** + +### questionDotToken? + +> `readonly` `optional` **questionDotToken**: [`QuestionDotToken`](../type-aliases/QuestionDotToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1339 + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Declaration`](Declaration.md).[`skipCheck`](Declaration.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Declaration`](Declaration.md).[`symbol`](Declaration.md#symbol) + +*** + +### typeArguments? + +> `readonly` `optional` **typeArguments**: [`NodeArray`](NodeArray.md)\<[`TypeNode`](TypeNode.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1340 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Declaration`](Declaration.md).[`forEachChild`](Declaration.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getChildAt`](Declaration.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getChildCount`](Declaration.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Declaration`](Declaration.md).[`getChildren`](Declaration.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getEnd`](Declaration.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFirstToken`](Declaration.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFullStart`](Declaration.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFullText`](Declaration.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFullWidth`](Declaration.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getLastToken`](Declaration.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getLeadingTriviaWidth`](Declaration.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getSourceFile`](Declaration.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getStart`](Declaration.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getText`](Declaration.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getWidth`](Declaration.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/CallHierarchyIncomingCall.md b/docs/api_docs/namespaces/ts/interfaces/CallHierarchyIncomingCall.md new file mode 100644 index 0000000000000000000000000000000000000000..04f3b3d0098bac65cf7c7d9e2dc71901ca325a8f --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/CallHierarchyIncomingCall.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / CallHierarchyIncomingCall + +# Interface: CallHierarchyIncomingCall + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6570 + +## Properties + +### from + +> **from**: [`CallHierarchyItem`](CallHierarchyItem.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6571 + +*** + +### fromSpans + +> **fromSpans**: [`TextSpan`](TextSpan.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6572 diff --git a/docs/api_docs/namespaces/ts/interfaces/CallHierarchyItem.md b/docs/api_docs/namespaces/ts/interfaces/CallHierarchyItem.md new file mode 100644 index 0000000000000000000000000000000000000000..caf7f8a975f26980ad8deaf8bdb4b8e62dacc3f0 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/CallHierarchyItem.md @@ -0,0 +1,65 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / CallHierarchyItem + +# Interface: CallHierarchyItem + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6561 + +## Properties + +### containerName? + +> `optional` **containerName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6568 + +*** + +### file + +> **file**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6565 + +*** + +### kind + +> **kind**: [`ScriptElementKind`](../enumerations/ScriptElementKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6563 + +*** + +### kindModifiers? + +> `optional` **kindModifiers**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6564 + +*** + +### name + +> **name**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6562 + +*** + +### selectionSpan + +> **selectionSpan**: [`TextSpan`](TextSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6567 + +*** + +### span + +> **span**: [`TextSpan`](TextSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6566 diff --git a/docs/api_docs/namespaces/ts/interfaces/CallHierarchyOutgoingCall.md b/docs/api_docs/namespaces/ts/interfaces/CallHierarchyOutgoingCall.md new file mode 100644 index 0000000000000000000000000000000000000000..53f63633912c8ffa151d96edc9cd74ddd62b732d --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/CallHierarchyOutgoingCall.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / CallHierarchyOutgoingCall + +# Interface: CallHierarchyOutgoingCall + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6574 + +## Properties + +### fromSpans + +> **fromSpans**: [`TextSpan`](TextSpan.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6576 + +*** + +### to + +> **to**: [`CallHierarchyItem`](CallHierarchyItem.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6575 diff --git a/docs/api_docs/namespaces/ts/interfaces/CallSignatureDeclaration.md b/docs/api_docs/namespaces/ts/interfaces/CallSignatureDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..f45e4c0ccf52fda3a030f28fe96204c575f6d053 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/CallSignatureDeclaration.md @@ -0,0 +1,561 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / CallSignatureDeclaration + +# Interface: CallSignatureDeclaration + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:739 + +## Extends + +- [`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`TypeElement`](TypeElement.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`_declarationBrand`](TypeElement.md#_declarationbrand) + +*** + +### \_typeElementBrand + +> **\_typeElementBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1637 + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`_typeElementBrand`](TypeElement.md#_typeelementbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`decorators`](TypeElement.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`end`](TypeElement.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`flags`](TypeElement.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`CallSignature`](../enumerations/SyntaxKind.md#callsignature) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:740 + +#### Overrides + +[`TypeElement`](TypeElement.md).[`kind`](TypeElement.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`locals`](TypeElement.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`modifiers`](TypeElement.md#modifiers) + +*** + +### name? + +> `readonly` `optional` **name**: [`PropertyName`](../type-aliases/PropertyName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:733 + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`name`](TypeElement.md#name) + +*** + +### parameters + +> `readonly` **parameters**: [`NodeArray`](NodeArray.md)\<[`ParameterDeclaration`](ParameterDeclaration.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:735 + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`parameters`](SignatureDeclarationBase.md#parameters) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`parent`](TypeElement.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`pos`](TypeElement.md#pos) + +*** + +### questionToken? + +> `readonly` `optional` **questionToken**: [`QuestionToken`](../type-aliases/QuestionToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1639 + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`questionToken`](TypeElement.md#questiontoken) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`skipCheck`](TypeElement.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`symbol`](TypeElement.md#symbol) + +*** + +### type? + +> `readonly` `optional` **type**: [`TypeNode`](TypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:736 + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`type`](SignatureDeclarationBase.md#type) + +*** + +### typeParameters? + +> `readonly` `optional` **typeParameters**: [`NodeArray`](NodeArray.md)\<[`TypeParameterDeclaration`](TypeParameterDeclaration.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:734 + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`typeParameters`](SignatureDeclarationBase.md#typeparameters) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`forEachChild`](TypeElement.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getChildAt`](TypeElement.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getChildCount`](TypeElement.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getChildren`](TypeElement.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getEnd`](TypeElement.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getFirstToken`](TypeElement.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getFullStart`](TypeElement.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getFullText`](TypeElement.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getFullWidth`](TypeElement.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getLastToken`](TypeElement.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getLeadingTriviaWidth`](TypeElement.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getSourceFile`](TypeElement.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getStart`](TypeElement.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getText`](TypeElement.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getWidth`](TypeElement.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/CancellationToken.md b/docs/api_docs/namespaces/ts/interfaces/CancellationToken.md new file mode 100644 index 0000000000000000000000000000000000000000..4140dd89638938a2813e6151a3493949b755a25e --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/CancellationToken.md @@ -0,0 +1,37 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / CancellationToken + +# Interface: CancellationToken + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2260 + +## Methods + +### isCancellationRequested() + +> **isCancellationRequested**(): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2261 + +#### Returns + +`boolean` + +*** + +### throwIfCancellationRequested() + +> **throwIfCancellationRequested**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2263 + +#### Returns + +`void` + +#### Throws + +OperationCanceledException if isCancellationRequested is true diff --git a/docs/api_docs/namespaces/ts/interfaces/CaseBlock.md b/docs/api_docs/namespaces/ts/interfaces/CaseBlock.md new file mode 100644 index 0000000000000000000000000000000000000000..02100e8b8eb54ea1663a0e0b1a1ddc24c130a832 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/CaseBlock.md @@ -0,0 +1,485 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / CaseBlock + +# Interface: CaseBlock + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1567 + +## Extends + +- [`Node`](Node.md) + +## Properties + +### clauses + +> `readonly` **clauses**: [`NodeArray`](NodeArray.md)\<[`CaseOrDefaultClause`](../type-aliases/CaseOrDefaultClause.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1570 + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`decorators`](Node.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Node`](Node.md).[`end`](Node.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Node`](Node.md).[`flags`](Node.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`CaseBlock`](../enumerations/SyntaxKind.md#caseblock) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1568 + +#### Overrides + +[`Node`](Node.md).[`kind`](Node.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Node`](Node.md).[`locals`](Node.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`modifiers`](Node.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`SwitchStatement`](SwitchStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1569 + +#### Overrides + +[`Node`](Node.md).[`parent`](Node.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Node`](Node.md).[`pos`](Node.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Node`](Node.md).[`skipCheck`](Node.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Node`](Node.md).[`symbol`](Node.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Node`](Node.md).[`forEachChild`](Node.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getChildAt`](Node.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getChildCount`](Node.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Node`](Node.md).[`getChildren`](Node.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getEnd`](Node.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getFirstToken`](Node.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullStart`](Node.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getFullText`](Node.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullWidth`](Node.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getLastToken`](Node.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getLeadingTriviaWidth`](Node.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Node`](Node.md).[`getSourceFile`](Node.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getStart`](Node.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getText`](Node.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getWidth`](Node.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/CaseClause.md b/docs/api_docs/namespaces/ts/interfaces/CaseClause.md new file mode 100644 index 0000000000000000000000000000000000000000..243a651d734522a00b44679e74156b4127b77c0f --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/CaseClause.md @@ -0,0 +1,493 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / CaseClause + +# Interface: CaseClause + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1572 + +## Extends + +- [`Node`](Node.md).[`JSDocContainer`](JSDocContainer.md) + +## Properties + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`decorators`](Node.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Node`](Node.md).[`end`](Node.md#end) + +*** + +### expression + +> `readonly` **expression**: [`Expression`](Expression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1575 + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Node`](Node.md).[`flags`](Node.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`CaseClause`](../enumerations/SyntaxKind.md#caseclause) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1573 + +#### Overrides + +[`Node`](Node.md).[`kind`](Node.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Node`](Node.md).[`locals`](Node.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`modifiers`](Node.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`CaseBlock`](CaseBlock.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1574 + +#### Overrides + +[`Node`](Node.md).[`parent`](Node.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Node`](Node.md).[`pos`](Node.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Node`](Node.md).[`skipCheck`](Node.md#skipcheck) + +*** + +### statements + +> `readonly` **statements**: [`NodeArray`](NodeArray.md)\<[`Statement`](Statement.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1576 + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Node`](Node.md).[`symbol`](Node.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Node`](Node.md).[`forEachChild`](Node.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getChildAt`](Node.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getChildCount`](Node.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Node`](Node.md).[`getChildren`](Node.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getEnd`](Node.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getFirstToken`](Node.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullStart`](Node.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getFullText`](Node.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullWidth`](Node.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getLastToken`](Node.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getLeadingTriviaWidth`](Node.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Node`](Node.md).[`getSourceFile`](Node.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getStart`](Node.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getText`](Node.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getWidth`](Node.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/CatchClause.md b/docs/api_docs/namespaces/ts/interfaces/CatchClause.md new file mode 100644 index 0000000000000000000000000000000000000000..dd06d4eebd8aba047d5f338f078b40456ed6f77c --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/CatchClause.md @@ -0,0 +1,493 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / CatchClause + +# Interface: CatchClause + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1599 + +## Extends + +- [`Node`](Node.md) + +## Properties + +### block + +> `readonly` **block**: [`Block`](Block.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1603 + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`decorators`](Node.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Node`](Node.md).[`end`](Node.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Node`](Node.md).[`flags`](Node.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`CatchClause`](../enumerations/SyntaxKind.md#catchclause) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1600 + +#### Overrides + +[`Node`](Node.md).[`kind`](Node.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Node`](Node.md).[`locals`](Node.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`modifiers`](Node.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`TryStatement`](TryStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1601 + +#### Overrides + +[`Node`](Node.md).[`parent`](Node.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Node`](Node.md).[`pos`](Node.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Node`](Node.md).[`skipCheck`](Node.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Node`](Node.md).[`symbol`](Node.md#symbol) + +*** + +### variableDeclaration? + +> `readonly` `optional` **variableDeclaration**: [`VariableDeclaration`](VariableDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1602 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Node`](Node.md).[`forEachChild`](Node.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getChildAt`](Node.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getChildCount`](Node.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Node`](Node.md).[`getChildren`](Node.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getEnd`](Node.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getFirstToken`](Node.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullStart`](Node.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getFullText`](Node.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullWidth`](Node.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getLastToken`](Node.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getLeadingTriviaWidth`](Node.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Node`](Node.md).[`getSourceFile`](Node.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getStart`](Node.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getText`](Node.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getWidth`](Node.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/CheckJsDirective.md b/docs/api_docs/namespaces/ts/interfaces/CheckJsDirective.md new file mode 100644 index 0000000000000000000000000000000000000000..1dbb7ffd0aeeec90e5fa8cf450ce32e819adba4e --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/CheckJsDirective.md @@ -0,0 +1,45 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / CheckJsDirective + +# Interface: CheckJsDirective + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1842 + +## Extends + +- [`TextRange`](TextRange.md) + +## Properties + +### enabled + +> **enabled**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1843 + +*** + +### end + +> **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:99 + +#### Inherited from + +[`TextRange`](TextRange.md).[`end`](TextRange.md#end) + +*** + +### pos + +> **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:98 + +#### Inherited from + +[`TextRange`](TextRange.md).[`pos`](TextRange.md#pos) diff --git a/docs/api_docs/namespaces/ts/interfaces/ClassDeclaration.md b/docs/api_docs/namespaces/ts/interfaces/ClassDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..b3a3cb287463e1802e30c8675933904ce15e928d --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ClassDeclaration.md @@ -0,0 +1,551 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ClassDeclaration + +# Interface: ClassDeclaration + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1615 + +## Extends + +- [`ClassLikeDeclarationBase`](ClassLikeDeclarationBase.md).[`DeclarationStatement`](DeclarationStatement.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`_declarationBrand`](DeclarationStatement.md#_declarationbrand) + +*** + +### \_statementBrand + +> **\_statementBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1471 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`_statementBrand`](DeclarationStatement.md#_statementbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`decorators`](DeclarationStatement.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`end`](DeclarationStatement.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`flags`](DeclarationStatement.md#flags) + +*** + +### heritageClauses? + +> `readonly` `optional` **heritageClauses**: [`NodeArray`](NodeArray.md)\<[`HeritageClause`](HeritageClause.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1612 + +#### Inherited from + +[`ClassLikeDeclarationBase`](ClassLikeDeclarationBase.md).[`heritageClauses`](ClassLikeDeclarationBase.md#heritageclauses) + +*** + +### kind + +> `readonly` **kind**: [`ClassDeclaration`](../enumerations/SyntaxKind.md#classdeclaration) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1616 + +#### Overrides + +[`DeclarationStatement`](DeclarationStatement.md).[`kind`](DeclarationStatement.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`locals`](DeclarationStatement.md#locals) + +*** + +### members + +> `readonly` **members**: [`NodeArray`](NodeArray.md)\<[`ClassElement`](ClassElement.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1613 + +#### Inherited from + +[`ClassLikeDeclarationBase`](ClassLikeDeclarationBase.md).[`members`](ClassLikeDeclarationBase.md#members) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1617 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Overrides + +[`DeclarationStatement`](DeclarationStatement.md).[`modifiers`](DeclarationStatement.md#modifiers) + +*** + +### name? + +> `readonly` `optional` **name**: [`Identifier`](Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1619 + +May be undefined in `export default class { ... }`. + +#### Overrides + +[`DeclarationStatement`](DeclarationStatement.md).[`name`](DeclarationStatement.md#name) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`parent`](DeclarationStatement.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`pos`](DeclarationStatement.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`skipCheck`](DeclarationStatement.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`symbol`](DeclarationStatement.md#symbol) + +*** + +### typeParameters? + +> `readonly` `optional` **typeParameters**: [`NodeArray`](NodeArray.md)\<[`TypeParameterDeclaration`](TypeParameterDeclaration.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1611 + +#### Inherited from + +[`ClassLikeDeclarationBase`](ClassLikeDeclarationBase.md).[`typeParameters`](ClassLikeDeclarationBase.md#typeparameters) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`forEachChild`](DeclarationStatement.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getChildAt`](DeclarationStatement.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getChildCount`](DeclarationStatement.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getChildren`](DeclarationStatement.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getEnd`](DeclarationStatement.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getFirstToken`](DeclarationStatement.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getFullStart`](DeclarationStatement.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getFullText`](DeclarationStatement.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getFullWidth`](DeclarationStatement.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getLastToken`](DeclarationStatement.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getLeadingTriviaWidth`](DeclarationStatement.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getSourceFile`](DeclarationStatement.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getStart`](DeclarationStatement.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getText`](DeclarationStatement.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getWidth`](DeclarationStatement.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/ClassElement.md b/docs/api_docs/namespaces/ts/interfaces/ClassElement.md new file mode 100644 index 0000000000000000000000000000000000000000..0189cab92d1c9c16dacd92d690dc9687f8f22980 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ClassElement.md @@ -0,0 +1,520 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ClassElement + +# Interface: ClassElement + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1632 + +## Extends + +- [`NamedDeclaration`](NamedDeclaration.md) + +## Extended by + +- [`PropertyDeclaration`](PropertyDeclaration.md) +- [`MethodDeclaration`](MethodDeclaration.md) +- [`ConstructorDeclaration`](ConstructorDeclaration.md) +- [`SemicolonClassElement`](SemicolonClassElement.md) +- [`GetAccessorDeclaration`](GetAccessorDeclaration.md) +- [`SetAccessorDeclaration`](SetAccessorDeclaration.md) +- [`IndexSignatureDeclaration`](IndexSignatureDeclaration.md) +- [`ClassStaticBlockDeclaration`](ClassStaticBlockDeclaration.md) + +## Properties + +### \_classElementBrand + +> **\_classElementBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1633 + +*** + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`_declarationBrand`](NamedDeclaration.md#_declarationbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`decorators`](NamedDeclaration.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`end`](NamedDeclaration.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`flags`](NamedDeclaration.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`SyntaxKind`](../enumerations/SyntaxKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:598 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`kind`](NamedDeclaration.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`locals`](NamedDeclaration.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`modifiers`](NamedDeclaration.md#modifiers) + +*** + +### name? + +> `readonly` `optional` **name**: [`PropertyName`](../type-aliases/PropertyName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1634 + +#### Overrides + +[`NamedDeclaration`](NamedDeclaration.md).[`name`](NamedDeclaration.md#name) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`parent`](NamedDeclaration.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`pos`](NamedDeclaration.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`skipCheck`](NamedDeclaration.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`symbol`](NamedDeclaration.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`forEachChild`](NamedDeclaration.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getChildAt`](NamedDeclaration.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getChildCount`](NamedDeclaration.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getChildren`](NamedDeclaration.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getEnd`](NamedDeclaration.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFirstToken`](NamedDeclaration.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFullStart`](NamedDeclaration.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFullText`](NamedDeclaration.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFullWidth`](NamedDeclaration.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getLastToken`](NamedDeclaration.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getLeadingTriviaWidth`](NamedDeclaration.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getSourceFile`](NamedDeclaration.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getStart`](NamedDeclaration.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getText`](NamedDeclaration.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getWidth`](NamedDeclaration.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/ClassExpression.md b/docs/api_docs/namespaces/ts/interfaces/ClassExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..01e431f08646c270a5cae8cbcff4768c511c558c --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ClassExpression.md @@ -0,0 +1,609 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ClassExpression + +# Interface: ClassExpression + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1627 + +## Extends + +- [`ClassLikeDeclarationBase`](ClassLikeDeclarationBase.md).[`PrimaryExpression`](PrimaryExpression.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`ClassLikeDeclarationBase`](ClassLikeDeclarationBase.md).[`_declarationBrand`](ClassLikeDeclarationBase.md#_declarationbrand) + +*** + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_expressionBrand`](PrimaryExpression.md#_expressionbrand) + +*** + +### \_leftHandSideExpressionBrand + +> **\_leftHandSideExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1086 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_leftHandSideExpressionBrand`](PrimaryExpression.md#_lefthandsideexpressionbrand) + +*** + +### \_memberExpressionBrand + +> **\_memberExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1089 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_memberExpressionBrand`](PrimaryExpression.md#_memberexpressionbrand) + +*** + +### \_primaryExpressionBrand + +> **\_primaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1092 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_primaryExpressionBrand`](PrimaryExpression.md#_primaryexpressionbrand) + +*** + +### \_unaryExpressionBrand + +> **\_unaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1066 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_unaryExpressionBrand`](PrimaryExpression.md#_unaryexpressionbrand) + +*** + +### \_updateExpressionBrand + +> **\_updateExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1071 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_updateExpressionBrand`](PrimaryExpression.md#_updateexpressionbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`decorators`](PrimaryExpression.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`end`](PrimaryExpression.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`flags`](PrimaryExpression.md#flags) + +*** + +### heritageClauses? + +> `readonly` `optional` **heritageClauses**: [`NodeArray`](NodeArray.md)\<[`HeritageClause`](HeritageClause.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1612 + +#### Inherited from + +[`ClassLikeDeclarationBase`](ClassLikeDeclarationBase.md).[`heritageClauses`](ClassLikeDeclarationBase.md#heritageclauses) + +*** + +### kind + +> `readonly` **kind**: [`ClassExpression`](../enumerations/SyntaxKind.md#classexpression) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1628 + +#### Overrides + +[`PrimaryExpression`](PrimaryExpression.md).[`kind`](PrimaryExpression.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`locals`](PrimaryExpression.md#locals) + +*** + +### members + +> `readonly` **members**: [`NodeArray`](NodeArray.md)\<[`ClassElement`](ClassElement.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1613 + +#### Inherited from + +[`ClassLikeDeclarationBase`](ClassLikeDeclarationBase.md).[`members`](ClassLikeDeclarationBase.md#members) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1629 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Overrides + +[`PrimaryExpression`](PrimaryExpression.md).[`modifiers`](PrimaryExpression.md#modifiers) + +*** + +### name? + +> `readonly` `optional` **name**: [`Identifier`](Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1610 + +#### Inherited from + +[`ClassLikeDeclarationBase`](ClassLikeDeclarationBase.md).[`name`](ClassLikeDeclarationBase.md#name) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`parent`](PrimaryExpression.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`pos`](PrimaryExpression.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`skipCheck`](PrimaryExpression.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`symbol`](PrimaryExpression.md#symbol) + +*** + +### typeParameters? + +> `readonly` `optional` **typeParameters**: [`NodeArray`](NodeArray.md)\<[`TypeParameterDeclaration`](TypeParameterDeclaration.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1611 + +#### Inherited from + +[`ClassLikeDeclarationBase`](ClassLikeDeclarationBase.md).[`typeParameters`](ClassLikeDeclarationBase.md#typeparameters) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`forEachChild`](PrimaryExpression.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getChildAt`](PrimaryExpression.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getChildCount`](PrimaryExpression.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getChildren`](PrimaryExpression.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getEnd`](PrimaryExpression.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFirstToken`](PrimaryExpression.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFullStart`](PrimaryExpression.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFullText`](PrimaryExpression.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFullWidth`](PrimaryExpression.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getLastToken`](PrimaryExpression.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getLeadingTriviaWidth`](PrimaryExpression.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getSourceFile`](PrimaryExpression.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getStart`](PrimaryExpression.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getText`](PrimaryExpression.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getWidth`](PrimaryExpression.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/ClassLikeDeclarationBase.md b/docs/api_docs/namespaces/ts/interfaces/ClassLikeDeclarationBase.md new file mode 100644 index 0000000000000000000000000000000000000000..5b26543c0623a466e4844c47cfe368c3e34e569d --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ClassLikeDeclarationBase.md @@ -0,0 +1,531 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ClassLikeDeclarationBase + +# Interface: ClassLikeDeclarationBase + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1608 + +## Extends + +- [`NamedDeclaration`](NamedDeclaration.md).[`JSDocContainer`](JSDocContainer.md) + +## Extended by + +- [`ClassDeclaration`](ClassDeclaration.md) +- [`StructDeclaration`](StructDeclaration.md) +- [`ClassExpression`](ClassExpression.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`_declarationBrand`](NamedDeclaration.md#_declarationbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`decorators`](NamedDeclaration.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`end`](NamedDeclaration.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`flags`](NamedDeclaration.md#flags) + +*** + +### heritageClauses? + +> `readonly` `optional` **heritageClauses**: [`NodeArray`](NodeArray.md)\<[`HeritageClause`](HeritageClause.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1612 + +*** + +### kind + +> `readonly` **kind**: [`ClassExpression`](../enumerations/SyntaxKind.md#classexpression) \| [`ClassDeclaration`](../enumerations/SyntaxKind.md#classdeclaration) \| [`StructDeclaration`](../enumerations/SyntaxKind.md#structdeclaration) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1609 + +#### Overrides + +[`NamedDeclaration`](NamedDeclaration.md).[`kind`](NamedDeclaration.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`locals`](NamedDeclaration.md#locals) + +*** + +### members + +> `readonly` **members**: [`NodeArray`](NodeArray.md)\<[`ClassElement`](ClassElement.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1613 + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`modifiers`](NamedDeclaration.md#modifiers) + +*** + +### name? + +> `readonly` `optional` **name**: [`Identifier`](Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1610 + +#### Overrides + +[`NamedDeclaration`](NamedDeclaration.md).[`name`](NamedDeclaration.md#name) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`parent`](NamedDeclaration.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`pos`](NamedDeclaration.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`skipCheck`](NamedDeclaration.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`symbol`](NamedDeclaration.md#symbol) + +*** + +### typeParameters? + +> `readonly` `optional` **typeParameters**: [`NodeArray`](NodeArray.md)\<[`TypeParameterDeclaration`](TypeParameterDeclaration.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1611 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`forEachChild`](NamedDeclaration.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getChildAt`](NamedDeclaration.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getChildCount`](NamedDeclaration.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getChildren`](NamedDeclaration.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getEnd`](NamedDeclaration.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFirstToken`](NamedDeclaration.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFullStart`](NamedDeclaration.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFullText`](NamedDeclaration.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFullWidth`](NamedDeclaration.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getLastToken`](NamedDeclaration.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getLeadingTriviaWidth`](NamedDeclaration.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getSourceFile`](NamedDeclaration.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getStart`](NamedDeclaration.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getText`](NamedDeclaration.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getWidth`](NamedDeclaration.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/ClassStaticBlockDeclaration.md b/docs/api_docs/namespaces/ts/interfaces/ClassStaticBlockDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..09d80195f3223b72eb20cd8bfb72b134f398f2cf --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ClassStaticBlockDeclaration.md @@ -0,0 +1,521 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ClassStaticBlockDeclaration + +# Interface: ClassStaticBlockDeclaration + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:906 + +## Extends + +- [`ClassElement`](ClassElement.md).[`JSDocContainer`](JSDocContainer.md) + +## Properties + +### \_classElementBrand + +> **\_classElementBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1633 + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`_classElementBrand`](ClassElement.md#_classelementbrand) + +*** + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`_declarationBrand`](ClassElement.md#_declarationbrand) + +*** + +### body + +> `readonly` **body**: [`Block`](Block.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:909 + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`decorators`](ClassElement.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`end`](ClassElement.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`flags`](ClassElement.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`ClassStaticBlockDeclaration`](../enumerations/SyntaxKind.md#classstaticblockdeclaration) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:907 + +#### Overrides + +[`ClassElement`](ClassElement.md).[`kind`](ClassElement.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`locals`](ClassElement.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`modifiers`](ClassElement.md#modifiers) + +*** + +### name? + +> `readonly` `optional` **name**: [`PropertyName`](../type-aliases/PropertyName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1634 + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`name`](ClassElement.md#name) + +*** + +### parent + +> `readonly` **parent**: [`ClassDeclaration`](ClassDeclaration.md) \| [`ClassExpression`](ClassExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:908 + +#### Overrides + +[`ClassElement`](ClassElement.md).[`parent`](ClassElement.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`pos`](ClassElement.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`skipCheck`](ClassElement.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`symbol`](ClassElement.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`forEachChild`](ClassElement.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`getChildAt`](ClassElement.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`getChildCount`](ClassElement.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`getChildren`](ClassElement.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`getEnd`](ClassElement.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`getFirstToken`](ClassElement.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`getFullStart`](ClassElement.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`getFullText`](ClassElement.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`getFullWidth`](ClassElement.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`getLastToken`](ClassElement.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`getLeadingTriviaWidth`](ClassElement.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`getSourceFile`](ClassElement.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`getStart`](ClassElement.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`getText`](ClassElement.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`getWidth`](ClassElement.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/ClassificationInfo.md b/docs/api_docs/namespaces/ts/interfaces/ClassificationInfo.md new file mode 100644 index 0000000000000000000000000000000000000000..66e6759f2e5504771f68eae309614b47b4610b1a --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ClassificationInfo.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ClassificationInfo + +# Interface: ClassificationInfo + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7112 + +## Properties + +### classification + +> **classification**: [`TokenClass`](../enumerations/TokenClass.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7114 + +*** + +### length + +> **length**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7113 diff --git a/docs/api_docs/namespaces/ts/interfaces/ClassificationResult.md b/docs/api_docs/namespaces/ts/interfaces/ClassificationResult.md new file mode 100644 index 0000000000000000000000000000000000000000..999b925a9524ed93201c9d6b89cdb159555c9233 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ClassificationResult.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ClassificationResult + +# Interface: ClassificationResult + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7108 + +## Properties + +### entries + +> **entries**: [`ClassificationInfo`](ClassificationInfo.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7110 + +*** + +### finalLexState + +> **finalLexState**: [`EndOfLineState`](../enumerations/EndOfLineState.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7109 diff --git a/docs/api_docs/namespaces/ts/interfaces/Classifications.md b/docs/api_docs/namespaces/ts/interfaces/Classifications.md new file mode 100644 index 0000000000000000000000000000000000000000..dee393e62c53bcca65fa5a3a335fea690fab0865 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/Classifications.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / Classifications + +# Interface: Classifications + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6514 + +## Properties + +### endOfLineState + +> **endOfLineState**: [`EndOfLineState`](../enumerations/EndOfLineState.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6516 + +*** + +### spans + +> **spans**: `number`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6515 diff --git a/docs/api_docs/namespaces/ts/interfaces/ClassifiedSpan.md b/docs/api_docs/namespaces/ts/interfaces/ClassifiedSpan.md new file mode 100644 index 0000000000000000000000000000000000000000..ae6f9a2b16341594833c0cad0cffc2761deb3675 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ClassifiedSpan.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ClassifiedSpan + +# Interface: ClassifiedSpan + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6518 + +## Properties + +### classificationType + +> **classificationType**: [`ClassificationTypeNames`](../enumerations/ClassificationTypeNames.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6520 + +*** + +### textSpan + +> **textSpan**: [`TextSpan`](TextSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6519 diff --git a/docs/api_docs/namespaces/ts/interfaces/ClassifiedSpan2020.md b/docs/api_docs/namespaces/ts/interfaces/ClassifiedSpan2020.md new file mode 100644 index 0000000000000000000000000000000000000000..5b914a1f159ed64ab03d475003bb9d0d1dfffaa7 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ClassifiedSpan2020.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ClassifiedSpan2020 + +# Interface: ClassifiedSpan2020 + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6522 + +## Properties + +### classificationType + +> **classificationType**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6524 + +*** + +### textSpan + +> **textSpan**: [`TextSpan`](TextSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6523 diff --git a/docs/api_docs/namespaces/ts/interfaces/Classifier.md b/docs/api_docs/namespaces/ts/interfaces/Classifier.md new file mode 100644 index 0000000000000000000000000000000000000000..03abf6db89c61361a8ef05fc3a046ea43e0f7d8a --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/Classifier.md @@ -0,0 +1,85 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / Classifier + +# Interface: Classifier + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7116 + +## Methods + +### ~~getClassificationsForLine()~~ + +> **getClassificationsForLine**(`text`, `lexState`, `syntacticClassifierAbsent`): [`ClassificationResult`](ClassificationResult.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7137 + +Gives lexical classifications of tokens on a line without any syntactic context. +For instance, a token consisting of the text 'string' can be either an identifier +named 'string' or the keyword 'string', however, because this classifier is not aware, +it relies on certain heuristics to give acceptable results. For classifications where +speed trumps accuracy, this function is preferable; however, for true accuracy, the +syntactic classifier is ideal. In fact, in certain editing scenarios, combining the +lexical, syntactic, and semantic classifiers may issue the best user experience. + +#### Parameters + +##### text + +`string` + +The text of a line to classify. + +##### lexState + +[`EndOfLineState`](../enumerations/EndOfLineState.md) + +The state of the lexical classifier at the end of the previous line. + +##### syntacticClassifierAbsent + +`boolean` + +Whether the client is *not* using a syntactic classifier. + If there is no syntactic classifier (syntacticClassifierAbsent=true), + certain heuristics may be used in its place; however, if there is a + syntactic classifier (syntacticClassifierAbsent=false), certain + classifications which may be incorrectly categorized will be given + back as Identifiers in order to allow the syntactic classifier to + subsume the classification. + +#### Returns + +[`ClassificationResult`](ClassificationResult.md) + +#### Deprecated + +Use getLexicalClassifications instead. + +*** + +### getEncodedLexicalClassifications() + +> **getEncodedLexicalClassifications**(`text`, `endOfLineState`, `syntacticClassifierAbsent`): [`Classifications`](Classifications.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7138 + +#### Parameters + +##### text + +`string` + +##### endOfLineState + +[`EndOfLineState`](../enumerations/EndOfLineState.md) + +##### syntacticClassifierAbsent + +`boolean` + +#### Returns + +[`Classifications`](Classifications.md) diff --git a/docs/api_docs/namespaces/ts/interfaces/CodeAction.md b/docs/api_docs/namespaces/ts/interfaces/CodeAction.md new file mode 100644 index 0000000000000000000000000000000000000000..63dc94c8f53cd620fbedd054950d234891cc0583 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/CodeAction.md @@ -0,0 +1,44 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / CodeAction + +# Interface: CodeAction + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6608 + +## Extended by + +- [`CodeFixAction`](CodeFixAction.md) + +## Properties + +### changes + +> **changes**: [`FileTextChanges`](FileTextChanges.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6612 + +Text changes to apply to each file as part of the code action + +*** + +### commands? + +> `optional` **commands**: [`InstallPackageAction`](InstallPackageAction.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6617 + +If the user accepts the code fix, the editor should send the action back in a `applyAction` request. +This allows the language service to have side effects (e.g. installing dependencies) upon a code fix. + +*** + +### description + +> **description**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6610 + +Description of the code action to display in the UI of the editor diff --git a/docs/api_docs/namespaces/ts/interfaces/CodeFixAction.md b/docs/api_docs/namespaces/ts/interfaces/CodeFixAction.md new file mode 100644 index 0000000000000000000000000000000000000000..03d5c8bbfa7fde14b3a5c5cd6b8a876c1af4895a --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/CodeFixAction.md @@ -0,0 +1,85 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / CodeFixAction + +# Interface: CodeFixAction + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6619 + +## Extends + +- [`CodeAction`](CodeAction.md) + +## Properties + +### changes + +> **changes**: [`FileTextChanges`](FileTextChanges.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6612 + +Text changes to apply to each file as part of the code action + +#### Inherited from + +[`CodeAction`](CodeAction.md).[`changes`](CodeAction.md#changes) + +*** + +### commands? + +> `optional` **commands**: [`InstallPackageAction`](InstallPackageAction.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6617 + +If the user accepts the code fix, the editor should send the action back in a `applyAction` request. +This allows the language service to have side effects (e.g. installing dependencies) upon a code fix. + +#### Inherited from + +[`CodeAction`](CodeAction.md).[`commands`](CodeAction.md#commands) + +*** + +### description + +> **description**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6610 + +Description of the code action to display in the UI of the editor + +#### Inherited from + +[`CodeAction`](CodeAction.md).[`description`](CodeAction.md#description) + +*** + +### fixAllDescription? + +> `optional` **fixAllDescription**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6627 + +*** + +### fixId? + +> `optional` **fixId**: `object` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6626 + +If present, one may call 'getCombinedCodeFix' with this fixId. +This may be omitted to indicate that the code fix can't be applied in a group. + +*** + +### fixName + +> **fixName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6621 + +Short name to identify the fix, for use by telemetry. diff --git a/docs/api_docs/namespaces/ts/interfaces/Collection.md b/docs/api_docs/namespaces/ts/interfaces/Collection.md new file mode 100644 index 0000000000000000000000000000000000000000..371d4734213cd3845794b41f8ef614c23d27bd31 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/Collection.md @@ -0,0 +1,104 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / Collection + +# Interface: Collection\ + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:41 + +Common write methods for ES6 Map/Set. + +## Extends + +- [`ReadonlyCollection`](ReadonlyCollection.md)\<`K`\> + +## Extended by + +- [`ESMap`](ESMap.md) +- [`Set`](Set.md) + +## Type Parameters + +• **K** + +## Properties + +### size + +> `readonly` **size**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:36 + +#### Inherited from + +[`ReadonlyCollection`](ReadonlyCollection.md).[`size`](ReadonlyCollection.md#size) + +## Methods + +### clear() + +> **clear**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:43 + +#### Returns + +`void` + +*** + +### delete() + +> **delete**(`key`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:42 + +#### Parameters + +##### key + +`K` + +#### Returns + +`boolean` + +*** + +### has() + +> **has**(`key`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:37 + +#### Parameters + +##### key + +`K` + +#### Returns + +`boolean` + +#### Inherited from + +[`ReadonlyCollection`](ReadonlyCollection.md).[`has`](ReadonlyCollection.md#has) + +*** + +### keys() + +> **keys**(): [`Iterator`](Iterator.md)\<`K`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:38 + +#### Returns + +[`Iterator`](Iterator.md)\<`K`\> + +#### Inherited from + +[`ReadonlyCollection`](ReadonlyCollection.md).[`keys`](ReadonlyCollection.md#keys) diff --git a/docs/api_docs/namespaces/ts/interfaces/CombinedCodeActions.md b/docs/api_docs/namespaces/ts/interfaces/CombinedCodeActions.md new file mode 100644 index 0000000000000000000000000000000000000000..7d99497506e413ccfbe65adf7c91109d913dae26 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/CombinedCodeActions.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / CombinedCodeActions + +# Interface: CombinedCodeActions + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6629 + +## Properties + +### changes + +> **changes**: readonly [`FileTextChanges`](FileTextChanges.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6630 + +*** + +### commands? + +> `optional` **commands**: readonly [`InstallPackageAction`](InstallPackageAction.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6631 diff --git a/docs/api_docs/namespaces/ts/interfaces/CombinedCodeFixScope.md b/docs/api_docs/namespaces/ts/interfaces/CombinedCodeFixScope.md new file mode 100644 index 0000000000000000000000000000000000000000..00d3cc07c07a42e9d4ca6fa8087ba14e2cee5d9d --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/CombinedCodeFixScope.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / CombinedCodeFixScope + +# Interface: CombinedCodeFixScope + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6438 + +## Extended by + +- [`OrganizeImportsArgs`](OrganizeImportsArgs.md) + +## Properties + +### fileName + +> **fileName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6440 + +*** + +### type + +> **type**: `"file"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6439 diff --git a/docs/api_docs/namespaces/ts/interfaces/CommaListExpression.md b/docs/api_docs/namespaces/ts/interfaces/CommaListExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..247dbacaaba5cf5dd960ca54003d76a7c500e507 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/CommaListExpression.md @@ -0,0 +1,499 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / CommaListExpression + +# Interface: CommaListExpression + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1479 + +A list of comma-separated expressions. This node is only created by transformations. + +## Extends + +- [`Expression`](Expression.md) + +## Properties + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`Expression`](Expression.md).[`_expressionBrand`](Expression.md#_expressionbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Expression`](Expression.md).[`decorators`](Expression.md#decorators) + +*** + +### elements + +> `readonly` **elements**: [`NodeArray`](NodeArray.md)\<[`Expression`](Expression.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1481 + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Expression`](Expression.md).[`end`](Expression.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Expression`](Expression.md).[`flags`](Expression.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`CommaListExpression`](../enumerations/SyntaxKind.md#commalistexpression) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1480 + +#### Overrides + +[`Expression`](Expression.md).[`kind`](Expression.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Expression`](Expression.md).[`locals`](Expression.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Expression`](Expression.md).[`modifiers`](Expression.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`Expression`](Expression.md).[`parent`](Expression.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Expression`](Expression.md).[`pos`](Expression.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Expression`](Expression.md).[`skipCheck`](Expression.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Expression`](Expression.md).[`symbol`](Expression.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Expression`](Expression.md).[`forEachChild`](Expression.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Expression`](Expression.md).[`getChildAt`](Expression.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getChildCount`](Expression.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Expression`](Expression.md).[`getChildren`](Expression.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getEnd`](Expression.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Expression`](Expression.md).[`getFirstToken`](Expression.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getFullStart`](Expression.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Expression`](Expression.md).[`getFullText`](Expression.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getFullWidth`](Expression.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Expression`](Expression.md).[`getLastToken`](Expression.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getLeadingTriviaWidth`](Expression.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Expression`](Expression.md).[`getSourceFile`](Expression.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getStart`](Expression.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Expression`](Expression.md).[`getText`](Expression.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getWidth`](Expression.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/CommentRange.md b/docs/api_docs/namespaces/ts/interfaces/CommentRange.md new file mode 100644 index 0000000000000000000000000000000000000000..61136b6651eb80b8de3c77654677f18035f99849 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/CommentRange.md @@ -0,0 +1,57 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / CommentRange + +# Interface: CommentRange + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1846 + +## Extends + +- [`TextRange`](TextRange.md) + +## Extended by + +- [`SynthesizedComment`](SynthesizedComment.md) + +## Properties + +### end + +> **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:99 + +#### Inherited from + +[`TextRange`](TextRange.md).[`end`](TextRange.md#end) + +*** + +### hasTrailingNewLine? + +> `optional` **hasTrailingNewLine**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1847 + +*** + +### kind + +> **kind**: [`CommentKind`](../type-aliases/CommentKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1848 + +*** + +### pos + +> **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:98 + +#### Inherited from + +[`TextRange`](TextRange.md).[`pos`](TextRange.md#pos) diff --git a/docs/api_docs/namespaces/ts/interfaces/CompilerHost.md b/docs/api_docs/namespaces/ts/interfaces/CompilerHost.md new file mode 100644 index 0000000000000000000000000000000000000000..81ef44347873cfbdb458eb9e988a2d6a9db0052c --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/CompilerHost.md @@ -0,0 +1,617 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / CompilerHost + +# Interface: CompilerHost + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3473 + +## Extends + +- [`ModuleResolutionHost`](ModuleResolutionHost.md) + +## Properties + +### writeFile + +> **writeFile**: [`WriteFileCallback`](../type-aliases/WriteFileCallback.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3479 + +## Methods + +### createHash()? + +> `optional` **createHash**(`data`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3497 + +#### Parameters + +##### data + +`string` + +#### Returns + +`string` + +*** + +### directoryExists()? + +> `optional` **directoryExists**(`directoryName`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3343 + +#### Parameters + +##### directoryName + +`string` + +#### Returns + +`boolean` + +#### Inherited from + +[`ModuleResolutionHost`](ModuleResolutionHost.md).[`directoryExists`](ModuleResolutionHost.md#directoryexists) + +*** + +### fileExists() + +> **fileExists**(`fileName`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3340 + +#### Parameters + +##### fileName + +`string` + +#### Returns + +`boolean` + +#### Inherited from + +[`ModuleResolutionHost`](ModuleResolutionHost.md).[`fileExists`](ModuleResolutionHost.md#fileexists) + +*** + +### getCancellationToken()? + +> `optional` **getCancellationToken**(): [`CancellationToken`](CancellationToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3476 + +#### Returns + +[`CancellationToken`](CancellationToken.md) + +*** + +### getCanonicalFileName() + +> **getCanonicalFileName**(`fileName`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3481 + +#### Parameters + +##### fileName + +`string` + +#### Returns + +`string` + +*** + +### getCurrentDirectory() + +> **getCurrentDirectory**(): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3480 + +#### Returns + +`string` + +#### Overrides + +[`ModuleResolutionHost`](ModuleResolutionHost.md).[`getCurrentDirectory`](ModuleResolutionHost.md#getcurrentdirectory) + +*** + +### getDefaultLibFileName() + +> **getDefaultLibFileName**(`options`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3477 + +#### Parameters + +##### options + +[`CompilerOptions`](CompilerOptions.md) + +#### Returns + +`string` + +*** + +### getDefaultLibLocation()? + +> `optional` **getDefaultLibLocation**(): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3478 + +#### Returns + +`string` + +*** + +### getDirectories()? + +> `optional` **getDirectories**(`path`): `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3350 + +#### Parameters + +##### path + +`string` + +#### Returns + +`string`[] + +#### Inherited from + +[`ModuleResolutionHost`](ModuleResolutionHost.md).[`getDirectories`](ModuleResolutionHost.md#getdirectories) + +*** + +### getEnvironmentVariable()? + +> `optional` **getEnvironmentVariable**(`name`): `undefined` \| `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3494 + +#### Parameters + +##### name + +`string` + +#### Returns + +`undefined` \| `string` + +*** + +### getFileCheckedModuleInfo()? + +> `optional` **getFileCheckedModuleInfo**(`containFilePath`): [`FileCheckModuleInfo`](FileCheckModuleInfo.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3511 + +#### Parameters + +##### containFilePath + +`string` + +#### Returns + +[`FileCheckModuleInfo`](FileCheckModuleInfo.md) + +#### Overrides + +[`ModuleResolutionHost`](ModuleResolutionHost.md).[`getFileCheckedModuleInfo`](ModuleResolutionHost.md#getfilecheckedmoduleinfo) + +*** + +### getJsDocNodeCheckedConfig()? + +> `optional` **getJsDocNodeCheckedConfig**(`jsDocFileCheckInfo`, `symbolSourceFilePath`): [`JsDocNodeCheckConfig`](JsDocNodeCheckConfig.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3504 + +get tagName where need to be determined based on the file path + +#### Parameters + +##### jsDocFileCheckInfo + +[`FileCheckModuleInfo`](FileCheckModuleInfo.md) + +filePath + +##### symbolSourceFilePath + +`string` + +filePath + +#### Returns + +[`JsDocNodeCheckConfig`](JsDocNodeCheckConfig.md) + +#### Overrides + +[`ModuleResolutionHost`](ModuleResolutionHost.md).[`getJsDocNodeCheckedConfig`](ModuleResolutionHost.md#getjsdocnodecheckedconfig) + +*** + +### getJsDocNodeConditionCheckedResult()? + +> `optional` **getJsDocNodeConditionCheckedResult**(`jsDocFileCheckedInfo`, `jsDocs`): [`ConditionCheckResult`](ConditionCheckResult.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3510 + +get checked results based on the file path and jsDocs + +#### Parameters + +##### jsDocFileCheckedInfo + +[`FileCheckModuleInfo`](FileCheckModuleInfo.md) + +##### jsDocs + +[`JsDocTagInfo`](JsDocTagInfo.md)[] + +#### Returns + +[`ConditionCheckResult`](ConditionCheckResult.md) + +#### Overrides + +[`ModuleResolutionHost`](ModuleResolutionHost.md).[`getJsDocNodeConditionCheckedResult`](ModuleResolutionHost.md#getjsdocnodeconditioncheckedresult) + +*** + +### getLastCompiledProgram()? + +> `optional` **getLastCompiledProgram**(): [`Program`](Program.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3512 + +#### Returns + +[`Program`](Program.md) + +*** + +### getModuleResolutionCache()? + +> `optional` **getModuleResolutionCache**(): `undefined` \| [`ModuleResolutionCache`](ModuleResolutionCache.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3489 + +Returns the module resolution cache used by a provided `resolveModuleNames` implementation so that any non-name module resolution operations (eg, package.json lookup) can reuse it + +#### Returns + +`undefined` \| [`ModuleResolutionCache`](ModuleResolutionCache.md) + +*** + +### getNewLine() + +> **getNewLine**(): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3483 + +#### Returns + +`string` + +*** + +### getParsedCommandLine()? + +> `optional` **getParsedCommandLine**(`fileName`): `undefined` \| [`ParsedCommandLine`](ParsedCommandLine.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3498 + +#### Parameters + +##### fileName + +`string` + +#### Returns + +`undefined` \| [`ParsedCommandLine`](ParsedCommandLine.md) + +*** + +### getSourceFile() + +> **getSourceFile**(`fileName`, `languageVersionOrOptions`, `onError`?, `shouldCreateNewSourceFile`?): `undefined` \| [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3474 + +#### Parameters + +##### fileName + +`string` + +##### languageVersionOrOptions + +[`ScriptTarget`](../enumerations/ScriptTarget.md) | [`CreateSourceFileOptions`](CreateSourceFileOptions.md) + +##### onError? + +(`message`) => `void` + +##### shouldCreateNewSourceFile? + +`boolean` + +#### Returns + +`undefined` \| [`SourceFile`](SourceFile.md) + +*** + +### getSourceFileByPath()? + +> `optional` **getSourceFileByPath**(`fileName`, `path`, `languageVersionOrOptions`, `onError`?, `shouldCreateNewSourceFile`?): `undefined` \| [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3475 + +#### Parameters + +##### fileName + +`string` + +##### path + +[`Path`](../type-aliases/Path.md) + +##### languageVersionOrOptions + +[`ScriptTarget`](../enumerations/ScriptTarget.md) | [`CreateSourceFileOptions`](CreateSourceFileOptions.md) + +##### onError? + +(`message`) => `void` + +##### shouldCreateNewSourceFile? + +`boolean` + +#### Returns + +`undefined` \| [`SourceFile`](SourceFile.md) + +*** + +### hasInvalidatedResolutions()? + +> `optional` **hasInvalidatedResolutions**(`filePath`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3496 + +If provided along with custom resolveModuleNames or resolveTypeReferenceDirectives, used to determine if unchanged file path needs to re-resolve modules/type reference directives + +#### Parameters + +##### filePath + +[`Path`](../type-aliases/Path.md) + +#### Returns + +`boolean` + +*** + +### readDirectory()? + +> `optional` **readDirectory**(`rootDir`, `extensions`, `excludes`, `includes`, `depth`?): `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3484 + +#### Parameters + +##### rootDir + +`string` + +##### extensions + +readonly `string`[] + +##### excludes + +`undefined` | readonly `string`[] + +##### includes + +readonly `string`[] + +##### depth? + +`number` + +#### Returns + +`string`[] + +*** + +### readFile() + +> **readFile**(`fileName`): `undefined` \| `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3341 + +#### Parameters + +##### fileName + +`string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[`ModuleResolutionHost`](ModuleResolutionHost.md).[`readFile`](ModuleResolutionHost.md#readfile) + +*** + +### realpath()? + +> `optional` **realpath**(`path`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3348 + +Resolve a symbolic link. + +#### Parameters + +##### path + +`string` + +#### Returns + +`string` + +#### See + +https://nodejs.org/api/fs.html#fs_fs_realpathsync_path_options + +#### Inherited from + +[`ModuleResolutionHost`](ModuleResolutionHost.md).[`realpath`](ModuleResolutionHost.md#realpath) + +*** + +### resolveModuleNames()? + +> `optional` **resolveModuleNames**(`moduleNames`, `containingFile`, `reusedNames`, `redirectedReference`, `options`, `containingSourceFile`?): (`undefined` \| [`ResolvedModule`](ResolvedModule.md))[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3485 + +#### Parameters + +##### moduleNames + +`string`[] + +##### containingFile + +`string` + +##### reusedNames + +`undefined` | `string`[] + +##### redirectedReference + +`undefined` | [`ResolvedProjectReference`](ResolvedProjectReference.md) + +##### options + +[`CompilerOptions`](CompilerOptions.md) + +##### containingSourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +(`undefined` \| [`ResolvedModule`](ResolvedModule.md))[] + +*** + +### resolveTypeReferenceDirectives()? + +> `optional` **resolveTypeReferenceDirectives**(`typeReferenceDirectiveNames`, `containingFile`, `redirectedReference`, `options`, `containingFileMode`?): (`undefined` \| [`ResolvedTypeReferenceDirective`](ResolvedTypeReferenceDirective.md))[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3493 + +This method is a companion for 'resolveModuleNames' and is used to resolve 'types' references to actual type declaration files + +#### Parameters + +##### typeReferenceDirectiveNames + +`string`[] | readonly [`FileReference`](FileReference.md)[] + +##### containingFile + +`string` + +##### redirectedReference + +`undefined` | [`ResolvedProjectReference`](ResolvedProjectReference.md) + +##### options + +[`CompilerOptions`](CompilerOptions.md) + +##### containingFileMode? + +[`CommonJS`](../enumerations/ModuleKind.md#commonjs) | [`ESNext`](../enumerations/ModuleKind.md#esnext) + +#### Returns + +(`undefined` \| [`ResolvedTypeReferenceDirective`](ResolvedTypeReferenceDirective.md))[] + +*** + +### trace()? + +> `optional` **trace**(`s`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3342 + +#### Parameters + +##### s + +`string` + +#### Returns + +`void` + +#### Inherited from + +[`ModuleResolutionHost`](ModuleResolutionHost.md).[`trace`](ModuleResolutionHost.md#trace) + +*** + +### useCaseSensitiveFileNames() + +> **useCaseSensitiveFileNames**(): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3482 + +#### Returns + +`boolean` + +#### Overrides + +`ModuleResolutionHost.useCaseSensitiveFileNames` diff --git a/docs/api_docs/namespaces/ts/interfaces/CompilerOptions.md b/docs/api_docs/namespaces/ts/interfaces/CompilerOptions.md new file mode 100644 index 0000000000000000000000000000000000000000..df779a118bbadfb3a1d274af8dee76555dbe6995 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/CompilerOptions.md @@ -0,0 +1,839 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / CompilerOptions + +# Interface: CompilerOptions + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3074 + +## Indexable + +\[`option`: `string`\]: [`CompilerOptionsValue`](../type-aliases/CompilerOptionsValue.md) \| [`TsConfigSourceFile`](TsConfigSourceFile.md) + +## Properties + +### allowJs? + +> `optional` **allowJs**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3075 + +*** + +### allowSyntheticDefaultImports? + +> `optional` **allowSyntheticDefaultImports**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3076 + +*** + +### allowUmdGlobalAccess? + +> `optional` **allowUmdGlobalAccess**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3077 + +*** + +### allowUnreachableCode? + +> `optional` **allowUnreachableCode**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3078 + +*** + +### allowUnusedLabels? + +> `optional` **allowUnusedLabels**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3079 + +*** + +### alwaysStrict? + +> `optional` **alwaysStrict**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3080 + +*** + +### assumeChangesOnlyAffectDirectDependencies? + +> `optional` **assumeChangesOnlyAffectDirectDependencies**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3127 + +*** + +### baseUrl? + +> `optional` **baseUrl**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3081 + +*** + +### charset? + +> `optional` **charset**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3082 + +*** + +### checkJs? + +> `optional` **checkJs**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3083 + +*** + +### compatibleSdkVersion? + +> `optional` **compatibleSdkVersion**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3177 + +*** + +### compatibleSdkVersionStage? + +> `optional` **compatibleSdkVersionStage**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3178 + +*** + +### composite? + +> `optional` **composite**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3144 + +*** + +### declaration? + +> `optional` **declaration**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3084 + +*** + +### declarationDir? + +> `optional` **declarationDir**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3087 + +*** + +### declarationMap? + +> `optional` **declarationMap**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3085 + +*** + +### disableReferencedProjectLoad? + +> `optional` **disableReferencedProjectLoad**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3091 + +*** + +### disableSizeLimit? + +> `optional` **disableSizeLimit**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3088 + +*** + +### disableSolutionSearching? + +> `optional` **disableSolutionSearching**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3090 + +*** + +### disableSourceOfProjectReferenceRedirect? + +> `optional` **disableSourceOfProjectReferenceRedirect**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3089 + +*** + +### downlevelIteration? + +> `optional` **downlevelIteration**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3092 + +*** + +### emitBOM? + +> `optional` **emitBOM**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3093 + +*** + +### emitDeclarationOnly? + +> `optional` **emitDeclarationOnly**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3086 + +*** + +### emitDecoratorMetadata? + +> `optional` **emitDecoratorMetadata**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3094 + +*** + +### emitNodeModulesFiles? + +> `optional` **emitNodeModulesFiles**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3173 + +*** + +### esModuleInterop? + +> `optional` **esModuleInterop**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3169 + +*** + +### ets? + +> `optional` **ets**: [`EtsOptions`](EtsOptions.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3171 + +*** + +### etsLoaderPath? + +> `optional` **etsLoaderPath**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3174 + +*** + +### exactOptionalPropertyTypes? + +> `optional` **exactOptionalPropertyTypes**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3095 + +*** + +### experimentalDecorators? + +> `optional` **experimentalDecorators**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3096 + +*** + +### forceConsistentCasingInFileNames? + +> `optional` **forceConsistentCasingInFileNames**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3097 + +*** + +### importHelpers? + +> `optional` **importHelpers**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3098 + +*** + +### importsNotUsedAsValues? + +> `optional` **importsNotUsedAsValues**: [`ImportsNotUsedAsValues`](../enumerations/ImportsNotUsedAsValues.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3099 + +*** + +### incremental? + +> `optional` **incremental**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3145 + +*** + +### inlineSourceMap? + +> `optional` **inlineSourceMap**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3100 + +*** + +### inlineSources? + +> `optional` **inlineSources**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3101 + +*** + +### isolatedModules? + +> `optional` **isolatedModules**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3102 + +*** + +### jsx? + +> `optional` **jsx**: [`JsxEmit`](../enumerations/JsxEmit.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3103 + +*** + +### jsxFactory? + +> `optional` **jsxFactory**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3141 + +*** + +### jsxFragmentFactory? + +> `optional` **jsxFragmentFactory**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3142 + +*** + +### jsxImportSource? + +> `optional` **jsxImportSource**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3143 + +*** + +### keyofStringsOnly? + +> `optional` **keyofStringsOnly**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3104 + +*** + +### lib? + +> `optional` **lib**: `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3105 + +*** + +### locale? + +> `optional` **locale**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3106 + +*** + +### mapRoot? + +> `optional` **mapRoot**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3107 + +*** + +### maxNodeModuleJsDepth? + +> `optional` **maxNodeModuleJsDepth**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3108 + +*** + +### module? + +> `optional` **module**: [`ModuleKind`](../enumerations/ModuleKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3109 + +*** + +### moduleDetection? + +> `optional` **moduleDetection**: [`ModuleDetectionKind`](../enumerations/ModuleDetectionKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3112 + +*** + +### moduleResolution? + +> `optional` **moduleResolution**: [`ModuleResolutionKind`](../enumerations/ModuleResolutionKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3110 + +*** + +### moduleSuffixes? + +> `optional` **moduleSuffixes**: `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3111 + +*** + +### newLine? + +> `optional` **newLine**: [`NewLineKind`](../enumerations/NewLineKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3113 + +*** + +### noEmit? + +> `optional` **noEmit**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3114 + +*** + +### noEmitHelpers? + +> `optional` **noEmitHelpers**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3115 + +*** + +### noEmitOnError? + +> `optional` **noEmitOnError**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3116 + +*** + +### noErrorTruncation? + +> `optional` **noErrorTruncation**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3117 + +*** + +### noFallthroughCasesInSwitch? + +> `optional` **noFallthroughCasesInSwitch**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3118 + +*** + +### noImplicitAny? + +> `optional` **noImplicitAny**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3119 + +*** + +### noImplicitOverride? + +> `optional` **noImplicitOverride**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3136 + +*** + +### noImplicitReturns? + +> `optional` **noImplicitReturns**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3120 + +*** + +### noImplicitThis? + +> `optional` **noImplicitThis**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3121 + +*** + +### noImplicitUseStrict? + +> `optional` **noImplicitUseStrict**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3125 + +*** + +### noLib? + +> `optional` **noLib**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3128 + +*** + +### noPropertyAccessFromIndexSignature? + +> `optional` **noPropertyAccessFromIndexSignature**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3126 + +*** + +### noResolve? + +> `optional` **noResolve**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3129 + +*** + +### noStrictGenericChecks? + +> `optional` **noStrictGenericChecks**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3122 + +*** + +### noUncheckedIndexedAccess? + +> `optional` **noUncheckedIndexedAccess**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3130 + +*** + +### noUnusedLocals? + +> `optional` **noUnusedLocals**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3123 + +*** + +### noUnusedParameters? + +> `optional` **noUnusedParameters**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3124 + +*** + +### out? + +> `optional` **out**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3131 + +*** + +### outDir? + +> `optional` **outDir**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3132 + +*** + +### outFile? + +> `optional` **outFile**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3133 + +*** + +### packageManagerType? + +> `optional` **packageManagerType**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3172 + +*** + +### paths? + +> `optional` **paths**: [`MapLike`](MapLike.md)\<`string`[]\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3134 + +*** + +### preserveConstEnums? + +> `optional` **preserveConstEnums**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3135 + +*** + +### preserveSymlinks? + +> `optional` **preserveSymlinks**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3137 + +*** + +### preserveValueImports? + +> `optional` **preserveValueImports**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3138 + +*** + +### project? + +> `optional` **project**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3139 + +*** + +### reactNamespace? + +> `optional` **reactNamespace**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3140 + +*** + +### removeComments? + +> `optional` **removeComments**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3147 + +*** + +### resolveJsonModule? + +> `optional` **resolveJsonModule**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3165 + +*** + +### rootDir? + +> `optional` **rootDir**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3148 + +*** + +### rootDirs? + +> `optional` **rootDirs**: `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3149 + +*** + +### skipDefaultLibCheck? + +> `optional` **skipDefaultLibCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3151 + +*** + +### skipLibCheck? + +> `optional` **skipLibCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3150 + +*** + +### skipPathsInKeyForCompilationSettings? + +> `optional` **skipPathsInKeyForCompilationSettings**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3176 + +*** + +### sourceMap? + +> `optional` **sourceMap**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3152 + +*** + +### sourceRoot? + +> `optional` **sourceRoot**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3153 + +*** + +### strict? + +> `optional` **strict**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3154 + +*** + +### strictBindCallApply? + +> `optional` **strictBindCallApply**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3156 + +*** + +### strictFunctionTypes? + +> `optional` **strictFunctionTypes**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3155 + +*** + +### strictNullChecks? + +> `optional` **strictNullChecks**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3157 + +*** + +### strictPropertyInitialization? + +> `optional` **strictPropertyInitialization**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3158 + +*** + +### stripInternal? + +> `optional` **stripInternal**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3159 + +*** + +### suppressExcessPropertyErrors? + +> `optional` **suppressExcessPropertyErrors**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3160 + +*** + +### suppressImplicitAnyIndexErrors? + +> `optional` **suppressImplicitAnyIndexErrors**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3161 + +*** + +### target? + +> `optional` **target**: [`ScriptTarget`](../enumerations/ScriptTarget.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3162 + +*** + +### traceResolution? + +> `optional` **traceResolution**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3163 + +*** + +### tsBuildInfoFile? + +> `optional` **tsBuildInfoFile**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3146 + +*** + +### tsImportSendableEnable? + +> `optional` **tsImportSendableEnable**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3175 + +*** + +### typeRoots? + +> `optional` **typeRoots**: `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3168 + +Paths used to compute primary types search locations + +*** + +### types? + +> `optional` **types**: `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3166 + +*** + +### useDefineForClassFields? + +> `optional` **useDefineForClassFields**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3170 + +*** + +### useUnknownInCatchVariables? + +> `optional` **useUnknownInCatchVariables**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3164 diff --git a/docs/api_docs/namespaces/ts/interfaces/CompletionEntry.md b/docs/api_docs/namespaces/ts/interfaces/CompletionEntry.md new file mode 100644 index 0000000000000000000000000000000000000000..406064ad51a6e0ade1a582475d2d5a12f5c79cb5 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/CompletionEntry.md @@ -0,0 +1,164 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / CompletionEntry + +# Interface: CompletionEntry + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7006 + +## Properties + +### data? + +> `optional` **data**: [`CompletionEntryData`](../type-aliases/CompletionEntryData.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7035 + +A property to be sent back to TS Server in the CompletionDetailsRequest, along with `name`, +that allows TS Server to look up the symbol represented by the completion item, disambiguating +items with the same name. Currently only defined for auto-import completions, but the type is +`unknown` in the protocol, so it can be changed as needed to support other kinds of completions. +The presence of this property should generally not be used to assume that this completion entry +is an auto-import. + +*** + +### displayParts? + +> `optional` **displayParts**: [`SymbolDisplayPart`](SymbolDisplayPart.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7037 + +*** + +### hasAction? + +> `optional` **hasAction**: `true` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7019 + +*** + +### insertText? + +> `optional` **insertText**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7011 + +*** + +### isFromUncheckedFile? + +> `optional` **isFromUncheckedFile**: `true` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7024 + +*** + +### isImportStatementCompletion? + +> `optional` **isImportStatementCompletion**: `true` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7026 + +*** + +### isPackageJsonImport? + +> `optional` **isPackageJsonImport**: `true` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7025 + +*** + +### isRecommended? + +> `optional` **isRecommended**: `true` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7023 + +*** + +### isSnippet? + +> `optional` **isSnippet**: `true` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7012 + +*** + +### jsDoc? + +> `optional` **jsDoc**: [`JSDocTagInfo`](JSDocTagInfo-1.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7036 + +*** + +### kind + +> **kind**: [`ScriptElementKind`](../enumerations/ScriptElementKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7008 + +*** + +### kindModifiers? + +> `optional` **kindModifiers**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7009 + +*** + +### labelDetails? + +> `optional` **labelDetails**: [`CompletionEntryLabelDetails`](CompletionEntryLabelDetails.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7022 + +*** + +### name + +> **name**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7007 + +*** + +### replacementSpan? + +> `optional` **replacementSpan**: [`TextSpan`](TextSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7018 + +An optional span that indicates the text to be replaced by this completion item. +If present, this span should be used instead of the default one. +It will be set if the required span differs from the one generated by the default replacement behavior. + +*** + +### sortText + +> **sortText**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7010 + +*** + +### source? + +> `optional` **source**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7020 + +*** + +### sourceDisplay? + +> `optional` **sourceDisplay**: [`SymbolDisplayPart`](SymbolDisplayPart.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7021 diff --git a/docs/api_docs/namespaces/ts/interfaces/CompletionEntryDataAutoImport.md b/docs/api_docs/namespaces/ts/interfaces/CompletionEntryDataAutoImport.md new file mode 100644 index 0000000000000000000000000000000000000000..a9425983c2c631e5bcd7c32425e57eec9cfb8b6d --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/CompletionEntryDataAutoImport.md @@ -0,0 +1,63 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / CompletionEntryDataAutoImport + +# Interface: CompletionEntryDataAutoImport + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6984 + +## Extended by + +- [`CompletionEntryDataUnresolved`](CompletionEntryDataUnresolved.md) +- [`CompletionEntryDataResolved`](CompletionEntryDataResolved.md) + +## Properties + +### ambientModuleName? + +> `optional` **ambientModuleName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6994 + +The module name (with quotes stripped) of the export's module symbol, if it was an ambient module + +*** + +### exportName + +> **exportName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6989 + +The name of the property or export in the module's symbol table. Differs from the completion name +in the case of InternalSymbolName.ExportEquals and InternalSymbolName.Default. + +*** + +### fileName? + +> `optional` **fileName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6992 + +The file name declaring the export's module symbol, if it was an external module + +*** + +### isPackageJsonImport? + +> `optional` **isPackageJsonImport**: `true` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6996 + +True if the export was found in the package.json AutoImportProvider + +*** + +### moduleSpecifier? + +> `optional` **moduleSpecifier**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6990 diff --git a/docs/api_docs/namespaces/ts/interfaces/CompletionEntryDataResolved.md b/docs/api_docs/namespaces/ts/interfaces/CompletionEntryDataResolved.md new file mode 100644 index 0000000000000000000000000000000000000000..461187535e5dc7116648785363f51305949a984f --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/CompletionEntryDataResolved.md @@ -0,0 +1,82 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / CompletionEntryDataResolved + +# Interface: CompletionEntryDataResolved + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7002 + +## Extends + +- [`CompletionEntryDataAutoImport`](CompletionEntryDataAutoImport.md) + +## Properties + +### ambientModuleName? + +> `optional` **ambientModuleName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6994 + +The module name (with quotes stripped) of the export's module symbol, if it was an ambient module + +#### Inherited from + +[`CompletionEntryDataAutoImport`](CompletionEntryDataAutoImport.md).[`ambientModuleName`](CompletionEntryDataAutoImport.md#ambientmodulename) + +*** + +### exportName + +> **exportName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6989 + +The name of the property or export in the module's symbol table. Differs from the completion name +in the case of InternalSymbolName.ExportEquals and InternalSymbolName.Default. + +#### Inherited from + +[`CompletionEntryDataAutoImport`](CompletionEntryDataAutoImport.md).[`exportName`](CompletionEntryDataAutoImport.md#exportname) + +*** + +### fileName? + +> `optional` **fileName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6992 + +The file name declaring the export's module symbol, if it was an external module + +#### Inherited from + +[`CompletionEntryDataAutoImport`](CompletionEntryDataAutoImport.md).[`fileName`](CompletionEntryDataAutoImport.md#filename) + +*** + +### isPackageJsonImport? + +> `optional` **isPackageJsonImport**: `true` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6996 + +True if the export was found in the package.json AutoImportProvider + +#### Inherited from + +[`CompletionEntryDataAutoImport`](CompletionEntryDataAutoImport.md).[`isPackageJsonImport`](CompletionEntryDataAutoImport.md#ispackagejsonimport) + +*** + +### moduleSpecifier + +> **moduleSpecifier**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7003 + +#### Overrides + +[`CompletionEntryDataAutoImport`](CompletionEntryDataAutoImport.md).[`moduleSpecifier`](CompletionEntryDataAutoImport.md#modulespecifier) diff --git a/docs/api_docs/namespaces/ts/interfaces/CompletionEntryDataUnresolved.md b/docs/api_docs/namespaces/ts/interfaces/CompletionEntryDataUnresolved.md new file mode 100644 index 0000000000000000000000000000000000000000..b2fc2ac02b48d5597e13b6a04c8281331115db8f --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/CompletionEntryDataUnresolved.md @@ -0,0 +1,92 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / CompletionEntryDataUnresolved + +# Interface: CompletionEntryDataUnresolved + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6998 + +## Extends + +- [`CompletionEntryDataAutoImport`](CompletionEntryDataAutoImport.md) + +## Properties + +### ambientModuleName? + +> `optional` **ambientModuleName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6994 + +The module name (with quotes stripped) of the export's module symbol, if it was an ambient module + +#### Inherited from + +[`CompletionEntryDataAutoImport`](CompletionEntryDataAutoImport.md).[`ambientModuleName`](CompletionEntryDataAutoImport.md#ambientmodulename) + +*** + +### exportMapKey + +> **exportMapKey**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7000 + +The key in the `ExportMapCache` where the completion entry's `SymbolExportInfo[]` is found + +*** + +### exportName + +> **exportName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6989 + +The name of the property or export in the module's symbol table. Differs from the completion name +in the case of InternalSymbolName.ExportEquals and InternalSymbolName.Default. + +#### Inherited from + +[`CompletionEntryDataAutoImport`](CompletionEntryDataAutoImport.md).[`exportName`](CompletionEntryDataAutoImport.md#exportname) + +*** + +### fileName? + +> `optional` **fileName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6992 + +The file name declaring the export's module symbol, if it was an external module + +#### Inherited from + +[`CompletionEntryDataAutoImport`](CompletionEntryDataAutoImport.md).[`fileName`](CompletionEntryDataAutoImport.md#filename) + +*** + +### isPackageJsonImport? + +> `optional` **isPackageJsonImport**: `true` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6996 + +True if the export was found in the package.json AutoImportProvider + +#### Inherited from + +[`CompletionEntryDataAutoImport`](CompletionEntryDataAutoImport.md).[`isPackageJsonImport`](CompletionEntryDataAutoImport.md#ispackagejsonimport) + +*** + +### moduleSpecifier? + +> `optional` **moduleSpecifier**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6990 + +#### Inherited from + +[`CompletionEntryDataAutoImport`](CompletionEntryDataAutoImport.md).[`moduleSpecifier`](CompletionEntryDataAutoImport.md#modulespecifier) diff --git a/docs/api_docs/namespaces/ts/interfaces/CompletionEntryDetails.md b/docs/api_docs/namespaces/ts/interfaces/CompletionEntryDetails.md new file mode 100644 index 0000000000000000000000000000000000000000..905b50e3b2cb79a35cc2663e63563dba97614eef --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/CompletionEntryDetails.md @@ -0,0 +1,85 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / CompletionEntryDetails + +# Interface: CompletionEntryDetails + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7043 + +## Properties + +### codeActions? + +> `optional` **codeActions**: [`CodeAction`](CodeAction.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7050 + +*** + +### displayParts + +> **displayParts**: [`SymbolDisplayPart`](SymbolDisplayPart.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7047 + +*** + +### documentation? + +> `optional` **documentation**: [`SymbolDisplayPart`](SymbolDisplayPart.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7048 + +*** + +### kind + +> **kind**: [`ScriptElementKind`](../enumerations/ScriptElementKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7045 + +*** + +### kindModifiers + +> **kindModifiers**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7046 + +*** + +### name + +> **name**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7044 + +*** + +### ~~source?~~ + +> `optional` **source**: [`SymbolDisplayPart`](SymbolDisplayPart.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7052 + +#### Deprecated + +Use `sourceDisplay` instead. + +*** + +### sourceDisplay? + +> `optional` **sourceDisplay**: [`SymbolDisplayPart`](SymbolDisplayPart.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7053 + +*** + +### tags? + +> `optional` **tags**: [`JSDocTagInfo`](JSDocTagInfo-1.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7049 diff --git a/docs/api_docs/namespaces/ts/interfaces/CompletionEntryLabelDetails.md b/docs/api_docs/namespaces/ts/interfaces/CompletionEntryLabelDetails.md new file mode 100644 index 0000000000000000000000000000000000000000..215e547933707dba9292cffb1d509afccb2ac648 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/CompletionEntryLabelDetails.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / CompletionEntryLabelDetails + +# Interface: CompletionEntryLabelDetails + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7039 + +## Properties + +### description? + +> `optional` **description**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7041 + +*** + +### detail? + +> `optional` **detail**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7040 diff --git a/docs/api_docs/namespaces/ts/interfaces/CompletionInfo.md b/docs/api_docs/namespaces/ts/interfaces/CompletionInfo.md new file mode 100644 index 0000000000000000000000000000000000000000..bda74fb15d0f5a7e1222928bbb17491177266aac --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/CompletionInfo.md @@ -0,0 +1,77 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / CompletionInfo + +# Interface: CompletionInfo + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6962 + +## Properties + +### entries + +> **entries**: [`CompletionEntry`](CompletionEntry.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6982 + +*** + +### flags? + +> `optional` **flags**: [`CompletionInfoFlags`](../enumerations/CompletionInfoFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6964 + +For performance telemetry. + +*** + +### isGlobalCompletion + +> **isGlobalCompletion**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6966 + +Not true for all global completions. This will be true if the enclosing scope matches a few syntax kinds. See `isSnippetScope`. + +*** + +### isIncomplete? + +> `optional` **isIncomplete**: `true` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6981 + +Indicates to client to continue requesting completions on subsequent keystrokes. + +*** + +### isMemberCompletion + +> **isMemberCompletion**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6967 + +*** + +### isNewIdentifierLocation + +> **isNewIdentifierLocation**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6977 + +true when the current location also allows for a new identifier + +*** + +### optionalReplacementSpan? + +> `optional` **optionalReplacementSpan**: [`TextSpan`](TextSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6973 + +In the absence of `CompletionEntry["replacementSpan"]`, the editor may choose whether to use +this span or its default one. If `CompletionEntry["replacementSpan"]` is defined, that span +must be used to commit that completion entry. diff --git a/docs/api_docs/namespaces/ts/interfaces/ComputedPropertyName.md b/docs/api_docs/namespaces/ts/interfaces/ComputedPropertyName.md new file mode 100644 index 0000000000000000000000000000000000000000..34b4156101774de4d28fdc0d570ae98f2b50c336 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ComputedPropertyName.md @@ -0,0 +1,485 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ComputedPropertyName + +# Interface: ComputedPropertyName + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:707 + +## Extends + +- [`Node`](Node.md) + +## Properties + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`decorators`](Node.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Node`](Node.md).[`end`](Node.md#end) + +*** + +### expression + +> `readonly` **expression**: [`Expression`](Expression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:710 + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Node`](Node.md).[`flags`](Node.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`ComputedPropertyName`](../enumerations/SyntaxKind.md#computedpropertyname) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:708 + +#### Overrides + +[`Node`](Node.md).[`kind`](Node.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Node`](Node.md).[`locals`](Node.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`modifiers`](Node.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Declaration`](Declaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:709 + +#### Overrides + +[`Node`](Node.md).[`parent`](Node.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Node`](Node.md).[`pos`](Node.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Node`](Node.md).[`skipCheck`](Node.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Node`](Node.md).[`symbol`](Node.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Node`](Node.md).[`forEachChild`](Node.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getChildAt`](Node.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getChildCount`](Node.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Node`](Node.md).[`getChildren`](Node.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getEnd`](Node.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getFirstToken`](Node.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullStart`](Node.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getFullText`](Node.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullWidth`](Node.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getLastToken`](Node.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getLeadingTriviaWidth`](Node.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Node`](Node.md).[`getSourceFile`](Node.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getStart`](Node.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getText`](Node.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getWidth`](Node.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/ConditionCheckResult.md b/docs/api_docs/namespaces/ts/interfaces/ConditionCheckResult.md new file mode 100644 index 0000000000000000000000000000000000000000..3cfad8a24662ff7d8ebf26c673463bae75255c6c --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ConditionCheckResult.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ConditionCheckResult + +# Interface: ConditionCheckResult + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3468 + +## Properties + +### message? + +> `optional` **message**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3471 + +*** + +### type? + +> `optional` **type**: [`DiagnosticCategory`](../enumerations/DiagnosticCategory.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3470 + +*** + +### valid + +> **valid**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3469 diff --git a/docs/api_docs/namespaces/ts/interfaces/ConditionalExpression.md b/docs/api_docs/namespaces/ts/interfaces/ConditionalExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..c8ef093431c90bc0dd62aab11e0b2c79a4cf02c4 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ConditionalExpression.md @@ -0,0 +1,529 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ConditionalExpression + +# Interface: ConditionalExpression + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1188 + +## Extends + +- [`Expression`](Expression.md) + +## Properties + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`Expression`](Expression.md).[`_expressionBrand`](Expression.md#_expressionbrand) + +*** + +### colonToken + +> `readonly` **colonToken**: [`ColonToken`](../type-aliases/ColonToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1193 + +*** + +### condition + +> `readonly` **condition**: [`Expression`](Expression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1190 + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Expression`](Expression.md).[`decorators`](Expression.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Expression`](Expression.md).[`end`](Expression.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Expression`](Expression.md).[`flags`](Expression.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`ConditionalExpression`](../enumerations/SyntaxKind.md#conditionalexpression) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1189 + +#### Overrides + +[`Expression`](Expression.md).[`kind`](Expression.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Expression`](Expression.md).[`locals`](Expression.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Expression`](Expression.md).[`modifiers`](Expression.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`Expression`](Expression.md).[`parent`](Expression.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Expression`](Expression.md).[`pos`](Expression.md#pos) + +*** + +### questionToken + +> `readonly` **questionToken**: [`QuestionToken`](../type-aliases/QuestionToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1191 + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Expression`](Expression.md).[`skipCheck`](Expression.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Expression`](Expression.md).[`symbol`](Expression.md#symbol) + +*** + +### whenFalse + +> `readonly` **whenFalse**: [`Expression`](Expression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1194 + +*** + +### whenTrue + +> `readonly` **whenTrue**: [`Expression`](Expression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1192 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Expression`](Expression.md).[`forEachChild`](Expression.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Expression`](Expression.md).[`getChildAt`](Expression.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getChildCount`](Expression.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Expression`](Expression.md).[`getChildren`](Expression.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getEnd`](Expression.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Expression`](Expression.md).[`getFirstToken`](Expression.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getFullStart`](Expression.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Expression`](Expression.md).[`getFullText`](Expression.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getFullWidth`](Expression.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Expression`](Expression.md).[`getLastToken`](Expression.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getLeadingTriviaWidth`](Expression.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Expression`](Expression.md).[`getSourceFile`](Expression.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getStart`](Expression.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Expression`](Expression.md).[`getText`](Expression.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getWidth`](Expression.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/ConditionalRoot.md b/docs/api_docs/namespaces/ts/interfaces/ConditionalRoot.md new file mode 100644 index 0000000000000000000000000000000000000000..c8a4a51d05eec5ea4842b74e65b5cd50e801d5c8 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ConditionalRoot.md @@ -0,0 +1,81 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ConditionalRoot + +# Interface: ConditionalRoot + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2901 + +## Properties + +### aliasSymbol? + +> `optional` **aliasSymbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2909 + +*** + +### aliasTypeArguments? + +> `optional` **aliasTypeArguments**: [`Type`](Type.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2910 + +*** + +### checkType + +> **checkType**: [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2903 + +*** + +### extendsType + +> **extendsType**: [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2904 + +*** + +### inferTypeParameters? + +> `optional` **inferTypeParameters**: [`TypeParameter`](TypeParameter.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2906 + +*** + +### instantiations? + +> `optional` **instantiations**: [`Map`](Map.md)\<[`Type`](Type.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2908 + +*** + +### isDistributive + +> **isDistributive**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2905 + +*** + +### node + +> **node**: [`ConditionalTypeNode`](ConditionalTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2902 + +*** + +### outerTypeParameters? + +> `optional` **outerTypeParameters**: [`TypeParameter`](TypeParameter.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2907 diff --git a/docs/api_docs/namespaces/ts/interfaces/ConditionalType.md b/docs/api_docs/namespaces/ts/interfaces/ConditionalType.md new file mode 100644 index 0000000000000000000000000000000000000000..b6d44520e37c20a4f2fa6a7420c13ce07a6a7437 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ConditionalType.md @@ -0,0 +1,487 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ConditionalType + +# Interface: ConditionalType + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2912 + +## Extends + +- [`InstantiableType`](InstantiableType.md) + +## Properties + +### aliasSymbol? + +> `optional` **aliasSymbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2773 + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`aliasSymbol`](InstantiableType.md#aliassymbol) + +*** + +### aliasTypeArguments? + +> `optional` **aliasTypeArguments**: readonly [`Type`](Type.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2774 + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`aliasTypeArguments`](InstantiableType.md#aliastypearguments) + +*** + +### checkType + +> **checkType**: [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2914 + +*** + +### extendsType + +> **extendsType**: [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2915 + +*** + +### flags + +> **flags**: [`TypeFlags`](../enumerations/TypeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2770 + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`flags`](InstantiableType.md#flags) + +*** + +### pattern? + +> `optional` **pattern**: [`DestructuringPattern`](../type-aliases/DestructuringPattern.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2772 + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`pattern`](InstantiableType.md#pattern) + +*** + +### resolvedFalseType? + +> `optional` **resolvedFalseType**: [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2917 + +*** + +### resolvedTrueType? + +> `optional` **resolvedTrueType**: [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2916 + +*** + +### root + +> **root**: [`ConditionalRoot`](ConditionalRoot.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2913 + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2771 + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`symbol`](InstantiableType.md#symbol) + +## Methods + +### getApparentProperties() + +> **getApparentProperties**(): [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6124 + +#### Returns + +[`Symbol`](Symbol.md)[] + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getApparentProperties`](InstantiableType.md#getapparentproperties) + +*** + +### getBaseTypes() + +> **getBaseTypes**(): `undefined` \| [`BaseType`](../type-aliases/BaseType.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6129 + +#### Returns + +`undefined` \| [`BaseType`](../type-aliases/BaseType.md)[] + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getBaseTypes`](InstantiableType.md#getbasetypes) + +*** + +### getCallSignatures() + +> **getCallSignatures**(): readonly [`Signature`](Signature.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6125 + +#### Returns + +readonly [`Signature`](Signature.md)[] + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getCallSignatures`](InstantiableType.md#getcallsignatures) + +*** + +### getConstraint() + +> **getConstraint**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6131 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getConstraint`](InstantiableType.md#getconstraint) + +*** + +### getConstructSignatures() + +> **getConstructSignatures**(): readonly [`Signature`](Signature.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6126 + +#### Returns + +readonly [`Signature`](Signature.md)[] + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getConstructSignatures`](InstantiableType.md#getconstructsignatures) + +*** + +### getDefault() + +> **getDefault**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6132 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getDefault`](InstantiableType.md#getdefault) + +*** + +### getFlags() + +> **getFlags**(): [`TypeFlags`](../enumerations/TypeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6120 + +#### Returns + +[`TypeFlags`](../enumerations/TypeFlags.md) + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getFlags`](InstantiableType.md#getflags) + +*** + +### getNonNullableType() + +> **getNonNullableType**(): [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6130 + +#### Returns + +[`Type`](Type.md) + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getNonNullableType`](InstantiableType.md#getnonnullabletype) + +*** + +### getNumberIndexType() + +> **getNumberIndexType**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6128 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getNumberIndexType`](InstantiableType.md#getnumberindextype) + +*** + +### getProperties() + +> **getProperties**(): [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6122 + +#### Returns + +[`Symbol`](Symbol.md)[] + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getProperties`](InstantiableType.md#getproperties) + +*** + +### getProperty() + +> **getProperty**(`propertyName`): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6123 + +#### Parameters + +##### propertyName + +`string` + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getProperty`](InstantiableType.md#getproperty) + +*** + +### getStringIndexType() + +> **getStringIndexType**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6127 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getStringIndexType`](InstantiableType.md#getstringindextype) + +*** + +### getSymbol() + +> **getSymbol**(): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6121 + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getSymbol`](InstantiableType.md#getsymbol) + +*** + +### isClass() + +> **isClass**(): `this is InterfaceType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6141 + +#### Returns + +`this is InterfaceType` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isClass`](InstantiableType.md#isclass) + +*** + +### isClassOrInterface() + +> **isClassOrInterface**(): `this is InterfaceType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6140 + +#### Returns + +`this is InterfaceType` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isClassOrInterface`](InstantiableType.md#isclassorinterface) + +*** + +### isIndexType() + +> **isIndexType**(): `this is IndexType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6142 + +#### Returns + +`this is IndexType` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isIndexType`](InstantiableType.md#isindextype) + +*** + +### isIntersection() + +> **isIntersection**(): `this is IntersectionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6134 + +#### Returns + +`this is IntersectionType` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isIntersection`](InstantiableType.md#isintersection) + +*** + +### isLiteral() + +> **isLiteral**(): `this is LiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6136 + +#### Returns + +`this is LiteralType` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isLiteral`](InstantiableType.md#isliteral) + +*** + +### isNumberLiteral() + +> **isNumberLiteral**(): `this is NumberLiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6138 + +#### Returns + +`this is NumberLiteralType` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isNumberLiteral`](InstantiableType.md#isnumberliteral) + +*** + +### isStringLiteral() + +> **isStringLiteral**(): `this is StringLiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6137 + +#### Returns + +`this is StringLiteralType` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isStringLiteral`](InstantiableType.md#isstringliteral) + +*** + +### isTypeParameter() + +> **isTypeParameter**(): `this is TypeParameter` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6139 + +#### Returns + +`this is TypeParameter` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isTypeParameter`](InstantiableType.md#istypeparameter) + +*** + +### isUnion() + +> **isUnion**(): `this is UnionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6133 + +#### Returns + +`this is UnionType` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isUnion`](InstantiableType.md#isunion) + +*** + +### isUnionOrIntersection() + +> **isUnionOrIntersection**(): `this is UnionOrIntersectionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6135 + +#### Returns + +`this is UnionOrIntersectionType` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isUnionOrIntersection`](InstantiableType.md#isunionorintersection) diff --git a/docs/api_docs/namespaces/ts/interfaces/ConditionalTypeNode.md b/docs/api_docs/namespaces/ts/interfaces/ConditionalTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..a876983bcc303a53c1a660f7caa8a1fa135e2f5c --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ConditionalTypeNode.md @@ -0,0 +1,521 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ConditionalTypeNode + +# Interface: ConditionalTypeNode + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1000 + +## Extends + +- [`TypeNode`](TypeNode.md) + +## Properties + +### \_typeNodeBrand + +> **\_typeNodeBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:912 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`_typeNodeBrand`](TypeNode.md#_typenodebrand) + +*** + +### checkType + +> `readonly` **checkType**: [`TypeNode`](TypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1002 + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`decorators`](TypeNode.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`end`](TypeNode.md#end) + +*** + +### extendsType + +> `readonly` **extendsType**: [`TypeNode`](TypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1003 + +*** + +### falseType + +> `readonly` **falseType**: [`TypeNode`](TypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1005 + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`flags`](TypeNode.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`ConditionalType`](../enumerations/SyntaxKind.md#conditionaltype) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1001 + +#### Overrides + +[`TypeNode`](TypeNode.md).[`kind`](TypeNode.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`locals`](TypeNode.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`modifiers`](TypeNode.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`parent`](TypeNode.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`pos`](TypeNode.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`skipCheck`](TypeNode.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`symbol`](TypeNode.md#symbol) + +*** + +### trueType + +> `readonly` **trueType**: [`TypeNode`](TypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1004 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`forEachChild`](TypeNode.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getChildAt`](TypeNode.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getChildCount`](TypeNode.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getChildren`](TypeNode.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getEnd`](TypeNode.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFirstToken`](TypeNode.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFullStart`](TypeNode.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFullText`](TypeNode.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFullWidth`](TypeNode.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getLastToken`](TypeNode.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getLeadingTriviaWidth`](TypeNode.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getSourceFile`](TypeNode.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getStart`](TypeNode.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getText`](TypeNode.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getWidth`](TypeNode.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/ConfigFileDiagnosticsReporter.md b/docs/api_docs/namespaces/ts/interfaces/ConfigFileDiagnosticsReporter.md new file mode 100644 index 0000000000000000000000000000000000000000..746597283450baa0c13b4fc0352bc1a4617398e0 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ConfigFileDiagnosticsReporter.md @@ -0,0 +1,26 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ConfigFileDiagnosticsReporter + +# Interface: ConfigFileDiagnosticsReporter + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5263 + +Reports config file diagnostics + +## Extended by + +- [`ParseConfigFileHost`](ParseConfigFileHost.md) +- [`WatchCompilerHostOfConfigFile`](WatchCompilerHostOfConfigFile.md) + +## Properties + +### onUnRecoverableConfigFileDiagnostic + +> **onUnRecoverableConfigFileDiagnostic**: [`DiagnosticReporter`](../type-aliases/DiagnosticReporter.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5267 + +Reports unrecoverable error when parsing config file diff --git a/docs/api_docs/namespaces/ts/interfaces/ConstructSignatureDeclaration.md b/docs/api_docs/namespaces/ts/interfaces/ConstructSignatureDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..ae8c7678d3ec9bf919a1004d8a4339c854eb7538 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ConstructSignatureDeclaration.md @@ -0,0 +1,561 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ConstructSignatureDeclaration + +# Interface: ConstructSignatureDeclaration + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:742 + +## Extends + +- [`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`TypeElement`](TypeElement.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`_declarationBrand`](TypeElement.md#_declarationbrand) + +*** + +### \_typeElementBrand + +> **\_typeElementBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1637 + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`_typeElementBrand`](TypeElement.md#_typeelementbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`decorators`](TypeElement.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`end`](TypeElement.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`flags`](TypeElement.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`ConstructSignature`](../enumerations/SyntaxKind.md#constructsignature) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:743 + +#### Overrides + +[`TypeElement`](TypeElement.md).[`kind`](TypeElement.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`locals`](TypeElement.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`modifiers`](TypeElement.md#modifiers) + +*** + +### name? + +> `readonly` `optional` **name**: [`PropertyName`](../type-aliases/PropertyName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:733 + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`name`](TypeElement.md#name) + +*** + +### parameters + +> `readonly` **parameters**: [`NodeArray`](NodeArray.md)\<[`ParameterDeclaration`](ParameterDeclaration.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:735 + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`parameters`](SignatureDeclarationBase.md#parameters) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`parent`](TypeElement.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`pos`](TypeElement.md#pos) + +*** + +### questionToken? + +> `readonly` `optional` **questionToken**: [`QuestionToken`](../type-aliases/QuestionToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1639 + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`questionToken`](TypeElement.md#questiontoken) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`skipCheck`](TypeElement.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`symbol`](TypeElement.md#symbol) + +*** + +### type? + +> `readonly` `optional` **type**: [`TypeNode`](TypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:736 + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`type`](SignatureDeclarationBase.md#type) + +*** + +### typeParameters? + +> `readonly` `optional` **typeParameters**: [`NodeArray`](NodeArray.md)\<[`TypeParameterDeclaration`](TypeParameterDeclaration.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:734 + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`typeParameters`](SignatureDeclarationBase.md#typeparameters) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`forEachChild`](TypeElement.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getChildAt`](TypeElement.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getChildCount`](TypeElement.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getChildren`](TypeElement.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getEnd`](TypeElement.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getFirstToken`](TypeElement.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getFullStart`](TypeElement.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getFullText`](TypeElement.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getFullWidth`](TypeElement.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getLastToken`](TypeElement.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getLeadingTriviaWidth`](TypeElement.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getSourceFile`](TypeElement.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getStart`](TypeElement.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getText`](TypeElement.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getWidth`](TypeElement.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/ConstructorDeclaration.md b/docs/api_docs/namespaces/ts/interfaces/ConstructorDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..a30c0a136f2af985a843e059a51cd5fd830542c7 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ConstructorDeclaration.md @@ -0,0 +1,616 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ConstructorDeclaration + +# Interface: ConstructorDeclaration + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:874 + +Several node kinds share function-like features such as a signature, +a name, and a body. These nodes should extend FunctionLikeDeclarationBase. +Examples: +- FunctionDeclaration +- MethodDeclaration +- AccessorDeclaration + +## Extends + +- [`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`ClassElement`](ClassElement.md).[`JSDocContainer`](JSDocContainer.md) + +## Properties + +### \_classElementBrand + +> **\_classElementBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1633 + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`_classElementBrand`](ClassElement.md#_classelementbrand) + +*** + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`_declarationBrand`](ClassElement.md#_declarationbrand) + +*** + +### \_functionLikeDeclarationBrand + +> **\_functionLikeDeclarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:846 + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`_functionLikeDeclarationBrand`](FunctionLikeDeclarationBase.md#_functionlikedeclarationbrand) + +*** + +### asteriskToken? + +> `readonly` `optional` **asteriskToken**: [`AsteriskToken`](../type-aliases/AsteriskToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:847 + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`asteriskToken`](FunctionLikeDeclarationBase.md#asterisktoken) + +*** + +### body? + +> `readonly` `optional` **body**: [`Block`](Block.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:878 + +#### Overrides + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`body`](FunctionLikeDeclarationBase.md#body) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`decorators`](ClassElement.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`end`](ClassElement.md#end) + +*** + +### exclamationToken? + +> `readonly` `optional` **exclamationToken**: [`ExclamationToken`](../type-aliases/ExclamationToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:849 + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`exclamationToken`](FunctionLikeDeclarationBase.md#exclamationtoken) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`flags`](ClassElement.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`Constructor`](../enumerations/SyntaxKind.md#constructor) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:875 + +#### Overrides + +[`ClassElement`](ClassElement.md).[`kind`](ClassElement.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`locals`](ClassElement.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`Modifier`](../type-aliases/Modifier.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:877 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Overrides + +[`ClassElement`](ClassElement.md).[`modifiers`](ClassElement.md#modifiers) + +*** + +### name? + +> `readonly` `optional` **name**: [`PropertyName`](../type-aliases/PropertyName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:733 + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`name`](ClassElement.md#name) + +*** + +### parameters + +> `readonly` **parameters**: [`NodeArray`](NodeArray.md)\<[`ParameterDeclaration`](ParameterDeclaration.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:735 + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`parameters`](FunctionLikeDeclarationBase.md#parameters) + +*** + +### parent + +> `readonly` **parent**: [`ClassLikeDeclaration`](../type-aliases/ClassLikeDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:876 + +#### Overrides + +[`ClassElement`](ClassElement.md).[`parent`](ClassElement.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`pos`](ClassElement.md#pos) + +*** + +### questionToken? + +> `readonly` `optional` **questionToken**: [`QuestionToken`](../type-aliases/QuestionToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:848 + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`questionToken`](FunctionLikeDeclarationBase.md#questiontoken) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`skipCheck`](ClassElement.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`symbol`](ClassElement.md#symbol) + +*** + +### type? + +> `readonly` `optional` **type**: [`TypeNode`](TypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:736 + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`type`](FunctionLikeDeclarationBase.md#type) + +*** + +### typeParameters? + +> `readonly` `optional` **typeParameters**: [`NodeArray`](NodeArray.md)\<[`TypeParameterDeclaration`](TypeParameterDeclaration.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:734 + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`typeParameters`](FunctionLikeDeclarationBase.md#typeparameters) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`forEachChild`](ClassElement.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`getChildAt`](ClassElement.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`getChildCount`](ClassElement.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`getChildren`](ClassElement.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`getEnd`](ClassElement.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`getFirstToken`](ClassElement.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`getFullStart`](ClassElement.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`getFullText`](ClassElement.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`getFullWidth`](ClassElement.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`getLastToken`](ClassElement.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`getLeadingTriviaWidth`](ClassElement.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`getSourceFile`](ClassElement.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`getStart`](ClassElement.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`getText`](ClassElement.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`getWidth`](ClassElement.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/ConstructorTypeNode.md b/docs/api_docs/namespaces/ts/interfaces/ConstructorTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..1f10f2c484e27c8147151d9c3609dc62c0b92335 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ConstructorTypeNode.md @@ -0,0 +1,549 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ConstructorTypeNode + +# Interface: ConstructorTypeNode + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:941 + +## Extends + +- [`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md).[`_declarationBrand`](FunctionOrConstructorTypeNodeBase.md#_declarationbrand) + +*** + +### \_typeNodeBrand + +> **\_typeNodeBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:912 + +#### Inherited from + +[`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md).[`_typeNodeBrand`](FunctionOrConstructorTypeNodeBase.md#_typenodebrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md).[`decorators`](FunctionOrConstructorTypeNodeBase.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md).[`end`](FunctionOrConstructorTypeNodeBase.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md).[`flags`](FunctionOrConstructorTypeNodeBase.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`ConstructorType`](../enumerations/SyntaxKind.md#constructortype) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:942 + +#### Overrides + +[`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md).[`kind`](FunctionOrConstructorTypeNodeBase.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md).[`locals`](FunctionOrConstructorTypeNodeBase.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`Modifier`](../type-aliases/Modifier.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:943 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Overrides + +[`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md).[`modifiers`](FunctionOrConstructorTypeNodeBase.md#modifiers) + +*** + +### name? + +> `readonly` `optional` **name**: [`PropertyName`](../type-aliases/PropertyName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:733 + +#### Inherited from + +[`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md).[`name`](FunctionOrConstructorTypeNodeBase.md#name) + +*** + +### parameters + +> `readonly` **parameters**: [`NodeArray`](NodeArray.md)\<[`ParameterDeclaration`](ParameterDeclaration.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:735 + +#### Inherited from + +[`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md).[`parameters`](FunctionOrConstructorTypeNodeBase.md#parameters) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md).[`parent`](FunctionOrConstructorTypeNodeBase.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md).[`pos`](FunctionOrConstructorTypeNodeBase.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md).[`skipCheck`](FunctionOrConstructorTypeNodeBase.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md).[`symbol`](FunctionOrConstructorTypeNodeBase.md#symbol) + +*** + +### type + +> `readonly` **type**: [`TypeNode`](TypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:936 + +#### Inherited from + +[`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md).[`type`](FunctionOrConstructorTypeNodeBase.md#type) + +*** + +### typeParameters? + +> `readonly` `optional` **typeParameters**: [`NodeArray`](NodeArray.md)\<[`TypeParameterDeclaration`](TypeParameterDeclaration.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:734 + +#### Inherited from + +[`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md).[`typeParameters`](FunctionOrConstructorTypeNodeBase.md#typeparameters) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md).[`forEachChild`](FunctionOrConstructorTypeNodeBase.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md).[`getChildAt`](FunctionOrConstructorTypeNodeBase.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md).[`getChildCount`](FunctionOrConstructorTypeNodeBase.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md).[`getChildren`](FunctionOrConstructorTypeNodeBase.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md).[`getEnd`](FunctionOrConstructorTypeNodeBase.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md).[`getFirstToken`](FunctionOrConstructorTypeNodeBase.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md).[`getFullStart`](FunctionOrConstructorTypeNodeBase.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md).[`getFullText`](FunctionOrConstructorTypeNodeBase.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md).[`getFullWidth`](FunctionOrConstructorTypeNodeBase.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md).[`getLastToken`](FunctionOrConstructorTypeNodeBase.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md).[`getLeadingTriviaWidth`](FunctionOrConstructorTypeNodeBase.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md).[`getSourceFile`](FunctionOrConstructorTypeNodeBase.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md).[`getStart`](FunctionOrConstructorTypeNodeBase.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md).[`getText`](FunctionOrConstructorTypeNodeBase.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md).[`getWidth`](FunctionOrConstructorTypeNodeBase.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/ContinueStatement.md b/docs/api_docs/namespaces/ts/interfaces/ContinueStatement.md new file mode 100644 index 0000000000000000000000000000000000000000..ba5a79e0e52670166b245f6f689d40adf28a8eba --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ContinueStatement.md @@ -0,0 +1,497 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ContinueStatement + +# Interface: ContinueStatement + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1547 + +## Extends + +- [`Statement`](Statement.md) + +## Properties + +### \_statementBrand + +> **\_statementBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1471 + +#### Inherited from + +[`Statement`](Statement.md).[`_statementBrand`](Statement.md#_statementbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Statement`](Statement.md).[`decorators`](Statement.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Statement`](Statement.md).[`end`](Statement.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Statement`](Statement.md).[`flags`](Statement.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`ContinueStatement`](../enumerations/SyntaxKind.md#continuestatement) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1548 + +#### Overrides + +[`Statement`](Statement.md).[`kind`](Statement.md#kind) + +*** + +### label? + +> `readonly` `optional` **label**: [`Identifier`](Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1549 + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Statement`](Statement.md).[`locals`](Statement.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Statement`](Statement.md).[`modifiers`](Statement.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`Statement`](Statement.md).[`parent`](Statement.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Statement`](Statement.md).[`pos`](Statement.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Statement`](Statement.md).[`skipCheck`](Statement.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Statement`](Statement.md).[`symbol`](Statement.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Statement`](Statement.md).[`forEachChild`](Statement.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getChildAt`](Statement.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getChildCount`](Statement.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Statement`](Statement.md).[`getChildren`](Statement.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getEnd`](Statement.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getFirstToken`](Statement.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getFullStart`](Statement.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Statement`](Statement.md).[`getFullText`](Statement.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getFullWidth`](Statement.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getLastToken`](Statement.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getLeadingTriviaWidth`](Statement.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getSourceFile`](Statement.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getStart`](Statement.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Statement`](Statement.md).[`getText`](Statement.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getWidth`](Statement.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/CoreTransformationContext.md b/docs/api_docs/namespaces/ts/interfaces/CoreTransformationContext.md new file mode 100644 index 0000000000000000000000000000000000000000..80948cde93cfe53bf9dfabc22842b24cec3bf9a6 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/CoreTransformationContext.md @@ -0,0 +1,131 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / CoreTransformationContext + +# Interface: CoreTransformationContext + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4078 + +## Extended by + +- [`TransformationContext`](TransformationContext.md) + +## Properties + +### factory + +> `readonly` **factory**: [`NodeFactory`](NodeFactory.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4079 + +## Methods + +### endLexicalEnvironment() + +> **endLexicalEnvironment**(): `undefined` \| [`Statement`](Statement.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4089 + +Ends a lexical environment, returning any declarations. + +#### Returns + +`undefined` \| [`Statement`](Statement.md)[] + +*** + +### getCompilerOptions() + +> **getCompilerOptions**(): [`CompilerOptions`](CompilerOptions.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4081 + +Gets the compiler options supplied to the transformer. + +#### Returns + +[`CompilerOptions`](CompilerOptions.md) + +*** + +### hoistFunctionDeclaration() + +> **hoistFunctionDeclaration**(`node`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4091 + +Hoists a function declaration to the containing scope. + +#### Parameters + +##### node + +[`FunctionDeclaration`](FunctionDeclaration.md) + +#### Returns + +`void` + +*** + +### hoistVariableDeclaration() + +> **hoistVariableDeclaration**(`node`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4093 + +Hoists a variable declaration to the containing scope. + +#### Parameters + +##### node + +[`Identifier`](Identifier.md) + +#### Returns + +`void` + +*** + +### resumeLexicalEnvironment() + +> **resumeLexicalEnvironment**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4087 + +Resumes a suspended lexical environment, usually before visiting a function body. + +#### Returns + +`void` + +*** + +### startLexicalEnvironment() + +> **startLexicalEnvironment**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4083 + +Starts a new lexical environment. + +#### Returns + +`void` + +*** + +### suspendLexicalEnvironment() + +> **suspendLexicalEnvironment**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4085 + +Suspends the current lexical environment, usually after visiting a parameter list. + +#### Returns + +`void` diff --git a/docs/api_docs/namespaces/ts/interfaces/CreateProgramOptions.md b/docs/api_docs/namespaces/ts/interfaces/CreateProgramOptions.md new file mode 100644 index 0000000000000000000000000000000000000000..127679b7d287e2b3a760a9b3c75a1d8a8ea31135 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/CreateProgramOptions.md @@ -0,0 +1,57 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / CreateProgramOptions + +# Interface: CreateProgramOptions + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3331 + +## Properties + +### configFileParsingDiagnostics? + +> `optional` **configFileParsingDiagnostics**: readonly [`Diagnostic`](Diagnostic.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3337 + +*** + +### host? + +> `optional` **host**: [`CompilerHost`](CompilerHost.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3335 + +*** + +### oldProgram? + +> `optional` **oldProgram**: [`Program`](Program.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3336 + +*** + +### options + +> **options**: [`CompilerOptions`](CompilerOptions.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3333 + +*** + +### projectReferences? + +> `optional` **projectReferences**: readonly [`ProjectReference`](ProjectReference.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3334 + +*** + +### rootNames + +> **rootNames**: readonly `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3332 diff --git a/docs/api_docs/namespaces/ts/interfaces/CreateSourceFileOptions.md b/docs/api_docs/namespaces/ts/interfaces/CreateSourceFileOptions.md new file mode 100644 index 0000000000000000000000000000000000000000..d685403343f047f99ada888aa52c904904c1d587 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/CreateSourceFileOptions.md @@ -0,0 +1,51 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / CreateSourceFileOptions + +# Interface: CreateSourceFileOptions + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5230 + +## Properties + +### impliedNodeFormat? + +> `optional` **impliedNodeFormat**: [`CommonJS`](../enumerations/ModuleKind.md#commonjs) \| [`ESNext`](../enumerations/ModuleKind.md#esnext) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5237 + +Controls the format the file is detected as - this can be derived from only the path +and files on disk, but needs to be done with a module resolution cache in scope to be performant. +This is usually `undefined` for compilations that do not have `moduleResolution` values of `node16` or `nodenext`. + +*** + +### languageVersion + +> **languageVersion**: [`ScriptTarget`](../enumerations/ScriptTarget.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5231 + +*** + +### setExternalModuleIndicator()? + +> `optional` **setExternalModuleIndicator**: (`file`) => `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5243 + +Controls how module-y-ness is set for the given file. Usually the result of calling +`getSetExternalModuleIndicator` on a valid `CompilerOptions` object. If not present, the default +check specified by `isFileProbablyExternalModule` will be used to set the field. + +#### Parameters + +##### file + +[`SourceFile`](SourceFile.md) + +#### Returns + +`void` diff --git a/docs/api_docs/namespaces/ts/interfaces/CustomTransformer.md b/docs/api_docs/namespaces/ts/interfaces/CustomTransformer.md new file mode 100644 index 0000000000000000000000000000000000000000..786fb8c33bd0f870f4ed90b200931226954462cc --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/CustomTransformer.md @@ -0,0 +1,45 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / CustomTransformer + +# Interface: CustomTransformer + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2342 + +## Methods + +### transformBundle() + +> **transformBundle**(`node`): [`Bundle`](Bundle.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2344 + +#### Parameters + +##### node + +[`Bundle`](Bundle.md) + +#### Returns + +[`Bundle`](Bundle.md) + +*** + +### transformSourceFile() + +> **transformSourceFile**(`node`): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2343 + +#### Parameters + +##### node + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`SourceFile`](SourceFile.md) diff --git a/docs/api_docs/namespaces/ts/interfaces/CustomTransformers.md b/docs/api_docs/namespaces/ts/interfaces/CustomTransformers.md new file mode 100644 index 0000000000000000000000000000000000000000..07d25fd73776314fb49f1d76f89021812c190128 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/CustomTransformers.md @@ -0,0 +1,39 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / CustomTransformers + +# Interface: CustomTransformers + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2346 + +## Properties + +### after? + +> `optional` **after**: ([`CustomTransformerFactory`](../type-aliases/CustomTransformerFactory.md) \| [`TransformerFactory`](../type-aliases/TransformerFactory.md)\<[`SourceFile`](SourceFile.md)\>)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2350 + +Custom transformers to evaluate after built-in .js transformations. + +*** + +### afterDeclarations? + +> `optional` **afterDeclarations**: ([`CustomTransformerFactory`](../type-aliases/CustomTransformerFactory.md) \| [`TransformerFactory`](../type-aliases/TransformerFactory.md)\<[`SourceFile`](SourceFile.md) \| [`Bundle`](Bundle.md)\>)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2352 + +Custom transformers to evaluate after built-in .d.ts transformations. + +*** + +### before? + +> `optional` **before**: ([`CustomTransformerFactory`](../type-aliases/CustomTransformerFactory.md) \| [`TransformerFactory`](../type-aliases/TransformerFactory.md)\<[`SourceFile`](SourceFile.md)\>)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2348 + +Custom transformers to evaluate before built-in .js transformations. diff --git a/docs/api_docs/namespaces/ts/interfaces/DebuggerStatement.md b/docs/api_docs/namespaces/ts/interfaces/DebuggerStatement.md new file mode 100644 index 0000000000000000000000000000000000000000..6bcdb57fdc3e28be0a82cb266f410bd910c9167e --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/DebuggerStatement.md @@ -0,0 +1,489 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / DebuggerStatement + +# Interface: DebuggerStatement + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1486 + +## Extends + +- [`Statement`](Statement.md) + +## Properties + +### \_statementBrand + +> **\_statementBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1471 + +#### Inherited from + +[`Statement`](Statement.md).[`_statementBrand`](Statement.md#_statementbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Statement`](Statement.md).[`decorators`](Statement.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Statement`](Statement.md).[`end`](Statement.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Statement`](Statement.md).[`flags`](Statement.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`DebuggerStatement`](../enumerations/SyntaxKind.md#debuggerstatement) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1487 + +#### Overrides + +[`Statement`](Statement.md).[`kind`](Statement.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Statement`](Statement.md).[`locals`](Statement.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Statement`](Statement.md).[`modifiers`](Statement.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`Statement`](Statement.md).[`parent`](Statement.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Statement`](Statement.md).[`pos`](Statement.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Statement`](Statement.md).[`skipCheck`](Statement.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Statement`](Statement.md).[`symbol`](Statement.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Statement`](Statement.md).[`forEachChild`](Statement.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getChildAt`](Statement.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getChildCount`](Statement.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Statement`](Statement.md).[`getChildren`](Statement.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getEnd`](Statement.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getFirstToken`](Statement.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getFullStart`](Statement.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Statement`](Statement.md).[`getFullText`](Statement.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getFullWidth`](Statement.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getLastToken`](Statement.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getLeadingTriviaWidth`](Statement.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getSourceFile`](Statement.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getStart`](Statement.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Statement`](Statement.md).[`getText`](Statement.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getWidth`](Statement.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/Declaration.md b/docs/api_docs/namespaces/ts/interfaces/Declaration.md new file mode 100644 index 0000000000000000000000000000000000000000..35c5ea6b4cf01ed3b93a219a8dd1b5b35eb47afe --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/Declaration.md @@ -0,0 +1,505 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / Declaration + +# Interface: Declaration + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:698 + +## Extends + +- [`Node`](Node.md) + +## Extended by + +- [`Identifier`](Identifier.md) +- [`NamedDeclaration`](NamedDeclaration.md) +- [`TypeLiteralNode`](TypeLiteralNode.md) +- [`NamedTupleMember`](NamedTupleMember.md) +- [`MappedTypeNode`](MappedTypeNode.md) +- [`StringLiteral`](StringLiteral.md) +- [`BinaryExpression`](BinaryExpression.md) +- [`EtsComponentExpression`](EtsComponentExpression.md) +- [`NoSubstitutionTemplateLiteral`](NoSubstitutionTemplateLiteral.md) +- [`NumericLiteral`](NumericLiteral.md) +- [`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md) +- [`CallExpression`](CallExpression.md) +- [`NewExpression`](NewExpression.md) +- [`JSDocEnumTag`](JSDocEnumTag.md) +- [`JSDocSignature`](JSDocSignature.md) +- [`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md) +- [`SourceFile`](SourceFile.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`decorators`](Node.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Node`](Node.md).[`end`](Node.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Node`](Node.md).[`flags`](Node.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`SyntaxKind`](../enumerations/SyntaxKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:598 + +#### Inherited from + +[`Node`](Node.md).[`kind`](Node.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Node`](Node.md).[`locals`](Node.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`modifiers`](Node.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`Node`](Node.md).[`parent`](Node.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Node`](Node.md).[`pos`](Node.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Node`](Node.md).[`skipCheck`](Node.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Node`](Node.md).[`symbol`](Node.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Node`](Node.md).[`forEachChild`](Node.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getChildAt`](Node.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getChildCount`](Node.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Node`](Node.md).[`getChildren`](Node.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getEnd`](Node.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getFirstToken`](Node.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullStart`](Node.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getFullText`](Node.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullWidth`](Node.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getLastToken`](Node.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getLeadingTriviaWidth`](Node.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Node`](Node.md).[`getSourceFile`](Node.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getStart`](Node.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getText`](Node.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getWidth`](Node.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/DeclarationStatement.md b/docs/api_docs/namespaces/ts/interfaces/DeclarationStatement.md new file mode 100644 index 0000000000000000000000000000000000000000..386f666ac8965c8b62d4b8b6f1d16dcfa0ac8f8e --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/DeclarationStatement.md @@ -0,0 +1,528 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / DeclarationStatement + +# Interface: DeclarationStatement + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:704 + +## Extends + +- [`NamedDeclaration`](NamedDeclaration.md).[`Statement`](Statement.md) + +## Extended by + +- [`FunctionDeclaration`](FunctionDeclaration.md) +- [`MissingDeclaration`](MissingDeclaration.md) +- [`ClassDeclaration`](ClassDeclaration.md) +- [`StructDeclaration`](StructDeclaration.md) +- [`InterfaceDeclaration`](InterfaceDeclaration.md) +- [`TypeAliasDeclaration`](TypeAliasDeclaration.md) +- [`EnumDeclaration`](EnumDeclaration.md) +- [`ModuleDeclaration`](ModuleDeclaration.md) +- [`ImportEqualsDeclaration`](ImportEqualsDeclaration.md) +- [`NamespaceExportDeclaration`](NamespaceExportDeclaration.md) +- [`ExportDeclaration`](ExportDeclaration.md) +- [`ExportAssignment`](ExportAssignment.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`_declarationBrand`](NamedDeclaration.md#_declarationbrand) + +*** + +### \_statementBrand + +> **\_statementBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1471 + +#### Inherited from + +[`Statement`](Statement.md).[`_statementBrand`](Statement.md#_statementbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Statement`](Statement.md).[`decorators`](Statement.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Statement`](Statement.md).[`end`](Statement.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Statement`](Statement.md).[`flags`](Statement.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`SyntaxKind`](../enumerations/SyntaxKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:598 + +#### Inherited from + +[`Statement`](Statement.md).[`kind`](Statement.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Statement`](Statement.md).[`locals`](Statement.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Statement`](Statement.md).[`modifiers`](Statement.md#modifiers) + +*** + +### name? + +> `readonly` `optional` **name**: [`Identifier`](Identifier.md) \| [`StringLiteral`](StringLiteral.md) \| [`NumericLiteral`](NumericLiteral.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:705 + +#### Overrides + +[`NamedDeclaration`](NamedDeclaration.md).[`name`](NamedDeclaration.md#name) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`Statement`](Statement.md).[`parent`](Statement.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Statement`](Statement.md).[`pos`](Statement.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Statement`](Statement.md).[`skipCheck`](Statement.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Statement`](Statement.md).[`symbol`](Statement.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Statement`](Statement.md).[`forEachChild`](Statement.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getChildAt`](Statement.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getChildCount`](Statement.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Statement`](Statement.md).[`getChildren`](Statement.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getEnd`](Statement.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getFirstToken`](Statement.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getFullStart`](Statement.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Statement`](Statement.md).[`getFullText`](Statement.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getFullWidth`](Statement.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getLastToken`](Statement.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getLeadingTriviaWidth`](Statement.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getSourceFile`](Statement.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getStart`](Statement.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Statement`](Statement.md).[`getText`](Statement.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getWidth`](Statement.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/Decorator.md b/docs/api_docs/namespaces/ts/interfaces/Decorator.md new file mode 100644 index 0000000000000000000000000000000000000000..b50864639495cb8984cb5e78758567530425a701 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/Decorator.md @@ -0,0 +1,485 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / Decorator + +# Interface: Decorator + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:716 + +## Extends + +- [`Node`](Node.md) + +## Properties + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`decorators`](Node.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Node`](Node.md).[`end`](Node.md#end) + +*** + +### expression + +> `readonly` **expression**: [`LeftHandSideExpression`](LeftHandSideExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:719 + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Node`](Node.md).[`flags`](Node.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`Decorator`](../enumerations/SyntaxKind.md#decorator) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:717 + +#### Overrides + +[`Node`](Node.md).[`kind`](Node.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Node`](Node.md).[`locals`](Node.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`modifiers`](Node.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`NamedDeclaration`](NamedDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:718 + +#### Overrides + +[`Node`](Node.md).[`parent`](Node.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Node`](Node.md).[`pos`](Node.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Node`](Node.md).[`skipCheck`](Node.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Node`](Node.md).[`symbol`](Node.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Node`](Node.md).[`forEachChild`](Node.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getChildAt`](Node.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getChildCount`](Node.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Node`](Node.md).[`getChildren`](Node.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getEnd`](Node.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getFirstToken`](Node.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullStart`](Node.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getFullText`](Node.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullWidth`](Node.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getLastToken`](Node.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getLeadingTriviaWidth`](Node.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Node`](Node.md).[`getSourceFile`](Node.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getStart`](Node.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getText`](Node.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getWidth`](Node.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/DefaultClause.md b/docs/api_docs/namespaces/ts/interfaces/DefaultClause.md new file mode 100644 index 0000000000000000000000000000000000000000..7872a07995062d101012ca9f134370c469d43f67 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/DefaultClause.md @@ -0,0 +1,485 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / DefaultClause + +# Interface: DefaultClause + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1578 + +## Extends + +- [`Node`](Node.md) + +## Properties + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`decorators`](Node.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Node`](Node.md).[`end`](Node.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Node`](Node.md).[`flags`](Node.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`DefaultClause`](../enumerations/SyntaxKind.md#defaultclause) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1579 + +#### Overrides + +[`Node`](Node.md).[`kind`](Node.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Node`](Node.md).[`locals`](Node.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`modifiers`](Node.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`CaseBlock`](CaseBlock.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1580 + +#### Overrides + +[`Node`](Node.md).[`parent`](Node.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Node`](Node.md).[`pos`](Node.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Node`](Node.md).[`skipCheck`](Node.md#skipcheck) + +*** + +### statements + +> `readonly` **statements**: [`NodeArray`](NodeArray.md)\<[`Statement`](Statement.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1581 + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Node`](Node.md).[`symbol`](Node.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Node`](Node.md).[`forEachChild`](Node.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getChildAt`](Node.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getChildCount`](Node.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Node`](Node.md).[`getChildren`](Node.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getEnd`](Node.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getFirstToken`](Node.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullStart`](Node.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getFullText`](Node.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullWidth`](Node.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getLastToken`](Node.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getLeadingTriviaWidth`](Node.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Node`](Node.md).[`getSourceFile`](Node.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getStart`](Node.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getText`](Node.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getWidth`](Node.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/DeferredTypeReference.md b/docs/api_docs/namespaces/ts/interfaces/DeferredTypeReference.md new file mode 100644 index 0000000000000000000000000000000000000000..0e4392c02eee8b05b0e0abe5af6100d7d0673bac --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/DeferredTypeReference.md @@ -0,0 +1,504 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / DeferredTypeReference + +# Interface: DeferredTypeReference + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2848 + +Type references (ObjectFlags.Reference). When a class or interface has type parameters or +a "this" type, references to the class or interface are made using type references. The +typeArguments property specifies the types to substitute for the type parameters of the +class or interface and optionally includes an extra element that specifies the type to +substitute for "this" in the resulting instantiation. When no extra argument is present, +the type reference itself is substituted for "this". The typeArguments property is undefined +if the class or interface has no type parameters and the reference isn't specifying an +explicit "this" argument. + +## Extends + +- [`TypeReference`](TypeReference.md) + +## Properties + +### aliasSymbol? + +> `optional` **aliasSymbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2773 + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`aliasSymbol`](TypeReference.md#aliassymbol) + +*** + +### aliasTypeArguments? + +> `optional` **aliasTypeArguments**: readonly [`Type`](Type.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2774 + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`aliasTypeArguments`](TypeReference.md#aliastypearguments) + +*** + +### flags + +> **flags**: [`TypeFlags`](../enumerations/TypeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2770 + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`flags`](TypeReference.md#flags) + +*** + +### node? + +> `optional` **node**: [`TypeReferenceNode`](TypeReferenceNode.md) \| [`ArrayTypeNode`](ArrayTypeNode.md) \| [`TupleTypeNode`](TupleTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2846 + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`node`](TypeReference.md#node) + +*** + +### objectFlags + +> **objectFlags**: [`ObjectFlags`](../enumerations/ObjectFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2818 + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`objectFlags`](TypeReference.md#objectflags) + +*** + +### pattern? + +> `optional` **pattern**: [`DestructuringPattern`](../type-aliases/DestructuringPattern.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2772 + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`pattern`](TypeReference.md#pattern) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2771 + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`symbol`](TypeReference.md#symbol) + +*** + +### target + +> **target**: [`GenericType`](GenericType.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2845 + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`target`](TypeReference.md#target) + +*** + +### typeArguments? + +> `optional` **typeArguments**: readonly [`Type`](Type.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6145 + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`typeArguments`](TypeReference.md#typearguments) + +## Methods + +### getApparentProperties() + +> **getApparentProperties**(): [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6124 + +#### Returns + +[`Symbol`](Symbol.md)[] + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`getApparentProperties`](TypeReference.md#getapparentproperties) + +*** + +### getBaseTypes() + +> **getBaseTypes**(): `undefined` \| [`BaseType`](../type-aliases/BaseType.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6129 + +#### Returns + +`undefined` \| [`BaseType`](../type-aliases/BaseType.md)[] + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`getBaseTypes`](TypeReference.md#getbasetypes) + +*** + +### getCallSignatures() + +> **getCallSignatures**(): readonly [`Signature`](Signature.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6125 + +#### Returns + +readonly [`Signature`](Signature.md)[] + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`getCallSignatures`](TypeReference.md#getcallsignatures) + +*** + +### getConstraint() + +> **getConstraint**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6131 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`getConstraint`](TypeReference.md#getconstraint) + +*** + +### getConstructSignatures() + +> **getConstructSignatures**(): readonly [`Signature`](Signature.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6126 + +#### Returns + +readonly [`Signature`](Signature.md)[] + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`getConstructSignatures`](TypeReference.md#getconstructsignatures) + +*** + +### getDefault() + +> **getDefault**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6132 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`getDefault`](TypeReference.md#getdefault) + +*** + +### getFlags() + +> **getFlags**(): [`TypeFlags`](../enumerations/TypeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6120 + +#### Returns + +[`TypeFlags`](../enumerations/TypeFlags.md) + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`getFlags`](TypeReference.md#getflags) + +*** + +### getNonNullableType() + +> **getNonNullableType**(): [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6130 + +#### Returns + +[`Type`](Type.md) + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`getNonNullableType`](TypeReference.md#getnonnullabletype) + +*** + +### getNumberIndexType() + +> **getNumberIndexType**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6128 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`getNumberIndexType`](TypeReference.md#getnumberindextype) + +*** + +### getProperties() + +> **getProperties**(): [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6122 + +#### Returns + +[`Symbol`](Symbol.md)[] + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`getProperties`](TypeReference.md#getproperties) + +*** + +### getProperty() + +> **getProperty**(`propertyName`): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6123 + +#### Parameters + +##### propertyName + +`string` + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`getProperty`](TypeReference.md#getproperty) + +*** + +### getStringIndexType() + +> **getStringIndexType**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6127 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`getStringIndexType`](TypeReference.md#getstringindextype) + +*** + +### getSymbol() + +> **getSymbol**(): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6121 + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`getSymbol`](TypeReference.md#getsymbol) + +*** + +### isClass() + +> **isClass**(): `this is InterfaceType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6141 + +#### Returns + +`this is InterfaceType` + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`isClass`](TypeReference.md#isclass) + +*** + +### isClassOrInterface() + +> **isClassOrInterface**(): `this is InterfaceType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6140 + +#### Returns + +`this is InterfaceType` + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`isClassOrInterface`](TypeReference.md#isclassorinterface) + +*** + +### isIndexType() + +> **isIndexType**(): `this is IndexType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6142 + +#### Returns + +`this is IndexType` + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`isIndexType`](TypeReference.md#isindextype) + +*** + +### isIntersection() + +> **isIntersection**(): `this is IntersectionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6134 + +#### Returns + +`this is IntersectionType` + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`isIntersection`](TypeReference.md#isintersection) + +*** + +### isLiteral() + +> **isLiteral**(): `this is LiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6136 + +#### Returns + +`this is LiteralType` + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`isLiteral`](TypeReference.md#isliteral) + +*** + +### isNumberLiteral() + +> **isNumberLiteral**(): `this is NumberLiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6138 + +#### Returns + +`this is NumberLiteralType` + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`isNumberLiteral`](TypeReference.md#isnumberliteral) + +*** + +### isStringLiteral() + +> **isStringLiteral**(): `this is StringLiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6137 + +#### Returns + +`this is StringLiteralType` + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`isStringLiteral`](TypeReference.md#isstringliteral) + +*** + +### isTypeParameter() + +> **isTypeParameter**(): `this is TypeParameter` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6139 + +#### Returns + +`this is TypeParameter` + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`isTypeParameter`](TypeReference.md#istypeparameter) + +*** + +### isUnion() + +> **isUnion**(): `this is UnionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6133 + +#### Returns + +`this is UnionType` + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`isUnion`](TypeReference.md#isunion) + +*** + +### isUnionOrIntersection() + +> **isUnionOrIntersection**(): `this is UnionOrIntersectionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6135 + +#### Returns + +`this is UnionOrIntersectionType` + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`isUnionOrIntersection`](TypeReference.md#isunionorintersection) diff --git a/docs/api_docs/namespaces/ts/interfaces/DefinitionInfo.md b/docs/api_docs/namespaces/ts/interfaces/DefinitionInfo.md new file mode 100644 index 0000000000000000000000000000000000000000..51008b2d1e46c9270ab517521c783e22ed0bd407 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/DefinitionInfo.md @@ -0,0 +1,135 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / DefinitionInfo + +# Interface: DefinitionInfo + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6821 + +## Extends + +- [`DocumentSpan`](DocumentSpan.md) + +## Extended by + +- [`ReferencedSymbolDefinitionInfo`](ReferencedSymbolDefinitionInfo.md) + +## Properties + +### containerKind + +> **containerKind**: [`ScriptElementKind`](../enumerations/ScriptElementKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6824 + +*** + +### containerName + +> **containerName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6825 + +*** + +### contextSpan? + +> `optional` **contextSpan**: [`TextSpan`](TextSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6713 + +If DocumentSpan.textSpan is the span for name of the declaration, +then this is the span for relevant declaration + +#### Inherited from + +[`DocumentSpan`](DocumentSpan.md).[`contextSpan`](DocumentSpan.md#contextspan) + +*** + +### fileName + +> **fileName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6702 + +#### Inherited from + +[`DocumentSpan`](DocumentSpan.md).[`fileName`](DocumentSpan.md#filename) + +*** + +### kind + +> **kind**: [`ScriptElementKind`](../enumerations/ScriptElementKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6822 + +*** + +### name + +> **name**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6823 + +*** + +### originalContextSpan? + +> `optional` **originalContextSpan**: [`TextSpan`](TextSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6714 + +#### Inherited from + +[`DocumentSpan`](DocumentSpan.md).[`originalContextSpan`](DocumentSpan.md#originalcontextspan) + +*** + +### originalFileName? + +> `optional` **originalFileName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6708 + +#### Inherited from + +[`DocumentSpan`](DocumentSpan.md).[`originalFileName`](DocumentSpan.md#originalfilename) + +*** + +### originalTextSpan? + +> `optional` **originalTextSpan**: [`TextSpan`](TextSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6707 + +If the span represents a location that was remapped (e.g. via a .d.ts.map file), +then the original filename and span will be specified here + +#### Inherited from + +[`DocumentSpan`](DocumentSpan.md).[`originalTextSpan`](DocumentSpan.md#originaltextspan) + +*** + +### textSpan + +> **textSpan**: [`TextSpan`](TextSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6701 + +#### Inherited from + +[`DocumentSpan`](DocumentSpan.md).[`textSpan`](DocumentSpan.md#textspan) + +*** + +### unverified? + +> `optional` **unverified**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6826 diff --git a/docs/api_docs/namespaces/ts/interfaces/DefinitionInfoAndBoundSpan.md b/docs/api_docs/namespaces/ts/interfaces/DefinitionInfoAndBoundSpan.md new file mode 100644 index 0000000000000000000000000000000000000000..08c79e8ade1acd22829d6154c8ffb746b2f18b04 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/DefinitionInfoAndBoundSpan.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / DefinitionInfoAndBoundSpan + +# Interface: DefinitionInfoAndBoundSpan + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6828 + +## Properties + +### definitions? + +> `optional` **definitions**: readonly [`DefinitionInfo`](DefinitionInfo.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6829 + +*** + +### textSpan + +> **textSpan**: [`TextSpan`](TextSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6830 diff --git a/docs/api_docs/namespaces/ts/interfaces/DeleteExpression.md b/docs/api_docs/namespaces/ts/interfaces/DeleteExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..af2d6eadfbe4f836e803aa0b85e25c808aba5763 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/DeleteExpression.md @@ -0,0 +1,509 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / DeleteExpression + +# Interface: DeleteExpression + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1113 + +## Extends + +- [`UnaryExpression`](UnaryExpression.md) + +## Properties + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`_expressionBrand`](UnaryExpression.md#_expressionbrand) + +*** + +### \_unaryExpressionBrand + +> **\_unaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1066 + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`_unaryExpressionBrand`](UnaryExpression.md#_unaryexpressionbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`decorators`](UnaryExpression.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`end`](UnaryExpression.md#end) + +*** + +### expression + +> `readonly` **expression**: [`UnaryExpression`](UnaryExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1115 + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`flags`](UnaryExpression.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`DeleteExpression`](../enumerations/SyntaxKind.md#deleteexpression) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1114 + +#### Overrides + +[`UnaryExpression`](UnaryExpression.md).[`kind`](UnaryExpression.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`locals`](UnaryExpression.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`modifiers`](UnaryExpression.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`parent`](UnaryExpression.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`pos`](UnaryExpression.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`skipCheck`](UnaryExpression.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`symbol`](UnaryExpression.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`forEachChild`](UnaryExpression.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getChildAt`](UnaryExpression.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getChildCount`](UnaryExpression.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getChildren`](UnaryExpression.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getEnd`](UnaryExpression.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getFirstToken`](UnaryExpression.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getFullStart`](UnaryExpression.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getFullText`](UnaryExpression.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getFullWidth`](UnaryExpression.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getLastToken`](UnaryExpression.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getLeadingTriviaWidth`](UnaryExpression.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getSourceFile`](UnaryExpression.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getStart`](UnaryExpression.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getText`](UnaryExpression.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getWidth`](UnaryExpression.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/Diagnostic.md b/docs/api_docs/namespaces/ts/interfaces/Diagnostic.md new file mode 100644 index 0000000000000000000000000000000000000000..d2687cc7243c634fd8bb0de0f15970deda784e60 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/Diagnostic.md @@ -0,0 +1,123 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / Diagnostic + +# Interface: Diagnostic + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2994 + +## Extends + +- [`DiagnosticRelatedInformation`](DiagnosticRelatedInformation.md) + +## Extended by + +- [`DiagnosticWithLocation`](DiagnosticWithLocation.md) + +## Properties + +### category + +> **category**: [`DiagnosticCategory`](../enumerations/DiagnosticCategory.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3002 + +#### Inherited from + +[`DiagnosticRelatedInformation`](DiagnosticRelatedInformation.md).[`category`](DiagnosticRelatedInformation.md#category) + +*** + +### code + +> **code**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3003 + +#### Inherited from + +[`DiagnosticRelatedInformation`](DiagnosticRelatedInformation.md).[`code`](DiagnosticRelatedInformation.md#code) + +*** + +### file + +> **file**: `undefined` \| [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3004 + +#### Inherited from + +[`DiagnosticRelatedInformation`](DiagnosticRelatedInformation.md).[`file`](DiagnosticRelatedInformation.md#file) + +*** + +### length + +> **length**: `undefined` \| `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3006 + +#### Inherited from + +[`DiagnosticRelatedInformation`](DiagnosticRelatedInformation.md).[`length`](DiagnosticRelatedInformation.md#length) + +*** + +### messageText + +> **messageText**: `string` \| [`DiagnosticMessageChain`](DiagnosticMessageChain.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3007 + +#### Inherited from + +[`DiagnosticRelatedInformation`](DiagnosticRelatedInformation.md).[`messageText`](DiagnosticRelatedInformation.md#messagetext) + +*** + +### relatedInformation? + +> `optional` **relatedInformation**: [`DiagnosticRelatedInformation`](DiagnosticRelatedInformation.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2999 + +*** + +### reportsDeprecated? + +> `optional` **reportsDeprecated**: `object` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2997 + +*** + +### reportsUnnecessary? + +> `optional` **reportsUnnecessary**: `object` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2996 + +May store more in future. For now, this will simply be `true` to indicate when a diagnostic is an unused-identifier diagnostic. + +*** + +### source? + +> `optional` **source**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2998 + +*** + +### start + +> **start**: `undefined` \| `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3005 + +#### Inherited from + +[`DiagnosticRelatedInformation`](DiagnosticRelatedInformation.md).[`start`](DiagnosticRelatedInformation.md#start) diff --git a/docs/api_docs/namespaces/ts/interfaces/DiagnosticMessage.md b/docs/api_docs/namespaces/ts/interfaces/DiagnosticMessage.md new file mode 100644 index 0000000000000000000000000000000000000000..5bf531200f0eb0cdf09a90eb2cd3860c1cf061ab --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/DiagnosticMessage.md @@ -0,0 +1,57 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / DiagnosticMessage + +# Interface: DiagnosticMessage + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2974 + +## Properties + +### category + +> **category**: [`DiagnosticCategory`](../enumerations/DiagnosticCategory.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2976 + +*** + +### code + +> **code**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2977 + +*** + +### key + +> **key**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2975 + +*** + +### message + +> **message**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2978 + +*** + +### reportsDeprecated? + +> `optional` **reportsDeprecated**: `object` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2980 + +*** + +### reportsUnnecessary? + +> `optional` **reportsUnnecessary**: `object` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2979 diff --git a/docs/api_docs/namespaces/ts/interfaces/DiagnosticMessageChain.md b/docs/api_docs/namespaces/ts/interfaces/DiagnosticMessageChain.md new file mode 100644 index 0000000000000000000000000000000000000000..ca48605475d4e007f9abc1aeb6c2e7ebf6fdc57e --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/DiagnosticMessageChain.md @@ -0,0 +1,46 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / DiagnosticMessageChain + +# Interface: DiagnosticMessageChain + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2988 + +A linked list of formatted diagnostic messages to be used as part of a multiline message. +It is built from the bottom up, leaving the head to be the "main" diagnostic. +While it seems that DiagnosticMessageChain is structurally similar to DiagnosticMessage, +the difference is that messages are all preformatted in DMC. + +## Properties + +### category + +> **category**: [`DiagnosticCategory`](../enumerations/DiagnosticCategory.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2990 + +*** + +### code + +> **code**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2991 + +*** + +### messageText + +> **messageText**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2989 + +*** + +### next? + +> `optional` **next**: [`DiagnosticMessageChain`](DiagnosticMessageChain.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2992 diff --git a/docs/api_docs/namespaces/ts/interfaces/DiagnosticRelatedInformation.md b/docs/api_docs/namespaces/ts/interfaces/DiagnosticRelatedInformation.md new file mode 100644 index 0000000000000000000000000000000000000000..a9e5df59c635cd876f09db78126aeb9c04039e54 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/DiagnosticRelatedInformation.md @@ -0,0 +1,61 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / DiagnosticRelatedInformation + +# Interface: DiagnosticRelatedInformation + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3001 + +## Extended by + +- [`Diagnostic`](Diagnostic.md) + +## Properties + +### category + +> **category**: [`DiagnosticCategory`](../enumerations/DiagnosticCategory.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3002 + +*** + +### code + +> **code**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3003 + +*** + +### file + +> **file**: `undefined` \| [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3004 + +*** + +### length + +> **length**: `undefined` \| `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3006 + +*** + +### messageText + +> **messageText**: `string` \| [`DiagnosticMessageChain`](DiagnosticMessageChain.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3007 + +*** + +### start + +> **start**: `undefined` \| `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3005 diff --git a/docs/api_docs/namespaces/ts/interfaces/DiagnosticWithLocation.md b/docs/api_docs/namespaces/ts/interfaces/DiagnosticWithLocation.md new file mode 100644 index 0000000000000000000000000000000000000000..0f63b27906eb0ca2d17579f35250ea0c84a93daa --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/DiagnosticWithLocation.md @@ -0,0 +1,135 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / DiagnosticWithLocation + +# Interface: DiagnosticWithLocation + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3009 + +## Extends + +- [`Diagnostic`](Diagnostic.md) + +## Properties + +### category + +> **category**: [`DiagnosticCategory`](../enumerations/DiagnosticCategory.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3002 + +#### Inherited from + +[`Diagnostic`](Diagnostic.md).[`category`](Diagnostic.md#category) + +*** + +### code + +> **code**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3003 + +#### Inherited from + +[`Diagnostic`](Diagnostic.md).[`code`](Diagnostic.md#code) + +*** + +### file + +> **file**: [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3010 + +#### Overrides + +[`Diagnostic`](Diagnostic.md).[`file`](Diagnostic.md#file) + +*** + +### length + +> **length**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3012 + +#### Overrides + +[`Diagnostic`](Diagnostic.md).[`length`](Diagnostic.md#length) + +*** + +### messageText + +> **messageText**: `string` \| [`DiagnosticMessageChain`](DiagnosticMessageChain.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3007 + +#### Inherited from + +[`Diagnostic`](Diagnostic.md).[`messageText`](Diagnostic.md#messagetext) + +*** + +### relatedInformation? + +> `optional` **relatedInformation**: [`DiagnosticRelatedInformation`](DiagnosticRelatedInformation.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2999 + +#### Inherited from + +[`Diagnostic`](Diagnostic.md).[`relatedInformation`](Diagnostic.md#relatedinformation) + +*** + +### reportsDeprecated? + +> `optional` **reportsDeprecated**: `object` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2997 + +#### Inherited from + +[`Diagnostic`](Diagnostic.md).[`reportsDeprecated`](Diagnostic.md#reportsdeprecated) + +*** + +### reportsUnnecessary? + +> `optional` **reportsUnnecessary**: `object` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2996 + +May store more in future. For now, this will simply be `true` to indicate when a diagnostic is an unused-identifier diagnostic. + +#### Inherited from + +[`Diagnostic`](Diagnostic.md).[`reportsUnnecessary`](Diagnostic.md#reportsunnecessary) + +*** + +### source? + +> `optional` **source**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2998 + +#### Inherited from + +[`Diagnostic`](Diagnostic.md).[`source`](Diagnostic.md#source) + +*** + +### start + +> **start**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3011 + +#### Overrides + +[`Diagnostic`](Diagnostic.md).[`start`](Diagnostic.md#start) diff --git a/docs/api_docs/namespaces/ts/interfaces/DoStatement.md b/docs/api_docs/namespaces/ts/interfaces/DoStatement.md new file mode 100644 index 0000000000000000000000000000000000000000..fe9a070470ff7bcc247fa2a6787f163a8b1c9b62 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/DoStatement.md @@ -0,0 +1,509 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / DoStatement + +# Interface: DoStatement + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1516 + +## Extends + +- [`IterationStatement`](IterationStatement.md) + +## Properties + +### \_statementBrand + +> **\_statementBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1471 + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`_statementBrand`](IterationStatement.md#_statementbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`decorators`](IterationStatement.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`end`](IterationStatement.md#end) + +*** + +### expression + +> `readonly` **expression**: [`Expression`](Expression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1518 + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`flags`](IterationStatement.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`DoStatement`](../enumerations/SyntaxKind.md#dostatement) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1517 + +#### Overrides + +[`IterationStatement`](IterationStatement.md).[`kind`](IterationStatement.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`locals`](IterationStatement.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`modifiers`](IterationStatement.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`parent`](IterationStatement.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`pos`](IterationStatement.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`skipCheck`](IterationStatement.md#skipcheck) + +*** + +### statement + +> `readonly` **statement**: [`Statement`](Statement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1514 + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`statement`](IterationStatement.md#statement) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`symbol`](IterationStatement.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`forEachChild`](IterationStatement.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getChildAt`](IterationStatement.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getChildCount`](IterationStatement.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getChildren`](IterationStatement.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getEnd`](IterationStatement.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getFirstToken`](IterationStatement.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getFullStart`](IterationStatement.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getFullText`](IterationStatement.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getFullWidth`](IterationStatement.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getLastToken`](IterationStatement.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getLeadingTriviaWidth`](IterationStatement.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getSourceFile`](IterationStatement.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getStart`](IterationStatement.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getText`](IterationStatement.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getWidth`](IterationStatement.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/DocCommentTemplateOptions.md b/docs/api_docs/namespaces/ts/interfaces/DocCommentTemplateOptions.md new file mode 100644 index 0000000000000000000000000000000000000000..a38d25a4dae8ef194b684d4324ff5107dbf28946 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/DocCommentTemplateOptions.md @@ -0,0 +1,17 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / DocCommentTemplateOptions + +# Interface: DocCommentTemplateOptions + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6913 + +## Properties + +### generateReturnInDocTemplate? + +> `readonly` `optional` **generateReturnInDocTemplate**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6914 diff --git a/docs/api_docs/namespaces/ts/interfaces/DocumentHighlights.md b/docs/api_docs/namespaces/ts/interfaces/DocumentHighlights.md new file mode 100644 index 0000000000000000000000000000000000000000..92e58b0c5e6a9b8eec3318fa152ce459d05c3119 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/DocumentHighlights.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / DocumentHighlights + +# Interface: DocumentHighlights + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7316 + +## Properties + +### fileName + +> **fileName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7317 + +*** + +### highlightSpans + +> **highlightSpans**: [`HighlightSpan`](HighlightSpan.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7318 diff --git a/docs/api_docs/namespaces/ts/interfaces/DocumentRegistry.md b/docs/api_docs/namespaces/ts/interfaces/DocumentRegistry.md new file mode 100644 index 0000000000000000000000000000000000000000..58e2956fd5ac800e5602d0ed24cc6d4050df41f4 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/DocumentRegistry.md @@ -0,0 +1,390 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / DocumentRegistry + +# Interface: DocumentRegistry + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7337 + +The document registry represents a store of SourceFile objects that can be shared between +multiple LanguageService instances. A LanguageService instance holds on the SourceFile (AST) +of files in the context. +SourceFile objects account for most of the memory usage by the language service. Sharing +the same DocumentRegistry instance between different instances of LanguageService allow +for more efficient memory utilization since all projects will share at least the library +file (lib.d.ts). + +A more advanced use of the document registry is to serialize sourceFile objects to disk +and re-hydrate them when needed. + +To create a default DocumentRegistry, use createDocumentRegistry to create one, and pass it +to all subsequent createLanguageService calls. + +## Methods + +### acquireDocument() + +> **acquireDocument**(`fileName`, `compilationSettingsOrHost`, `scriptSnapshot`, `version`, `scriptKind`?, `sourceFileOptions`?): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7355 + +Request a stored SourceFile with a given fileName and compilationSettings. +The first call to acquire will call createLanguageServiceSourceFile to generate +the SourceFile if was not found in the registry. + +#### Parameters + +##### fileName + +`string` + +The name of the file requested + +##### compilationSettingsOrHost + +Some compilation settings like target affects the +shape of a the resulting SourceFile. This allows the DocumentRegistry to store +multiple copies of the same file for different compilation settings. A minimal +resolution cache is needed to fully define a source file's shape when +the compilation settings include `module: node16`+, so providing a cache host +object should be preferred. A common host is a language service `ConfiguredProject`. + +[`CompilerOptions`](CompilerOptions.md) | [`MinimalResolutionCacheHost`](MinimalResolutionCacheHost.md) + +##### scriptSnapshot + +[`IScriptSnapshot`](IScriptSnapshot.md) + +Text of the file. Only used if the file was not found +in the registry and a new one was created. + +##### version + +`string` + +Current version of the file. Only used if the file was not found +in the registry and a new one was created. + +##### scriptKind? + +[`ScriptKind`](../enumerations/ScriptKind.md) + +##### sourceFileOptions? + +[`ScriptTarget`](../enumerations/ScriptTarget.md) | [`CreateSourceFileOptions`](CreateSourceFileOptions.md) + +#### Returns + +[`SourceFile`](SourceFile.md) + +*** + +### acquireDocumentWithKey() + +> **acquireDocumentWithKey**(`fileName`, `path`, `compilationSettingsOrHost`, `key`, `scriptSnapshot`, `version`, `scriptKind`?, `sourceFileOptions`?): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7356 + +#### Parameters + +##### fileName + +`string` + +##### path + +[`Path`](../type-aliases/Path.md) + +##### compilationSettingsOrHost + +[`CompilerOptions`](CompilerOptions.md) | [`MinimalResolutionCacheHost`](MinimalResolutionCacheHost.md) + +##### key + +[`DocumentRegistryBucketKey`](../type-aliases/DocumentRegistryBucketKey.md) + +##### scriptSnapshot + +[`IScriptSnapshot`](IScriptSnapshot.md) + +##### version + +`string` + +##### scriptKind? + +[`ScriptKind`](../enumerations/ScriptKind.md) + +##### sourceFileOptions? + +[`ScriptTarget`](../enumerations/ScriptTarget.md) | [`CreateSourceFileOptions`](CreateSourceFileOptions.md) + +#### Returns + +[`SourceFile`](SourceFile.md) + +*** + +### getKeyForCompilationSettings() + +> **getKeyForCompilationSettings**(`settings`): [`DocumentRegistryBucketKey`](../type-aliases/DocumentRegistryBucketKey.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7374 + +#### Parameters + +##### settings + +[`CompilerOptions`](CompilerOptions.md) + +#### Returns + +[`DocumentRegistryBucketKey`](../type-aliases/DocumentRegistryBucketKey.md) + +*** + +### releaseDocument() + +#### Call Signature + +> **releaseDocument**(`fileName`, `compilationSettings`, `scriptKind`?): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7386 + +##### Parameters + +###### fileName + +`string` + +###### compilationSettings + +[`CompilerOptions`](CompilerOptions.md) + +###### scriptKind? + +[`ScriptKind`](../enumerations/ScriptKind.md) + +##### Returns + +`void` + +##### Deprecated + +pass scriptKind and impliedNodeFormat for correctness + +#### Call Signature + +> **releaseDocument**(`fileName`, `compilationSettings`, `scriptKind`, `impliedNodeFormat`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7398 + +Informs the DocumentRegistry that a file is not needed any longer. + +Note: It is not allowed to call release on a SourceFile that was not acquired from +this registry originally. + +##### Parameters + +###### fileName + +`string` + +The name of the file to be released + +###### compilationSettings + +[`CompilerOptions`](CompilerOptions.md) + +The compilation settings used to acquire the file + +###### scriptKind + +[`ScriptKind`](../enumerations/ScriptKind.md) + +The script kind of the file to be released + +###### impliedNodeFormat + +The implied source file format of the file to be released + +`undefined` | [`CommonJS`](../enumerations/ModuleKind.md#commonjs) | [`ESNext`](../enumerations/ModuleKind.md#esnext) + +##### Returns + +`void` + +*** + +### releaseDocumentWithKey() + +#### Call Signature + +> **releaseDocumentWithKey**(`path`, `key`, `scriptKind`?): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7401 + +##### Parameters + +###### path + +[`Path`](../type-aliases/Path.md) + +###### key + +[`DocumentRegistryBucketKey`](../type-aliases/DocumentRegistryBucketKey.md) + +###### scriptKind? + +[`ScriptKind`](../enumerations/ScriptKind.md) + +##### Returns + +`void` + +##### Deprecated + +pass scriptKind for and impliedNodeFormat correctness + +#### Call Signature + +> **releaseDocumentWithKey**(`path`, `key`, `scriptKind`, `impliedNodeFormat`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7402 + +##### Parameters + +###### path + +[`Path`](../type-aliases/Path.md) + +###### key + +[`DocumentRegistryBucketKey`](../type-aliases/DocumentRegistryBucketKey.md) + +###### scriptKind + +[`ScriptKind`](../enumerations/ScriptKind.md) + +###### impliedNodeFormat + +`undefined` | [`CommonJS`](../enumerations/ModuleKind.md#commonjs) | [`ESNext`](../enumerations/ModuleKind.md#esnext) + +##### Returns + +`void` + +*** + +### reportStats() + +> **reportStats**(): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7403 + +#### Returns + +`string` + +*** + +### updateDocument() + +> **updateDocument**(`fileName`, `compilationSettingsOrHost`, `scriptSnapshot`, `version`, `scriptKind`?, `sourceFileOptions`?): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7372 + +Request an updated version of an already existing SourceFile with a given fileName +and compilationSettings. The update will in-turn call updateLanguageServiceSourceFile +to get an updated SourceFile. + +#### Parameters + +##### fileName + +`string` + +The name of the file requested + +##### compilationSettingsOrHost + +Some compilation settings like target affects the +shape of a the resulting SourceFile. This allows the DocumentRegistry to store +multiple copies of the same file for different compilation settings. A minimal +resolution cache is needed to fully define a source file's shape when +the compilation settings include `module: node16`+, so providing a cache host +object should be preferred. A common host is a language service `ConfiguredProject`. + +[`CompilerOptions`](CompilerOptions.md) | [`MinimalResolutionCacheHost`](MinimalResolutionCacheHost.md) + +##### scriptSnapshot + +[`IScriptSnapshot`](IScriptSnapshot.md) + +Text of the file. + +##### version + +`string` + +Current version of the file. + +##### scriptKind? + +[`ScriptKind`](../enumerations/ScriptKind.md) + +##### sourceFileOptions? + +[`ScriptTarget`](../enumerations/ScriptTarget.md) | [`CreateSourceFileOptions`](CreateSourceFileOptions.md) + +#### Returns + +[`SourceFile`](SourceFile.md) + +*** + +### updateDocumentWithKey() + +> **updateDocumentWithKey**(`fileName`, `path`, `compilationSettingsOrHost`, `key`, `scriptSnapshot`, `version`, `scriptKind`?, `sourceFileOptions`?): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7373 + +#### Parameters + +##### fileName + +`string` + +##### path + +[`Path`](../type-aliases/Path.md) + +##### compilationSettingsOrHost + +[`CompilerOptions`](CompilerOptions.md) | [`MinimalResolutionCacheHost`](MinimalResolutionCacheHost.md) + +##### key + +[`DocumentRegistryBucketKey`](../type-aliases/DocumentRegistryBucketKey.md) + +##### scriptSnapshot + +[`IScriptSnapshot`](IScriptSnapshot.md) + +##### version + +`string` + +##### scriptKind? + +[`ScriptKind`](../enumerations/ScriptKind.md) + +##### sourceFileOptions? + +[`ScriptTarget`](../enumerations/ScriptTarget.md) | [`CreateSourceFileOptions`](CreateSourceFileOptions.md) + +#### Returns + +[`SourceFile`](SourceFile.md) diff --git a/docs/api_docs/namespaces/ts/interfaces/DocumentSpan.md b/docs/api_docs/namespaces/ts/interfaces/DocumentSpan.md new file mode 100644 index 0000000000000000000000000000000000000000..c3c995d3f6f265828f65abaf701d2dcb3561a511 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/DocumentSpan.md @@ -0,0 +1,70 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / DocumentSpan + +# Interface: DocumentSpan + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6700 + +## Extended by + +- [`RenameLocation`](RenameLocation.md) +- [`ReferenceEntry`](ReferenceEntry.md) +- [`ImplementationLocation`](ImplementationLocation.md) +- [`DefinitionInfo`](DefinitionInfo.md) + +## Properties + +### contextSpan? + +> `optional` **contextSpan**: [`TextSpan`](TextSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6713 + +If DocumentSpan.textSpan is the span for name of the declaration, +then this is the span for relevant declaration + +*** + +### fileName + +> **fileName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6702 + +*** + +### originalContextSpan? + +> `optional` **originalContextSpan**: [`TextSpan`](TextSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6714 + +*** + +### originalFileName? + +> `optional` **originalFileName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6708 + +*** + +### originalTextSpan? + +> `optional` **originalTextSpan**: [`TextSpan`](TextSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6707 + +If the span represents a location that was remapped (e.g. via a .d.ts.map file), +then the original filename and span will be specified here + +*** + +### textSpan + +> **textSpan**: [`TextSpan`](TextSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6701 diff --git a/docs/api_docs/namespaces/ts/interfaces/ESMap.md b/docs/api_docs/namespaces/ts/interfaces/ESMap.md new file mode 100644 index 0000000000000000000000000000000000000000..ccf73c54b20377c2caf4f342e43ddc935cca19aa --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ESMap.md @@ -0,0 +1,212 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ESMap + +# Interface: ESMap\ + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:58 + +ES6 Map interface. + +## Extends + +- [`ReadonlyESMap`](ReadonlyESMap.md)\<`K`, `V`\>.[`Collection`](Collection.md)\<`K`\> + +## Extended by + +- [`Map`](Map.md) +- [`UnderscoreEscapedMap`](UnderscoreEscapedMap.md) + +## Type Parameters + +• **K** + +• **V** + +## Properties + +### size + +> `readonly` **size**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:36 + +#### Inherited from + +[`Collection`](Collection.md).[`size`](Collection.md#size) + +## Methods + +### clear() + +> **clear**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:43 + +#### Returns + +`void` + +#### Inherited from + +[`Collection`](Collection.md).[`clear`](Collection.md#clear) + +*** + +### delete() + +> **delete**(`key`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:42 + +#### Parameters + +##### key + +`K` + +#### Returns + +`boolean` + +#### Inherited from + +[`Collection`](Collection.md).[`delete`](Collection.md#delete) + +*** + +### entries() + +> **entries**(): [`Iterator`](Iterator.md)\<\[`K`, `V`\]\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:49 + +#### Returns + +[`Iterator`](Iterator.md)\<\[`K`, `V`\]\> + +#### Inherited from + +[`ReadonlyESMap`](ReadonlyESMap.md).[`entries`](ReadonlyESMap.md#entries) + +*** + +### forEach() + +> **forEach**(`action`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:50 + +#### Parameters + +##### action + +(`value`, `key`) => `void` + +#### Returns + +`void` + +#### Inherited from + +[`ReadonlyESMap`](ReadonlyESMap.md).[`forEach`](ReadonlyESMap.md#foreach) + +*** + +### get() + +> **get**(`key`): `undefined` \| `V` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:47 + +#### Parameters + +##### key + +`K` + +#### Returns + +`undefined` \| `V` + +#### Inherited from + +[`ReadonlyESMap`](ReadonlyESMap.md).[`get`](ReadonlyESMap.md#get) + +*** + +### has() + +> **has**(`key`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:37 + +#### Parameters + +##### key + +`K` + +#### Returns + +`boolean` + +#### Inherited from + +[`Collection`](Collection.md).[`has`](Collection.md#has) + +*** + +### keys() + +> **keys**(): [`Iterator`](Iterator.md)\<`K`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:38 + +#### Returns + +[`Iterator`](Iterator.md)\<`K`\> + +#### Inherited from + +[`Collection`](Collection.md).[`keys`](Collection.md#keys) + +*** + +### set() + +> **set**(`key`, `value`): `this` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:59 + +#### Parameters + +##### key + +`K` + +##### value + +`V` + +#### Returns + +`this` + +*** + +### values() + +> **values**(): [`Iterator`](Iterator.md)\<`V`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:48 + +#### Returns + +[`Iterator`](Iterator.md)\<`V`\> + +#### Inherited from + +[`ReadonlyESMap`](ReadonlyESMap.md).[`values`](ReadonlyESMap.md#values) diff --git a/docs/api_docs/namespaces/ts/interfaces/EditorOptions.md b/docs/api_docs/namespaces/ts/interfaces/EditorOptions.md new file mode 100644 index 0000000000000000000000000000000000000000..178464383ede71a917cd06a64a9abe6a9834472c --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/EditorOptions.md @@ -0,0 +1,65 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / EditorOptions + +# Interface: ~~EditorOptions~~ + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6763 + +## Deprecated + +- consider using EditorSettings instead + +## Extended by + +- [`FormatCodeOptions`](FormatCodeOptions.md) + +## Properties + +### ~~BaseIndentSize?~~ + +> `optional` **BaseIndentSize**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6764 + +*** + +### ~~ConvertTabsToSpaces~~ + +> **ConvertTabsToSpaces**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6768 + +*** + +### ~~IndentSize~~ + +> **IndentSize**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6765 + +*** + +### ~~IndentStyle~~ + +> **IndentStyle**: [`IndentStyle`](../enumerations/IndentStyle.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6769 + +*** + +### ~~NewLineCharacter~~ + +> **NewLineCharacter**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6767 + +*** + +### ~~TabSize~~ + +> **TabSize**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6766 diff --git a/docs/api_docs/namespaces/ts/interfaces/EditorSettings.md b/docs/api_docs/namespaces/ts/interfaces/EditorSettings.md new file mode 100644 index 0000000000000000000000000000000000000000..3f3afef2e5d98d6f5c91fd1973f2a704eb72f95f --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/EditorSettings.md @@ -0,0 +1,69 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / EditorSettings + +# Interface: EditorSettings + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6771 + +## Extended by + +- [`FormatCodeSettings`](FormatCodeSettings.md) + +## Properties + +### baseIndentSize? + +> `optional` **baseIndentSize**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6772 + +*** + +### convertTabsToSpaces? + +> `optional` **convertTabsToSpaces**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6776 + +*** + +### indentSize? + +> `optional` **indentSize**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6773 + +*** + +### indentStyle? + +> `optional` **indentStyle**: [`IndentStyle`](../enumerations/IndentStyle.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6777 + +*** + +### newLineCharacter? + +> `optional` **newLineCharacter**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6775 + +*** + +### tabSize? + +> `optional` **tabSize**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6774 + +*** + +### trimTrailingWhitespace? + +> `optional` **trimTrailingWhitespace**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6778 diff --git a/docs/api_docs/namespaces/ts/interfaces/ElementAccessChain.md b/docs/api_docs/namespaces/ts/interfaces/ElementAccessChain.md new file mode 100644 index 0000000000000000000000000000000000000000..7698aa987580bbe0ad1a3c143d73a20cd474d19b --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ElementAccessChain.md @@ -0,0 +1,581 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ElementAccessChain + +# Interface: ElementAccessChain + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1329 + +## Extends + +- [`ElementAccessExpression`](ElementAccessExpression.md) + +## Properties + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`_expressionBrand`](ElementAccessExpression.md#_expressionbrand) + +*** + +### \_leftHandSideExpressionBrand + +> **\_leftHandSideExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1086 + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`_leftHandSideExpressionBrand`](ElementAccessExpression.md#_lefthandsideexpressionbrand) + +*** + +### \_memberExpressionBrand + +> **\_memberExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1089 + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`_memberExpressionBrand`](ElementAccessExpression.md#_memberexpressionbrand) + +*** + +### \_optionalChainBrand + +> **\_optionalChainBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1330 + +*** + +### \_unaryExpressionBrand + +> **\_unaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1066 + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`_unaryExpressionBrand`](ElementAccessExpression.md#_unaryexpressionbrand) + +*** + +### \_updateExpressionBrand + +> **\_updateExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1071 + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`_updateExpressionBrand`](ElementAccessExpression.md#_updateexpressionbrand) + +*** + +### argumentExpression + +> `readonly` **argumentExpression**: [`Expression`](Expression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1327 + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`argumentExpression`](ElementAccessExpression.md#argumentexpression) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`decorators`](ElementAccessExpression.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`end`](ElementAccessExpression.md#end) + +*** + +### expression + +> `readonly` **expression**: [`LeftHandSideExpression`](LeftHandSideExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1325 + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`expression`](ElementAccessExpression.md#expression) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`flags`](ElementAccessExpression.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`ElementAccessExpression`](../enumerations/SyntaxKind.md#elementaccessexpression) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1324 + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`kind`](ElementAccessExpression.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`locals`](ElementAccessExpression.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`modifiers`](ElementAccessExpression.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`parent`](ElementAccessExpression.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`pos`](ElementAccessExpression.md#pos) + +*** + +### questionDotToken? + +> `readonly` `optional` **questionDotToken**: [`QuestionDotToken`](../type-aliases/QuestionDotToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1326 + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`questionDotToken`](ElementAccessExpression.md#questiondottoken) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`skipCheck`](ElementAccessExpression.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`symbol`](ElementAccessExpression.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`forEachChild`](ElementAccessExpression.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`getChildAt`](ElementAccessExpression.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`getChildCount`](ElementAccessExpression.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`getChildren`](ElementAccessExpression.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`getEnd`](ElementAccessExpression.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`getFirstToken`](ElementAccessExpression.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`getFullStart`](ElementAccessExpression.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`getFullText`](ElementAccessExpression.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`getFullWidth`](ElementAccessExpression.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`getLastToken`](ElementAccessExpression.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`getLeadingTriviaWidth`](ElementAccessExpression.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`getSourceFile`](ElementAccessExpression.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`getStart`](ElementAccessExpression.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`getText`](ElementAccessExpression.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`getWidth`](ElementAccessExpression.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/ElementAccessExpression.md b/docs/api_docs/namespaces/ts/interfaces/ElementAccessExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..aecb069b3938970974464a8c9bd48dc9280c888e --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ElementAccessExpression.md @@ -0,0 +1,566 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ElementAccessExpression + +# Interface: ElementAccessExpression + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1323 + +## Extends + +- [`MemberExpression`](MemberExpression.md) + +## Extended by + +- [`ElementAccessChain`](ElementAccessChain.md) +- [`SuperElementAccessExpression`](SuperElementAccessExpression.md) + +## Properties + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`_expressionBrand`](MemberExpression.md#_expressionbrand) + +*** + +### \_leftHandSideExpressionBrand + +> **\_leftHandSideExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1086 + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`_leftHandSideExpressionBrand`](MemberExpression.md#_lefthandsideexpressionbrand) + +*** + +### \_memberExpressionBrand + +> **\_memberExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1089 + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`_memberExpressionBrand`](MemberExpression.md#_memberexpressionbrand) + +*** + +### \_unaryExpressionBrand + +> **\_unaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1066 + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`_unaryExpressionBrand`](MemberExpression.md#_unaryexpressionbrand) + +*** + +### \_updateExpressionBrand + +> **\_updateExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1071 + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`_updateExpressionBrand`](MemberExpression.md#_updateexpressionbrand) + +*** + +### argumentExpression + +> `readonly` **argumentExpression**: [`Expression`](Expression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1327 + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`decorators`](MemberExpression.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`end`](MemberExpression.md#end) + +*** + +### expression + +> `readonly` **expression**: [`LeftHandSideExpression`](LeftHandSideExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1325 + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`flags`](MemberExpression.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`ElementAccessExpression`](../enumerations/SyntaxKind.md#elementaccessexpression) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1324 + +#### Overrides + +[`MemberExpression`](MemberExpression.md).[`kind`](MemberExpression.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`locals`](MemberExpression.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`modifiers`](MemberExpression.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`parent`](MemberExpression.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`pos`](MemberExpression.md#pos) + +*** + +### questionDotToken? + +> `readonly` `optional` **questionDotToken**: [`QuestionDotToken`](../type-aliases/QuestionDotToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1326 + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`skipCheck`](MemberExpression.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`symbol`](MemberExpression.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`forEachChild`](MemberExpression.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`getChildAt`](MemberExpression.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`getChildCount`](MemberExpression.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`getChildren`](MemberExpression.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`getEnd`](MemberExpression.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`getFirstToken`](MemberExpression.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`getFullStart`](MemberExpression.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`getFullText`](MemberExpression.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`getFullWidth`](MemberExpression.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`getLastToken`](MemberExpression.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`getLeadingTriviaWidth`](MemberExpression.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`getSourceFile`](MemberExpression.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`getStart`](MemberExpression.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`getText`](MemberExpression.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`getWidth`](MemberExpression.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/EmitAndSemanticDiagnosticsBuilderProgram.md b/docs/api_docs/namespaces/ts/interfaces/EmitAndSemanticDiagnosticsBuilderProgram.md new file mode 100644 index 0000000000000000000000000000000000000000..f3bbe4c1bf6ff0b723d9273638b471ed9e02cf01 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/EmitAndSemanticDiagnosticsBuilderProgram.md @@ -0,0 +1,436 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / EmitAndSemanticDiagnosticsBuilderProgram + +# Interface: EmitAndSemanticDiagnosticsBuilderProgram + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5747 + +The builder that can handle the changes in program and iterate through changed file to emit the files +The semantic diagnostics are cached per file and managed by clearing for the changed/affected files + +## Extends + +- [`SemanticDiagnosticsBuilderProgram`](SemanticDiagnosticsBuilderProgram.md) + +## Properties + +### builderProgramForLinter? + +> `optional` **builderProgramForLinter**: [`EmitAndSemanticDiagnosticsBuilderProgram`](EmitAndSemanticDiagnosticsBuilderProgram.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5731 + +#### Inherited from + +[`SemanticDiagnosticsBuilderProgram`](SemanticDiagnosticsBuilderProgram.md).[`builderProgramForLinter`](SemanticDiagnosticsBuilderProgram.md#builderprogramforlinter) + +## Methods + +### emit() + +> **emit**(`targetSourceFile`?, `writeFile`?, `cancellationToken`?, `emitOnlyDtsFiles`?, `customTransformers`?): [`EmitResult`](EmitResult.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5725 + +Emits the JavaScript and declaration files. +When targetSource file is specified, emits the files corresponding to that source file, +otherwise for the whole program. +In case of EmitAndSemanticDiagnosticsBuilderProgram, when targetSourceFile is specified, +it is assumed that that file is handled from affected file list. If targetSourceFile is not specified, +it will only emit all the affected files instead of whole program + +The first of writeFile if provided, writeFile of BuilderProgramHost if provided, writeFile of compiler host +in that order would be used to write the files + +#### Parameters + +##### targetSourceFile? + +[`SourceFile`](SourceFile.md) + +##### writeFile? + +[`WriteFileCallback`](../type-aliases/WriteFileCallback.md) + +##### cancellationToken? + +[`CancellationToken`](CancellationToken.md) + +##### emitOnlyDtsFiles? + +`boolean` + +##### customTransformers? + +[`CustomTransformers`](CustomTransformers.md) + +#### Returns + +[`EmitResult`](EmitResult.md) + +#### Inherited from + +[`SemanticDiagnosticsBuilderProgram`](SemanticDiagnosticsBuilderProgram.md).[`emit`](SemanticDiagnosticsBuilderProgram.md#emit) + +*** + +### emitNextAffectedFile() + +> **emitNextAffectedFile**(`writeFile`?, `cancellationToken`?, `emitOnlyDtsFiles`?, `customTransformers`?): [`AffectedFileResult`](../type-aliases/AffectedFileResult.md)\<[`EmitResult`](EmitResult.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5753 + +Emits the next affected file's emit result (EmitResult and sourceFiles emitted) or returns undefined if iteration is complete +The first of writeFile if provided, writeFile of BuilderProgramHost if provided, writeFile of compiler host +in that order would be used to write the files + +#### Parameters + +##### writeFile? + +[`WriteFileCallback`](../type-aliases/WriteFileCallback.md) + +##### cancellationToken? + +[`CancellationToken`](CancellationToken.md) + +##### emitOnlyDtsFiles? + +`boolean` + +##### customTransformers? + +[`CustomTransformers`](CustomTransformers.md) + +#### Returns + +[`AffectedFileResult`](../type-aliases/AffectedFileResult.md)\<[`EmitResult`](EmitResult.md)\> + +*** + +### getAllDependencies() + +> **getAllDependencies**(`sourceFile`): readonly `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5704 + +Get all the dependencies of the file + +#### Parameters + +##### sourceFile + +[`SourceFile`](SourceFile.md) + +#### Returns + +readonly `string`[] + +#### Inherited from + +[`SemanticDiagnosticsBuilderProgram`](SemanticDiagnosticsBuilderProgram.md).[`getAllDependencies`](SemanticDiagnosticsBuilderProgram.md#getalldependencies) + +*** + +### getCompilerOptions() + +> **getCompilerOptions**(): [`CompilerOptions`](CompilerOptions.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5672 + +Get compiler options of the program + +#### Returns + +[`CompilerOptions`](CompilerOptions.md) + +#### Inherited from + +[`SemanticDiagnosticsBuilderProgram`](SemanticDiagnosticsBuilderProgram.md).[`getCompilerOptions`](SemanticDiagnosticsBuilderProgram.md#getcompileroptions) + +*** + +### getConfigFileParsingDiagnostics() + +> **getConfigFileParsingDiagnostics**(): readonly [`Diagnostic`](Diagnostic.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5692 + +Get the diagnostics from config file parsing + +#### Returns + +readonly [`Diagnostic`](Diagnostic.md)[] + +#### Inherited from + +[`SemanticDiagnosticsBuilderProgram`](SemanticDiagnosticsBuilderProgram.md).[`getConfigFileParsingDiagnostics`](SemanticDiagnosticsBuilderProgram.md#getconfigfileparsingdiagnostics) + +*** + +### getCurrentDirectory() + +> **getCurrentDirectory**(): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5729 + +Get the current directory of the program + +#### Returns + +`string` + +#### Inherited from + +[`SemanticDiagnosticsBuilderProgram`](SemanticDiagnosticsBuilderProgram.md).[`getCurrentDirectory`](SemanticDiagnosticsBuilderProgram.md#getcurrentdirectory) + +*** + +### getDeclarationDiagnostics() + +> **getDeclarationDiagnostics**(`sourceFile`?, `cancellationToken`?): readonly [`DiagnosticWithLocation`](DiagnosticWithLocation.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5700 + +Get the declaration diagnostics, for all source files if source file is not supplied + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### cancellationToken? + +[`CancellationToken`](CancellationToken.md) + +#### Returns + +readonly [`DiagnosticWithLocation`](DiagnosticWithLocation.md)[] + +#### Inherited from + +[`SemanticDiagnosticsBuilderProgram`](SemanticDiagnosticsBuilderProgram.md).[`getDeclarationDiagnostics`](SemanticDiagnosticsBuilderProgram.md#getdeclarationdiagnostics) + +*** + +### getGlobalDiagnostics() + +> **getGlobalDiagnostics**(`cancellationToken`?): readonly [`Diagnostic`](Diagnostic.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5688 + +Get the diagnostics that dont belong to any file + +#### Parameters + +##### cancellationToken? + +[`CancellationToken`](CancellationToken.md) + +#### Returns + +readonly [`Diagnostic`](Diagnostic.md)[] + +#### Inherited from + +[`SemanticDiagnosticsBuilderProgram`](SemanticDiagnosticsBuilderProgram.md).[`getGlobalDiagnostics`](SemanticDiagnosticsBuilderProgram.md#getglobaldiagnostics) + +*** + +### getOptionsDiagnostics() + +> **getOptionsDiagnostics**(`cancellationToken`?): readonly [`Diagnostic`](Diagnostic.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5684 + +Get the diagnostics for compiler options + +#### Parameters + +##### cancellationToken? + +[`CancellationToken`](CancellationToken.md) + +#### Returns + +readonly [`Diagnostic`](Diagnostic.md)[] + +#### Inherited from + +[`SemanticDiagnosticsBuilderProgram`](SemanticDiagnosticsBuilderProgram.md).[`getOptionsDiagnostics`](SemanticDiagnosticsBuilderProgram.md#getoptionsdiagnostics) + +*** + +### getProgram() + +> **getProgram**(): [`Program`](Program.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5668 + +Returns current program + +#### Returns + +[`Program`](Program.md) + +#### Inherited from + +[`SemanticDiagnosticsBuilderProgram`](SemanticDiagnosticsBuilderProgram.md).[`getProgram`](SemanticDiagnosticsBuilderProgram.md#getprogram) + +*** + +### getSemanticDiagnostics() + +> **getSemanticDiagnostics**(`sourceFile`?, `cancellationToken`?): readonly [`Diagnostic`](Diagnostic.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5713 + +Gets the semantic diagnostics from the program corresponding to this state of file (if provided) or whole program +The semantic diagnostics are cached and managed here +Note that it is assumed that when asked about semantic diagnostics through this API, +the file has been taken out of affected files so it is safe to use cache or get from program and cache the diagnostics +In case of SemanticDiagnosticsBuilderProgram if the source file is not provided, +it will iterate through all the affected files, to ensure that cache stays valid and yet provide a way to get all semantic diagnostics + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### cancellationToken? + +[`CancellationToken`](CancellationToken.md) + +#### Returns + +readonly [`Diagnostic`](Diagnostic.md)[] + +#### Inherited from + +[`SemanticDiagnosticsBuilderProgram`](SemanticDiagnosticsBuilderProgram.md).[`getSemanticDiagnostics`](SemanticDiagnosticsBuilderProgram.md#getsemanticdiagnostics) + +*** + +### getSemanticDiagnosticsOfNextAffectedFile() + +> **getSemanticDiagnosticsOfNextAffectedFile**(`cancellationToken`?, `ignoreSourceFile`?): [`AffectedFileResult`](../type-aliases/AffectedFileResult.md)\ + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5741 + +Gets the semantic diagnostics from the program for the next affected file and caches it +Returns undefined if the iteration is complete + +#### Parameters + +##### cancellationToken? + +[`CancellationToken`](CancellationToken.md) + +##### ignoreSourceFile? + +(`sourceFile`) => `boolean` + +#### Returns + +[`AffectedFileResult`](../type-aliases/AffectedFileResult.md)\ + +#### Inherited from + +[`SemanticDiagnosticsBuilderProgram`](SemanticDiagnosticsBuilderProgram.md).[`getSemanticDiagnosticsOfNextAffectedFile`](SemanticDiagnosticsBuilderProgram.md#getsemanticdiagnosticsofnextaffectedfile) + +*** + +### getSourceFile() + +> **getSourceFile**(`fileName`): `undefined` \| [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5676 + +Get the source file in the program with file name + +#### Parameters + +##### fileName + +`string` + +#### Returns + +`undefined` \| [`SourceFile`](SourceFile.md) + +#### Inherited from + +[`SemanticDiagnosticsBuilderProgram`](SemanticDiagnosticsBuilderProgram.md).[`getSourceFile`](SemanticDiagnosticsBuilderProgram.md#getsourcefile) + +*** + +### getSourceFiles() + +> **getSourceFiles**(): readonly [`SourceFile`](SourceFile.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5680 + +Get a list of files in the program + +#### Returns + +readonly [`SourceFile`](SourceFile.md)[] + +#### Inherited from + +[`SemanticDiagnosticsBuilderProgram`](SemanticDiagnosticsBuilderProgram.md).[`getSourceFiles`](SemanticDiagnosticsBuilderProgram.md#getsourcefiles) + +*** + +### getSyntacticDiagnostics() + +> **getSyntacticDiagnostics**(`sourceFile`?, `cancellationToken`?): readonly [`Diagnostic`](Diagnostic.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5696 + +Get the syntax diagnostics, for all source files if source file is not supplied + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### cancellationToken? + +[`CancellationToken`](CancellationToken.md) + +#### Returns + +readonly [`Diagnostic`](Diagnostic.md)[] + +#### Inherited from + +[`SemanticDiagnosticsBuilderProgram`](SemanticDiagnosticsBuilderProgram.md).[`getSyntacticDiagnostics`](SemanticDiagnosticsBuilderProgram.md#getsyntacticdiagnostics) + +*** + +### isFileUpdateInConstEnumCache()? + +> `optional` **isFileUpdateInConstEnumCache**(`sourceFile`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5730 + +#### Parameters + +##### sourceFile + +[`SourceFile`](SourceFile.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`SemanticDiagnosticsBuilderProgram`](SemanticDiagnosticsBuilderProgram.md).[`isFileUpdateInConstEnumCache`](SemanticDiagnosticsBuilderProgram.md#isfileupdateinconstenumcache) diff --git a/docs/api_docs/namespaces/ts/interfaces/EmitHelperBase.md b/docs/api_docs/namespaces/ts/interfaces/EmitHelperBase.md new file mode 100644 index 0000000000000000000000000000000000000000..29c938a1fb9330879ba3a18a67ab01a0bfb5bbb3 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/EmitHelperBase.md @@ -0,0 +1,54 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / EmitHelperBase + +# Interface: EmitHelperBase + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3553 + +## Extended by + +- [`ScopedEmitHelper`](ScopedEmitHelper.md) +- [`UnscopedEmitHelper`](UnscopedEmitHelper.md) + +## Properties + +### dependencies? + +> `readonly` `optional` **dependencies**: [`EmitHelper`](../type-aliases/EmitHelper.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3558 + +*** + +### name + +> `readonly` **name**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3554 + +*** + +### priority? + +> `readonly` `optional` **priority**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3557 + +*** + +### scoped + +> `readonly` **scoped**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3555 + +*** + +### text + +> `readonly` **text**: `string` \| (`node`) => `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3556 diff --git a/docs/api_docs/namespaces/ts/interfaces/EmitHost.md b/docs/api_docs/namespaces/ts/interfaces/EmitHost.md new file mode 100644 index 0000000000000000000000000000000000000000..cb9d0dcff440d078bb1349fef892e3d9d34f9ff2 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/EmitHost.md @@ -0,0 +1,517 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / EmitHost + +# Interface: EmitHost + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3584 + +## Extends + +- [`ScriptReferenceHost`](ScriptReferenceHost.md).[`ModuleSpecifierResolutionHost`](ModuleSpecifierResolutionHost.md).[`SourceFileMayBeEmittedHost`](SourceFileMayBeEmittedHost.md) + +## Properties + +### getSourceFileFromReference() + +> **getSourceFileFromReference**: (`referencingFile`, `ref`) => `undefined` \| [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3595 + +#### Parameters + +##### referencingFile + +[`SourceFile`](SourceFile.md) | [`UnparsedSource`](UnparsedSource.md) + +##### ref + +[`FileReference`](FileReference.md) + +#### Returns + +`undefined` \| [`SourceFile`](SourceFile.md) + +*** + +### redirectTargetsMap + +> `readonly` **redirectTargetsMap**: [`RedirectTargetsMap`](../type-aliases/RedirectTargetsMap.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3596 + +#### Overrides + +[`ModuleSpecifierResolutionHost`](ModuleSpecifierResolutionHost.md).[`redirectTargetsMap`](ModuleSpecifierResolutionHost.md#redirecttargetsmap) + +*** + +### writeFile + +> **writeFile**: [`WriteFileCallback`](../type-aliases/WriteFileCallback.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3594 + +## Methods + +### createHash()? + +> `optional` **createHash**(`data`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3597 + +#### Parameters + +##### data + +`string` + +#### Returns + +`string` + +*** + +### directoryExists()? + +> `optional` **directoryExists**(`path`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4344 + +#### Parameters + +##### path + +`string` + +#### Returns + +`boolean` + +#### Inherited from + +[`ModuleSpecifierResolutionHost`](ModuleSpecifierResolutionHost.md).[`directoryExists`](ModuleSpecifierResolutionHost.md#directoryexists) + +*** + +### fileExists() + +> **fileExists**(`path`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4342 + +#### Parameters + +##### path + +`string` + +#### Returns + +`boolean` + +#### Inherited from + +[`ModuleSpecifierResolutionHost`](ModuleSpecifierResolutionHost.md).[`fileExists`](ModuleSpecifierResolutionHost.md#fileexists) + +*** + +### getCanonicalFileName() + +> **getCanonicalFileName**(`fileName`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3590 + +#### Parameters + +##### fileName + +`string` + +#### Returns + +`string` + +*** + +### getCommonSourceDirectory() + +> **getCommonSourceDirectory**(): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3589 + +#### Returns + +`string` + +*** + +### getCompilerOptions() + +> **getCompilerOptions**(): [`CompilerOptions`](CompilerOptions.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2231 + +#### Returns + +[`CompilerOptions`](CompilerOptions.md) + +#### Inherited from + +[`SourceFileMayBeEmittedHost`](SourceFileMayBeEmittedHost.md).[`getCompilerOptions`](SourceFileMayBeEmittedHost.md#getcompileroptions) + +*** + +### getCurrentDirectory() + +> **getCurrentDirectory**(): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3587 + +#### Returns + +`string` + +#### Overrides + +[`ModuleSpecifierResolutionHost`](ModuleSpecifierResolutionHost.md).[`getCurrentDirectory`](ModuleSpecifierResolutionHost.md#getcurrentdirectory) + +*** + +### getGlobalTypingsCacheLocation()? + +> `optional` **getGlobalTypingsCacheLocation**(): `undefined` \| `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4349 + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[`ModuleSpecifierResolutionHost`](ModuleSpecifierResolutionHost.md).[`getGlobalTypingsCacheLocation`](ModuleSpecifierResolutionHost.md#getglobaltypingscachelocation) + +*** + +### getLibFileFromReference() + +> **getLibFileFromReference**(`ref`): `undefined` \| [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3588 + +#### Parameters + +##### ref + +[`FileReference`](FileReference.md) + +#### Returns + +`undefined` \| [`SourceFile`](SourceFile.md) + +*** + +### getModuleSpecifierCache()? + +> `optional` **getModuleSpecifierCache**(): [`ModuleSpecifierCache`](ModuleSpecifierCache.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4347 + +#### Returns + +[`ModuleSpecifierCache`](ModuleSpecifierCache.md) + +#### Inherited from + +[`ModuleSpecifierResolutionHost`](ModuleSpecifierResolutionHost.md).[`getModuleSpecifierCache`](ModuleSpecifierResolutionHost.md#getmodulespecifiercache) + +*** + +### getNearestAncestorDirectoryWithPackageJson()? + +> `optional` **getNearestAncestorDirectoryWithPackageJson**(`fileName`, `rootDir`?): `undefined` \| `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4350 + +#### Parameters + +##### fileName + +`string` + +##### rootDir? + +`string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[`ModuleSpecifierResolutionHost`](ModuleSpecifierResolutionHost.md).[`getNearestAncestorDirectoryWithPackageJson`](ModuleSpecifierResolutionHost.md#getnearestancestordirectorywithpackagejson) + +*** + +### getNewLine() + +> **getNewLine**(): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3591 + +#### Returns + +`string` + +*** + +### getPackageJsonInfoCache()? + +> `optional` **getPackageJsonInfoCache**(): `undefined` \| [`PackageJsonInfoCache`](PackageJsonInfoCache.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4348 + +#### Returns + +`undefined` \| [`PackageJsonInfoCache`](PackageJsonInfoCache.md) + +#### Inherited from + +[`ModuleSpecifierResolutionHost`](ModuleSpecifierResolutionHost.md).[`getPackageJsonInfoCache`](ModuleSpecifierResolutionHost.md#getpackagejsoninfocache) + +*** + +### getPrependNodes() + +> **getPrependNodes**(): readonly ([`InputFiles`](InputFiles.md) \| [`UnparsedSource`](UnparsedSource.md))[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3593 + +#### Returns + +readonly ([`InputFiles`](InputFiles.md) \| [`UnparsedSource`](UnparsedSource.md))[] + +*** + +### getProjectReferenceRedirect() + +> **getProjectReferenceRedirect**(`fileName`): `undefined` \| `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4352 + +#### Parameters + +##### fileName + +`string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[`ModuleSpecifierResolutionHost`](ModuleSpecifierResolutionHost.md).[`getProjectReferenceRedirect`](ModuleSpecifierResolutionHost.md#getprojectreferenceredirect) + +*** + +### getResolvedProjectReferenceToRedirect() + +> **getResolvedProjectReferenceToRedirect**(`fileName`): `undefined` \| [`ResolvedProjectReference`](ResolvedProjectReference.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3581 + +#### Parameters + +##### fileName + +`string` + +#### Returns + +`undefined` \| [`ResolvedProjectReference`](ResolvedProjectReference.md) + +#### Inherited from + +[`SourceFileMayBeEmittedHost`](SourceFileMayBeEmittedHost.md).[`getResolvedProjectReferenceToRedirect`](SourceFileMayBeEmittedHost.md#getresolvedprojectreferencetoredirect) + +*** + +### getSourceFile() + +> **getSourceFile**(`fileName`): `undefined` \| [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2232 + +#### Parameters + +##### fileName + +`string` + +#### Returns + +`undefined` \| [`SourceFile`](SourceFile.md) + +#### Inherited from + +[`ScriptReferenceHost`](ScriptReferenceHost.md).[`getSourceFile`](ScriptReferenceHost.md#getsourcefile) + +*** + +### getSourceFileByPath() + +> **getSourceFileByPath**(`path`): `undefined` \| [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2233 + +#### Parameters + +##### path + +[`Path`](../type-aliases/Path.md) + +#### Returns + +`undefined` \| [`SourceFile`](SourceFile.md) + +#### Inherited from + +[`ScriptReferenceHost`](ScriptReferenceHost.md).[`getSourceFileByPath`](ScriptReferenceHost.md#getsourcefilebypath) + +*** + +### getSourceFiles() + +> **getSourceFiles**(): readonly [`SourceFile`](SourceFile.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3585 + +#### Returns + +readonly [`SourceFile`](SourceFile.md)[] + +*** + +### isEmitBlocked() + +> **isEmitBlocked**(`emitFileName`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3592 + +#### Parameters + +##### emitFileName + +`string` + +#### Returns + +`boolean` + +*** + +### isSourceFileFromExternalLibrary() + +> **isSourceFileFromExternalLibrary**(`file`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3580 + +#### Parameters + +##### file + +[`SourceFile`](SourceFile.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`SourceFileMayBeEmittedHost`](SourceFileMayBeEmittedHost.md).[`isSourceFileFromExternalLibrary`](SourceFileMayBeEmittedHost.md#issourcefilefromexternallibrary) + +*** + +### isSourceOfProjectReferenceRedirect() + +> **isSourceOfProjectReferenceRedirect**(`fileName`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4353 + +#### Parameters + +##### fileName + +`string` + +#### Returns + +`boolean` + +#### Inherited from + +[`SourceFileMayBeEmittedHost`](SourceFileMayBeEmittedHost.md).[`isSourceOfProjectReferenceRedirect`](SourceFileMayBeEmittedHost.md#issourceofprojectreferenceredirect) + +*** + +### readFile()? + +> `optional` **readFile**(`path`): `undefined` \| `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4345 + +#### Parameters + +##### path + +`string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[`ModuleSpecifierResolutionHost`](ModuleSpecifierResolutionHost.md).[`readFile`](ModuleSpecifierResolutionHost.md#readfile) + +*** + +### realpath()? + +> `optional` **realpath**(`path`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4346 + +#### Parameters + +##### path + +`string` + +#### Returns + +`string` + +#### Inherited from + +[`ModuleSpecifierResolutionHost`](ModuleSpecifierResolutionHost.md).[`realpath`](ModuleSpecifierResolutionHost.md#realpath) + +*** + +### useCaseSensitiveFileNames() + +> **useCaseSensitiveFileNames**(): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3586 + +#### Returns + +`boolean` + +#### Overrides + +[`ModuleSpecifierResolutionHost`](ModuleSpecifierResolutionHost.md).[`useCaseSensitiveFileNames`](ModuleSpecifierResolutionHost.md#usecasesensitivefilenames) diff --git a/docs/api_docs/namespaces/ts/interfaces/EmitOutput.md b/docs/api_docs/namespaces/ts/interfaces/EmitOutput.md new file mode 100644 index 0000000000000000000000000000000000000000..9bdc596596aab1ea814382783011334b5fe62192 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/EmitOutput.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / EmitOutput + +# Interface: EmitOutput + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5631 + +## Properties + +### emitSkipped + +> **emitSkipped**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5633 + +*** + +### outputFiles + +> **outputFiles**: [`OutputFile`](OutputFile.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5632 diff --git a/docs/api_docs/namespaces/ts/interfaces/EmitResult.md b/docs/api_docs/namespaces/ts/interfaces/EmitResult.md new file mode 100644 index 0000000000000000000000000000000000000000..8512d7b99b2b282239de496c09ab393fd4dacb33 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/EmitResult.md @@ -0,0 +1,35 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / EmitResult + +# Interface: EmitResult + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2378 + +## Properties + +### diagnostics + +> **diagnostics**: readonly [`Diagnostic`](Diagnostic.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2381 + +Contains declaration emit diagnostics + +*** + +### emitSkipped + +> **emitSkipped**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2379 + +*** + +### emittedFiles? + +> `optional` **emittedFiles**: `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2382 diff --git a/docs/api_docs/namespaces/ts/interfaces/EmitTextWriter.md b/docs/api_docs/namespaces/ts/interfaces/EmitTextWriter.md new file mode 100644 index 0000000000000000000000000000000000000000..14fb7dc99389ba4b8255692041c0db645133c3f4 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/EmitTextWriter.md @@ -0,0 +1,753 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / EmitTextWriter + +# Interface: EmitTextWriter + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4319 + +## Extends + +- `SymbolWriter` + +## Properties + +### moduleResolverHost? + +> `optional` **moduleResolverHost**: [`ModuleSpecifierResolutionHost`](ModuleSpecifierResolutionHost.md) & `object` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4384 + +#### Type declaration + +##### getCommonSourceDirectory() + +###### Returns + +`string` + +#### Inherited from + +`SymbolWriter.moduleResolverHost` + +## Methods + +### clear() + +> **clear**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2569 + +#### Returns + +`void` + +#### Inherited from + +`SymbolWriter.clear` + +*** + +### decreaseIndent() + +> **decreaseIndent**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2568 + +#### Returns + +`void` + +#### Inherited from + +`SymbolWriter.decreaseIndent` + +*** + +### getColumn() + +> **getColumn**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4328 + +#### Returns + +`number` + +*** + +### getIndent() + +> **getIndent**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4329 + +#### Returns + +`number` + +*** + +### getLine() + +> **getLine**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4327 + +#### Returns + +`number` + +*** + +### getText() + +> **getText**(): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4323 + +#### Returns + +`string` + +*** + +### getTextPos() + +> **getTextPos**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4326 + +#### Returns + +`number` + +*** + +### getTextPosWithWriteLine()? + +> `optional` **getTextPosWithWriteLine**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4333 + +#### Returns + +`number` + +*** + +### hasTrailingComment() + +> **hasTrailingComment**(): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4331 + +#### Returns + +`boolean` + +*** + +### hasTrailingWhitespace() + +> **hasTrailingWhitespace**(): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4332 + +#### Returns + +`boolean` + +*** + +### increaseIndent() + +> **increaseIndent**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2567 + +#### Returns + +`void` + +#### Inherited from + +`SymbolWriter.increaseIndent` + +*** + +### isAtStartOfLine() + +> **isAtStartOfLine**(): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4330 + +#### Returns + +`boolean` + +*** + +### nonEscapingWrite()? + +> `optional` **nonEscapingWrite**(`text`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4334 + +#### Parameters + +##### text + +`string` + +#### Returns + +`void` + +*** + +### rawWrite() + +> **rawWrite**(`s`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4324 + +#### Parameters + +##### s + +`string` + +#### Returns + +`void` + +*** + +### reportCyclicStructureError()? + +> `optional` **reportCyclicStructureError**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4381 + +#### Returns + +`void` + +#### Inherited from + +`SymbolWriter.reportCyclicStructureError` + +*** + +### reportImportTypeNodeResolutionModeOverride()? + +> `optional` **reportImportTypeNodeResolutionModeOverride**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4391 + +#### Returns + +`void` + +#### Inherited from + +`SymbolWriter.reportImportTypeNodeResolutionModeOverride` + +*** + +### reportInaccessibleThisError()? + +> `optional` **reportInaccessibleThisError**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4378 + +#### Returns + +`void` + +#### Inherited from + +`SymbolWriter.reportInaccessibleThisError` + +*** + +### reportInaccessibleUniqueSymbolError()? + +> `optional` **reportInaccessibleUniqueSymbolError**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4380 + +#### Returns + +`void` + +#### Inherited from + +`SymbolWriter.reportInaccessibleUniqueSymbolError` + +*** + +### reportLikelyUnsafeImportRequiredError()? + +> `optional` **reportLikelyUnsafeImportRequiredError**(`specifier`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4382 + +#### Parameters + +##### specifier + +`string` + +#### Returns + +`void` + +#### Inherited from + +`SymbolWriter.reportLikelyUnsafeImportRequiredError` + +*** + +### reportNonlocalAugmentation()? + +> `optional` **reportNonlocalAugmentation**(`containingFile`, `parentSymbol`, `augmentingSymbol`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4389 + +#### Parameters + +##### containingFile + +[`SourceFile`](SourceFile.md) + +##### parentSymbol + +[`Symbol`](Symbol.md) + +##### augmentingSymbol + +[`Symbol`](Symbol.md) + +#### Returns + +`void` + +#### Inherited from + +`SymbolWriter.reportNonlocalAugmentation` + +*** + +### reportNonSerializableProperty()? + +> `optional` **reportNonSerializableProperty**(`propertyName`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4390 + +#### Parameters + +##### propertyName + +`string` + +#### Returns + +`void` + +#### Inherited from + +`SymbolWriter.reportNonSerializableProperty` + +*** + +### reportPrivateInBaseOfClassExpression()? + +> `optional` **reportPrivateInBaseOfClassExpression**(`propertyName`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4379 + +#### Parameters + +##### propertyName + +`string` + +#### Returns + +`void` + +#### Inherited from + +`SymbolWriter.reportPrivateInBaseOfClassExpression` + +*** + +### reportTruncationError()? + +> `optional` **reportTruncationError**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4383 + +#### Returns + +`void` + +#### Inherited from + +`SymbolWriter.reportTruncationError` + +*** + +### trackExternalModuleSymbolOfImportTypeNode()? + +> `optional` **trackExternalModuleSymbolOfImportTypeNode**(`symbol`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4388 + +#### Parameters + +##### symbol + +[`Symbol`](Symbol.md) + +#### Returns + +`void` + +#### Inherited from + +`SymbolWriter.trackExternalModuleSymbolOfImportTypeNode` + +*** + +### trackReferencedAmbientModule()? + +> `optional` **trackReferencedAmbientModule**(`decl`, `symbol`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4387 + +#### Parameters + +##### decl + +[`ModuleDeclaration`](ModuleDeclaration.md) + +##### symbol + +[`Symbol`](Symbol.md) + +#### Returns + +`void` + +#### Inherited from + +`SymbolWriter.trackReferencedAmbientModule` + +*** + +### trackSymbol()? + +> `optional` **trackSymbol**(`symbol`, `enclosingDeclaration`, `meaning`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4377 + +#### Parameters + +##### symbol + +[`Symbol`](Symbol.md) + +##### enclosingDeclaration + +`undefined` | [`Node`](Node.md) + +##### meaning + +[`SymbolFlags`](../enumerations/SymbolFlags.md) + +#### Returns + +`boolean` + +#### Inherited from + +`SymbolWriter.trackSymbol` + +*** + +### write() + +> **write**(`s`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4320 + +#### Parameters + +##### s + +`string` + +#### Returns + +`void` + +*** + +### writeComment() + +> **writeComment**(`text`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4322 + +#### Parameters + +##### text + +`string` + +#### Returns + +`void` + +*** + +### writeKeyword() + +> **writeKeyword**(`text`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2558 + +#### Parameters + +##### text + +`string` + +#### Returns + +`void` + +#### Inherited from + +`SymbolWriter.writeKeyword` + +*** + +### writeLine() + +> **writeLine**(`force`?): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2566 + +#### Parameters + +##### force? + +`boolean` + +#### Returns + +`void` + +#### Inherited from + +`SymbolWriter.writeLine` + +*** + +### writeLiteral() + +> **writeLiteral**(`s`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4325 + +#### Parameters + +##### s + +`string` + +#### Returns + +`void` + +*** + +### writeOperator() + +> **writeOperator**(`text`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2559 + +#### Parameters + +##### text + +`string` + +#### Returns + +`void` + +#### Inherited from + +`SymbolWriter.writeOperator` + +*** + +### writeParameter() + +> **writeParameter**(`text`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2563 + +#### Parameters + +##### text + +`string` + +#### Returns + +`void` + +#### Inherited from + +`SymbolWriter.writeParameter` + +*** + +### writeProperty() + +> **writeProperty**(`text`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2564 + +#### Parameters + +##### text + +`string` + +#### Returns + +`void` + +#### Inherited from + +`SymbolWriter.writeProperty` + +*** + +### writePunctuation() + +> **writePunctuation**(`text`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2560 + +#### Parameters + +##### text + +`string` + +#### Returns + +`void` + +#### Inherited from + +`SymbolWriter.writePunctuation` + +*** + +### writeSpace() + +> **writeSpace**(`text`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2561 + +#### Parameters + +##### text + +`string` + +#### Returns + +`void` + +#### Inherited from + +`SymbolWriter.writeSpace` + +*** + +### writeStringLiteral() + +> **writeStringLiteral**(`text`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2562 + +#### Parameters + +##### text + +`string` + +#### Returns + +`void` + +#### Inherited from + +`SymbolWriter.writeStringLiteral` + +*** + +### writeSymbol() + +> **writeSymbol**(`text`, `symbol`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2565 + +#### Parameters + +##### text + +`string` + +##### symbol + +[`Symbol`](Symbol.md) + +#### Returns + +`void` + +#### Inherited from + +`SymbolWriter.writeSymbol` + +*** + +### writeTrailingSemicolon() + +> **writeTrailingSemicolon**(`text`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4321 + +#### Parameters + +##### text + +`string` + +#### Returns + +`void` diff --git a/docs/api_docs/namespaces/ts/interfaces/EmptyStatement.md b/docs/api_docs/namespaces/ts/interfaces/EmptyStatement.md new file mode 100644 index 0000000000000000000000000000000000000000..b267da53012ce46ad639f86698d0d25c7c9966d6 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/EmptyStatement.md @@ -0,0 +1,489 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / EmptyStatement + +# Interface: EmptyStatement + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1483 + +## Extends + +- [`Statement`](Statement.md) + +## Properties + +### \_statementBrand + +> **\_statementBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1471 + +#### Inherited from + +[`Statement`](Statement.md).[`_statementBrand`](Statement.md#_statementbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Statement`](Statement.md).[`decorators`](Statement.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Statement`](Statement.md).[`end`](Statement.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Statement`](Statement.md).[`flags`](Statement.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`EmptyStatement`](../enumerations/SyntaxKind.md#emptystatement) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1484 + +#### Overrides + +[`Statement`](Statement.md).[`kind`](Statement.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Statement`](Statement.md).[`locals`](Statement.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Statement`](Statement.md).[`modifiers`](Statement.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`Statement`](Statement.md).[`parent`](Statement.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Statement`](Statement.md).[`pos`](Statement.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Statement`](Statement.md).[`skipCheck`](Statement.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Statement`](Statement.md).[`symbol`](Statement.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Statement`](Statement.md).[`forEachChild`](Statement.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getChildAt`](Statement.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getChildCount`](Statement.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Statement`](Statement.md).[`getChildren`](Statement.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getEnd`](Statement.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getFirstToken`](Statement.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getFullStart`](Statement.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Statement`](Statement.md).[`getFullText`](Statement.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getFullWidth`](Statement.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getLastToken`](Statement.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getLeadingTriviaWidth`](Statement.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getSourceFile`](Statement.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getStart`](Statement.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Statement`](Statement.md).[`getText`](Statement.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getWidth`](Statement.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/EnumDeclaration.md b/docs/api_docs/namespaces/ts/interfaces/EnumDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..de98b047696be442aca497976619d4fe74ff938d --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/EnumDeclaration.md @@ -0,0 +1,521 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / EnumDeclaration + +# Interface: EnumDeclaration + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1668 + +## Extends + +- [`DeclarationStatement`](DeclarationStatement.md).[`JSDocContainer`](JSDocContainer.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`_declarationBrand`](DeclarationStatement.md#_declarationbrand) + +*** + +### \_statementBrand + +> **\_statementBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1471 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`_statementBrand`](DeclarationStatement.md#_statementbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`decorators`](DeclarationStatement.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`end`](DeclarationStatement.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`flags`](DeclarationStatement.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`EnumDeclaration`](../enumerations/SyntaxKind.md#enumdeclaration) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1669 + +#### Overrides + +[`DeclarationStatement`](DeclarationStatement.md).[`kind`](DeclarationStatement.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`locals`](DeclarationStatement.md#locals) + +*** + +### members + +> `readonly` **members**: [`NodeArray`](NodeArray.md)\<[`EnumMember`](EnumMember.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1672 + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`Modifier`](../type-aliases/Modifier.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1670 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Overrides + +[`DeclarationStatement`](DeclarationStatement.md).[`modifiers`](DeclarationStatement.md#modifiers) + +*** + +### name + +> `readonly` **name**: [`Identifier`](Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1671 + +#### Overrides + +[`DeclarationStatement`](DeclarationStatement.md).[`name`](DeclarationStatement.md#name) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`parent`](DeclarationStatement.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`pos`](DeclarationStatement.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`skipCheck`](DeclarationStatement.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`symbol`](DeclarationStatement.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`forEachChild`](DeclarationStatement.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getChildAt`](DeclarationStatement.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getChildCount`](DeclarationStatement.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getChildren`](DeclarationStatement.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getEnd`](DeclarationStatement.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getFirstToken`](DeclarationStatement.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getFullStart`](DeclarationStatement.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getFullText`](DeclarationStatement.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getFullWidth`](DeclarationStatement.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getLastToken`](DeclarationStatement.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getLeadingTriviaWidth`](DeclarationStatement.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getSourceFile`](DeclarationStatement.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getStart`](DeclarationStatement.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getText`](DeclarationStatement.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getWidth`](DeclarationStatement.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/EnumMember.md b/docs/api_docs/namespaces/ts/interfaces/EnumMember.md new file mode 100644 index 0000000000000000000000000000000000000000..bb9f87c9dce7df56dc552d00ff540ec827536dbc --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/EnumMember.md @@ -0,0 +1,509 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / EnumMember + +# Interface: EnumMember + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1662 + +## Extends + +- [`NamedDeclaration`](NamedDeclaration.md).[`JSDocContainer`](JSDocContainer.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`_declarationBrand`](NamedDeclaration.md#_declarationbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`decorators`](NamedDeclaration.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`end`](NamedDeclaration.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`flags`](NamedDeclaration.md#flags) + +*** + +### initializer? + +> `readonly` `optional` **initializer**: [`Expression`](Expression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1666 + +*** + +### kind + +> `readonly` **kind**: [`EnumMember`](../enumerations/SyntaxKind.md#enummember) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1663 + +#### Overrides + +[`NamedDeclaration`](NamedDeclaration.md).[`kind`](NamedDeclaration.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`locals`](NamedDeclaration.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`modifiers`](NamedDeclaration.md#modifiers) + +*** + +### name + +> `readonly` **name**: [`PropertyName`](../type-aliases/PropertyName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1665 + +#### Overrides + +[`NamedDeclaration`](NamedDeclaration.md).[`name`](NamedDeclaration.md#name) + +*** + +### parent + +> `readonly` **parent**: [`EnumDeclaration`](EnumDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1664 + +#### Overrides + +[`NamedDeclaration`](NamedDeclaration.md).[`parent`](NamedDeclaration.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`pos`](NamedDeclaration.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`skipCheck`](NamedDeclaration.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`symbol`](NamedDeclaration.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`forEachChild`](NamedDeclaration.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getChildAt`](NamedDeclaration.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getChildCount`](NamedDeclaration.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getChildren`](NamedDeclaration.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getEnd`](NamedDeclaration.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFirstToken`](NamedDeclaration.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFullStart`](NamedDeclaration.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFullText`](NamedDeclaration.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFullWidth`](NamedDeclaration.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getLastToken`](NamedDeclaration.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getLeadingTriviaWidth`](NamedDeclaration.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getSourceFile`](NamedDeclaration.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getStart`](NamedDeclaration.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getText`](NamedDeclaration.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getWidth`](NamedDeclaration.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/EnumType.md b/docs/api_docs/namespaces/ts/interfaces/EnumType.md new file mode 100644 index 0000000000000000000000000000000000000000..8374bbd04428e20e83aa97c4fc4d5fdad39f69eb --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/EnumType.md @@ -0,0 +1,447 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / EnumType + +# Interface: EnumType + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2794 + +## Extends + +- [`Type`](Type.md) + +## Properties + +### aliasSymbol? + +> `optional` **aliasSymbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2773 + +#### Inherited from + +[`Type`](Type.md).[`aliasSymbol`](Type.md#aliassymbol) + +*** + +### aliasTypeArguments? + +> `optional` **aliasTypeArguments**: readonly [`Type`](Type.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2774 + +#### Inherited from + +[`Type`](Type.md).[`aliasTypeArguments`](Type.md#aliastypearguments) + +*** + +### flags + +> **flags**: [`TypeFlags`](../enumerations/TypeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2770 + +#### Inherited from + +[`Type`](Type.md).[`flags`](Type.md#flags) + +*** + +### pattern? + +> `optional` **pattern**: [`DestructuringPattern`](../type-aliases/DestructuringPattern.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2772 + +#### Inherited from + +[`Type`](Type.md).[`pattern`](Type.md#pattern) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2771 + +#### Inherited from + +[`Type`](Type.md).[`symbol`](Type.md#symbol) + +## Methods + +### getApparentProperties() + +> **getApparentProperties**(): [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6124 + +#### Returns + +[`Symbol`](Symbol.md)[] + +#### Inherited from + +[`Type`](Type.md).[`getApparentProperties`](Type.md#getapparentproperties) + +*** + +### getBaseTypes() + +> **getBaseTypes**(): `undefined` \| [`BaseType`](../type-aliases/BaseType.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6129 + +#### Returns + +`undefined` \| [`BaseType`](../type-aliases/BaseType.md)[] + +#### Inherited from + +[`Type`](Type.md).[`getBaseTypes`](Type.md#getbasetypes) + +*** + +### getCallSignatures() + +> **getCallSignatures**(): readonly [`Signature`](Signature.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6125 + +#### Returns + +readonly [`Signature`](Signature.md)[] + +#### Inherited from + +[`Type`](Type.md).[`getCallSignatures`](Type.md#getcallsignatures) + +*** + +### getConstraint() + +> **getConstraint**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6131 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`Type`](Type.md).[`getConstraint`](Type.md#getconstraint) + +*** + +### getConstructSignatures() + +> **getConstructSignatures**(): readonly [`Signature`](Signature.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6126 + +#### Returns + +readonly [`Signature`](Signature.md)[] + +#### Inherited from + +[`Type`](Type.md).[`getConstructSignatures`](Type.md#getconstructsignatures) + +*** + +### getDefault() + +> **getDefault**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6132 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`Type`](Type.md).[`getDefault`](Type.md#getdefault) + +*** + +### getFlags() + +> **getFlags**(): [`TypeFlags`](../enumerations/TypeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6120 + +#### Returns + +[`TypeFlags`](../enumerations/TypeFlags.md) + +#### Inherited from + +[`Type`](Type.md).[`getFlags`](Type.md#getflags) + +*** + +### getNonNullableType() + +> **getNonNullableType**(): [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6130 + +#### Returns + +[`Type`](Type.md) + +#### Inherited from + +[`Type`](Type.md).[`getNonNullableType`](Type.md#getnonnullabletype) + +*** + +### getNumberIndexType() + +> **getNumberIndexType**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6128 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`Type`](Type.md).[`getNumberIndexType`](Type.md#getnumberindextype) + +*** + +### getProperties() + +> **getProperties**(): [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6122 + +#### Returns + +[`Symbol`](Symbol.md)[] + +#### Inherited from + +[`Type`](Type.md).[`getProperties`](Type.md#getproperties) + +*** + +### getProperty() + +> **getProperty**(`propertyName`): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6123 + +#### Parameters + +##### propertyName + +`string` + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +#### Inherited from + +[`Type`](Type.md).[`getProperty`](Type.md#getproperty) + +*** + +### getStringIndexType() + +> **getStringIndexType**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6127 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`Type`](Type.md).[`getStringIndexType`](Type.md#getstringindextype) + +*** + +### getSymbol() + +> **getSymbol**(): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6121 + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +#### Inherited from + +[`Type`](Type.md).[`getSymbol`](Type.md#getsymbol) + +*** + +### isClass() + +> **isClass**(): `this is InterfaceType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6141 + +#### Returns + +`this is InterfaceType` + +#### Inherited from + +[`Type`](Type.md).[`isClass`](Type.md#isclass) + +*** + +### isClassOrInterface() + +> **isClassOrInterface**(): `this is InterfaceType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6140 + +#### Returns + +`this is InterfaceType` + +#### Inherited from + +[`Type`](Type.md).[`isClassOrInterface`](Type.md#isclassorinterface) + +*** + +### isIndexType() + +> **isIndexType**(): `this is IndexType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6142 + +#### Returns + +`this is IndexType` + +#### Inherited from + +[`Type`](Type.md).[`isIndexType`](Type.md#isindextype) + +*** + +### isIntersection() + +> **isIntersection**(): `this is IntersectionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6134 + +#### Returns + +`this is IntersectionType` + +#### Inherited from + +[`Type`](Type.md).[`isIntersection`](Type.md#isintersection) + +*** + +### isLiteral() + +> **isLiteral**(): `this is LiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6136 + +#### Returns + +`this is LiteralType` + +#### Inherited from + +[`Type`](Type.md).[`isLiteral`](Type.md#isliteral) + +*** + +### isNumberLiteral() + +> **isNumberLiteral**(): `this is NumberLiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6138 + +#### Returns + +`this is NumberLiteralType` + +#### Inherited from + +[`Type`](Type.md).[`isNumberLiteral`](Type.md#isnumberliteral) + +*** + +### isStringLiteral() + +> **isStringLiteral**(): `this is StringLiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6137 + +#### Returns + +`this is StringLiteralType` + +#### Inherited from + +[`Type`](Type.md).[`isStringLiteral`](Type.md#isstringliteral) + +*** + +### isTypeParameter() + +> **isTypeParameter**(): `this is TypeParameter` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6139 + +#### Returns + +`this is TypeParameter` + +#### Inherited from + +[`Type`](Type.md).[`isTypeParameter`](Type.md#istypeparameter) + +*** + +### isUnion() + +> **isUnion**(): `this is UnionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6133 + +#### Returns + +`this is UnionType` + +#### Inherited from + +[`Type`](Type.md).[`isUnion`](Type.md#isunion) + +*** + +### isUnionOrIntersection() + +> **isUnionOrIntersection**(): `this is UnionOrIntersectionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6135 + +#### Returns + +`this is UnionOrIntersectionType` + +#### Inherited from + +[`Type`](Type.md).[`isUnionOrIntersection`](Type.md#isunionorintersection) diff --git a/docs/api_docs/namespaces/ts/interfaces/EtsComponentExpression.md b/docs/api_docs/namespaces/ts/interfaces/EtsComponentExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..142dcfa55658171effa343b8b2731de6ba0cea57 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/EtsComponentExpression.md @@ -0,0 +1,593 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / EtsComponentExpression + +# Interface: EtsComponentExpression + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1204 + +## Extends + +- [`PrimaryExpression`](PrimaryExpression.md).[`Declaration`](Declaration.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`Declaration`](Declaration.md).[`_declarationBrand`](Declaration.md#_declarationbrand) + +*** + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_expressionBrand`](PrimaryExpression.md#_expressionbrand) + +*** + +### \_leftHandSideExpressionBrand + +> **\_leftHandSideExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1086 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_leftHandSideExpressionBrand`](PrimaryExpression.md#_lefthandsideexpressionbrand) + +*** + +### \_memberExpressionBrand + +> **\_memberExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1089 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_memberExpressionBrand`](PrimaryExpression.md#_memberexpressionbrand) + +*** + +### \_primaryExpressionBrand + +> **\_primaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1092 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_primaryExpressionBrand`](PrimaryExpression.md#_primaryexpressionbrand) + +*** + +### \_unaryExpressionBrand + +> **\_unaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1066 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_unaryExpressionBrand`](PrimaryExpression.md#_unaryexpressionbrand) + +*** + +### \_updateExpressionBrand + +> **\_updateExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1071 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_updateExpressionBrand`](PrimaryExpression.md#_updateexpressionbrand) + +*** + +### arguments + +> `readonly` **arguments**: [`NodeArray`](NodeArray.md)\<[`Expression`](Expression.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1208 + +*** + +### body? + +> `readonly` `optional` **body**: [`Block`](Block.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1209 + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Declaration`](Declaration.md).[`decorators`](Declaration.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Declaration`](Declaration.md).[`end`](Declaration.md#end) + +*** + +### expression + +> `readonly` **expression**: [`LeftHandSideExpression`](LeftHandSideExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1206 + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Declaration`](Declaration.md).[`flags`](Declaration.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`EtsComponentExpression`](../enumerations/SyntaxKind.md#etscomponentexpression) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1205 + +#### Overrides + +[`Declaration`](Declaration.md).[`kind`](Declaration.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Declaration`](Declaration.md).[`locals`](Declaration.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Declaration`](Declaration.md).[`modifiers`](Declaration.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`Declaration`](Declaration.md).[`parent`](Declaration.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Declaration`](Declaration.md).[`pos`](Declaration.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Declaration`](Declaration.md).[`skipCheck`](Declaration.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Declaration`](Declaration.md).[`symbol`](Declaration.md#symbol) + +*** + +### typeArguments? + +> `readonly` `optional` **typeArguments**: [`NodeArray`](NodeArray.md)\<[`TypeNode`](TypeNode.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1207 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Declaration`](Declaration.md).[`forEachChild`](Declaration.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getChildAt`](Declaration.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getChildCount`](Declaration.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Declaration`](Declaration.md).[`getChildren`](Declaration.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getEnd`](Declaration.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFirstToken`](Declaration.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFullStart`](Declaration.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFullText`](Declaration.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFullWidth`](Declaration.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getLastToken`](Declaration.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getLeadingTriviaWidth`](Declaration.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getSourceFile`](Declaration.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getStart`](Declaration.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getText`](Declaration.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getWidth`](Declaration.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/EtsOptions.md b/docs/api_docs/namespaces/ts/interfaces/EtsOptions.md new file mode 100644 index 0000000000000000000000000000000000000000..1e29aa8f90b91c1715294666f80a28ef12ea3d68 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/EtsOptions.md @@ -0,0 +1,157 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / EtsOptions + +# Interface: EtsOptions + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3181 + +## Properties + +### components + +> **components**: `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3186 + +*** + +### concurrent + +> **concurrent**: `object` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3205 + +#### decorator + +> **decorator**: `string` + +*** + +### customComponent? + +> `optional` **customComponent**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3208 + +*** + +### emitDecorators + +> **emitDecorators**: `object`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3213 + +#### emitParameters + +> **emitParameters**: `boolean` + +#### name + +> **name**: `string` + +*** + +### extend + +> **extend**: `object` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3188 + +#### components + +> **components**: `object`[] + +#### decorator + +> **decorator**: `string`[] + +*** + +### libs + +> **libs**: `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3187 + +*** + +### propertyDecorators + +> **propertyDecorators**: `object`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3209 + +#### name + +> **name**: `string` + +#### needInitialization + +> **needInitialization**: `boolean` + +*** + +### render + +> **render**: `object` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3182 + +#### decorator + +> **decorator**: `string`[] + +#### method + +> **method**: `string`[] + +*** + +### styles + +> **styles**: `object` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3196 + +#### component + +> **component**: `object` + +##### component.instance + +> **instance**: `string` + +##### component.name + +> **name**: `string` + +##### component.type + +> **type**: `string` + +#### decorator + +> **decorator**: `string` + +#### property + +> **property**: `string` + +*** + +### syntaxComponents + +> **syntaxComponents**: `object` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3217 + +#### attrUICallback + +> **attrUICallback**: `object`[] + +#### paramsUICallback + +> **paramsUICallback**: `string`[] diff --git a/docs/api_docs/namespaces/ts/interfaces/EvolvingArrayType.md b/docs/api_docs/namespaces/ts/interfaces/EvolvingArrayType.md new file mode 100644 index 0000000000000000000000000000000000000000..a8c01b4d8ff83fceefbedee9e12f75778810f813 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/EvolvingArrayType.md @@ -0,0 +1,475 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / EvolvingArrayType + +# Interface: EvolvingArrayType + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2882 + +## Extends + +- [`ObjectType`](ObjectType.md) + +## Properties + +### aliasSymbol? + +> `optional` **aliasSymbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2773 + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`aliasSymbol`](ObjectType.md#aliassymbol) + +*** + +### aliasTypeArguments? + +> `optional` **aliasTypeArguments**: readonly [`Type`](Type.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2774 + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`aliasTypeArguments`](ObjectType.md#aliastypearguments) + +*** + +### elementType + +> **elementType**: [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2883 + +*** + +### finalArrayType? + +> `optional` **finalArrayType**: [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2884 + +*** + +### flags + +> **flags**: [`TypeFlags`](../enumerations/TypeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2770 + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`flags`](ObjectType.md#flags) + +*** + +### objectFlags + +> **objectFlags**: [`ObjectFlags`](../enumerations/ObjectFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2818 + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`objectFlags`](ObjectType.md#objectflags) + +*** + +### pattern? + +> `optional` **pattern**: [`DestructuringPattern`](../type-aliases/DestructuringPattern.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2772 + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`pattern`](ObjectType.md#pattern) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2771 + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`symbol`](ObjectType.md#symbol) + +## Methods + +### getApparentProperties() + +> **getApparentProperties**(): [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6124 + +#### Returns + +[`Symbol`](Symbol.md)[] + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`getApparentProperties`](ObjectType.md#getapparentproperties) + +*** + +### getBaseTypes() + +> **getBaseTypes**(): `undefined` \| [`BaseType`](../type-aliases/BaseType.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6129 + +#### Returns + +`undefined` \| [`BaseType`](../type-aliases/BaseType.md)[] + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`getBaseTypes`](ObjectType.md#getbasetypes) + +*** + +### getCallSignatures() + +> **getCallSignatures**(): readonly [`Signature`](Signature.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6125 + +#### Returns + +readonly [`Signature`](Signature.md)[] + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`getCallSignatures`](ObjectType.md#getcallsignatures) + +*** + +### getConstraint() + +> **getConstraint**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6131 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`getConstraint`](ObjectType.md#getconstraint) + +*** + +### getConstructSignatures() + +> **getConstructSignatures**(): readonly [`Signature`](Signature.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6126 + +#### Returns + +readonly [`Signature`](Signature.md)[] + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`getConstructSignatures`](ObjectType.md#getconstructsignatures) + +*** + +### getDefault() + +> **getDefault**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6132 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`getDefault`](ObjectType.md#getdefault) + +*** + +### getFlags() + +> **getFlags**(): [`TypeFlags`](../enumerations/TypeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6120 + +#### Returns + +[`TypeFlags`](../enumerations/TypeFlags.md) + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`getFlags`](ObjectType.md#getflags) + +*** + +### getNonNullableType() + +> **getNonNullableType**(): [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6130 + +#### Returns + +[`Type`](Type.md) + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`getNonNullableType`](ObjectType.md#getnonnullabletype) + +*** + +### getNumberIndexType() + +> **getNumberIndexType**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6128 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`getNumberIndexType`](ObjectType.md#getnumberindextype) + +*** + +### getProperties() + +> **getProperties**(): [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6122 + +#### Returns + +[`Symbol`](Symbol.md)[] + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`getProperties`](ObjectType.md#getproperties) + +*** + +### getProperty() + +> **getProperty**(`propertyName`): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6123 + +#### Parameters + +##### propertyName + +`string` + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`getProperty`](ObjectType.md#getproperty) + +*** + +### getStringIndexType() + +> **getStringIndexType**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6127 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`getStringIndexType`](ObjectType.md#getstringindextype) + +*** + +### getSymbol() + +> **getSymbol**(): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6121 + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`getSymbol`](ObjectType.md#getsymbol) + +*** + +### isClass() + +> **isClass**(): `this is InterfaceType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6141 + +#### Returns + +`this is InterfaceType` + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`isClass`](ObjectType.md#isclass) + +*** + +### isClassOrInterface() + +> **isClassOrInterface**(): `this is InterfaceType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6140 + +#### Returns + +`this is InterfaceType` + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`isClassOrInterface`](ObjectType.md#isclassorinterface) + +*** + +### isIndexType() + +> **isIndexType**(): `this is IndexType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6142 + +#### Returns + +`this is IndexType` + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`isIndexType`](ObjectType.md#isindextype) + +*** + +### isIntersection() + +> **isIntersection**(): `this is IntersectionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6134 + +#### Returns + +`this is IntersectionType` + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`isIntersection`](ObjectType.md#isintersection) + +*** + +### isLiteral() + +> **isLiteral**(): `this is LiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6136 + +#### Returns + +`this is LiteralType` + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`isLiteral`](ObjectType.md#isliteral) + +*** + +### isNumberLiteral() + +> **isNumberLiteral**(): `this is NumberLiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6138 + +#### Returns + +`this is NumberLiteralType` + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`isNumberLiteral`](ObjectType.md#isnumberliteral) + +*** + +### isStringLiteral() + +> **isStringLiteral**(): `this is StringLiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6137 + +#### Returns + +`this is StringLiteralType` + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`isStringLiteral`](ObjectType.md#isstringliteral) + +*** + +### isTypeParameter() + +> **isTypeParameter**(): `this is TypeParameter` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6139 + +#### Returns + +`this is TypeParameter` + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`isTypeParameter`](ObjectType.md#istypeparameter) + +*** + +### isUnion() + +> **isUnion**(): `this is UnionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6133 + +#### Returns + +`this is UnionType` + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`isUnion`](ObjectType.md#isunion) + +*** + +### isUnionOrIntersection() + +> **isUnionOrIntersection**(): `this is UnionOrIntersectionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6135 + +#### Returns + +`this is UnionOrIntersectionType` + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`isUnionOrIntersection`](ObjectType.md#isunionorintersection) diff --git a/docs/api_docs/namespaces/ts/interfaces/ExportAssignment.md b/docs/api_docs/namespaces/ts/interfaces/ExportAssignment.md new file mode 100644 index 0000000000000000000000000000000000000000..efd460629ab43938ada6fa777c39a2a173908ca1 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ExportAssignment.md @@ -0,0 +1,532 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ExportAssignment + +# Interface: ExportAssignment + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1831 + +This is either an `export =` or an `export default` declaration. +Unless `isExportEquals` is set, this node was parsed as an `export default`. + +## Extends + +- [`DeclarationStatement`](DeclarationStatement.md).[`JSDocContainer`](JSDocContainer.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`_declarationBrand`](DeclarationStatement.md#_declarationbrand) + +*** + +### \_statementBrand + +> **\_statementBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1471 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`_statementBrand`](DeclarationStatement.md#_statementbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`decorators`](DeclarationStatement.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`end`](DeclarationStatement.md#end) + +*** + +### expression + +> `readonly` **expression**: [`Expression`](Expression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1836 + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`flags`](DeclarationStatement.md#flags) + +*** + +### isExportEquals? + +> `readonly` `optional` **isExportEquals**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1835 + +*** + +### kind + +> `readonly` **kind**: [`ExportAssignment`](../enumerations/SyntaxKind.md#exportassignment) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1832 + +#### Overrides + +[`DeclarationStatement`](DeclarationStatement.md).[`kind`](DeclarationStatement.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`locals`](DeclarationStatement.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`Modifier`](../type-aliases/Modifier.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1834 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Overrides + +[`DeclarationStatement`](DeclarationStatement.md).[`modifiers`](DeclarationStatement.md#modifiers) + +*** + +### name? + +> `readonly` `optional` **name**: [`Identifier`](Identifier.md) \| [`StringLiteral`](StringLiteral.md) \| [`NumericLiteral`](NumericLiteral.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:705 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`name`](DeclarationStatement.md#name) + +*** + +### parent + +> `readonly` **parent**: [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1833 + +#### Overrides + +[`DeclarationStatement`](DeclarationStatement.md).[`parent`](DeclarationStatement.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`pos`](DeclarationStatement.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`skipCheck`](DeclarationStatement.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`symbol`](DeclarationStatement.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`forEachChild`](DeclarationStatement.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getChildAt`](DeclarationStatement.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getChildCount`](DeclarationStatement.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getChildren`](DeclarationStatement.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getEnd`](DeclarationStatement.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getFirstToken`](DeclarationStatement.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getFullStart`](DeclarationStatement.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getFullText`](DeclarationStatement.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getFullWidth`](DeclarationStatement.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getLastToken`](DeclarationStatement.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getLeadingTriviaWidth`](DeclarationStatement.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getSourceFile`](DeclarationStatement.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getStart`](DeclarationStatement.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getText`](DeclarationStatement.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getWidth`](DeclarationStatement.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/ExportDeclaration.md b/docs/api_docs/namespaces/ts/interfaces/ExportDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..2e6e50327d4c6a5495273aa1287b2a4de2b66f73 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ExportDeclaration.md @@ -0,0 +1,549 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ExportDeclaration + +# Interface: ExportDeclaration + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1763 + +## Extends + +- [`DeclarationStatement`](DeclarationStatement.md).[`JSDocContainer`](JSDocContainer.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`_declarationBrand`](DeclarationStatement.md#_declarationbrand) + +*** + +### \_statementBrand + +> **\_statementBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1471 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`_statementBrand`](DeclarationStatement.md#_statementbrand) + +*** + +### assertClause? + +> `readonly` `optional` **assertClause**: [`AssertClause`](AssertClause.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1772 + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`decorators`](DeclarationStatement.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`end`](DeclarationStatement.md#end) + +*** + +### exportClause? + +> `readonly` `optional` **exportClause**: [`NamedExportBindings`](../type-aliases/NamedExportBindings.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1769 + +Will not be assigned in the case of `export * from "foo";` + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`flags`](DeclarationStatement.md#flags) + +*** + +### isTypeOnly + +> `readonly` **isTypeOnly**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1767 + +*** + +### kind + +> `readonly` **kind**: [`ExportDeclaration`](../enumerations/SyntaxKind.md#exportdeclaration) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1764 + +#### Overrides + +[`DeclarationStatement`](DeclarationStatement.md).[`kind`](DeclarationStatement.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`locals`](DeclarationStatement.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`Modifier`](../type-aliases/Modifier.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1766 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Overrides + +[`DeclarationStatement`](DeclarationStatement.md).[`modifiers`](DeclarationStatement.md#modifiers) + +*** + +### moduleSpecifier? + +> `readonly` `optional` **moduleSpecifier**: [`Expression`](Expression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1771 + +If this is not a StringLiteral it will be a grammar error. + +*** + +### name? + +> `readonly` `optional` **name**: [`Identifier`](Identifier.md) \| [`StringLiteral`](StringLiteral.md) \| [`NumericLiteral`](NumericLiteral.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:705 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`name`](DeclarationStatement.md#name) + +*** + +### parent + +> `readonly` **parent**: [`SourceFile`](SourceFile.md) \| [`ModuleBlock`](ModuleBlock.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1765 + +#### Overrides + +[`DeclarationStatement`](DeclarationStatement.md).[`parent`](DeclarationStatement.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`pos`](DeclarationStatement.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`skipCheck`](DeclarationStatement.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`symbol`](DeclarationStatement.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`forEachChild`](DeclarationStatement.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getChildAt`](DeclarationStatement.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getChildCount`](DeclarationStatement.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getChildren`](DeclarationStatement.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getEnd`](DeclarationStatement.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getFirstToken`](DeclarationStatement.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getFullStart`](DeclarationStatement.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getFullText`](DeclarationStatement.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getFullWidth`](DeclarationStatement.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getLastToken`](DeclarationStatement.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getLeadingTriviaWidth`](DeclarationStatement.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getSourceFile`](DeclarationStatement.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getStart`](DeclarationStatement.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getText`](DeclarationStatement.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getWidth`](DeclarationStatement.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/ExportSpecifier.md b/docs/api_docs/namespaces/ts/interfaces/ExportSpecifier.md new file mode 100644 index 0000000000000000000000000000000000000000..8bcd77cadc1aab4f73f94403bc9c04f8ad60bee8 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ExportSpecifier.md @@ -0,0 +1,517 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ExportSpecifier + +# Interface: ExportSpecifier + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1792 + +## Extends + +- [`NamedDeclaration`](NamedDeclaration.md).[`JSDocContainer`](JSDocContainer.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`_declarationBrand`](NamedDeclaration.md#_declarationbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`decorators`](NamedDeclaration.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`end`](NamedDeclaration.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`flags`](NamedDeclaration.md#flags) + +*** + +### isTypeOnly + +> `readonly` **isTypeOnly**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1795 + +*** + +### kind + +> `readonly` **kind**: [`ExportSpecifier`](../enumerations/SyntaxKind.md#exportspecifier) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1793 + +#### Overrides + +[`NamedDeclaration`](NamedDeclaration.md).[`kind`](NamedDeclaration.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`locals`](NamedDeclaration.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`modifiers`](NamedDeclaration.md#modifiers) + +*** + +### name + +> `readonly` **name**: [`Identifier`](Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1797 + +#### Overrides + +[`NamedDeclaration`](NamedDeclaration.md).[`name`](NamedDeclaration.md#name) + +*** + +### parent + +> `readonly` **parent**: [`NamedExports`](NamedExports.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1794 + +#### Overrides + +[`NamedDeclaration`](NamedDeclaration.md).[`parent`](NamedDeclaration.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`pos`](NamedDeclaration.md#pos) + +*** + +### propertyName? + +> `readonly` `optional` **propertyName**: [`Identifier`](Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1796 + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`skipCheck`](NamedDeclaration.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`symbol`](NamedDeclaration.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`forEachChild`](NamedDeclaration.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getChildAt`](NamedDeclaration.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getChildCount`](NamedDeclaration.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getChildren`](NamedDeclaration.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getEnd`](NamedDeclaration.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFirstToken`](NamedDeclaration.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFullStart`](NamedDeclaration.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFullText`](NamedDeclaration.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFullWidth`](NamedDeclaration.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getLastToken`](NamedDeclaration.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getLeadingTriviaWidth`](NamedDeclaration.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getSourceFile`](NamedDeclaration.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getStart`](NamedDeclaration.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getText`](NamedDeclaration.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getWidth`](NamedDeclaration.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/Expression.md b/docs/api_docs/namespaces/ts/interfaces/Expression.md new file mode 100644 index 0000000000000000000000000000000000000000..53973b278fc0c3bf8afd5a3a7854a4737924f16b --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/Expression.md @@ -0,0 +1,503 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / Expression + +# Interface: Expression + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1055 + +## Extends + +- [`Node`](Node.md) + +## Extended by + +- [`OmittedExpression`](OmittedExpression.md) +- [`UnaryExpression`](UnaryExpression.md) +- [`YieldExpression`](YieldExpression.md) +- [`SyntheticExpression`](SyntheticExpression.md) +- [`BinaryExpression`](BinaryExpression.md) +- [`ConditionalExpression`](ConditionalExpression.md) +- [`ArrowFunction`](ArrowFunction.md) +- [`SpreadElement`](SpreadElement.md) +- [`AsExpression`](AsExpression.md) +- [`SatisfiesExpression`](SatisfiesExpression.md) +- [`JsxOpeningElement`](JsxOpeningElement.md) +- [`JsxOpeningFragment`](JsxOpeningFragment.md) +- [`JsxClosingFragment`](JsxClosingFragment.md) +- [`JsxExpression`](JsxExpression.md) +- [`CommaListExpression`](CommaListExpression.md) + +## Properties + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`decorators`](Node.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Node`](Node.md).[`end`](Node.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Node`](Node.md).[`flags`](Node.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`SyntaxKind`](../enumerations/SyntaxKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:598 + +#### Inherited from + +[`Node`](Node.md).[`kind`](Node.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Node`](Node.md).[`locals`](Node.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`modifiers`](Node.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`Node`](Node.md).[`parent`](Node.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Node`](Node.md).[`pos`](Node.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Node`](Node.md).[`skipCheck`](Node.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Node`](Node.md).[`symbol`](Node.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Node`](Node.md).[`forEachChild`](Node.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getChildAt`](Node.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getChildCount`](Node.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Node`](Node.md).[`getChildren`](Node.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getEnd`](Node.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getFirstToken`](Node.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullStart`](Node.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getFullText`](Node.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullWidth`](Node.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getLastToken`](Node.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getLeadingTriviaWidth`](Node.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Node`](Node.md).[`getSourceFile`](Node.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getStart`](Node.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getText`](Node.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getWidth`](Node.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/ExpressionStatement.md b/docs/api_docs/namespaces/ts/interfaces/ExpressionStatement.md new file mode 100644 index 0000000000000000000000000000000000000000..2047363619136d0481b81b9ba8a53075f1d07704 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ExpressionStatement.md @@ -0,0 +1,501 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ExpressionStatement + +# Interface: ExpressionStatement + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1503 + +## Extends + +- [`Statement`](Statement.md) + +## Extended by + +- [`JsonObjectExpressionStatement`](JsonObjectExpressionStatement.md) + +## Properties + +### \_statementBrand + +> **\_statementBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1471 + +#### Inherited from + +[`Statement`](Statement.md).[`_statementBrand`](Statement.md#_statementbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Statement`](Statement.md).[`decorators`](Statement.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Statement`](Statement.md).[`end`](Statement.md#end) + +*** + +### expression + +> `readonly` **expression**: [`Expression`](Expression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1505 + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Statement`](Statement.md).[`flags`](Statement.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`ExpressionStatement`](../enumerations/SyntaxKind.md#expressionstatement) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1504 + +#### Overrides + +[`Statement`](Statement.md).[`kind`](Statement.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Statement`](Statement.md).[`locals`](Statement.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Statement`](Statement.md).[`modifiers`](Statement.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`Statement`](Statement.md).[`parent`](Statement.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Statement`](Statement.md).[`pos`](Statement.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Statement`](Statement.md).[`skipCheck`](Statement.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Statement`](Statement.md).[`symbol`](Statement.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Statement`](Statement.md).[`forEachChild`](Statement.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getChildAt`](Statement.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getChildCount`](Statement.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Statement`](Statement.md).[`getChildren`](Statement.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getEnd`](Statement.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getFirstToken`](Statement.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getFullStart`](Statement.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Statement`](Statement.md).[`getFullText`](Statement.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getFullWidth`](Statement.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getLastToken`](Statement.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getLeadingTriviaWidth`](Statement.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getSourceFile`](Statement.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getStart`](Statement.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Statement`](Statement.md).[`getText`](Statement.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getWidth`](Statement.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/ExpressionWithTypeArguments.md b/docs/api_docs/namespaces/ts/interfaces/ExpressionWithTypeArguments.md new file mode 100644 index 0000000000000000000000000000000000000000..929967a6a4e926b76813d7c57d1a0119a18335cd --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ExpressionWithTypeArguments.md @@ -0,0 +1,569 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ExpressionWithTypeArguments + +# Interface: ExpressionWithTypeArguments + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1353 + +## Extends + +- [`MemberExpression`](MemberExpression.md).[`NodeWithTypeArguments`](NodeWithTypeArguments.md) + +## Properties + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`_expressionBrand`](MemberExpression.md#_expressionbrand) + +*** + +### \_leftHandSideExpressionBrand + +> **\_leftHandSideExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1086 + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`_leftHandSideExpressionBrand`](MemberExpression.md#_lefthandsideexpressionbrand) + +*** + +### \_memberExpressionBrand + +> **\_memberExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1089 + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`_memberExpressionBrand`](MemberExpression.md#_memberexpressionbrand) + +*** + +### \_typeNodeBrand + +> **\_typeNodeBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:912 + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`_typeNodeBrand`](NodeWithTypeArguments.md#_typenodebrand) + +*** + +### \_unaryExpressionBrand + +> **\_unaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1066 + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`_unaryExpressionBrand`](MemberExpression.md#_unaryexpressionbrand) + +*** + +### \_updateExpressionBrand + +> **\_updateExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1071 + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`_updateExpressionBrand`](MemberExpression.md#_updateexpressionbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`decorators`](NodeWithTypeArguments.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`end`](NodeWithTypeArguments.md#end) + +*** + +### expression + +> `readonly` **expression**: [`LeftHandSideExpression`](LeftHandSideExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1355 + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`flags`](NodeWithTypeArguments.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`ExpressionWithTypeArguments`](../enumerations/SyntaxKind.md#expressionwithtypearguments) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1354 + +#### Overrides + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`kind`](NodeWithTypeArguments.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`locals`](NodeWithTypeArguments.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`modifiers`](NodeWithTypeArguments.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`parent`](NodeWithTypeArguments.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`pos`](NodeWithTypeArguments.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`skipCheck`](NodeWithTypeArguments.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`symbol`](NodeWithTypeArguments.md#symbol) + +*** + +### typeArguments? + +> `readonly` `optional` **typeArguments**: [`NodeArray`](NodeArray.md)\<[`TypeNode`](TypeNode.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:946 + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`typeArguments`](NodeWithTypeArguments.md#typearguments) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`forEachChild`](NodeWithTypeArguments.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`getChildAt`](NodeWithTypeArguments.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`getChildCount`](NodeWithTypeArguments.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`getChildren`](NodeWithTypeArguments.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`getEnd`](NodeWithTypeArguments.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`getFirstToken`](NodeWithTypeArguments.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`getFullStart`](NodeWithTypeArguments.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`getFullText`](NodeWithTypeArguments.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`getFullWidth`](NodeWithTypeArguments.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`getLastToken`](NodeWithTypeArguments.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`getLeadingTriviaWidth`](NodeWithTypeArguments.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`getSourceFile`](NodeWithTypeArguments.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`getStart`](NodeWithTypeArguments.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`getText`](NodeWithTypeArguments.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`getWidth`](NodeWithTypeArguments.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/ExtendedConfigCacheEntry.md b/docs/api_docs/namespaces/ts/interfaces/ExtendedConfigCacheEntry.md new file mode 100644 index 0000000000000000000000000000000000000000..3b9a85d25af44226771fe8b5eab77878416616ee --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ExtendedConfigCacheEntry.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ExtendedConfigCacheEntry + +# Interface: ExtendedConfigCacheEntry + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5331 + +## Properties + +### extendedConfig + +> **extendedConfig**: `undefined` \| [`ParsedTsconfig`](ParsedTsconfig.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5333 + +*** + +### extendedResult + +> **extendedResult**: [`TsConfigSourceFile`](TsConfigSourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5332 diff --git a/docs/api_docs/namespaces/ts/interfaces/ExternalModuleReference.md b/docs/api_docs/namespaces/ts/interfaces/ExternalModuleReference.md new file mode 100644 index 0000000000000000000000000000000000000000..ac6fc0d5f7ada464ad8922cf1de0d804b587eabc --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ExternalModuleReference.md @@ -0,0 +1,485 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ExternalModuleReference + +# Interface: ExternalModuleReference + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1712 + +## Extends + +- [`Node`](Node.md) + +## Properties + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`decorators`](Node.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Node`](Node.md).[`end`](Node.md#end) + +*** + +### expression + +> `readonly` **expression**: [`Expression`](Expression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1715 + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Node`](Node.md).[`flags`](Node.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`ExternalModuleReference`](../enumerations/SyntaxKind.md#externalmodulereference) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1713 + +#### Overrides + +[`Node`](Node.md).[`kind`](Node.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Node`](Node.md).[`locals`](Node.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`modifiers`](Node.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`ImportEqualsDeclaration`](ImportEqualsDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1714 + +#### Overrides + +[`Node`](Node.md).[`parent`](Node.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Node`](Node.md).[`pos`](Node.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Node`](Node.md).[`skipCheck`](Node.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Node`](Node.md).[`symbol`](Node.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Node`](Node.md).[`forEachChild`](Node.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getChildAt`](Node.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getChildCount`](Node.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Node`](Node.md).[`getChildren`](Node.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getEnd`](Node.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getFirstToken`](Node.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullStart`](Node.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getFullText`](Node.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullWidth`](Node.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getLastToken`](Node.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getLeadingTriviaWidth`](Node.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Node`](Node.md).[`getSourceFile`](Node.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getStart`](Node.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getText`](Node.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getWidth`](Node.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/FalseLiteral.md b/docs/api_docs/namespaces/ts/interfaces/FalseLiteral.md new file mode 100644 index 0000000000000000000000000000000000000000..2bfdc8de375956a4e84aa6a2ed78c76ebc8e991a --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/FalseLiteral.md @@ -0,0 +1,549 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / FalseLiteral + +# Interface: FalseLiteral + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1100 + +## Extends + +- [`PrimaryExpression`](PrimaryExpression.md) + +## Properties + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_expressionBrand`](PrimaryExpression.md#_expressionbrand) + +*** + +### \_leftHandSideExpressionBrand + +> **\_leftHandSideExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1086 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_leftHandSideExpressionBrand`](PrimaryExpression.md#_lefthandsideexpressionbrand) + +*** + +### \_memberExpressionBrand + +> **\_memberExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1089 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_memberExpressionBrand`](PrimaryExpression.md#_memberexpressionbrand) + +*** + +### \_primaryExpressionBrand + +> **\_primaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1092 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_primaryExpressionBrand`](PrimaryExpression.md#_primaryexpressionbrand) + +*** + +### \_unaryExpressionBrand + +> **\_unaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1066 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_unaryExpressionBrand`](PrimaryExpression.md#_unaryexpressionbrand) + +*** + +### \_updateExpressionBrand + +> **\_updateExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1071 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_updateExpressionBrand`](PrimaryExpression.md#_updateexpressionbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`decorators`](PrimaryExpression.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`end`](PrimaryExpression.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`flags`](PrimaryExpression.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`FalseKeyword`](../enumerations/SyntaxKind.md#falsekeyword) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1101 + +#### Overrides + +[`PrimaryExpression`](PrimaryExpression.md).[`kind`](PrimaryExpression.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`locals`](PrimaryExpression.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`modifiers`](PrimaryExpression.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`parent`](PrimaryExpression.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`pos`](PrimaryExpression.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`skipCheck`](PrimaryExpression.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`symbol`](PrimaryExpression.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`forEachChild`](PrimaryExpression.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getChildAt`](PrimaryExpression.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getChildCount`](PrimaryExpression.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getChildren`](PrimaryExpression.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getEnd`](PrimaryExpression.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFirstToken`](PrimaryExpression.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFullStart`](PrimaryExpression.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFullText`](PrimaryExpression.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFullWidth`](PrimaryExpression.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getLastToken`](PrimaryExpression.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getLeadingTriviaWidth`](PrimaryExpression.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getSourceFile`](PrimaryExpression.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getStart`](PrimaryExpression.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getText`](PrimaryExpression.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getWidth`](PrimaryExpression.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/FileCheckModuleInfo.md b/docs/api_docs/namespaces/ts/interfaces/FileCheckModuleInfo.md new file mode 100644 index 0000000000000000000000000000000000000000..838b5cc0a455db88ca01206998ed8bcdcf3a3813 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/FileCheckModuleInfo.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / FileCheckModuleInfo + +# Interface: FileCheckModuleInfo + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3439 + +## Properties + +### checkPayload + +> **checkPayload**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3441 + +*** + +### currentFileName + +> **currentFileName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3442 + +*** + +### fileNeedCheck + +> **fileNeedCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3440 diff --git a/docs/api_docs/namespaces/ts/interfaces/FileExtensionInfo.md b/docs/api_docs/namespaces/ts/interfaces/FileExtensionInfo.md new file mode 100644 index 0000000000000000000000000000000000000000..26ab85aca31b0bb22cda83479c490a6c0c719efc --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/FileExtensionInfo.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / FileExtensionInfo + +# Interface: FileExtensionInfo + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2969 + +## Properties + +### extension + +> **extension**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2970 + +*** + +### isMixedContent + +> **isMixedContent**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2971 + +*** + +### scriptKind? + +> `optional` **scriptKind**: [`ScriptKind`](../enumerations/ScriptKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2972 diff --git a/docs/api_docs/namespaces/ts/interfaces/FileReference.md b/docs/api_docs/namespaces/ts/interfaces/FileReference.md new file mode 100644 index 0000000000000000000000000000000000000000..a0ec9c4700fcb25271a20b535d62cf77f00396b4 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/FileReference.md @@ -0,0 +1,53 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / FileReference + +# Interface: FileReference + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1838 + +## Extends + +- [`TextRange`](TextRange.md) + +## Properties + +### end + +> **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:99 + +#### Inherited from + +[`TextRange`](TextRange.md).[`end`](TextRange.md#end) + +*** + +### fileName + +> **fileName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1839 + +*** + +### pos + +> **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:98 + +#### Inherited from + +[`TextRange`](TextRange.md).[`pos`](TextRange.md#pos) + +*** + +### resolutionMode? + +> `optional` **resolutionMode**: [`CommonJS`](../enumerations/ModuleKind.md#commonjs) \| [`ESNext`](../enumerations/ModuleKind.md#esnext) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1840 diff --git a/docs/api_docs/namespaces/ts/interfaces/FileTextChanges.md b/docs/api_docs/namespaces/ts/interfaces/FileTextChanges.md new file mode 100644 index 0000000000000000000000000000000000000000..b72530c5b48184b925b4a966c7b44986c043fefa --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/FileTextChanges.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / FileTextChanges + +# Interface: FileTextChanges + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6603 + +## Properties + +### fileName + +> **fileName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6604 + +*** + +### isNewFile? + +> `optional` **isNewFile**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6606 + +*** + +### textChanges + +> **textChanges**: readonly [`TextChange`](TextChange.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6605 diff --git a/docs/api_docs/namespaces/ts/interfaces/FileWatcher.md b/docs/api_docs/namespaces/ts/interfaces/FileWatcher.md new file mode 100644 index 0000000000000000000000000000000000000000..2fde5806cbb673010c9aa81dca689462bab59b63 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/FileWatcher.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / FileWatcher + +# Interface: FileWatcher + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4565 + +## Methods + +### close() + +> **close**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4566 + +#### Returns + +`void` diff --git a/docs/api_docs/namespaces/ts/interfaces/FlowArrayMutation.md b/docs/api_docs/namespaces/ts/interfaces/FlowArrayMutation.md new file mode 100644 index 0000000000000000000000000000000000000000..d24e7aa7c35020f5360e61e0916aa4c688be874b --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/FlowArrayMutation.md @@ -0,0 +1,53 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / FlowArrayMutation + +# Interface: FlowArrayMutation + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2091 + +## Extends + +- [`FlowNodeBase`](FlowNodeBase.md) + +## Properties + +### antecedent + +> **antecedent**: [`FlowNode`](../type-aliases/FlowNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2093 + +*** + +### flags + +> **flags**: [`FlowFlags`](../enumerations/FlowFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2064 + +#### Inherited from + +[`FlowNodeBase`](FlowNodeBase.md).[`flags`](FlowNodeBase.md#flags) + +*** + +### id? + +> `optional` **id**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2065 + +#### Inherited from + +[`FlowNodeBase`](FlowNodeBase.md).[`id`](FlowNodeBase.md#id) + +*** + +### node + +> **node**: [`BinaryExpression`](BinaryExpression.md) \| [`CallExpression`](CallExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2092 diff --git a/docs/api_docs/namespaces/ts/interfaces/FlowAssignment.md b/docs/api_docs/namespaces/ts/interfaces/FlowAssignment.md new file mode 100644 index 0000000000000000000000000000000000000000..22f70bbecad918f18e56dd351cded850e19c69c0 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/FlowAssignment.md @@ -0,0 +1,53 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / FlowAssignment + +# Interface: FlowAssignment + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2073 + +## Extends + +- [`FlowNodeBase`](FlowNodeBase.md) + +## Properties + +### antecedent + +> **antecedent**: [`FlowNode`](../type-aliases/FlowNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2075 + +*** + +### flags + +> **flags**: [`FlowFlags`](../enumerations/FlowFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2064 + +#### Inherited from + +[`FlowNodeBase`](FlowNodeBase.md).[`flags`](FlowNodeBase.md#flags) + +*** + +### id? + +> `optional` **id**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2065 + +#### Inherited from + +[`FlowNodeBase`](FlowNodeBase.md).[`id`](FlowNodeBase.md#id) + +*** + +### node + +> **node**: [`Expression`](Expression.md) \| [`VariableDeclaration`](VariableDeclaration.md) \| [`BindingElement`](BindingElement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2074 diff --git a/docs/api_docs/namespaces/ts/interfaces/FlowCall.md b/docs/api_docs/namespaces/ts/interfaces/FlowCall.md new file mode 100644 index 0000000000000000000000000000000000000000..a50bba7639f02e716b69826c88920be89d0cd818 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/FlowCall.md @@ -0,0 +1,53 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / FlowCall + +# Interface: FlowCall + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2077 + +## Extends + +- [`FlowNodeBase`](FlowNodeBase.md) + +## Properties + +### antecedent + +> **antecedent**: [`FlowNode`](../type-aliases/FlowNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2079 + +*** + +### flags + +> **flags**: [`FlowFlags`](../enumerations/FlowFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2064 + +#### Inherited from + +[`FlowNodeBase`](FlowNodeBase.md).[`flags`](FlowNodeBase.md#flags) + +*** + +### id? + +> `optional` **id**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2065 + +#### Inherited from + +[`FlowNodeBase`](FlowNodeBase.md).[`id`](FlowNodeBase.md#id) + +*** + +### node + +> **node**: [`CallExpression`](CallExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2078 diff --git a/docs/api_docs/namespaces/ts/interfaces/FlowCondition.md b/docs/api_docs/namespaces/ts/interfaces/FlowCondition.md new file mode 100644 index 0000000000000000000000000000000000000000..0ca3ca0de55fc3fa6615eac291e5422e755f0f6c --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/FlowCondition.md @@ -0,0 +1,53 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / FlowCondition + +# Interface: FlowCondition + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2081 + +## Extends + +- [`FlowNodeBase`](FlowNodeBase.md) + +## Properties + +### antecedent + +> **antecedent**: [`FlowNode`](../type-aliases/FlowNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2083 + +*** + +### flags + +> **flags**: [`FlowFlags`](../enumerations/FlowFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2064 + +#### Inherited from + +[`FlowNodeBase`](FlowNodeBase.md).[`flags`](FlowNodeBase.md#flags) + +*** + +### id? + +> `optional` **id**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2065 + +#### Inherited from + +[`FlowNodeBase`](FlowNodeBase.md).[`id`](FlowNodeBase.md#id) + +*** + +### node + +> **node**: [`Expression`](Expression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2082 diff --git a/docs/api_docs/namespaces/ts/interfaces/FlowLabel.md b/docs/api_docs/namespaces/ts/interfaces/FlowLabel.md new file mode 100644 index 0000000000000000000000000000000000000000..5b85278926c77ffc3058574fca91cc8f98d26604 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/FlowLabel.md @@ -0,0 +1,45 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / FlowLabel + +# Interface: FlowLabel + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2070 + +## Extends + +- [`FlowNodeBase`](FlowNodeBase.md) + +## Properties + +### antecedents + +> **antecedents**: `undefined` \| [`FlowNode`](../type-aliases/FlowNode.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2071 + +*** + +### flags + +> **flags**: [`FlowFlags`](../enumerations/FlowFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2064 + +#### Inherited from + +[`FlowNodeBase`](FlowNodeBase.md).[`flags`](FlowNodeBase.md#flags) + +*** + +### id? + +> `optional` **id**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2065 + +#### Inherited from + +[`FlowNodeBase`](FlowNodeBase.md).[`id`](FlowNodeBase.md#id) diff --git a/docs/api_docs/namespaces/ts/interfaces/FlowNodeBase.md b/docs/api_docs/namespaces/ts/interfaces/FlowNodeBase.md new file mode 100644 index 0000000000000000000000000000000000000000..6c10d531a1f457b446e88b5b31b82b5ccf32af9c --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/FlowNodeBase.md @@ -0,0 +1,36 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / FlowNodeBase + +# Interface: FlowNodeBase + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2063 + +## Extended by + +- [`FlowStart`](FlowStart.md) +- [`FlowLabel`](FlowLabel.md) +- [`FlowAssignment`](FlowAssignment.md) +- [`FlowCall`](FlowCall.md) +- [`FlowCondition`](FlowCondition.md) +- [`FlowSwitchClause`](FlowSwitchClause.md) +- [`FlowArrayMutation`](FlowArrayMutation.md) +- [`FlowReduceLabel`](FlowReduceLabel.md) + +## Properties + +### flags + +> **flags**: [`FlowFlags`](../enumerations/FlowFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2064 + +*** + +### id? + +> `optional` **id**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2065 diff --git a/docs/api_docs/namespaces/ts/interfaces/FlowReduceLabel.md b/docs/api_docs/namespaces/ts/interfaces/FlowReduceLabel.md new file mode 100644 index 0000000000000000000000000000000000000000..3af25c48a8a16c674485b6a8565ee315b31a9b3f --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/FlowReduceLabel.md @@ -0,0 +1,61 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / FlowReduceLabel + +# Interface: FlowReduceLabel + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2095 + +## Extends + +- [`FlowNodeBase`](FlowNodeBase.md) + +## Properties + +### antecedent + +> **antecedent**: [`FlowNode`](../type-aliases/FlowNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2098 + +*** + +### antecedents + +> **antecedents**: [`FlowNode`](../type-aliases/FlowNode.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2097 + +*** + +### flags + +> **flags**: [`FlowFlags`](../enumerations/FlowFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2064 + +#### Inherited from + +[`FlowNodeBase`](FlowNodeBase.md).[`flags`](FlowNodeBase.md#flags) + +*** + +### id? + +> `optional` **id**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2065 + +#### Inherited from + +[`FlowNodeBase`](FlowNodeBase.md).[`id`](FlowNodeBase.md#id) + +*** + +### target + +> **target**: [`FlowLabel`](FlowLabel.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2096 diff --git a/docs/api_docs/namespaces/ts/interfaces/FlowStart.md b/docs/api_docs/namespaces/ts/interfaces/FlowStart.md new file mode 100644 index 0000000000000000000000000000000000000000..e7d2cd7c3a3d6eb46a8aa818b1de336faca27a97 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/FlowStart.md @@ -0,0 +1,45 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / FlowStart + +# Interface: FlowStart + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2067 + +## Extends + +- [`FlowNodeBase`](FlowNodeBase.md) + +## Properties + +### flags + +> **flags**: [`FlowFlags`](../enumerations/FlowFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2064 + +#### Inherited from + +[`FlowNodeBase`](FlowNodeBase.md).[`flags`](FlowNodeBase.md#flags) + +*** + +### id? + +> `optional` **id**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2065 + +#### Inherited from + +[`FlowNodeBase`](FlowNodeBase.md).[`id`](FlowNodeBase.md#id) + +*** + +### node? + +> `optional` **node**: [`MethodDeclaration`](MethodDeclaration.md) \| [`GetAccessorDeclaration`](GetAccessorDeclaration.md) \| [`SetAccessorDeclaration`](SetAccessorDeclaration.md) \| [`ArrowFunction`](ArrowFunction.md) \| [`FunctionExpression`](FunctionExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2068 diff --git a/docs/api_docs/namespaces/ts/interfaces/FlowSwitchClause.md b/docs/api_docs/namespaces/ts/interfaces/FlowSwitchClause.md new file mode 100644 index 0000000000000000000000000000000000000000..682476b9c44fdca6ca5e4aa1d5b945fc9169b60b --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/FlowSwitchClause.md @@ -0,0 +1,69 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / FlowSwitchClause + +# Interface: FlowSwitchClause + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2085 + +## Extends + +- [`FlowNodeBase`](FlowNodeBase.md) + +## Properties + +### antecedent + +> **antecedent**: [`FlowNode`](../type-aliases/FlowNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2089 + +*** + +### clauseEnd + +> **clauseEnd**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2088 + +*** + +### clauseStart + +> **clauseStart**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2087 + +*** + +### flags + +> **flags**: [`FlowFlags`](../enumerations/FlowFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2064 + +#### Inherited from + +[`FlowNodeBase`](FlowNodeBase.md).[`flags`](FlowNodeBase.md#flags) + +*** + +### id? + +> `optional` **id**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2065 + +#### Inherited from + +[`FlowNodeBase`](FlowNodeBase.md).[`id`](FlowNodeBase.md#id) + +*** + +### switchStatement + +> **switchStatement**: [`SwitchStatement`](SwitchStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2086 diff --git a/docs/api_docs/namespaces/ts/interfaces/ForInStatement.md b/docs/api_docs/namespaces/ts/interfaces/ForInStatement.md new file mode 100644 index 0000000000000000000000000000000000000000..a8946b4bd964e8e278b901597e68809b55670f7f --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ForInStatement.md @@ -0,0 +1,517 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ForInStatement + +# Interface: ForInStatement + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1532 + +## Extends + +- [`IterationStatement`](IterationStatement.md) + +## Properties + +### \_statementBrand + +> **\_statementBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1471 + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`_statementBrand`](IterationStatement.md#_statementbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`decorators`](IterationStatement.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`end`](IterationStatement.md#end) + +*** + +### expression + +> `readonly` **expression**: [`Expression`](Expression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1535 + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`flags`](IterationStatement.md#flags) + +*** + +### initializer + +> `readonly` **initializer**: [`ForInitializer`](../type-aliases/ForInitializer.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1534 + +*** + +### kind + +> `readonly` **kind**: [`ForInStatement`](../enumerations/SyntaxKind.md#forinstatement) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1533 + +#### Overrides + +[`IterationStatement`](IterationStatement.md).[`kind`](IterationStatement.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`locals`](IterationStatement.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`modifiers`](IterationStatement.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`parent`](IterationStatement.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`pos`](IterationStatement.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`skipCheck`](IterationStatement.md#skipcheck) + +*** + +### statement + +> `readonly` **statement**: [`Statement`](Statement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1514 + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`statement`](IterationStatement.md#statement) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`symbol`](IterationStatement.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`forEachChild`](IterationStatement.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getChildAt`](IterationStatement.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getChildCount`](IterationStatement.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getChildren`](IterationStatement.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getEnd`](IterationStatement.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getFirstToken`](IterationStatement.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getFullStart`](IterationStatement.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getFullText`](IterationStatement.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getFullWidth`](IterationStatement.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getLastToken`](IterationStatement.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getLeadingTriviaWidth`](IterationStatement.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getSourceFile`](IterationStatement.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getStart`](IterationStatement.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getText`](IterationStatement.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getWidth`](IterationStatement.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/ForOfStatement.md b/docs/api_docs/namespaces/ts/interfaces/ForOfStatement.md new file mode 100644 index 0000000000000000000000000000000000000000..a224a55b7b737fe524e02459f7e9061f2bde2743 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ForOfStatement.md @@ -0,0 +1,525 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ForOfStatement + +# Interface: ForOfStatement + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1537 + +## Extends + +- [`IterationStatement`](IterationStatement.md) + +## Properties + +### \_statementBrand + +> **\_statementBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1471 + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`_statementBrand`](IterationStatement.md#_statementbrand) + +*** + +### awaitModifier? + +> `readonly` `optional` **awaitModifier**: [`AwaitKeyword`](../type-aliases/AwaitKeyword.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1539 + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`decorators`](IterationStatement.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`end`](IterationStatement.md#end) + +*** + +### expression + +> `readonly` **expression**: [`Expression`](Expression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1541 + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`flags`](IterationStatement.md#flags) + +*** + +### initializer + +> `readonly` **initializer**: [`ForInitializer`](../type-aliases/ForInitializer.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1540 + +*** + +### kind + +> `readonly` **kind**: [`ForOfStatement`](../enumerations/SyntaxKind.md#forofstatement) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1538 + +#### Overrides + +[`IterationStatement`](IterationStatement.md).[`kind`](IterationStatement.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`locals`](IterationStatement.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`modifiers`](IterationStatement.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`parent`](IterationStatement.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`pos`](IterationStatement.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`skipCheck`](IterationStatement.md#skipcheck) + +*** + +### statement + +> `readonly` **statement**: [`Statement`](Statement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1514 + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`statement`](IterationStatement.md#statement) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`symbol`](IterationStatement.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`forEachChild`](IterationStatement.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getChildAt`](IterationStatement.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getChildCount`](IterationStatement.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getChildren`](IterationStatement.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getEnd`](IterationStatement.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getFirstToken`](IterationStatement.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getFullStart`](IterationStatement.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getFullText`](IterationStatement.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getFullWidth`](IterationStatement.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getLastToken`](IterationStatement.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getLeadingTriviaWidth`](IterationStatement.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getSourceFile`](IterationStatement.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getStart`](IterationStatement.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getText`](IterationStatement.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getWidth`](IterationStatement.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/ForStatement.md b/docs/api_docs/namespaces/ts/interfaces/ForStatement.md new file mode 100644 index 0000000000000000000000000000000000000000..acdefd28c305ac1eb19ca8ab082f46bcb4e511e0 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ForStatement.md @@ -0,0 +1,525 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ForStatement + +# Interface: ForStatement + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1525 + +## Extends + +- [`IterationStatement`](IterationStatement.md) + +## Properties + +### \_statementBrand + +> **\_statementBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1471 + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`_statementBrand`](IterationStatement.md#_statementbrand) + +*** + +### condition? + +> `readonly` `optional` **condition**: [`Expression`](Expression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1528 + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`decorators`](IterationStatement.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`end`](IterationStatement.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`flags`](IterationStatement.md#flags) + +*** + +### incrementor? + +> `readonly` `optional` **incrementor**: [`Expression`](Expression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1529 + +*** + +### initializer? + +> `readonly` `optional` **initializer**: [`ForInitializer`](../type-aliases/ForInitializer.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1527 + +*** + +### kind + +> `readonly` **kind**: [`ForStatement`](../enumerations/SyntaxKind.md#forstatement) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1526 + +#### Overrides + +[`IterationStatement`](IterationStatement.md).[`kind`](IterationStatement.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`locals`](IterationStatement.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`modifiers`](IterationStatement.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`parent`](IterationStatement.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`pos`](IterationStatement.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`skipCheck`](IterationStatement.md#skipcheck) + +*** + +### statement + +> `readonly` **statement**: [`Statement`](Statement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1514 + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`statement`](IterationStatement.md#statement) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`symbol`](IterationStatement.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`forEachChild`](IterationStatement.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getChildAt`](IterationStatement.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getChildCount`](IterationStatement.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getChildren`](IterationStatement.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getEnd`](IterationStatement.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getFirstToken`](IterationStatement.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getFullStart`](IterationStatement.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getFullText`](IterationStatement.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getFullWidth`](IterationStatement.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getLastToken`](IterationStatement.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getLeadingTriviaWidth`](IterationStatement.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getSourceFile`](IterationStatement.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getStart`](IterationStatement.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getText`](IterationStatement.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getWidth`](IterationStatement.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/FormatCodeOptions.md b/docs/api_docs/namespaces/ts/interfaces/FormatCodeOptions.md new file mode 100644 index 0000000000000000000000000000000000000000..7e7ba386b596a160faef8aebbf7631fbc86894aa --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/FormatCodeOptions.md @@ -0,0 +1,217 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / FormatCodeOptions + +# Interface: ~~FormatCodeOptions~~ + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6781 + +## Deprecated + +- consider using FormatCodeSettings instead + +## Extends + +- [`EditorOptions`](EditorOptions.md) + +## Properties + +### ~~BaseIndentSize?~~ + +> `optional` **BaseIndentSize**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6764 + +#### Inherited from + +[`EditorOptions`](EditorOptions.md).[`BaseIndentSize`](EditorOptions.md#baseindentsize) + +*** + +### ~~ConvertTabsToSpaces~~ + +> **ConvertTabsToSpaces**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6768 + +#### Inherited from + +[`EditorOptions`](EditorOptions.md).[`ConvertTabsToSpaces`](EditorOptions.md#converttabstospaces) + +*** + +### ~~IndentSize~~ + +> **IndentSize**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6765 + +#### Inherited from + +[`EditorOptions`](EditorOptions.md).[`IndentSize`](EditorOptions.md#indentsize) + +*** + +### ~~IndentStyle~~ + +> **IndentStyle**: [`IndentStyle`](../enumerations/IndentStyle.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6769 + +#### Inherited from + +[`EditorOptions`](EditorOptions.md).[`IndentStyle`](EditorOptions.md#indentstyle) + +*** + +### ~~InsertSpaceAfterCommaDelimiter~~ + +> **InsertSpaceAfterCommaDelimiter**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6782 + +*** + +### ~~InsertSpaceAfterConstructor?~~ + +> `optional` **InsertSpaceAfterConstructor**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6785 + +*** + +### ~~InsertSpaceAfterFunctionKeywordForAnonymousFunctions~~ + +> **InsertSpaceAfterFunctionKeywordForAnonymousFunctions**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6787 + +*** + +### ~~InsertSpaceAfterKeywordsInControlFlowStatements~~ + +> **InsertSpaceAfterKeywordsInControlFlowStatements**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6786 + +*** + +### ~~InsertSpaceAfterOpeningAndBeforeClosingJsxExpressionBraces?~~ + +> `optional` **InsertSpaceAfterOpeningAndBeforeClosingJsxExpressionBraces**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6792 + +*** + +### ~~InsertSpaceAfterOpeningAndBeforeClosingNonemptyBraces?~~ + +> `optional` **InsertSpaceAfterOpeningAndBeforeClosingNonemptyBraces**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6790 + +*** + +### ~~InsertSpaceAfterOpeningAndBeforeClosingNonemptyBrackets~~ + +> **InsertSpaceAfterOpeningAndBeforeClosingNonemptyBrackets**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6789 + +*** + +### ~~InsertSpaceAfterOpeningAndBeforeClosingNonemptyParenthesis~~ + +> **InsertSpaceAfterOpeningAndBeforeClosingNonemptyParenthesis**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6788 + +*** + +### ~~InsertSpaceAfterOpeningAndBeforeClosingTemplateStringBraces~~ + +> **InsertSpaceAfterOpeningAndBeforeClosingTemplateStringBraces**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6791 + +*** + +### ~~InsertSpaceAfterSemicolonInForStatements~~ + +> **InsertSpaceAfterSemicolonInForStatements**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6783 + +*** + +### ~~InsertSpaceAfterTypeAssertion?~~ + +> `optional` **InsertSpaceAfterTypeAssertion**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6793 + +*** + +### ~~InsertSpaceBeforeAndAfterBinaryOperators~~ + +> **InsertSpaceBeforeAndAfterBinaryOperators**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6784 + +*** + +### ~~InsertSpaceBeforeFunctionParenthesis?~~ + +> `optional` **InsertSpaceBeforeFunctionParenthesis**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6794 + +*** + +### ~~insertSpaceBeforeTypeAnnotation?~~ + +> `optional` **insertSpaceBeforeTypeAnnotation**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6797 + +*** + +### ~~NewLineCharacter~~ + +> **NewLineCharacter**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6767 + +#### Inherited from + +[`EditorOptions`](EditorOptions.md).[`NewLineCharacter`](EditorOptions.md#newlinecharacter) + +*** + +### ~~PlaceOpenBraceOnNewLineForControlBlocks~~ + +> **PlaceOpenBraceOnNewLineForControlBlocks**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6796 + +*** + +### ~~PlaceOpenBraceOnNewLineForFunctions~~ + +> **PlaceOpenBraceOnNewLineForFunctions**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6795 + +*** + +### ~~TabSize~~ + +> **TabSize**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6766 + +#### Inherited from + +[`EditorOptions`](EditorOptions.md).[`TabSize`](EditorOptions.md#tabsize) diff --git a/docs/api_docs/namespaces/ts/interfaces/FormatCodeSettings.md b/docs/api_docs/namespaces/ts/interfaces/FormatCodeSettings.md new file mode 100644 index 0000000000000000000000000000000000000000..2a7fc4fc56cc2de40dff4a7a829cce9bc2409009 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/FormatCodeSettings.md @@ -0,0 +1,249 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / FormatCodeSettings + +# Interface: FormatCodeSettings + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6799 + +## Extends + +- [`EditorSettings`](EditorSettings.md) + +## Properties + +### baseIndentSize? + +> `optional` **baseIndentSize**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6772 + +#### Inherited from + +[`EditorSettings`](EditorSettings.md).[`baseIndentSize`](EditorSettings.md#baseindentsize) + +*** + +### convertTabsToSpaces? + +> `optional` **convertTabsToSpaces**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6776 + +#### Inherited from + +[`EditorSettings`](EditorSettings.md).[`convertTabsToSpaces`](EditorSettings.md#converttabstospaces) + +*** + +### indentMultiLineObjectLiteralBeginningOnBlankLine? + +> `readonly` `optional` **indentMultiLineObjectLiteralBeginningOnBlankLine**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6817 + +*** + +### indentSize? + +> `optional` **indentSize**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6773 + +#### Inherited from + +[`EditorSettings`](EditorSettings.md).[`indentSize`](EditorSettings.md#indentsize) + +*** + +### indentStyle? + +> `optional` **indentStyle**: [`IndentStyle`](../enumerations/IndentStyle.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6777 + +#### Inherited from + +[`EditorSettings`](EditorSettings.md).[`indentStyle`](EditorSettings.md#indentstyle) + +*** + +### insertSpaceAfterCommaDelimiter? + +> `readonly` `optional` **insertSpaceAfterCommaDelimiter**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6800 + +*** + +### insertSpaceAfterConstructor? + +> `readonly` `optional` **insertSpaceAfterConstructor**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6803 + +*** + +### insertSpaceAfterFunctionKeywordForAnonymousFunctions? + +> `readonly` `optional` **insertSpaceAfterFunctionKeywordForAnonymousFunctions**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6805 + +*** + +### insertSpaceAfterKeywordsInControlFlowStatements? + +> `readonly` `optional` **insertSpaceAfterKeywordsInControlFlowStatements**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6804 + +*** + +### insertSpaceAfterOpeningAndBeforeClosingEmptyBraces? + +> `readonly` `optional` **insertSpaceAfterOpeningAndBeforeClosingEmptyBraces**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6809 + +*** + +### insertSpaceAfterOpeningAndBeforeClosingJsxExpressionBraces? + +> `readonly` `optional` **insertSpaceAfterOpeningAndBeforeClosingJsxExpressionBraces**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6811 + +*** + +### insertSpaceAfterOpeningAndBeforeClosingNonemptyBraces? + +> `readonly` `optional` **insertSpaceAfterOpeningAndBeforeClosingNonemptyBraces**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6808 + +*** + +### insertSpaceAfterOpeningAndBeforeClosingNonemptyBrackets? + +> `readonly` `optional` **insertSpaceAfterOpeningAndBeforeClosingNonemptyBrackets**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6807 + +*** + +### insertSpaceAfterOpeningAndBeforeClosingNonemptyParenthesis? + +> `readonly` `optional` **insertSpaceAfterOpeningAndBeforeClosingNonemptyParenthesis**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6806 + +*** + +### insertSpaceAfterOpeningAndBeforeClosingTemplateStringBraces? + +> `readonly` `optional` **insertSpaceAfterOpeningAndBeforeClosingTemplateStringBraces**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6810 + +*** + +### insertSpaceAfterSemicolonInForStatements? + +> `readonly` `optional` **insertSpaceAfterSemicolonInForStatements**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6801 + +*** + +### insertSpaceAfterTypeAssertion? + +> `readonly` `optional` **insertSpaceAfterTypeAssertion**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6812 + +*** + +### insertSpaceBeforeAndAfterBinaryOperators? + +> `readonly` `optional` **insertSpaceBeforeAndAfterBinaryOperators**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6802 + +*** + +### insertSpaceBeforeFunctionParenthesis? + +> `readonly` `optional` **insertSpaceBeforeFunctionParenthesis**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6813 + +*** + +### insertSpaceBeforeTypeAnnotation? + +> `readonly` `optional` **insertSpaceBeforeTypeAnnotation**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6816 + +*** + +### newLineCharacter? + +> `optional` **newLineCharacter**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6775 + +#### Inherited from + +[`EditorSettings`](EditorSettings.md).[`newLineCharacter`](EditorSettings.md#newlinecharacter) + +*** + +### placeOpenBraceOnNewLineForControlBlocks? + +> `readonly` `optional` **placeOpenBraceOnNewLineForControlBlocks**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6815 + +*** + +### placeOpenBraceOnNewLineForFunctions? + +> `readonly` `optional` **placeOpenBraceOnNewLineForFunctions**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6814 + +*** + +### semicolons? + +> `readonly` `optional` **semicolons**: [`SemicolonPreference`](../enumerations/SemicolonPreference.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6818 + +*** + +### tabSize? + +> `optional` **tabSize**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6774 + +#### Inherited from + +[`EditorSettings`](EditorSettings.md).[`tabSize`](EditorSettings.md#tabsize) + +*** + +### trimTrailingWhitespace? + +> `optional` **trimTrailingWhitespace**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6778 + +#### Inherited from + +[`EditorSettings`](EditorSettings.md).[`trimTrailingWhitespace`](EditorSettings.md#trimtrailingwhitespace) diff --git a/docs/api_docs/namespaces/ts/interfaces/FormatDiagnosticsHost.md b/docs/api_docs/namespaces/ts/interfaces/FormatDiagnosticsHost.md new file mode 100644 index 0000000000000000000000000000000000000000..4f38f6b55d0026ab82b2bf26a18dc936aa6b87df --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/FormatDiagnosticsHost.md @@ -0,0 +1,51 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / FormatDiagnosticsHost + +# Interface: FormatDiagnosticsHost + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5547 + +## Methods + +### getCanonicalFileName() + +> **getCanonicalFileName**(`fileName`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5549 + +#### Parameters + +##### fileName + +`string` + +#### Returns + +`string` + +*** + +### getCurrentDirectory() + +> **getCurrentDirectory**(): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5548 + +#### Returns + +`string` + +*** + +### getNewLine() + +> **getNewLine**(): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5550 + +#### Returns + +`string` diff --git a/docs/api_docs/namespaces/ts/interfaces/FunctionDeclaration.md b/docs/api_docs/namespaces/ts/interfaces/FunctionDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..aed4e7aef095948d370951ffe46e668c816e2a2e --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/FunctionDeclaration.md @@ -0,0 +1,616 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / FunctionDeclaration + +# Interface: FunctionDeclaration + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:855 + +Several node kinds share function-like features such as a signature, +a name, and a body. These nodes should extend FunctionLikeDeclarationBase. +Examples: +- FunctionDeclaration +- MethodDeclaration +- AccessorDeclaration + +## Extends + +- [`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`DeclarationStatement`](DeclarationStatement.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`_declarationBrand`](DeclarationStatement.md#_declarationbrand) + +*** + +### \_functionLikeDeclarationBrand + +> **\_functionLikeDeclarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:846 + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`_functionLikeDeclarationBrand`](FunctionLikeDeclarationBase.md#_functionlikedeclarationbrand) + +*** + +### \_statementBrand + +> **\_statementBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1471 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`_statementBrand`](DeclarationStatement.md#_statementbrand) + +*** + +### asteriskToken? + +> `readonly` `optional` **asteriskToken**: [`AsteriskToken`](../type-aliases/AsteriskToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:847 + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`asteriskToken`](FunctionLikeDeclarationBase.md#asterisktoken) + +*** + +### body? + +> `readonly` `optional` **body**: [`Block`](Block.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:859 + +#### Overrides + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`body`](FunctionLikeDeclarationBase.md#body) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`decorators`](DeclarationStatement.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`end`](DeclarationStatement.md#end) + +*** + +### exclamationToken? + +> `readonly` `optional` **exclamationToken**: [`ExclamationToken`](../type-aliases/ExclamationToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:849 + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`exclamationToken`](FunctionLikeDeclarationBase.md#exclamationtoken) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`flags`](DeclarationStatement.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`FunctionDeclaration`](../enumerations/SyntaxKind.md#functiondeclaration) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:856 + +#### Overrides + +[`DeclarationStatement`](DeclarationStatement.md).[`kind`](DeclarationStatement.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`locals`](DeclarationStatement.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`Modifier`](../type-aliases/Modifier.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:857 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Overrides + +[`DeclarationStatement`](DeclarationStatement.md).[`modifiers`](DeclarationStatement.md#modifiers) + +*** + +### name? + +> `readonly` `optional` **name**: [`Identifier`](Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:858 + +#### Overrides + +[`DeclarationStatement`](DeclarationStatement.md).[`name`](DeclarationStatement.md#name) + +*** + +### parameters + +> `readonly` **parameters**: [`NodeArray`](NodeArray.md)\<[`ParameterDeclaration`](ParameterDeclaration.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:735 + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`parameters`](FunctionLikeDeclarationBase.md#parameters) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`parent`](DeclarationStatement.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`pos`](DeclarationStatement.md#pos) + +*** + +### questionToken? + +> `readonly` `optional` **questionToken**: [`QuestionToken`](../type-aliases/QuestionToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:848 + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`questionToken`](FunctionLikeDeclarationBase.md#questiontoken) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`skipCheck`](DeclarationStatement.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`symbol`](DeclarationStatement.md#symbol) + +*** + +### type? + +> `readonly` `optional` **type**: [`TypeNode`](TypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:736 + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`type`](FunctionLikeDeclarationBase.md#type) + +*** + +### typeParameters? + +> `readonly` `optional` **typeParameters**: [`NodeArray`](NodeArray.md)\<[`TypeParameterDeclaration`](TypeParameterDeclaration.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:734 + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`typeParameters`](FunctionLikeDeclarationBase.md#typeparameters) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`forEachChild`](DeclarationStatement.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getChildAt`](DeclarationStatement.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getChildCount`](DeclarationStatement.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getChildren`](DeclarationStatement.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getEnd`](DeclarationStatement.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getFirstToken`](DeclarationStatement.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getFullStart`](DeclarationStatement.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getFullText`](DeclarationStatement.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getFullWidth`](DeclarationStatement.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getLastToken`](DeclarationStatement.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getLeadingTriviaWidth`](DeclarationStatement.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getSourceFile`](DeclarationStatement.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getStart`](DeclarationStatement.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getText`](DeclarationStatement.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getWidth`](DeclarationStatement.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/FunctionExpression.md b/docs/api_docs/namespaces/ts/interfaces/FunctionExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..36ef9e7db9425c14dba3ea9f54a89bc597e9b0a9 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/FunctionExpression.md @@ -0,0 +1,676 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / FunctionExpression + +# Interface: FunctionExpression + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1198 + +Several node kinds share function-like features such as a signature, +a name, and a body. These nodes should extend FunctionLikeDeclarationBase. +Examples: +- FunctionDeclaration +- MethodDeclaration +- AccessorDeclaration + +## Extends + +- [`PrimaryExpression`](PrimaryExpression.md).[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`JSDocContainer`](JSDocContainer.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`_declarationBrand`](FunctionLikeDeclarationBase.md#_declarationbrand) + +*** + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_expressionBrand`](PrimaryExpression.md#_expressionbrand) + +*** + +### \_functionLikeDeclarationBrand + +> **\_functionLikeDeclarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:846 + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`_functionLikeDeclarationBrand`](FunctionLikeDeclarationBase.md#_functionlikedeclarationbrand) + +*** + +### \_leftHandSideExpressionBrand + +> **\_leftHandSideExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1086 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_leftHandSideExpressionBrand`](PrimaryExpression.md#_lefthandsideexpressionbrand) + +*** + +### \_memberExpressionBrand + +> **\_memberExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1089 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_memberExpressionBrand`](PrimaryExpression.md#_memberexpressionbrand) + +*** + +### \_primaryExpressionBrand + +> **\_primaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1092 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_primaryExpressionBrand`](PrimaryExpression.md#_primaryexpressionbrand) + +*** + +### \_unaryExpressionBrand + +> **\_unaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1066 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_unaryExpressionBrand`](PrimaryExpression.md#_unaryexpressionbrand) + +*** + +### \_updateExpressionBrand + +> **\_updateExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1071 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_updateExpressionBrand`](PrimaryExpression.md#_updateexpressionbrand) + +*** + +### asteriskToken? + +> `readonly` `optional` **asteriskToken**: [`AsteriskToken`](../type-aliases/AsteriskToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:847 + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`asteriskToken`](FunctionLikeDeclarationBase.md#asterisktoken) + +*** + +### body + +> `readonly` **body**: [`Block`](Block.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1202 + +#### Overrides + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`body`](FunctionLikeDeclarationBase.md#body) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`decorators`](FunctionLikeDeclarationBase.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`end`](FunctionLikeDeclarationBase.md#end) + +*** + +### exclamationToken? + +> `readonly` `optional` **exclamationToken**: [`ExclamationToken`](../type-aliases/ExclamationToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:849 + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`exclamationToken`](FunctionLikeDeclarationBase.md#exclamationtoken) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`flags`](FunctionLikeDeclarationBase.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`FunctionExpression`](../enumerations/SyntaxKind.md#functionexpression) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1199 + +#### Overrides + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`kind`](FunctionLikeDeclarationBase.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`locals`](FunctionLikeDeclarationBase.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`Modifier`](../type-aliases/Modifier.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1200 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Overrides + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`modifiers`](FunctionLikeDeclarationBase.md#modifiers) + +*** + +### name? + +> `readonly` `optional` **name**: [`Identifier`](Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1201 + +#### Overrides + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`name`](FunctionLikeDeclarationBase.md#name) + +*** + +### parameters + +> `readonly` **parameters**: [`NodeArray`](NodeArray.md)\<[`ParameterDeclaration`](ParameterDeclaration.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:735 + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`parameters`](FunctionLikeDeclarationBase.md#parameters) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`parent`](FunctionLikeDeclarationBase.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`pos`](FunctionLikeDeclarationBase.md#pos) + +*** + +### questionToken? + +> `readonly` `optional` **questionToken**: [`QuestionToken`](../type-aliases/QuestionToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:848 + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`questionToken`](FunctionLikeDeclarationBase.md#questiontoken) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`skipCheck`](FunctionLikeDeclarationBase.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`symbol`](FunctionLikeDeclarationBase.md#symbol) + +*** + +### type? + +> `readonly` `optional` **type**: [`TypeNode`](TypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:736 + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`type`](FunctionLikeDeclarationBase.md#type) + +*** + +### typeParameters? + +> `readonly` `optional` **typeParameters**: [`NodeArray`](NodeArray.md)\<[`TypeParameterDeclaration`](TypeParameterDeclaration.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:734 + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`typeParameters`](FunctionLikeDeclarationBase.md#typeparameters) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`forEachChild`](FunctionLikeDeclarationBase.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`getChildAt`](FunctionLikeDeclarationBase.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`getChildCount`](FunctionLikeDeclarationBase.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`getChildren`](FunctionLikeDeclarationBase.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`getEnd`](FunctionLikeDeclarationBase.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`getFirstToken`](FunctionLikeDeclarationBase.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`getFullStart`](FunctionLikeDeclarationBase.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`getFullText`](FunctionLikeDeclarationBase.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`getFullWidth`](FunctionLikeDeclarationBase.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`getLastToken`](FunctionLikeDeclarationBase.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`getLeadingTriviaWidth`](FunctionLikeDeclarationBase.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`getSourceFile`](FunctionLikeDeclarationBase.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`getStart`](FunctionLikeDeclarationBase.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`getText`](FunctionLikeDeclarationBase.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`getWidth`](FunctionLikeDeclarationBase.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/FunctionLikeDeclarationBase.md b/docs/api_docs/namespaces/ts/interfaces/FunctionLikeDeclarationBase.md new file mode 100644 index 0000000000000000000000000000000000000000..cb5c06dc0b8a2e3609491aa0c7e25a27dbb39863 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/FunctionLikeDeclarationBase.md @@ -0,0 +1,594 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / FunctionLikeDeclarationBase + +# Interface: FunctionLikeDeclarationBase + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:845 + +Several node kinds share function-like features such as a signature, +a name, and a body. These nodes should extend FunctionLikeDeclarationBase. +Examples: +- FunctionDeclaration +- MethodDeclaration +- AccessorDeclaration + +## Extends + +- [`SignatureDeclarationBase`](SignatureDeclarationBase.md) + +## Extended by + +- [`FunctionDeclaration`](FunctionDeclaration.md) +- [`MethodDeclaration`](MethodDeclaration.md) +- [`ConstructorDeclaration`](ConstructorDeclaration.md) +- [`GetAccessorDeclaration`](GetAccessorDeclaration.md) +- [`SetAccessorDeclaration`](SetAccessorDeclaration.md) +- [`FunctionExpression`](FunctionExpression.md) +- [`ArrowFunction`](ArrowFunction.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`_declarationBrand`](SignatureDeclarationBase.md#_declarationbrand) + +*** + +### \_functionLikeDeclarationBrand + +> **\_functionLikeDeclarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:846 + +*** + +### asteriskToken? + +> `readonly` `optional` **asteriskToken**: [`AsteriskToken`](../type-aliases/AsteriskToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:847 + +*** + +### body? + +> `readonly` `optional` **body**: [`Expression`](Expression.md) \| [`Block`](Block.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:850 + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`decorators`](SignatureDeclarationBase.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`end`](SignatureDeclarationBase.md#end) + +*** + +### exclamationToken? + +> `readonly` `optional` **exclamationToken**: [`ExclamationToken`](../type-aliases/ExclamationToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:849 + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`flags`](SignatureDeclarationBase.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`MethodSignature`](../enumerations/SyntaxKind.md#methodsignature) \| [`MethodDeclaration`](../enumerations/SyntaxKind.md#methoddeclaration) \| [`Constructor`](../enumerations/SyntaxKind.md#constructor) \| [`GetAccessor`](../enumerations/SyntaxKind.md#getaccessor) \| [`SetAccessor`](../enumerations/SyntaxKind.md#setaccessor) \| [`CallSignature`](../enumerations/SyntaxKind.md#callsignature) \| [`ConstructSignature`](../enumerations/SyntaxKind.md#constructsignature) \| [`IndexSignature`](../enumerations/SyntaxKind.md#indexsignature) \| [`FunctionType`](../enumerations/SyntaxKind.md#functiontype) \| [`ConstructorType`](../enumerations/SyntaxKind.md#constructortype) \| [`FunctionExpression`](../enumerations/SyntaxKind.md#functionexpression) \| [`ArrowFunction`](../enumerations/SyntaxKind.md#arrowfunction) \| [`FunctionDeclaration`](../enumerations/SyntaxKind.md#functiondeclaration) \| [`JSDocFunctionType`](../enumerations/SyntaxKind.md#jsdocfunctiontype) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:732 + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`kind`](SignatureDeclarationBase.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`locals`](SignatureDeclarationBase.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`modifiers`](SignatureDeclarationBase.md#modifiers) + +*** + +### name? + +> `readonly` `optional` **name**: [`PropertyName`](../type-aliases/PropertyName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:733 + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`name`](SignatureDeclarationBase.md#name) + +*** + +### parameters + +> `readonly` **parameters**: [`NodeArray`](NodeArray.md)\<[`ParameterDeclaration`](ParameterDeclaration.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:735 + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`parameters`](SignatureDeclarationBase.md#parameters) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`parent`](SignatureDeclarationBase.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`pos`](SignatureDeclarationBase.md#pos) + +*** + +### questionToken? + +> `readonly` `optional` **questionToken**: [`QuestionToken`](../type-aliases/QuestionToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:848 + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`skipCheck`](SignatureDeclarationBase.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`symbol`](SignatureDeclarationBase.md#symbol) + +*** + +### type? + +> `readonly` `optional` **type**: [`TypeNode`](TypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:736 + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`type`](SignatureDeclarationBase.md#type) + +*** + +### typeParameters? + +> `readonly` `optional` **typeParameters**: [`NodeArray`](NodeArray.md)\<[`TypeParameterDeclaration`](TypeParameterDeclaration.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:734 + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`typeParameters`](SignatureDeclarationBase.md#typeparameters) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`forEachChild`](SignatureDeclarationBase.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`getChildAt`](SignatureDeclarationBase.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`getChildCount`](SignatureDeclarationBase.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`getChildren`](SignatureDeclarationBase.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`getEnd`](SignatureDeclarationBase.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`getFirstToken`](SignatureDeclarationBase.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`getFullStart`](SignatureDeclarationBase.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`getFullText`](SignatureDeclarationBase.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`getFullWidth`](SignatureDeclarationBase.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`getLastToken`](SignatureDeclarationBase.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`getLeadingTriviaWidth`](SignatureDeclarationBase.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`getSourceFile`](SignatureDeclarationBase.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`getStart`](SignatureDeclarationBase.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`getText`](SignatureDeclarationBase.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`getWidth`](SignatureDeclarationBase.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/FunctionOrConstructorTypeNodeBase.md b/docs/api_docs/namespaces/ts/interfaces/FunctionOrConstructorTypeNodeBase.md new file mode 100644 index 0000000000000000000000000000000000000000..aac7fdcd1c9949c3bf88b795e264f54c8c0a1764 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/FunctionOrConstructorTypeNodeBase.md @@ -0,0 +1,554 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / FunctionOrConstructorTypeNodeBase + +# Interface: FunctionOrConstructorTypeNodeBase + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:934 + +## Extends + +- [`TypeNode`](TypeNode.md).[`SignatureDeclarationBase`](SignatureDeclarationBase.md) + +## Extended by + +- [`FunctionTypeNode`](FunctionTypeNode.md) +- [`ConstructorTypeNode`](ConstructorTypeNode.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`_declarationBrand`](SignatureDeclarationBase.md#_declarationbrand) + +*** + +### \_typeNodeBrand + +> **\_typeNodeBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:912 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`_typeNodeBrand`](TypeNode.md#_typenodebrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`decorators`](SignatureDeclarationBase.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`end`](SignatureDeclarationBase.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`flags`](SignatureDeclarationBase.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`FunctionType`](../enumerations/SyntaxKind.md#functiontype) \| [`ConstructorType`](../enumerations/SyntaxKind.md#constructortype) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:935 + +#### Overrides + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`kind`](SignatureDeclarationBase.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`locals`](SignatureDeclarationBase.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`modifiers`](SignatureDeclarationBase.md#modifiers) + +*** + +### name? + +> `readonly` `optional` **name**: [`PropertyName`](../type-aliases/PropertyName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:733 + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`name`](SignatureDeclarationBase.md#name) + +*** + +### parameters + +> `readonly` **parameters**: [`NodeArray`](NodeArray.md)\<[`ParameterDeclaration`](ParameterDeclaration.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:735 + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`parameters`](SignatureDeclarationBase.md#parameters) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`parent`](SignatureDeclarationBase.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`pos`](SignatureDeclarationBase.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`skipCheck`](SignatureDeclarationBase.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`symbol`](SignatureDeclarationBase.md#symbol) + +*** + +### type + +> `readonly` **type**: [`TypeNode`](TypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:936 + +#### Overrides + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`type`](SignatureDeclarationBase.md#type) + +*** + +### typeParameters? + +> `readonly` `optional` **typeParameters**: [`NodeArray`](NodeArray.md)\<[`TypeParameterDeclaration`](TypeParameterDeclaration.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:734 + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`typeParameters`](SignatureDeclarationBase.md#typeparameters) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`forEachChild`](SignatureDeclarationBase.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`getChildAt`](SignatureDeclarationBase.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`getChildCount`](SignatureDeclarationBase.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`getChildren`](SignatureDeclarationBase.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`getEnd`](SignatureDeclarationBase.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`getFirstToken`](SignatureDeclarationBase.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`getFullStart`](SignatureDeclarationBase.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`getFullText`](SignatureDeclarationBase.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`getFullWidth`](SignatureDeclarationBase.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`getLastToken`](SignatureDeclarationBase.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`getLeadingTriviaWidth`](SignatureDeclarationBase.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`getSourceFile`](SignatureDeclarationBase.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`getStart`](SignatureDeclarationBase.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`getText`](SignatureDeclarationBase.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`getWidth`](SignatureDeclarationBase.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/FunctionTypeNode.md b/docs/api_docs/namespaces/ts/interfaces/FunctionTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..ec258acd883aa16114ae8d94a93ec8abd720241d --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/FunctionTypeNode.md @@ -0,0 +1,542 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / FunctionTypeNode + +# Interface: FunctionTypeNode + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:938 + +## Extends + +- [`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md).[`_declarationBrand`](FunctionOrConstructorTypeNodeBase.md#_declarationbrand) + +*** + +### \_typeNodeBrand + +> **\_typeNodeBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:912 + +#### Inherited from + +[`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md).[`_typeNodeBrand`](FunctionOrConstructorTypeNodeBase.md#_typenodebrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md).[`decorators`](FunctionOrConstructorTypeNodeBase.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md).[`end`](FunctionOrConstructorTypeNodeBase.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md).[`flags`](FunctionOrConstructorTypeNodeBase.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`FunctionType`](../enumerations/SyntaxKind.md#functiontype) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:939 + +#### Overrides + +[`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md).[`kind`](FunctionOrConstructorTypeNodeBase.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md).[`locals`](FunctionOrConstructorTypeNodeBase.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`Modifier`](../type-aliases/Modifier.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8408 + +#### Deprecated + +A function type cannot have modifiers + +#### Inherited from + +[`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md).[`modifiers`](FunctionOrConstructorTypeNodeBase.md#modifiers) + +*** + +### name? + +> `readonly` `optional` **name**: [`PropertyName`](../type-aliases/PropertyName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:733 + +#### Inherited from + +[`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md).[`name`](FunctionOrConstructorTypeNodeBase.md#name) + +*** + +### parameters + +> `readonly` **parameters**: [`NodeArray`](NodeArray.md)\<[`ParameterDeclaration`](ParameterDeclaration.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:735 + +#### Inherited from + +[`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md).[`parameters`](FunctionOrConstructorTypeNodeBase.md#parameters) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md).[`parent`](FunctionOrConstructorTypeNodeBase.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md).[`pos`](FunctionOrConstructorTypeNodeBase.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md).[`skipCheck`](FunctionOrConstructorTypeNodeBase.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md).[`symbol`](FunctionOrConstructorTypeNodeBase.md#symbol) + +*** + +### type + +> `readonly` **type**: [`TypeNode`](TypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:936 + +#### Inherited from + +[`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md).[`type`](FunctionOrConstructorTypeNodeBase.md#type) + +*** + +### typeParameters? + +> `readonly` `optional` **typeParameters**: [`NodeArray`](NodeArray.md)\<[`TypeParameterDeclaration`](TypeParameterDeclaration.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:734 + +#### Inherited from + +[`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md).[`typeParameters`](FunctionOrConstructorTypeNodeBase.md#typeparameters) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md).[`forEachChild`](FunctionOrConstructorTypeNodeBase.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md).[`getChildAt`](FunctionOrConstructorTypeNodeBase.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md).[`getChildCount`](FunctionOrConstructorTypeNodeBase.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md).[`getChildren`](FunctionOrConstructorTypeNodeBase.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md).[`getEnd`](FunctionOrConstructorTypeNodeBase.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md).[`getFirstToken`](FunctionOrConstructorTypeNodeBase.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md).[`getFullStart`](FunctionOrConstructorTypeNodeBase.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md).[`getFullText`](FunctionOrConstructorTypeNodeBase.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md).[`getFullWidth`](FunctionOrConstructorTypeNodeBase.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md).[`getLastToken`](FunctionOrConstructorTypeNodeBase.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md).[`getLeadingTriviaWidth`](FunctionOrConstructorTypeNodeBase.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md).[`getSourceFile`](FunctionOrConstructorTypeNodeBase.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md).[`getStart`](FunctionOrConstructorTypeNodeBase.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md).[`getText`](FunctionOrConstructorTypeNodeBase.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md).[`getWidth`](FunctionOrConstructorTypeNodeBase.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/GenericType.md b/docs/api_docs/namespaces/ts/interfaces/GenericType.md new file mode 100644 index 0000000000000000000000000000000000000000..00df698ca2e511d7d9f39ccbab3d08f5fdc8f85f --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/GenericType.md @@ -0,0 +1,549 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / GenericType + +# Interface: GenericType + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2850 + +Class and interface types (ObjectFlags.Class and ObjectFlags.Interface). + +## Extends + +- [`InterfaceType`](InterfaceType.md).[`TypeReference`](TypeReference.md) + +## Extended by + +- [`TupleType`](TupleType.md) + +## Properties + +### aliasSymbol? + +> `optional` **aliasSymbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2773 + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`aliasSymbol`](TypeReference.md#aliassymbol) + +*** + +### aliasTypeArguments? + +> `optional` **aliasTypeArguments**: readonly [`Type`](Type.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2774 + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`aliasTypeArguments`](TypeReference.md#aliastypearguments) + +*** + +### flags + +> **flags**: [`TypeFlags`](../enumerations/TypeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2770 + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`flags`](TypeReference.md#flags) + +*** + +### localTypeParameters + +> **localTypeParameters**: `undefined` \| [`TypeParameter`](TypeParameter.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2824 + +#### Inherited from + +[`InterfaceType`](InterfaceType.md).[`localTypeParameters`](InterfaceType.md#localtypeparameters) + +*** + +### node? + +> `optional` **node**: [`TypeReferenceNode`](TypeReferenceNode.md) \| [`ArrayTypeNode`](ArrayTypeNode.md) \| [`TupleTypeNode`](TupleTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2846 + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`node`](TypeReference.md#node) + +*** + +### objectFlags + +> **objectFlags**: [`ObjectFlags`](../enumerations/ObjectFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2818 + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`objectFlags`](TypeReference.md#objectflags) + +*** + +### outerTypeParameters + +> **outerTypeParameters**: `undefined` \| [`TypeParameter`](TypeParameter.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2823 + +#### Inherited from + +[`InterfaceType`](InterfaceType.md).[`outerTypeParameters`](InterfaceType.md#outertypeparameters) + +*** + +### pattern? + +> `optional` **pattern**: [`DestructuringPattern`](../type-aliases/DestructuringPattern.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2772 + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`pattern`](TypeReference.md#pattern) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2771 + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`symbol`](TypeReference.md#symbol) + +*** + +### target + +> **target**: [`GenericType`](GenericType.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2845 + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`target`](TypeReference.md#target) + +*** + +### thisType + +> **thisType**: `undefined` \| [`TypeParameter`](TypeParameter.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2825 + +#### Inherited from + +[`InterfaceType`](InterfaceType.md).[`thisType`](InterfaceType.md#thistype) + +*** + +### typeArguments? + +> `optional` **typeArguments**: readonly [`Type`](Type.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6145 + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`typeArguments`](TypeReference.md#typearguments) + +*** + +### typeParameters + +> **typeParameters**: `undefined` \| [`TypeParameter`](TypeParameter.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2822 + +#### Inherited from + +[`InterfaceType`](InterfaceType.md).[`typeParameters`](InterfaceType.md#typeparameters) + +## Methods + +### getApparentProperties() + +> **getApparentProperties**(): [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6124 + +#### Returns + +[`Symbol`](Symbol.md)[] + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`getApparentProperties`](TypeReference.md#getapparentproperties) + +*** + +### getBaseTypes() + +> **getBaseTypes**(): `undefined` \| [`BaseType`](../type-aliases/BaseType.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6129 + +#### Returns + +`undefined` \| [`BaseType`](../type-aliases/BaseType.md)[] + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`getBaseTypes`](TypeReference.md#getbasetypes) + +*** + +### getCallSignatures() + +> **getCallSignatures**(): readonly [`Signature`](Signature.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6125 + +#### Returns + +readonly [`Signature`](Signature.md)[] + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`getCallSignatures`](TypeReference.md#getcallsignatures) + +*** + +### getConstraint() + +> **getConstraint**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6131 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`getConstraint`](TypeReference.md#getconstraint) + +*** + +### getConstructSignatures() + +> **getConstructSignatures**(): readonly [`Signature`](Signature.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6126 + +#### Returns + +readonly [`Signature`](Signature.md)[] + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`getConstructSignatures`](TypeReference.md#getconstructsignatures) + +*** + +### getDefault() + +> **getDefault**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6132 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`getDefault`](TypeReference.md#getdefault) + +*** + +### getFlags() + +> **getFlags**(): [`TypeFlags`](../enumerations/TypeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6120 + +#### Returns + +[`TypeFlags`](../enumerations/TypeFlags.md) + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`getFlags`](TypeReference.md#getflags) + +*** + +### getNonNullableType() + +> **getNonNullableType**(): [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6130 + +#### Returns + +[`Type`](Type.md) + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`getNonNullableType`](TypeReference.md#getnonnullabletype) + +*** + +### getNumberIndexType() + +> **getNumberIndexType**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6128 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`getNumberIndexType`](TypeReference.md#getnumberindextype) + +*** + +### getProperties() + +> **getProperties**(): [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6122 + +#### Returns + +[`Symbol`](Symbol.md)[] + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`getProperties`](TypeReference.md#getproperties) + +*** + +### getProperty() + +> **getProperty**(`propertyName`): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6123 + +#### Parameters + +##### propertyName + +`string` + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`getProperty`](TypeReference.md#getproperty) + +*** + +### getStringIndexType() + +> **getStringIndexType**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6127 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`getStringIndexType`](TypeReference.md#getstringindextype) + +*** + +### getSymbol() + +> **getSymbol**(): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6121 + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`getSymbol`](TypeReference.md#getsymbol) + +*** + +### isClass() + +> **isClass**(): `this is InterfaceType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6141 + +#### Returns + +`this is InterfaceType` + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`isClass`](TypeReference.md#isclass) + +*** + +### isClassOrInterface() + +> **isClassOrInterface**(): `this is InterfaceType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6140 + +#### Returns + +`this is InterfaceType` + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`isClassOrInterface`](TypeReference.md#isclassorinterface) + +*** + +### isIndexType() + +> **isIndexType**(): `this is IndexType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6142 + +#### Returns + +`this is IndexType` + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`isIndexType`](TypeReference.md#isindextype) + +*** + +### isIntersection() + +> **isIntersection**(): `this is IntersectionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6134 + +#### Returns + +`this is IntersectionType` + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`isIntersection`](TypeReference.md#isintersection) + +*** + +### isLiteral() + +> **isLiteral**(): `this is LiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6136 + +#### Returns + +`this is LiteralType` + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`isLiteral`](TypeReference.md#isliteral) + +*** + +### isNumberLiteral() + +> **isNumberLiteral**(): `this is NumberLiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6138 + +#### Returns + +`this is NumberLiteralType` + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`isNumberLiteral`](TypeReference.md#isnumberliteral) + +*** + +### isStringLiteral() + +> **isStringLiteral**(): `this is StringLiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6137 + +#### Returns + +`this is StringLiteralType` + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`isStringLiteral`](TypeReference.md#isstringliteral) + +*** + +### isTypeParameter() + +> **isTypeParameter**(): `this is TypeParameter` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6139 + +#### Returns + +`this is TypeParameter` + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`isTypeParameter`](TypeReference.md#istypeparameter) + +*** + +### isUnion() + +> **isUnion**(): `this is UnionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6133 + +#### Returns + +`this is UnionType` + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`isUnion`](TypeReference.md#isunion) + +*** + +### isUnionOrIntersection() + +> **isUnionOrIntersection**(): `this is UnionOrIntersectionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6135 + +#### Returns + +`this is UnionOrIntersectionType` + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`isUnionOrIntersection`](TypeReference.md#isunionorintersection) diff --git a/docs/api_docs/namespaces/ts/interfaces/GetAccessorDeclaration.md b/docs/api_docs/namespaces/ts/interfaces/GetAccessorDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..34e9a7f62ff21c81a2e8d03475887cbf731294a7 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/GetAccessorDeclaration.md @@ -0,0 +1,640 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / GetAccessorDeclaration + +# Interface: GetAccessorDeclaration + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:885 + +Several node kinds share function-like features such as a signature, +a name, and a body. These nodes should extend FunctionLikeDeclarationBase. +Examples: +- FunctionDeclaration +- MethodDeclaration +- AccessorDeclaration + +## Extends + +- [`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`ClassElement`](ClassElement.md).[`TypeElement`](TypeElement.md).[`ObjectLiteralElement`](ObjectLiteralElement.md).[`JSDocContainer`](JSDocContainer.md) + +## Properties + +### \_classElementBrand + +> **\_classElementBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1633 + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`_classElementBrand`](ClassElement.md#_classelementbrand) + +*** + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`_declarationBrand`](ObjectLiteralElement.md#_declarationbrand) + +*** + +### \_functionLikeDeclarationBrand + +> **\_functionLikeDeclarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:846 + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`_functionLikeDeclarationBrand`](FunctionLikeDeclarationBase.md#_functionlikedeclarationbrand) + +*** + +### \_objectLiteralBrand + +> **\_objectLiteralBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:798 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`_objectLiteralBrand`](ObjectLiteralElement.md#_objectliteralbrand) + +*** + +### \_typeElementBrand + +> **\_typeElementBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1637 + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`_typeElementBrand`](TypeElement.md#_typeelementbrand) + +*** + +### asteriskToken? + +> `readonly` `optional` **asteriskToken**: [`AsteriskToken`](../type-aliases/AsteriskToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:847 + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`asteriskToken`](FunctionLikeDeclarationBase.md#asterisktoken) + +*** + +### body? + +> `readonly` `optional` **body**: [`Block`](Block.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:890 + +#### Overrides + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`body`](FunctionLikeDeclarationBase.md#body) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`decorators`](ObjectLiteralElement.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`end`](ObjectLiteralElement.md#end) + +*** + +### exclamationToken? + +> `readonly` `optional` **exclamationToken**: [`ExclamationToken`](../type-aliases/ExclamationToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:849 + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`exclamationToken`](FunctionLikeDeclarationBase.md#exclamationtoken) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`flags`](ObjectLiteralElement.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`GetAccessor`](../enumerations/SyntaxKind.md#getaccessor) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:886 + +#### Overrides + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`kind`](ObjectLiteralElement.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`locals`](ObjectLiteralElement.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:888 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Overrides + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`modifiers`](ObjectLiteralElement.md#modifiers) + +*** + +### name + +> `readonly` **name**: [`PropertyName`](../type-aliases/PropertyName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:889 + +#### Overrides + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`name`](ObjectLiteralElement.md#name) + +*** + +### parameters + +> `readonly` **parameters**: [`NodeArray`](NodeArray.md)\<[`ParameterDeclaration`](ParameterDeclaration.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:735 + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`parameters`](FunctionLikeDeclarationBase.md#parameters) + +*** + +### parent + +> `readonly` **parent**: [`ClassLikeDeclaration`](../type-aliases/ClassLikeDeclaration.md) \| [`ObjectLiteralExpression`](ObjectLiteralExpression.md) \| [`InterfaceDeclaration`](InterfaceDeclaration.md) \| [`TypeLiteralNode`](TypeLiteralNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:887 + +#### Overrides + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`parent`](ObjectLiteralElement.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`pos`](ObjectLiteralElement.md#pos) + +*** + +### questionToken? + +> `readonly` `optional` **questionToken**: [`QuestionToken`](../type-aliases/QuestionToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:848 + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`questionToken`](TypeElement.md#questiontoken) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`skipCheck`](ObjectLiteralElement.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`symbol`](ObjectLiteralElement.md#symbol) + +*** + +### type? + +> `readonly` `optional` **type**: [`TypeNode`](TypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:736 + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`type`](FunctionLikeDeclarationBase.md#type) + +*** + +### typeParameters? + +> `readonly` `optional` **typeParameters**: [`NodeArray`](NodeArray.md)\<[`TypeParameterDeclaration`](TypeParameterDeclaration.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:734 + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`typeParameters`](FunctionLikeDeclarationBase.md#typeparameters) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`forEachChild`](ObjectLiteralElement.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getChildAt`](ObjectLiteralElement.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getChildCount`](ObjectLiteralElement.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getChildren`](ObjectLiteralElement.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getEnd`](ObjectLiteralElement.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getFirstToken`](ObjectLiteralElement.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getFullStart`](ObjectLiteralElement.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getFullText`](ObjectLiteralElement.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getFullWidth`](ObjectLiteralElement.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getLastToken`](ObjectLiteralElement.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getLeadingTriviaWidth`](ObjectLiteralElement.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getSourceFile`](ObjectLiteralElement.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getStart`](ObjectLiteralElement.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getText`](ObjectLiteralElement.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getWidth`](ObjectLiteralElement.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/GetCompletionsAtPositionOptions.md b/docs/api_docs/namespaces/ts/interfaces/GetCompletionsAtPositionOptions.md new file mode 100644 index 0000000000000000000000000000000000000000..c6d7a9d1c9d7e359b746ed62e1f1dbe01474a8a1 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/GetCompletionsAtPositionOptions.md @@ -0,0 +1,394 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / GetCompletionsAtPositionOptions + +# Interface: GetCompletionsAtPositionOptions + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6461 + +## Extends + +- [`UserPreferences`](UserPreferences.md) + +## Properties + +### allowIncompleteCompletions? + +> `readonly` `optional` **allowIncompleteCompletions**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4486 + +#### Inherited from + +[`UserPreferences`](UserPreferences.md).[`allowIncompleteCompletions`](UserPreferences.md#allowincompletecompletions) + +*** + +### allowRenameOfImportPath? + +> `readonly` `optional` **allowRenameOfImportPath**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4503 + +#### Inherited from + +[`UserPreferences`](UserPreferences.md).[`allowRenameOfImportPath`](UserPreferences.md#allowrenameofimportpath) + +*** + +### allowTextChangesInNewFiles? + +> `readonly` `optional` **allowTextChangesInNewFiles**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4490 + +#### Inherited from + +[`UserPreferences`](UserPreferences.md).[`allowTextChangesInNewFiles`](UserPreferences.md#allowtextchangesinnewfiles) + +*** + +### autoImportFileExcludePatterns? + +> `readonly` `optional` **autoImportFileExcludePatterns**: `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4504 + +#### Inherited from + +[`UserPreferences`](UserPreferences.md).[`autoImportFileExcludePatterns`](UserPreferences.md#autoimportfileexcludepatterns) + +*** + +### disableSuggestions? + +> `readonly` `optional` **disableSuggestions**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4476 + +#### Inherited from + +[`UserPreferences`](UserPreferences.md).[`disableSuggestions`](UserPreferences.md#disablesuggestions) + +*** + +### importModuleSpecifierEnding? + +> `readonly` `optional` **importModuleSpecifierEnding**: `"index"` \| `"auto"` \| `"minimal"` \| `"js"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4489 + +Determines whether we import `foo/index.ts` as "foo", "foo/index", or "foo/index.js" + +#### Inherited from + +[`UserPreferences`](UserPreferences.md).[`importModuleSpecifierEnding`](UserPreferences.md#importmodulespecifierending) + +*** + +### importModuleSpecifierPreference? + +> `readonly` `optional` **importModuleSpecifierPreference**: `"shortest"` \| `"project-relative"` \| `"relative"` \| `"non-relative"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4487 + +#### Inherited from + +[`UserPreferences`](UserPreferences.md).[`importModuleSpecifierPreference`](UserPreferences.md#importmodulespecifierpreference) + +*** + +### includeAutomaticOptionalChainCompletions? + +> `readonly` `optional` **includeAutomaticOptionalChainCompletions**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4481 + +#### Inherited from + +[`UserPreferences`](UserPreferences.md).[`includeAutomaticOptionalChainCompletions`](UserPreferences.md#includeautomaticoptionalchaincompletions) + +*** + +### includeCompletionsForImportStatements? + +> `readonly` `optional` **includeCompletionsForImportStatements**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4479 + +#### Inherited from + +[`UserPreferences`](UserPreferences.md).[`includeCompletionsForImportStatements`](UserPreferences.md#includecompletionsforimportstatements) + +*** + +### includeCompletionsForModuleExports? + +> `readonly` `optional` **includeCompletionsForModuleExports**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4478 + +#### Inherited from + +[`UserPreferences`](UserPreferences.md).[`includeCompletionsForModuleExports`](UserPreferences.md#includecompletionsformoduleexports) + +*** + +### includeCompletionsWithClassMemberSnippets? + +> `readonly` `optional` **includeCompletionsWithClassMemberSnippets**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4483 + +#### Inherited from + +[`UserPreferences`](UserPreferences.md).[`includeCompletionsWithClassMemberSnippets`](UserPreferences.md#includecompletionswithclassmembersnippets) + +*** + +### includeCompletionsWithInsertText? + +> `readonly` `optional` **includeCompletionsWithInsertText**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4482 + +#### Inherited from + +[`UserPreferences`](UserPreferences.md).[`includeCompletionsWithInsertText`](UserPreferences.md#includecompletionswithinserttext) + +*** + +### includeCompletionsWithObjectLiteralMethodSnippets? + +> `readonly` `optional` **includeCompletionsWithObjectLiteralMethodSnippets**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4484 + +#### Inherited from + +[`UserPreferences`](UserPreferences.md).[`includeCompletionsWithObjectLiteralMethodSnippets`](UserPreferences.md#includecompletionswithobjectliteralmethodsnippets) + +*** + +### includeCompletionsWithSnippetText? + +> `readonly` `optional` **includeCompletionsWithSnippetText**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4480 + +#### Inherited from + +[`UserPreferences`](UserPreferences.md).[`includeCompletionsWithSnippetText`](UserPreferences.md#includecompletionswithsnippettext) + +*** + +### ~~includeExternalModuleExports?~~ + +> `optional` **includeExternalModuleExports**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6469 + +#### Deprecated + +Use includeCompletionsForModuleExports + +*** + +### includeInlayEnumMemberValueHints? + +> `readonly` `optional` **includeInlayEnumMemberValueHints**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4502 + +#### Inherited from + +[`UserPreferences`](UserPreferences.md).[`includeInlayEnumMemberValueHints`](UserPreferences.md#includeinlayenummembervaluehints) + +*** + +### includeInlayFunctionLikeReturnTypeHints? + +> `readonly` `optional` **includeInlayFunctionLikeReturnTypeHints**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4501 + +#### Inherited from + +[`UserPreferences`](UserPreferences.md).[`includeInlayFunctionLikeReturnTypeHints`](UserPreferences.md#includeinlayfunctionlikereturntypehints) + +*** + +### includeInlayFunctionParameterTypeHints? + +> `readonly` `optional` **includeInlayFunctionParameterTypeHints**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4497 + +#### Inherited from + +[`UserPreferences`](UserPreferences.md).[`includeInlayFunctionParameterTypeHints`](UserPreferences.md#includeinlayfunctionparametertypehints) + +*** + +### includeInlayParameterNameHints? + +> `readonly` `optional` **includeInlayParameterNameHints**: `"all"` \| `"none"` \| `"literals"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4495 + +#### Inherited from + +[`UserPreferences`](UserPreferences.md).[`includeInlayParameterNameHints`](UserPreferences.md#includeinlayparameternamehints) + +*** + +### includeInlayParameterNameHintsWhenArgumentMatchesName? + +> `readonly` `optional` **includeInlayParameterNameHintsWhenArgumentMatchesName**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4496 + +#### Inherited from + +[`UserPreferences`](UserPreferences.md).[`includeInlayParameterNameHintsWhenArgumentMatchesName`](UserPreferences.md#includeinlayparameternamehintswhenargumentmatchesname) + +*** + +### includeInlayPropertyDeclarationTypeHints? + +> `readonly` `optional` **includeInlayPropertyDeclarationTypeHints**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4500 + +#### Inherited from + +[`UserPreferences`](UserPreferences.md).[`includeInlayPropertyDeclarationTypeHints`](UserPreferences.md#includeinlaypropertydeclarationtypehints) + +*** + +### includeInlayVariableTypeHints? + +> `readonly` `optional` **includeInlayVariableTypeHints**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4498 + +#### Inherited from + +[`UserPreferences`](UserPreferences.md).[`includeInlayVariableTypeHints`](UserPreferences.md#includeinlayvariabletypehints) + +*** + +### includeInlayVariableTypeHintsWhenTypeMatchesName? + +> `readonly` `optional` **includeInlayVariableTypeHintsWhenTypeMatchesName**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4499 + +#### Inherited from + +[`UserPreferences`](UserPreferences.md).[`includeInlayVariableTypeHintsWhenTypeMatchesName`](UserPreferences.md#includeinlayvariabletypehintswhentypematchesname) + +*** + +### ~~includeInsertTextCompletions?~~ + +> `optional` **includeInsertTextCompletions**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6471 + +#### Deprecated + +Use includeCompletionsWithInsertText + +*** + +### includePackageJsonAutoImports? + +> `readonly` `optional` **includePackageJsonAutoImports**: `"on"` \| `"off"` \| `"auto"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4492 + +#### Inherited from + +[`UserPreferences`](UserPreferences.md).[`includePackageJsonAutoImports`](UserPreferences.md#includepackagejsonautoimports) + +*** + +### jsxAttributeCompletionStyle? + +> `readonly` `optional` **jsxAttributeCompletionStyle**: `"auto"` \| `"braces"` \| `"none"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4494 + +#### Inherited from + +[`UserPreferences`](UserPreferences.md).[`jsxAttributeCompletionStyle`](UserPreferences.md#jsxattributecompletionstyle) + +*** + +### providePrefixAndSuffixTextForRename? + +> `readonly` `optional` **providePrefixAndSuffixTextForRename**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4491 + +#### Inherited from + +[`UserPreferences`](UserPreferences.md).[`providePrefixAndSuffixTextForRename`](UserPreferences.md#provideprefixandsuffixtextforrename) + +*** + +### provideRefactorNotApplicableReason? + +> `readonly` `optional` **provideRefactorNotApplicableReason**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4493 + +#### Inherited from + +[`UserPreferences`](UserPreferences.md).[`provideRefactorNotApplicableReason`](UserPreferences.md#providerefactornotapplicablereason) + +*** + +### quotePreference? + +> `readonly` `optional` **quotePreference**: `"auto"` \| `"double"` \| `"single"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4477 + +#### Inherited from + +[`UserPreferences`](UserPreferences.md).[`quotePreference`](UserPreferences.md#quotepreference) + +*** + +### triggerCharacter? + +> `optional` **triggerCharacter**: [`CompletionsTriggerCharacter`](../type-aliases/CompletionsTriggerCharacter.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6466 + +If the editor is asking for completions because a certain character was typed +(as opposed to when the user explicitly requested them) this should be set. + +*** + +### triggerKind? + +> `optional` **triggerKind**: [`CompletionTriggerKind`](../enumerations/CompletionTriggerKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6467 + +*** + +### useLabelDetailsInCompletionEntries? + +> `readonly` `optional` **useLabelDetailsInCompletionEntries**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4485 + +#### Inherited from + +[`UserPreferences`](UserPreferences.md).[`useLabelDetailsInCompletionEntries`](UserPreferences.md#uselabeldetailsincompletionentries) diff --git a/docs/api_docs/namespaces/ts/interfaces/GetEffectiveTypeRootsHost.md b/docs/api_docs/namespaces/ts/interfaces/GetEffectiveTypeRootsHost.md new file mode 100644 index 0000000000000000000000000000000000000000..a1b1a0074e4b841280e27119d803dad87c956858 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/GetEffectiveTypeRootsHost.md @@ -0,0 +1,43 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / GetEffectiveTypeRootsHost + +# Interface: GetEffectiveTypeRootsHost + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4336 + +## Extended by + +- [`LanguageServiceHost`](LanguageServiceHost.md) + +## Methods + +### directoryExists()? + +> `optional` **directoryExists**(`directoryName`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4337 + +#### Parameters + +##### directoryName + +`string` + +#### Returns + +`boolean` + +*** + +### getCurrentDirectory()? + +> `optional` **getCurrentDirectory**(): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4338 + +#### Returns + +`string` diff --git a/docs/api_docs/namespaces/ts/interfaces/HeritageClause.md b/docs/api_docs/namespaces/ts/interfaces/HeritageClause.md new file mode 100644 index 0000000000000000000000000000000000000000..c43e580db873756fbf6ab42efac29f03fea3ce61 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/HeritageClause.md @@ -0,0 +1,493 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / HeritageClause + +# Interface: HeritageClause + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1649 + +## Extends + +- [`Node`](Node.md) + +## Properties + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`decorators`](Node.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Node`](Node.md).[`end`](Node.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Node`](Node.md).[`flags`](Node.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`HeritageClause`](../enumerations/SyntaxKind.md#heritageclause) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1650 + +#### Overrides + +[`Node`](Node.md).[`kind`](Node.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Node`](Node.md).[`locals`](Node.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`modifiers`](Node.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`ClassLikeDeclaration`](../type-aliases/ClassLikeDeclaration.md) \| [`InterfaceDeclaration`](InterfaceDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1651 + +#### Overrides + +[`Node`](Node.md).[`parent`](Node.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Node`](Node.md).[`pos`](Node.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Node`](Node.md).[`skipCheck`](Node.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Node`](Node.md).[`symbol`](Node.md#symbol) + +*** + +### token + +> `readonly` **token**: [`ExtendsKeyword`](../enumerations/SyntaxKind.md#extendskeyword) \| [`ImplementsKeyword`](../enumerations/SyntaxKind.md#implementskeyword) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1652 + +*** + +### types + +> `readonly` **types**: [`NodeArray`](NodeArray.md)\<[`ExpressionWithTypeArguments`](ExpressionWithTypeArguments.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1653 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Node`](Node.md).[`forEachChild`](Node.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getChildAt`](Node.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getChildCount`](Node.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Node`](Node.md).[`getChildren`](Node.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getEnd`](Node.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getFirstToken`](Node.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullStart`](Node.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getFullText`](Node.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullWidth`](Node.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getLastToken`](Node.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getLeadingTriviaWidth`](Node.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Node`](Node.md).[`getSourceFile`](Node.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getStart`](Node.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getText`](Node.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getWidth`](Node.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/HighlightSpan.md b/docs/api_docs/namespaces/ts/interfaces/HighlightSpan.md new file mode 100644 index 0000000000000000000000000000000000000000..755c1d75612c25b8e5c276ff2038d5fd642f2af2 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/HighlightSpan.md @@ -0,0 +1,49 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / HighlightSpan + +# Interface: HighlightSpan + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6734 + +## Properties + +### contextSpan? + +> `optional` **contextSpan**: [`TextSpan`](TextSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6738 + +*** + +### fileName? + +> `optional` **fileName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6735 + +*** + +### isInString? + +> `optional` **isInString**: `true` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6736 + +*** + +### kind + +> **kind**: [`HighlightSpanKind`](../enumerations/HighlightSpanKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6739 + +*** + +### textSpan + +> **textSpan**: [`TextSpan`](TextSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6737 diff --git a/docs/api_docs/namespaces/ts/interfaces/HostCancellationToken.md b/docs/api_docs/namespaces/ts/interfaces/HostCancellationToken.md new file mode 100644 index 0000000000000000000000000000000000000000..363191c3281c035d3c8cafc9d8e1029c1b2b328f --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/HostCancellationToken.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / HostCancellationToken + +# Interface: HostCancellationToken + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6201 + +## Methods + +### isCancellationRequested() + +> **isCancellationRequested**(): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6202 + +#### Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/interfaces/IScriptSnapshot.md b/docs/api_docs/namespaces/ts/interfaces/IScriptSnapshot.md new file mode 100644 index 0000000000000000000000000000000000000000..3b336efe42a3ee151abe68f3ce6ad25cd0ffeda4 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/IScriptSnapshot.md @@ -0,0 +1,89 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / IScriptSnapshot + +# Interface: IScriptSnapshot + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6174 + +Represents an immutable snapshot of a script at a specified time.Once acquired, the +snapshot is observably immutable. i.e. the same calls with the same parameters will return +the same values. + +## Methods + +### dispose()? + +> `optional` **dispose**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6188 + +Releases all resources held by this script snapshot + +#### Returns + +`void` + +*** + +### getChangeRange() + +> **getChangeRange**(`oldSnapshot`): `undefined` \| [`TextChangeRange`](TextChangeRange.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6186 + +Gets the TextChangeRange that describe how the text changed between this text and +an older version. This information is used by the incremental parser to determine +what sections of the script need to be re-parsed. 'undefined' can be returned if the +change range cannot be determined. However, in that case, incremental parsing will +not happen and the entire document will be re - parsed. + +#### Parameters + +##### oldSnapshot + +[`IScriptSnapshot`](IScriptSnapshot.md) + +#### Returns + +`undefined` \| [`TextChangeRange`](TextChangeRange.md) + +*** + +### getLength() + +> **getLength**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6178 + +Gets the length of this script snapshot. + +#### Returns + +`number` + +*** + +### getText() + +> **getText**(`start`, `end`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6176 + +Gets a portion of the script snapshot specified by [start, end). + +#### Parameters + +##### start + +`number` + +##### end + +`number` + +#### Returns + +`string` diff --git a/docs/api_docs/namespaces/ts/interfaces/Identifier.md b/docs/api_docs/namespaces/ts/interfaces/Identifier.md new file mode 100644 index 0000000000000000000000000000000000000000..34f21aae561d8cfd804b3945742a40c5f897551f --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/Identifier.md @@ -0,0 +1,600 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / Identifier + +# Interface: Identifier + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:676 + +## Extends + +- [`PrimaryExpression`](PrimaryExpression.md).[`Declaration`](Declaration.md) + +## Extended by + +- [`TransientIdentifier`](TransientIdentifier.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`Declaration`](Declaration.md).[`_declarationBrand`](Declaration.md#_declarationbrand) + +*** + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_expressionBrand`](PrimaryExpression.md#_expressionbrand) + +*** + +### \_leftHandSideExpressionBrand + +> **\_leftHandSideExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1086 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_leftHandSideExpressionBrand`](PrimaryExpression.md#_lefthandsideexpressionbrand) + +*** + +### \_memberExpressionBrand + +> **\_memberExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1089 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_memberExpressionBrand`](PrimaryExpression.md#_memberexpressionbrand) + +*** + +### \_primaryExpressionBrand + +> **\_primaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1092 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_primaryExpressionBrand`](PrimaryExpression.md#_primaryexpressionbrand) + +*** + +### \_unaryExpressionBrand + +> **\_unaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1066 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_unaryExpressionBrand`](PrimaryExpression.md#_unaryexpressionbrand) + +*** + +### \_updateExpressionBrand + +> **\_updateExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1071 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_updateExpressionBrand`](PrimaryExpression.md#_updateexpressionbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Declaration`](Declaration.md).[`decorators`](Declaration.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Declaration`](Declaration.md).[`end`](Declaration.md#end) + +*** + +### escapedText + +> `readonly` **escapedText**: [`__String`](../type-aliases/String.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:682 + +Prefer to use `id.unescapedText`. (Note: This is available only in services, not internally to the TypeScript compiler.) +Text of identifier, but if the identifier begins with two underscores, this will begin with three. + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Declaration`](Declaration.md).[`flags`](Declaration.md#flags) + +*** + +### isInJSDocNamespace? + +> `optional` **isInJSDocNamespace**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:684 + +*** + +### kind + +> `readonly` **kind**: [`Identifier`](../enumerations/SyntaxKind.md#identifier) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:677 + +#### Overrides + +[`Declaration`](Declaration.md).[`kind`](Declaration.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Declaration`](Declaration.md).[`locals`](Declaration.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Declaration`](Declaration.md).[`modifiers`](Declaration.md#modifiers) + +*** + +### originalKeywordKind? + +> `readonly` `optional` **originalKeywordKind**: [`SyntaxKind`](../enumerations/SyntaxKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:683 + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`Declaration`](Declaration.md).[`parent`](Declaration.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Declaration`](Declaration.md).[`pos`](Declaration.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Declaration`](Declaration.md).[`skipCheck`](Declaration.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Declaration`](Declaration.md).[`symbol`](Declaration.md#symbol) + +*** + +### text + +> `readonly` **text**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6105 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Declaration`](Declaration.md).[`forEachChild`](Declaration.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getChildAt`](Declaration.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getChildCount`](Declaration.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Declaration`](Declaration.md).[`getChildren`](Declaration.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getEnd`](Declaration.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFirstToken`](Declaration.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFullStart`](Declaration.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFullText`](Declaration.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFullWidth`](Declaration.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getLastToken`](Declaration.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getLeadingTriviaWidth`](Declaration.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getSourceFile`](Declaration.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getStart`](Declaration.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getText`](Declaration.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getWidth`](Declaration.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/IdentifierTypePredicate.md b/docs/api_docs/namespaces/ts/interfaces/IdentifierTypePredicate.md new file mode 100644 index 0000000000000000000000000000000000000000..6be1769b02051045d41dc985cfa5c54275de7ac9 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/IdentifierTypePredicate.md @@ -0,0 +1,53 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / IdentifierTypePredicate + +# Interface: IdentifierTypePredicate + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2587 + +## Extends + +- [`TypePredicateBase`](TypePredicateBase.md) + +## Properties + +### kind + +> **kind**: [`Identifier`](../enumerations/TypePredicateKind.md#identifier) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2588 + +#### Overrides + +[`TypePredicateBase`](TypePredicateBase.md).[`kind`](TypePredicateBase.md#kind) + +*** + +### parameterIndex + +> **parameterIndex**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2590 + +*** + +### parameterName + +> **parameterName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2589 + +*** + +### type + +> **type**: [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2591 + +#### Overrides + +[`TypePredicateBase`](TypePredicateBase.md).[`type`](TypePredicateBase.md#type) diff --git a/docs/api_docs/namespaces/ts/interfaces/IfStatement.md b/docs/api_docs/namespaces/ts/interfaces/IfStatement.md new file mode 100644 index 0000000000000000000000000000000000000000..7a8d226cfda535700bcf92c06f01444c9154f9d7 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/IfStatement.md @@ -0,0 +1,513 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / IfStatement + +# Interface: IfStatement + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1507 + +## Extends + +- [`Statement`](Statement.md) + +## Properties + +### \_statementBrand + +> **\_statementBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1471 + +#### Inherited from + +[`Statement`](Statement.md).[`_statementBrand`](Statement.md#_statementbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Statement`](Statement.md).[`decorators`](Statement.md#decorators) + +*** + +### elseStatement? + +> `readonly` `optional` **elseStatement**: [`Statement`](Statement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1511 + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Statement`](Statement.md).[`end`](Statement.md#end) + +*** + +### expression + +> `readonly` **expression**: [`Expression`](Expression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1509 + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Statement`](Statement.md).[`flags`](Statement.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`IfStatement`](../enumerations/SyntaxKind.md#ifstatement) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1508 + +#### Overrides + +[`Statement`](Statement.md).[`kind`](Statement.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Statement`](Statement.md).[`locals`](Statement.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Statement`](Statement.md).[`modifiers`](Statement.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`Statement`](Statement.md).[`parent`](Statement.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Statement`](Statement.md).[`pos`](Statement.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Statement`](Statement.md).[`skipCheck`](Statement.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Statement`](Statement.md).[`symbol`](Statement.md#symbol) + +*** + +### thenStatement + +> `readonly` **thenStatement**: [`Statement`](Statement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1510 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Statement`](Statement.md).[`forEachChild`](Statement.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getChildAt`](Statement.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getChildCount`](Statement.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Statement`](Statement.md).[`getChildren`](Statement.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getEnd`](Statement.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getFirstToken`](Statement.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getFullStart`](Statement.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Statement`](Statement.md).[`getFullText`](Statement.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getFullWidth`](Statement.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getLastToken`](Statement.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getLeadingTriviaWidth`](Statement.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getSourceFile`](Statement.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getStart`](Statement.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Statement`](Statement.md).[`getText`](Statement.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getWidth`](Statement.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/ImplementationLocation.md b/docs/api_docs/namespaces/ts/interfaces/ImplementationLocation.md new file mode 100644 index 0000000000000000000000000000000000000000..989b496b109a796874e47f149b488c636aea6a1a --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ImplementationLocation.md @@ -0,0 +1,107 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ImplementationLocation + +# Interface: ImplementationLocation + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6724 + +## Extends + +- [`DocumentSpan`](DocumentSpan.md) + +## Properties + +### contextSpan? + +> `optional` **contextSpan**: [`TextSpan`](TextSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6713 + +If DocumentSpan.textSpan is the span for name of the declaration, +then this is the span for relevant declaration + +#### Inherited from + +[`DocumentSpan`](DocumentSpan.md).[`contextSpan`](DocumentSpan.md#contextspan) + +*** + +### displayParts + +> **displayParts**: [`SymbolDisplayPart`](SymbolDisplayPart.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6726 + +*** + +### fileName + +> **fileName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6702 + +#### Inherited from + +[`DocumentSpan`](DocumentSpan.md).[`fileName`](DocumentSpan.md#filename) + +*** + +### kind + +> **kind**: [`ScriptElementKind`](../enumerations/ScriptElementKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6725 + +*** + +### originalContextSpan? + +> `optional` **originalContextSpan**: [`TextSpan`](TextSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6714 + +#### Inherited from + +[`DocumentSpan`](DocumentSpan.md).[`originalContextSpan`](DocumentSpan.md#originalcontextspan) + +*** + +### originalFileName? + +> `optional` **originalFileName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6708 + +#### Inherited from + +[`DocumentSpan`](DocumentSpan.md).[`originalFileName`](DocumentSpan.md#originalfilename) + +*** + +### originalTextSpan? + +> `optional` **originalTextSpan**: [`TextSpan`](TextSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6707 + +If the span represents a location that was remapped (e.g. via a .d.ts.map file), +then the original filename and span will be specified here + +#### Inherited from + +[`DocumentSpan`](DocumentSpan.md).[`originalTextSpan`](DocumentSpan.md#originaltextspan) + +*** + +### textSpan + +> **textSpan**: [`TextSpan`](TextSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6701 + +#### Inherited from + +[`DocumentSpan`](DocumentSpan.md).[`textSpan`](DocumentSpan.md#textspan) diff --git a/docs/api_docs/namespaces/ts/interfaces/ImportCall.md b/docs/api_docs/namespaces/ts/interfaces/ImportCall.md new file mode 100644 index 0000000000000000000000000000000000000000..f27c18a5a6cf7713047cc6d49aafd0fb0e7cae6a --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ImportCall.md @@ -0,0 +1,585 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ImportCall + +# Interface: ImportCall + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1350 + +## Extends + +- [`CallExpression`](CallExpression.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`_declarationBrand`](CallExpression.md#_declarationbrand) + +*** + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`_expressionBrand`](CallExpression.md#_expressionbrand) + +*** + +### \_leftHandSideExpressionBrand + +> **\_leftHandSideExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1086 + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`_leftHandSideExpressionBrand`](CallExpression.md#_lefthandsideexpressionbrand) + +*** + +### \_unaryExpressionBrand + +> **\_unaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1066 + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`_unaryExpressionBrand`](CallExpression.md#_unaryexpressionbrand) + +*** + +### \_updateExpressionBrand + +> **\_updateExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1071 + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`_updateExpressionBrand`](CallExpression.md#_updateexpressionbrand) + +*** + +### arguments + +> `readonly` **arguments**: [`NodeArray`](NodeArray.md)\<[`Expression`](Expression.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1341 + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`arguments`](CallExpression.md#arguments) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`decorators`](CallExpression.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`end`](CallExpression.md#end) + +*** + +### expression + +> `readonly` **expression**: [`ImportExpression`](ImportExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1351 + +#### Overrides + +[`CallExpression`](CallExpression.md).[`expression`](CallExpression.md#expression) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`flags`](CallExpression.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`CallExpression`](../enumerations/SyntaxKind.md#callexpression) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1337 + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`kind`](CallExpression.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`locals`](CallExpression.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`modifiers`](CallExpression.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`parent`](CallExpression.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`pos`](CallExpression.md#pos) + +*** + +### questionDotToken? + +> `readonly` `optional` **questionDotToken**: [`QuestionDotToken`](../type-aliases/QuestionDotToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1339 + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`questionDotToken`](CallExpression.md#questiondottoken) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`skipCheck`](CallExpression.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`symbol`](CallExpression.md#symbol) + +*** + +### typeArguments? + +> `readonly` `optional` **typeArguments**: [`NodeArray`](NodeArray.md)\<[`TypeNode`](TypeNode.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1340 + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`typeArguments`](CallExpression.md#typearguments) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`forEachChild`](CallExpression.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`getChildAt`](CallExpression.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`getChildCount`](CallExpression.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`getChildren`](CallExpression.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`getEnd`](CallExpression.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`getFirstToken`](CallExpression.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`getFullStart`](CallExpression.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`getFullText`](CallExpression.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`getFullWidth`](CallExpression.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`getLastToken`](CallExpression.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`getLeadingTriviaWidth`](CallExpression.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`getSourceFile`](CallExpression.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`getStart`](CallExpression.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`getText`](CallExpression.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`getWidth`](CallExpression.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/ImportClause.md b/docs/api_docs/namespaces/ts/interfaces/ImportClause.md new file mode 100644 index 0000000000000000000000000000000000000000..22671c0bc7c46cd8cdd85d3dbfd722cfb45f3125 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ImportClause.md @@ -0,0 +1,525 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ImportClause + +# Interface: ImportClause + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1728 + +## Extends + +- [`NamedDeclaration`](NamedDeclaration.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`_declarationBrand`](NamedDeclaration.md#_declarationbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`decorators`](NamedDeclaration.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`end`](NamedDeclaration.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`flags`](NamedDeclaration.md#flags) + +*** + +### isLazy? + +> `readonly` `optional` **isLazy**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1734 + +*** + +### isTypeOnly + +> `readonly` **isTypeOnly**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1731 + +*** + +### kind + +> `readonly` **kind**: [`ImportClause`](../enumerations/SyntaxKind.md#importclause) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1729 + +#### Overrides + +[`NamedDeclaration`](NamedDeclaration.md).[`kind`](NamedDeclaration.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`locals`](NamedDeclaration.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`modifiers`](NamedDeclaration.md#modifiers) + +*** + +### name? + +> `readonly` `optional` **name**: [`Identifier`](Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1732 + +#### Overrides + +[`NamedDeclaration`](NamedDeclaration.md).[`name`](NamedDeclaration.md#name) + +*** + +### namedBindings? + +> `readonly` `optional` **namedBindings**: [`NamedImportBindings`](../type-aliases/NamedImportBindings.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1733 + +*** + +### parent + +> `readonly` **parent**: [`ImportDeclaration`](ImportDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1730 + +#### Overrides + +[`NamedDeclaration`](NamedDeclaration.md).[`parent`](NamedDeclaration.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`pos`](NamedDeclaration.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`skipCheck`](NamedDeclaration.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`symbol`](NamedDeclaration.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`forEachChild`](NamedDeclaration.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getChildAt`](NamedDeclaration.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getChildCount`](NamedDeclaration.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getChildren`](NamedDeclaration.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getEnd`](NamedDeclaration.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFirstToken`](NamedDeclaration.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFullStart`](NamedDeclaration.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFullText`](NamedDeclaration.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFullWidth`](NamedDeclaration.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getLastToken`](NamedDeclaration.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getLeadingTriviaWidth`](NamedDeclaration.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getSourceFile`](NamedDeclaration.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getStart`](NamedDeclaration.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getText`](NamedDeclaration.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getWidth`](NamedDeclaration.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/ImportDeclaration.md b/docs/api_docs/namespaces/ts/interfaces/ImportDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..d3e9b4a878181121d7a7e319e6834888e602d29a --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ImportDeclaration.md @@ -0,0 +1,515 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ImportDeclaration + +# Interface: ImportDeclaration + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1717 + +## Extends + +- [`Statement`](Statement.md) + +## Properties + +### \_statementBrand + +> **\_statementBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1471 + +#### Inherited from + +[`Statement`](Statement.md).[`_statementBrand`](Statement.md#_statementbrand) + +*** + +### assertClause? + +> `readonly` `optional` **assertClause**: [`AssertClause`](AssertClause.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1724 + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Statement`](Statement.md).[`decorators`](Statement.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Statement`](Statement.md).[`end`](Statement.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Statement`](Statement.md).[`flags`](Statement.md#flags) + +*** + +### importClause? + +> `readonly` `optional` **importClause**: [`ImportClause`](ImportClause.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1721 + +*** + +### kind + +> `readonly` **kind**: [`ImportDeclaration`](../enumerations/SyntaxKind.md#importdeclaration) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1718 + +#### Overrides + +[`Statement`](Statement.md).[`kind`](Statement.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Statement`](Statement.md).[`locals`](Statement.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`Modifier`](../type-aliases/Modifier.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1720 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Overrides + +[`Statement`](Statement.md).[`modifiers`](Statement.md#modifiers) + +*** + +### moduleSpecifier + +> `readonly` **moduleSpecifier**: [`Expression`](Expression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1723 + +If this is not a StringLiteral it will be a grammar error. + +*** + +### parent + +> `readonly` **parent**: [`SourceFile`](SourceFile.md) \| [`ModuleBlock`](ModuleBlock.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1719 + +#### Overrides + +[`Statement`](Statement.md).[`parent`](Statement.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Statement`](Statement.md).[`pos`](Statement.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Statement`](Statement.md).[`skipCheck`](Statement.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Statement`](Statement.md).[`symbol`](Statement.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Statement`](Statement.md).[`forEachChild`](Statement.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getChildAt`](Statement.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getChildCount`](Statement.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Statement`](Statement.md).[`getChildren`](Statement.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getEnd`](Statement.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getFirstToken`](Statement.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getFullStart`](Statement.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Statement`](Statement.md).[`getFullText`](Statement.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getFullWidth`](Statement.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getLastToken`](Statement.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getLeadingTriviaWidth`](Statement.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getSourceFile`](Statement.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getStart`](Statement.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Statement`](Statement.md).[`getText`](Statement.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getWidth`](Statement.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/ImportEqualsDeclaration.md b/docs/api_docs/namespaces/ts/interfaces/ImportEqualsDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..6c876da651ae2e5e646329ee1def76b7acf4ef00 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ImportEqualsDeclaration.md @@ -0,0 +1,533 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ImportEqualsDeclaration + +# Interface: ImportEqualsDeclaration + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1704 + +One of: +- import x = require("mod"); +- import x = M.x; + +## Extends + +- [`DeclarationStatement`](DeclarationStatement.md).[`JSDocContainer`](JSDocContainer.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`_declarationBrand`](DeclarationStatement.md#_declarationbrand) + +*** + +### \_statementBrand + +> **\_statementBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1471 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`_statementBrand`](DeclarationStatement.md#_statementbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`decorators`](DeclarationStatement.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`end`](DeclarationStatement.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`flags`](DeclarationStatement.md#flags) + +*** + +### isTypeOnly + +> `readonly` **isTypeOnly**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1709 + +*** + +### kind + +> `readonly` **kind**: [`ImportEqualsDeclaration`](../enumerations/SyntaxKind.md#importequalsdeclaration) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1705 + +#### Overrides + +[`DeclarationStatement`](DeclarationStatement.md).[`kind`](DeclarationStatement.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`locals`](DeclarationStatement.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`Modifier`](../type-aliases/Modifier.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1707 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Overrides + +[`DeclarationStatement`](DeclarationStatement.md).[`modifiers`](DeclarationStatement.md#modifiers) + +*** + +### moduleReference + +> `readonly` **moduleReference**: [`ModuleReference`](../type-aliases/ModuleReference.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1710 + +*** + +### name + +> `readonly` **name**: [`Identifier`](Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1708 + +#### Overrides + +[`DeclarationStatement`](DeclarationStatement.md).[`name`](DeclarationStatement.md#name) + +*** + +### parent + +> `readonly` **parent**: [`SourceFile`](SourceFile.md) \| [`ModuleBlock`](ModuleBlock.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1706 + +#### Overrides + +[`DeclarationStatement`](DeclarationStatement.md).[`parent`](DeclarationStatement.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`pos`](DeclarationStatement.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`skipCheck`](DeclarationStatement.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`symbol`](DeclarationStatement.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`forEachChild`](DeclarationStatement.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getChildAt`](DeclarationStatement.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getChildCount`](DeclarationStatement.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getChildren`](DeclarationStatement.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getEnd`](DeclarationStatement.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getFirstToken`](DeclarationStatement.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getFullStart`](DeclarationStatement.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getFullText`](DeclarationStatement.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getFullWidth`](DeclarationStatement.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getLastToken`](DeclarationStatement.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getLeadingTriviaWidth`](DeclarationStatement.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getSourceFile`](DeclarationStatement.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getStart`](DeclarationStatement.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getText`](DeclarationStatement.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getWidth`](DeclarationStatement.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/ImportExpression.md b/docs/api_docs/namespaces/ts/interfaces/ImportExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..36a12ede3c06f481fe5e1febe469d01fe336dcdc --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ImportExpression.md @@ -0,0 +1,549 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ImportExpression + +# Interface: ImportExpression + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1110 + +## Extends + +- [`PrimaryExpression`](PrimaryExpression.md) + +## Properties + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_expressionBrand`](PrimaryExpression.md#_expressionbrand) + +*** + +### \_leftHandSideExpressionBrand + +> **\_leftHandSideExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1086 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_leftHandSideExpressionBrand`](PrimaryExpression.md#_lefthandsideexpressionbrand) + +*** + +### \_memberExpressionBrand + +> **\_memberExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1089 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_memberExpressionBrand`](PrimaryExpression.md#_memberexpressionbrand) + +*** + +### \_primaryExpressionBrand + +> **\_primaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1092 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_primaryExpressionBrand`](PrimaryExpression.md#_primaryexpressionbrand) + +*** + +### \_unaryExpressionBrand + +> **\_unaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1066 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_unaryExpressionBrand`](PrimaryExpression.md#_unaryexpressionbrand) + +*** + +### \_updateExpressionBrand + +> **\_updateExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1071 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_updateExpressionBrand`](PrimaryExpression.md#_updateexpressionbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`decorators`](PrimaryExpression.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`end`](PrimaryExpression.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`flags`](PrimaryExpression.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`ImportKeyword`](../enumerations/SyntaxKind.md#importkeyword) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1111 + +#### Overrides + +[`PrimaryExpression`](PrimaryExpression.md).[`kind`](PrimaryExpression.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`locals`](PrimaryExpression.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`modifiers`](PrimaryExpression.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`parent`](PrimaryExpression.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`pos`](PrimaryExpression.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`skipCheck`](PrimaryExpression.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`symbol`](PrimaryExpression.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`forEachChild`](PrimaryExpression.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getChildAt`](PrimaryExpression.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getChildCount`](PrimaryExpression.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getChildren`](PrimaryExpression.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getEnd`](PrimaryExpression.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFirstToken`](PrimaryExpression.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFullStart`](PrimaryExpression.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFullText`](PrimaryExpression.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFullWidth`](PrimaryExpression.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getLastToken`](PrimaryExpression.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getLeadingTriviaWidth`](PrimaryExpression.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getSourceFile`](PrimaryExpression.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getStart`](PrimaryExpression.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getText`](PrimaryExpression.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getWidth`](PrimaryExpression.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/ImportSpecifier.md b/docs/api_docs/namespaces/ts/interfaces/ImportSpecifier.md new file mode 100644 index 0000000000000000000000000000000000000000..3c3acbb29c0f0571e9b9fa1b6f4b0f8bdae89f0c --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ImportSpecifier.md @@ -0,0 +1,517 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ImportSpecifier + +# Interface: ImportSpecifier + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1785 + +## Extends + +- [`NamedDeclaration`](NamedDeclaration.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`_declarationBrand`](NamedDeclaration.md#_declarationbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`decorators`](NamedDeclaration.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`end`](NamedDeclaration.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`flags`](NamedDeclaration.md#flags) + +*** + +### isTypeOnly + +> `readonly` **isTypeOnly**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1790 + +*** + +### kind + +> `readonly` **kind**: [`ImportSpecifier`](../enumerations/SyntaxKind.md#importspecifier) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1786 + +#### Overrides + +[`NamedDeclaration`](NamedDeclaration.md).[`kind`](NamedDeclaration.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`locals`](NamedDeclaration.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`modifiers`](NamedDeclaration.md#modifiers) + +*** + +### name + +> `readonly` **name**: [`Identifier`](Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1789 + +#### Overrides + +[`NamedDeclaration`](NamedDeclaration.md).[`name`](NamedDeclaration.md#name) + +*** + +### parent + +> `readonly` **parent**: [`NamedImports`](NamedImports.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1787 + +#### Overrides + +[`NamedDeclaration`](NamedDeclaration.md).[`parent`](NamedDeclaration.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`pos`](NamedDeclaration.md#pos) + +*** + +### propertyName? + +> `readonly` `optional` **propertyName**: [`Identifier`](Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1788 + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`skipCheck`](NamedDeclaration.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`symbol`](NamedDeclaration.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`forEachChild`](NamedDeclaration.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getChildAt`](NamedDeclaration.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getChildCount`](NamedDeclaration.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getChildren`](NamedDeclaration.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getEnd`](NamedDeclaration.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFirstToken`](NamedDeclaration.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFullStart`](NamedDeclaration.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFullText`](NamedDeclaration.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFullWidth`](NamedDeclaration.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getLastToken`](NamedDeclaration.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getLeadingTriviaWidth`](NamedDeclaration.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getSourceFile`](NamedDeclaration.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getStart`](NamedDeclaration.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getText`](NamedDeclaration.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getWidth`](NamedDeclaration.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/ImportTypeAssertionContainer.md b/docs/api_docs/namespaces/ts/interfaces/ImportTypeAssertionContainer.md new file mode 100644 index 0000000000000000000000000000000000000000..6417682a1f639b29b511602a795bb72a6723e5fd --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ImportTypeAssertionContainer.md @@ -0,0 +1,493 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ImportTypeAssertionContainer + +# Interface: ImportTypeAssertionContainer + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:917 + +## Extends + +- [`Node`](Node.md) + +## Properties + +### assertClause + +> `readonly` **assertClause**: [`AssertClause`](AssertClause.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:920 + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`decorators`](Node.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Node`](Node.md).[`end`](Node.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Node`](Node.md).[`flags`](Node.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`ImportTypeAssertionContainer`](../enumerations/SyntaxKind.md#importtypeassertioncontainer) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:918 + +#### Overrides + +[`Node`](Node.md).[`kind`](Node.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Node`](Node.md).[`locals`](Node.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`modifiers`](Node.md#modifiers) + +*** + +### multiLine? + +> `readonly` `optional` **multiLine**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:921 + +*** + +### parent + +> `readonly` **parent**: [`ImportTypeNode`](ImportTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:919 + +#### Overrides + +[`Node`](Node.md).[`parent`](Node.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Node`](Node.md).[`pos`](Node.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Node`](Node.md).[`skipCheck`](Node.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Node`](Node.md).[`symbol`](Node.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Node`](Node.md).[`forEachChild`](Node.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getChildAt`](Node.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getChildCount`](Node.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Node`](Node.md).[`getChildren`](Node.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getEnd`](Node.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getFirstToken`](Node.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullStart`](Node.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getFullText`](Node.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullWidth`](Node.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getLastToken`](Node.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getLeadingTriviaWidth`](Node.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Node`](Node.md).[`getSourceFile`](Node.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getStart`](Node.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getText`](Node.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getWidth`](Node.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/ImportTypeNode.md b/docs/api_docs/namespaces/ts/interfaces/ImportTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..063387164f7f765a6d3ebe30e31576a997c6dea3 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ImportTypeNode.md @@ -0,0 +1,533 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ImportTypeNode + +# Interface: ImportTypeNode + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:923 + +## Extends + +- [`NodeWithTypeArguments`](NodeWithTypeArguments.md) + +## Properties + +### \_typeNodeBrand + +> **\_typeNodeBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:912 + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`_typeNodeBrand`](NodeWithTypeArguments.md#_typenodebrand) + +*** + +### argument + +> `readonly` **argument**: [`TypeNode`](TypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:926 + +*** + +### assertions? + +> `readonly` `optional` **assertions**: [`ImportTypeAssertionContainer`](ImportTypeAssertionContainer.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:927 + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`decorators`](NodeWithTypeArguments.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`end`](NodeWithTypeArguments.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`flags`](NodeWithTypeArguments.md#flags) + +*** + +### isTypeOf + +> `readonly` **isTypeOf**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:925 + +*** + +### kind + +> `readonly` **kind**: [`ImportType`](../enumerations/SyntaxKind.md#importtype) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:924 + +#### Overrides + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`kind`](NodeWithTypeArguments.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`locals`](NodeWithTypeArguments.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`modifiers`](NodeWithTypeArguments.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`parent`](NodeWithTypeArguments.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`pos`](NodeWithTypeArguments.md#pos) + +*** + +### qualifier? + +> `readonly` `optional` **qualifier**: [`EntityName`](../type-aliases/EntityName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:928 + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`skipCheck`](NodeWithTypeArguments.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`symbol`](NodeWithTypeArguments.md#symbol) + +*** + +### typeArguments? + +> `readonly` `optional` **typeArguments**: [`NodeArray`](NodeArray.md)\<[`TypeNode`](TypeNode.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:946 + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`typeArguments`](NodeWithTypeArguments.md#typearguments) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`forEachChild`](NodeWithTypeArguments.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`getChildAt`](NodeWithTypeArguments.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`getChildCount`](NodeWithTypeArguments.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`getChildren`](NodeWithTypeArguments.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`getEnd`](NodeWithTypeArguments.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`getFirstToken`](NodeWithTypeArguments.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`getFullStart`](NodeWithTypeArguments.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`getFullText`](NodeWithTypeArguments.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`getFullWidth`](NodeWithTypeArguments.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`getLastToken`](NodeWithTypeArguments.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`getLeadingTriviaWidth`](NodeWithTypeArguments.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`getSourceFile`](NodeWithTypeArguments.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`getStart`](NodeWithTypeArguments.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`getText`](NodeWithTypeArguments.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`getWidth`](NodeWithTypeArguments.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/IncompleteCompletionsCache.md b/docs/api_docs/namespaces/ts/interfaces/IncompleteCompletionsCache.md new file mode 100644 index 0000000000000000000000000000000000000000..4fcf4336d400114ad383639690c04f59ef64e816 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/IncompleteCompletionsCache.md @@ -0,0 +1,51 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / IncompleteCompletionsCache + +# Interface: IncompleteCompletionsCache + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6217 + +## Methods + +### clear() + +> **clear**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6220 + +#### Returns + +`void` + +*** + +### get() + +> **get**(): `undefined` \| [`CompletionInfo`](CompletionInfo.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6218 + +#### Returns + +`undefined` \| [`CompletionInfo`](CompletionInfo.md) + +*** + +### set() + +> **set**(`response`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6219 + +#### Parameters + +##### response + +[`CompletionInfo`](CompletionInfo.md) + +#### Returns + +`void` diff --git a/docs/api_docs/namespaces/ts/interfaces/IncompleteType.md b/docs/api_docs/namespaces/ts/interfaces/IncompleteType.md new file mode 100644 index 0000000000000000000000000000000000000000..46138c0dcda119b956fa7b18306fb709bde4a353 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/IncompleteType.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / IncompleteType + +# Interface: IncompleteType + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2101 + +## Properties + +### flags + +> **flags**: [`TypeFlags`](../enumerations/TypeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2102 + +*** + +### type + +> **type**: [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2103 diff --git a/docs/api_docs/namespaces/ts/interfaces/IncrementalProgramOptions.md b/docs/api_docs/namespaces/ts/interfaces/IncrementalProgramOptions.md new file mode 100644 index 0000000000000000000000000000000000000000..151a8553f9489e2c1556b73ad54bbd1b1c51e00b --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/IncrementalProgramOptions.md @@ -0,0 +1,61 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / IncrementalProgramOptions + +# Interface: IncrementalProgramOptions\ + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5782 + +## Type Parameters + +• **T** *extends* [`BuilderProgram`](BuilderProgram.md) + +## Properties + +### configFileParsingDiagnostics? + +> `optional` **configFileParsingDiagnostics**: readonly [`Diagnostic`](Diagnostic.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5785 + +*** + +### createProgram? + +> `optional` **createProgram**: [`CreateProgram`](../type-aliases/CreateProgram.md)\<`T`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5788 + +*** + +### host? + +> `optional` **host**: [`CompilerHost`](CompilerHost.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5787 + +*** + +### options + +> **options**: [`CompilerOptions`](CompilerOptions.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5784 + +*** + +### projectReferences? + +> `optional` **projectReferences**: readonly [`ProjectReference`](ProjectReference.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5786 + +*** + +### rootNames + +> **rootNames**: readonly `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5783 diff --git a/docs/api_docs/namespaces/ts/interfaces/IndexInfo.md b/docs/api_docs/namespaces/ts/interfaces/IndexInfo.md new file mode 100644 index 0000000000000000000000000000000000000000..7b0ae318dc1c899e9d0f16172e21ae9b9401d470 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/IndexInfo.md @@ -0,0 +1,41 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / IndexInfo + +# Interface: IndexInfo + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2945 + +## Properties + +### declaration? + +> `optional` **declaration**: [`IndexSignatureDeclaration`](IndexSignatureDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2949 + +*** + +### isReadonly + +> **isReadonly**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2948 + +*** + +### keyType + +> **keyType**: [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2946 + +*** + +### type + +> **type**: [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2947 diff --git a/docs/api_docs/namespaces/ts/interfaces/IndexSignatureDeclaration.md b/docs/api_docs/namespaces/ts/interfaces/IndexSignatureDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..111c94807c8de6a31ddf795185f74e1fa03e40cd --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/IndexSignatureDeclaration.md @@ -0,0 +1,573 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / IndexSignatureDeclaration + +# Interface: IndexSignatureDeclaration + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:900 + +## Extends + +- [`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`ClassElement`](ClassElement.md).[`TypeElement`](TypeElement.md) + +## Properties + +### \_classElementBrand + +> **\_classElementBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1633 + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`_classElementBrand`](ClassElement.md#_classelementbrand) + +*** + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`_declarationBrand`](TypeElement.md#_declarationbrand) + +*** + +### \_typeElementBrand + +> **\_typeElementBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1637 + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`_typeElementBrand`](TypeElement.md#_typeelementbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`decorators`](TypeElement.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`end`](TypeElement.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`flags`](TypeElement.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`IndexSignature`](../enumerations/SyntaxKind.md#indexsignature) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:901 + +#### Overrides + +[`TypeElement`](TypeElement.md).[`kind`](TypeElement.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`locals`](TypeElement.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`Modifier`](../type-aliases/Modifier.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:903 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Overrides + +[`TypeElement`](TypeElement.md).[`modifiers`](TypeElement.md#modifiers) + +*** + +### name? + +> `readonly` `optional` **name**: [`PropertyName`](../type-aliases/PropertyName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:733 + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`name`](TypeElement.md#name) + +*** + +### parameters + +> `readonly` **parameters**: [`NodeArray`](NodeArray.md)\<[`ParameterDeclaration`](ParameterDeclaration.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:735 + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`parameters`](SignatureDeclarationBase.md#parameters) + +*** + +### parent + +> `readonly` **parent**: [`ObjectTypeDeclaration`](../type-aliases/ObjectTypeDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:902 + +#### Overrides + +[`TypeElement`](TypeElement.md).[`parent`](TypeElement.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`pos`](TypeElement.md#pos) + +*** + +### questionToken? + +> `readonly` `optional` **questionToken**: [`QuestionToken`](../type-aliases/QuestionToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1639 + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`questionToken`](TypeElement.md#questiontoken) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`skipCheck`](TypeElement.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`symbol`](TypeElement.md#symbol) + +*** + +### type + +> `readonly` **type**: [`TypeNode`](TypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:904 + +#### Overrides + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`type`](SignatureDeclarationBase.md#type) + +*** + +### typeParameters? + +> `readonly` `optional` **typeParameters**: [`NodeArray`](NodeArray.md)\<[`TypeParameterDeclaration`](TypeParameterDeclaration.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:734 + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`typeParameters`](SignatureDeclarationBase.md#typeparameters) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`forEachChild`](TypeElement.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getChildAt`](TypeElement.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getChildCount`](TypeElement.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getChildren`](TypeElement.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getEnd`](TypeElement.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getFirstToken`](TypeElement.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getFullStart`](TypeElement.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getFullText`](TypeElement.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getFullWidth`](TypeElement.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getLastToken`](TypeElement.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getLeadingTriviaWidth`](TypeElement.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getSourceFile`](TypeElement.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getStart`](TypeElement.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getText`](TypeElement.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getWidth`](TypeElement.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/IndexType.md b/docs/api_docs/namespaces/ts/interfaces/IndexType.md new file mode 100644 index 0000000000000000000000000000000000000000..5f973eb35a62917c2f6b1df0214ac20ec2104d79 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/IndexType.md @@ -0,0 +1,455 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / IndexType + +# Interface: IndexType + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2898 + +## Extends + +- [`InstantiableType`](InstantiableType.md) + +## Properties + +### aliasSymbol? + +> `optional` **aliasSymbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2773 + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`aliasSymbol`](InstantiableType.md#aliassymbol) + +*** + +### aliasTypeArguments? + +> `optional` **aliasTypeArguments**: readonly [`Type`](Type.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2774 + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`aliasTypeArguments`](InstantiableType.md#aliastypearguments) + +*** + +### flags + +> **flags**: [`TypeFlags`](../enumerations/TypeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2770 + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`flags`](InstantiableType.md#flags) + +*** + +### pattern? + +> `optional` **pattern**: [`DestructuringPattern`](../type-aliases/DestructuringPattern.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2772 + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`pattern`](InstantiableType.md#pattern) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2771 + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`symbol`](InstantiableType.md#symbol) + +*** + +### type + +> **type**: [`UnionOrIntersectionType`](UnionOrIntersectionType.md) \| [`InstantiableType`](InstantiableType.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2899 + +## Methods + +### getApparentProperties() + +> **getApparentProperties**(): [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6124 + +#### Returns + +[`Symbol`](Symbol.md)[] + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getApparentProperties`](InstantiableType.md#getapparentproperties) + +*** + +### getBaseTypes() + +> **getBaseTypes**(): `undefined` \| [`BaseType`](../type-aliases/BaseType.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6129 + +#### Returns + +`undefined` \| [`BaseType`](../type-aliases/BaseType.md)[] + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getBaseTypes`](InstantiableType.md#getbasetypes) + +*** + +### getCallSignatures() + +> **getCallSignatures**(): readonly [`Signature`](Signature.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6125 + +#### Returns + +readonly [`Signature`](Signature.md)[] + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getCallSignatures`](InstantiableType.md#getcallsignatures) + +*** + +### getConstraint() + +> **getConstraint**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6131 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getConstraint`](InstantiableType.md#getconstraint) + +*** + +### getConstructSignatures() + +> **getConstructSignatures**(): readonly [`Signature`](Signature.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6126 + +#### Returns + +readonly [`Signature`](Signature.md)[] + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getConstructSignatures`](InstantiableType.md#getconstructsignatures) + +*** + +### getDefault() + +> **getDefault**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6132 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getDefault`](InstantiableType.md#getdefault) + +*** + +### getFlags() + +> **getFlags**(): [`TypeFlags`](../enumerations/TypeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6120 + +#### Returns + +[`TypeFlags`](../enumerations/TypeFlags.md) + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getFlags`](InstantiableType.md#getflags) + +*** + +### getNonNullableType() + +> **getNonNullableType**(): [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6130 + +#### Returns + +[`Type`](Type.md) + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getNonNullableType`](InstantiableType.md#getnonnullabletype) + +*** + +### getNumberIndexType() + +> **getNumberIndexType**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6128 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getNumberIndexType`](InstantiableType.md#getnumberindextype) + +*** + +### getProperties() + +> **getProperties**(): [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6122 + +#### Returns + +[`Symbol`](Symbol.md)[] + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getProperties`](InstantiableType.md#getproperties) + +*** + +### getProperty() + +> **getProperty**(`propertyName`): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6123 + +#### Parameters + +##### propertyName + +`string` + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getProperty`](InstantiableType.md#getproperty) + +*** + +### getStringIndexType() + +> **getStringIndexType**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6127 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getStringIndexType`](InstantiableType.md#getstringindextype) + +*** + +### getSymbol() + +> **getSymbol**(): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6121 + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getSymbol`](InstantiableType.md#getsymbol) + +*** + +### isClass() + +> **isClass**(): `this is InterfaceType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6141 + +#### Returns + +`this is InterfaceType` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isClass`](InstantiableType.md#isclass) + +*** + +### isClassOrInterface() + +> **isClassOrInterface**(): `this is InterfaceType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6140 + +#### Returns + +`this is InterfaceType` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isClassOrInterface`](InstantiableType.md#isclassorinterface) + +*** + +### isIndexType() + +> **isIndexType**(): `this is IndexType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6142 + +#### Returns + +`this is IndexType` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isIndexType`](InstantiableType.md#isindextype) + +*** + +### isIntersection() + +> **isIntersection**(): `this is IntersectionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6134 + +#### Returns + +`this is IntersectionType` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isIntersection`](InstantiableType.md#isintersection) + +*** + +### isLiteral() + +> **isLiteral**(): `this is LiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6136 + +#### Returns + +`this is LiteralType` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isLiteral`](InstantiableType.md#isliteral) + +*** + +### isNumberLiteral() + +> **isNumberLiteral**(): `this is NumberLiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6138 + +#### Returns + +`this is NumberLiteralType` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isNumberLiteral`](InstantiableType.md#isnumberliteral) + +*** + +### isStringLiteral() + +> **isStringLiteral**(): `this is StringLiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6137 + +#### Returns + +`this is StringLiteralType` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isStringLiteral`](InstantiableType.md#isstringliteral) + +*** + +### isTypeParameter() + +> **isTypeParameter**(): `this is TypeParameter` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6139 + +#### Returns + +`this is TypeParameter` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isTypeParameter`](InstantiableType.md#istypeparameter) + +*** + +### isUnion() + +> **isUnion**(): `this is UnionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6133 + +#### Returns + +`this is UnionType` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isUnion`](InstantiableType.md#isunion) + +*** + +### isUnionOrIntersection() + +> **isUnionOrIntersection**(): `this is UnionOrIntersectionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6135 + +#### Returns + +`this is UnionOrIntersectionType` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isUnionOrIntersection`](InstantiableType.md#isunionorintersection) diff --git a/docs/api_docs/namespaces/ts/interfaces/IndexedAccessType.md b/docs/api_docs/namespaces/ts/interfaces/IndexedAccessType.md new file mode 100644 index 0000000000000000000000000000000000000000..968acd798226f25841c33057d5d5f15ca68d1d03 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/IndexedAccessType.md @@ -0,0 +1,487 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / IndexedAccessType + +# Interface: IndexedAccessType + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2890 + +## Extends + +- [`InstantiableType`](InstantiableType.md) + +## Properties + +### aliasSymbol? + +> `optional` **aliasSymbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2773 + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`aliasSymbol`](InstantiableType.md#aliassymbol) + +*** + +### aliasTypeArguments? + +> `optional` **aliasTypeArguments**: readonly [`Type`](Type.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2774 + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`aliasTypeArguments`](InstantiableType.md#aliastypearguments) + +*** + +### constraint? + +> `optional` **constraint**: [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2893 + +*** + +### flags + +> **flags**: [`TypeFlags`](../enumerations/TypeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2770 + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`flags`](InstantiableType.md#flags) + +*** + +### indexType + +> **indexType**: [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2892 + +*** + +### objectType + +> **objectType**: [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2891 + +*** + +### pattern? + +> `optional` **pattern**: [`DestructuringPattern`](../type-aliases/DestructuringPattern.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2772 + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`pattern`](InstantiableType.md#pattern) + +*** + +### simplifiedForReading? + +> `optional` **simplifiedForReading**: [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2894 + +*** + +### simplifiedForWriting? + +> `optional` **simplifiedForWriting**: [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2895 + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2771 + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`symbol`](InstantiableType.md#symbol) + +## Methods + +### getApparentProperties() + +> **getApparentProperties**(): [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6124 + +#### Returns + +[`Symbol`](Symbol.md)[] + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getApparentProperties`](InstantiableType.md#getapparentproperties) + +*** + +### getBaseTypes() + +> **getBaseTypes**(): `undefined` \| [`BaseType`](../type-aliases/BaseType.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6129 + +#### Returns + +`undefined` \| [`BaseType`](../type-aliases/BaseType.md)[] + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getBaseTypes`](InstantiableType.md#getbasetypes) + +*** + +### getCallSignatures() + +> **getCallSignatures**(): readonly [`Signature`](Signature.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6125 + +#### Returns + +readonly [`Signature`](Signature.md)[] + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getCallSignatures`](InstantiableType.md#getcallsignatures) + +*** + +### getConstraint() + +> **getConstraint**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6131 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getConstraint`](InstantiableType.md#getconstraint) + +*** + +### getConstructSignatures() + +> **getConstructSignatures**(): readonly [`Signature`](Signature.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6126 + +#### Returns + +readonly [`Signature`](Signature.md)[] + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getConstructSignatures`](InstantiableType.md#getconstructsignatures) + +*** + +### getDefault() + +> **getDefault**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6132 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getDefault`](InstantiableType.md#getdefault) + +*** + +### getFlags() + +> **getFlags**(): [`TypeFlags`](../enumerations/TypeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6120 + +#### Returns + +[`TypeFlags`](../enumerations/TypeFlags.md) + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getFlags`](InstantiableType.md#getflags) + +*** + +### getNonNullableType() + +> **getNonNullableType**(): [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6130 + +#### Returns + +[`Type`](Type.md) + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getNonNullableType`](InstantiableType.md#getnonnullabletype) + +*** + +### getNumberIndexType() + +> **getNumberIndexType**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6128 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getNumberIndexType`](InstantiableType.md#getnumberindextype) + +*** + +### getProperties() + +> **getProperties**(): [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6122 + +#### Returns + +[`Symbol`](Symbol.md)[] + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getProperties`](InstantiableType.md#getproperties) + +*** + +### getProperty() + +> **getProperty**(`propertyName`): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6123 + +#### Parameters + +##### propertyName + +`string` + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getProperty`](InstantiableType.md#getproperty) + +*** + +### getStringIndexType() + +> **getStringIndexType**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6127 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getStringIndexType`](InstantiableType.md#getstringindextype) + +*** + +### getSymbol() + +> **getSymbol**(): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6121 + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getSymbol`](InstantiableType.md#getsymbol) + +*** + +### isClass() + +> **isClass**(): `this is InterfaceType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6141 + +#### Returns + +`this is InterfaceType` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isClass`](InstantiableType.md#isclass) + +*** + +### isClassOrInterface() + +> **isClassOrInterface**(): `this is InterfaceType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6140 + +#### Returns + +`this is InterfaceType` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isClassOrInterface`](InstantiableType.md#isclassorinterface) + +*** + +### isIndexType() + +> **isIndexType**(): `this is IndexType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6142 + +#### Returns + +`this is IndexType` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isIndexType`](InstantiableType.md#isindextype) + +*** + +### isIntersection() + +> **isIntersection**(): `this is IntersectionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6134 + +#### Returns + +`this is IntersectionType` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isIntersection`](InstantiableType.md#isintersection) + +*** + +### isLiteral() + +> **isLiteral**(): `this is LiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6136 + +#### Returns + +`this is LiteralType` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isLiteral`](InstantiableType.md#isliteral) + +*** + +### isNumberLiteral() + +> **isNumberLiteral**(): `this is NumberLiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6138 + +#### Returns + +`this is NumberLiteralType` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isNumberLiteral`](InstantiableType.md#isnumberliteral) + +*** + +### isStringLiteral() + +> **isStringLiteral**(): `this is StringLiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6137 + +#### Returns + +`this is StringLiteralType` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isStringLiteral`](InstantiableType.md#isstringliteral) + +*** + +### isTypeParameter() + +> **isTypeParameter**(): `this is TypeParameter` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6139 + +#### Returns + +`this is TypeParameter` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isTypeParameter`](InstantiableType.md#istypeparameter) + +*** + +### isUnion() + +> **isUnion**(): `this is UnionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6133 + +#### Returns + +`this is UnionType` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isUnion`](InstantiableType.md#isunion) + +*** + +### isUnionOrIntersection() + +> **isUnionOrIntersection**(): `this is UnionOrIntersectionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6135 + +#### Returns + +`this is UnionOrIntersectionType` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isUnionOrIntersection`](InstantiableType.md#isunionorintersection) diff --git a/docs/api_docs/namespaces/ts/interfaces/IndexedAccessTypeNode.md b/docs/api_docs/namespaces/ts/interfaces/IndexedAccessTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..88bdfeb38da3bce13028a90b9bb21df226b19564 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/IndexedAccessTypeNode.md @@ -0,0 +1,505 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / IndexedAccessTypeNode + +# Interface: IndexedAccessTypeNode + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1020 + +## Extends + +- [`TypeNode`](TypeNode.md) + +## Properties + +### \_typeNodeBrand + +> **\_typeNodeBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:912 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`_typeNodeBrand`](TypeNode.md#_typenodebrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`decorators`](TypeNode.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`end`](TypeNode.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`flags`](TypeNode.md#flags) + +*** + +### indexType + +> `readonly` **indexType**: [`TypeNode`](TypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1023 + +*** + +### kind + +> `readonly` **kind**: [`IndexedAccessType`](../enumerations/SyntaxKind.md#indexedaccesstype) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1021 + +#### Overrides + +[`TypeNode`](TypeNode.md).[`kind`](TypeNode.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`locals`](TypeNode.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`modifiers`](TypeNode.md#modifiers) + +*** + +### objectType + +> `readonly` **objectType**: [`TypeNode`](TypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1022 + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`parent`](TypeNode.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`pos`](TypeNode.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`skipCheck`](TypeNode.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`symbol`](TypeNode.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`forEachChild`](TypeNode.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getChildAt`](TypeNode.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getChildCount`](TypeNode.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getChildren`](TypeNode.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getEnd`](TypeNode.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFirstToken`](TypeNode.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFullStart`](TypeNode.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFullText`](TypeNode.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFullWidth`](TypeNode.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getLastToken`](TypeNode.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getLeadingTriviaWidth`](TypeNode.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getSourceFile`](TypeNode.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getStart`](TypeNode.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getText`](TypeNode.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getWidth`](TypeNode.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/InferTypeNode.md b/docs/api_docs/namespaces/ts/interfaces/InferTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..aa87031e78bd4e63213107d2d09e284a694f16a2 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/InferTypeNode.md @@ -0,0 +1,497 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / InferTypeNode + +# Interface: InferTypeNode + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1007 + +## Extends + +- [`TypeNode`](TypeNode.md) + +## Properties + +### \_typeNodeBrand + +> **\_typeNodeBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:912 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`_typeNodeBrand`](TypeNode.md#_typenodebrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`decorators`](TypeNode.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`end`](TypeNode.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`flags`](TypeNode.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`InferType`](../enumerations/SyntaxKind.md#infertype) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1008 + +#### Overrides + +[`TypeNode`](TypeNode.md).[`kind`](TypeNode.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`locals`](TypeNode.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`modifiers`](TypeNode.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`parent`](TypeNode.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`pos`](TypeNode.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`skipCheck`](TypeNode.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`symbol`](TypeNode.md#symbol) + +*** + +### typeParameter + +> `readonly` **typeParameter**: [`TypeParameterDeclaration`](TypeParameterDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1009 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`forEachChild`](TypeNode.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getChildAt`](TypeNode.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getChildCount`](TypeNode.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getChildren`](TypeNode.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getEnd`](TypeNode.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFirstToken`](TypeNode.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFullStart`](TypeNode.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFullText`](TypeNode.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFullWidth`](TypeNode.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getLastToken`](TypeNode.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getLeadingTriviaWidth`](TypeNode.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getSourceFile`](TypeNode.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getStart`](TypeNode.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getText`](TypeNode.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getWidth`](TypeNode.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/InlayHint.md b/docs/api_docs/namespaces/ts/interfaces/InlayHint.md new file mode 100644 index 0000000000000000000000000000000000000000..c493daa6e9917fe9ea131ba11a60753c5125ba25 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/InlayHint.md @@ -0,0 +1,49 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / InlayHint + +# Interface: InlayHint + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6583 + +## Properties + +### kind + +> **kind**: [`InlayHintKind`](../enumerations/InlayHintKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6586 + +*** + +### position + +> **position**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6585 + +*** + +### text + +> **text**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6584 + +*** + +### whitespaceAfter? + +> `optional` **whitespaceAfter**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6588 + +*** + +### whitespaceBefore? + +> `optional` **whitespaceBefore**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6587 diff --git a/docs/api_docs/namespaces/ts/interfaces/InlayHintsContext.md b/docs/api_docs/namespaces/ts/interfaces/InlayHintsContext.md new file mode 100644 index 0000000000000000000000000000000000000000..c8cde74121e091bc519b03e936fed39b2be16d67 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/InlayHintsContext.md @@ -0,0 +1,57 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / InlayHintsContext + +# Interface: InlayHintsContext + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7302 + +## Properties + +### cancellationToken + +> **cancellationToken**: [`CancellationToken`](CancellationToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7305 + +*** + +### file + +> **file**: [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7303 + +*** + +### host + +> **host**: [`LanguageServiceHost`](LanguageServiceHost.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7306 + +*** + +### preferences + +> **preferences**: [`UserPreferences`](UserPreferences.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7308 + +*** + +### program + +> **program**: [`Program`](Program.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7304 + +*** + +### span + +> **span**: [`TextSpan`](TextSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7307 diff --git a/docs/api_docs/namespaces/ts/interfaces/InputFiles.md b/docs/api_docs/namespaces/ts/interfaces/InputFiles.md new file mode 100644 index 0000000000000000000000000000000000000000..a659b2c1560dfa7218ffe639049baa6f12d1b49d --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/InputFiles.md @@ -0,0 +1,541 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / InputFiles + +# Interface: InputFiles + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2163 + +## Extends + +- [`Node`](Node.md) + +## Properties + +### declarationMapPath? + +> `optional` **declarationMapPath**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2171 + +*** + +### declarationMapText? + +> `optional` **declarationMapText**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2172 + +*** + +### declarationPath? + +> `optional` **declarationPath**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2169 + +*** + +### declarationText + +> **declarationText**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2170 + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`decorators`](Node.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Node`](Node.md).[`end`](Node.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Node`](Node.md).[`flags`](Node.md#flags) + +*** + +### javascriptMapPath? + +> `optional` **javascriptMapPath**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2167 + +*** + +### javascriptMapText? + +> `optional` **javascriptMapText**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2168 + +*** + +### javascriptPath? + +> `optional` **javascriptPath**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2165 + +*** + +### javascriptText + +> **javascriptText**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2166 + +*** + +### kind + +> `readonly` **kind**: [`InputFiles`](../enumerations/SyntaxKind.md#inputfiles) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2164 + +#### Overrides + +[`Node`](Node.md).[`kind`](Node.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Node`](Node.md).[`locals`](Node.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`modifiers`](Node.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`Node`](Node.md).[`parent`](Node.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Node`](Node.md).[`pos`](Node.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Node`](Node.md).[`skipCheck`](Node.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Node`](Node.md).[`symbol`](Node.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Node`](Node.md).[`forEachChild`](Node.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getChildAt`](Node.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getChildCount`](Node.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Node`](Node.md).[`getChildren`](Node.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getEnd`](Node.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getFirstToken`](Node.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullStart`](Node.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getFullText`](Node.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullWidth`](Node.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getLastToken`](Node.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getLeadingTriviaWidth`](Node.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Node`](Node.md).[`getSourceFile`](Node.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getStart`](Node.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getText`](Node.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getWidth`](Node.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/InstallPackageAction.md b/docs/api_docs/namespaces/ts/interfaces/InstallPackageAction.md new file mode 100644 index 0000000000000000000000000000000000000000..e649fa654660171615495e2d35423e89c97521d8 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/InstallPackageAction.md @@ -0,0 +1,9 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / InstallPackageAction + +# Interface: InstallPackageAction + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6634 diff --git a/docs/api_docs/namespaces/ts/interfaces/InstallPackageOptions.md b/docs/api_docs/namespaces/ts/interfaces/InstallPackageOptions.md new file mode 100644 index 0000000000000000000000000000000000000000..6bd4911ef87246ea9558ec3771f1ab60f5f5f20a --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/InstallPackageOptions.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / InstallPackageOptions + +# Interface: InstallPackageOptions + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6204 + +## Properties + +### fileName + +> **fileName**: [`Path`](../type-aliases/Path.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6205 + +*** + +### packageName + +> **packageName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6206 diff --git a/docs/api_docs/namespaces/ts/interfaces/InstantiableType.md b/docs/api_docs/namespaces/ts/interfaces/InstantiableType.md new file mode 100644 index 0000000000000000000000000000000000000000..aba5e0384ff8de729ecb1af382c2bdf6959ac288 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/InstantiableType.md @@ -0,0 +1,457 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / InstantiableType + +# Interface: InstantiableType + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2886 + +## Extends + +- [`Type`](Type.md) + +## Extended by + +- [`TypeParameter`](TypeParameter.md) +- [`IndexedAccessType`](IndexedAccessType.md) +- [`IndexType`](IndexType.md) +- [`ConditionalType`](ConditionalType.md) +- [`TemplateLiteralType`](TemplateLiteralType.md) +- [`StringMappingType`](StringMappingType.md) +- [`SubstitutionType`](SubstitutionType.md) + +## Properties + +### aliasSymbol? + +> `optional` **aliasSymbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2773 + +#### Inherited from + +[`Type`](Type.md).[`aliasSymbol`](Type.md#aliassymbol) + +*** + +### aliasTypeArguments? + +> `optional` **aliasTypeArguments**: readonly [`Type`](Type.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2774 + +#### Inherited from + +[`Type`](Type.md).[`aliasTypeArguments`](Type.md#aliastypearguments) + +*** + +### flags + +> **flags**: [`TypeFlags`](../enumerations/TypeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2770 + +#### Inherited from + +[`Type`](Type.md).[`flags`](Type.md#flags) + +*** + +### pattern? + +> `optional` **pattern**: [`DestructuringPattern`](../type-aliases/DestructuringPattern.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2772 + +#### Inherited from + +[`Type`](Type.md).[`pattern`](Type.md#pattern) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2771 + +#### Inherited from + +[`Type`](Type.md).[`symbol`](Type.md#symbol) + +## Methods + +### getApparentProperties() + +> **getApparentProperties**(): [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6124 + +#### Returns + +[`Symbol`](Symbol.md)[] + +#### Inherited from + +[`Type`](Type.md).[`getApparentProperties`](Type.md#getapparentproperties) + +*** + +### getBaseTypes() + +> **getBaseTypes**(): `undefined` \| [`BaseType`](../type-aliases/BaseType.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6129 + +#### Returns + +`undefined` \| [`BaseType`](../type-aliases/BaseType.md)[] + +#### Inherited from + +[`Type`](Type.md).[`getBaseTypes`](Type.md#getbasetypes) + +*** + +### getCallSignatures() + +> **getCallSignatures**(): readonly [`Signature`](Signature.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6125 + +#### Returns + +readonly [`Signature`](Signature.md)[] + +#### Inherited from + +[`Type`](Type.md).[`getCallSignatures`](Type.md#getcallsignatures) + +*** + +### getConstraint() + +> **getConstraint**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6131 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`Type`](Type.md).[`getConstraint`](Type.md#getconstraint) + +*** + +### getConstructSignatures() + +> **getConstructSignatures**(): readonly [`Signature`](Signature.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6126 + +#### Returns + +readonly [`Signature`](Signature.md)[] + +#### Inherited from + +[`Type`](Type.md).[`getConstructSignatures`](Type.md#getconstructsignatures) + +*** + +### getDefault() + +> **getDefault**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6132 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`Type`](Type.md).[`getDefault`](Type.md#getdefault) + +*** + +### getFlags() + +> **getFlags**(): [`TypeFlags`](../enumerations/TypeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6120 + +#### Returns + +[`TypeFlags`](../enumerations/TypeFlags.md) + +#### Inherited from + +[`Type`](Type.md).[`getFlags`](Type.md#getflags) + +*** + +### getNonNullableType() + +> **getNonNullableType**(): [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6130 + +#### Returns + +[`Type`](Type.md) + +#### Inherited from + +[`Type`](Type.md).[`getNonNullableType`](Type.md#getnonnullabletype) + +*** + +### getNumberIndexType() + +> **getNumberIndexType**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6128 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`Type`](Type.md).[`getNumberIndexType`](Type.md#getnumberindextype) + +*** + +### getProperties() + +> **getProperties**(): [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6122 + +#### Returns + +[`Symbol`](Symbol.md)[] + +#### Inherited from + +[`Type`](Type.md).[`getProperties`](Type.md#getproperties) + +*** + +### getProperty() + +> **getProperty**(`propertyName`): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6123 + +#### Parameters + +##### propertyName + +`string` + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +#### Inherited from + +[`Type`](Type.md).[`getProperty`](Type.md#getproperty) + +*** + +### getStringIndexType() + +> **getStringIndexType**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6127 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`Type`](Type.md).[`getStringIndexType`](Type.md#getstringindextype) + +*** + +### getSymbol() + +> **getSymbol**(): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6121 + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +#### Inherited from + +[`Type`](Type.md).[`getSymbol`](Type.md#getsymbol) + +*** + +### isClass() + +> **isClass**(): `this is InterfaceType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6141 + +#### Returns + +`this is InterfaceType` + +#### Inherited from + +[`Type`](Type.md).[`isClass`](Type.md#isclass) + +*** + +### isClassOrInterface() + +> **isClassOrInterface**(): `this is InterfaceType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6140 + +#### Returns + +`this is InterfaceType` + +#### Inherited from + +[`Type`](Type.md).[`isClassOrInterface`](Type.md#isclassorinterface) + +*** + +### isIndexType() + +> **isIndexType**(): `this is IndexType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6142 + +#### Returns + +`this is IndexType` + +#### Inherited from + +[`Type`](Type.md).[`isIndexType`](Type.md#isindextype) + +*** + +### isIntersection() + +> **isIntersection**(): `this is IntersectionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6134 + +#### Returns + +`this is IntersectionType` + +#### Inherited from + +[`Type`](Type.md).[`isIntersection`](Type.md#isintersection) + +*** + +### isLiteral() + +> **isLiteral**(): `this is LiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6136 + +#### Returns + +`this is LiteralType` + +#### Inherited from + +[`Type`](Type.md).[`isLiteral`](Type.md#isliteral) + +*** + +### isNumberLiteral() + +> **isNumberLiteral**(): `this is NumberLiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6138 + +#### Returns + +`this is NumberLiteralType` + +#### Inherited from + +[`Type`](Type.md).[`isNumberLiteral`](Type.md#isnumberliteral) + +*** + +### isStringLiteral() + +> **isStringLiteral**(): `this is StringLiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6137 + +#### Returns + +`this is StringLiteralType` + +#### Inherited from + +[`Type`](Type.md).[`isStringLiteral`](Type.md#isstringliteral) + +*** + +### isTypeParameter() + +> **isTypeParameter**(): `this is TypeParameter` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6139 + +#### Returns + +`this is TypeParameter` + +#### Inherited from + +[`Type`](Type.md).[`isTypeParameter`](Type.md#istypeparameter) + +*** + +### isUnion() + +> **isUnion**(): `this is UnionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6133 + +#### Returns + +`this is UnionType` + +#### Inherited from + +[`Type`](Type.md).[`isUnion`](Type.md#isunion) + +*** + +### isUnionOrIntersection() + +> **isUnionOrIntersection**(): `this is UnionOrIntersectionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6135 + +#### Returns + +`this is UnionOrIntersectionType` + +#### Inherited from + +[`Type`](Type.md).[`isUnionOrIntersection`](Type.md#isunionorintersection) diff --git a/docs/api_docs/namespaces/ts/interfaces/InterfaceDeclaration.md b/docs/api_docs/namespaces/ts/interfaces/InterfaceDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..1ca65413122f1d03b1057a3737fb3d0044bf0f4d --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/InterfaceDeclaration.md @@ -0,0 +1,537 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / InterfaceDeclaration + +# Interface: InterfaceDeclaration + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1641 + +## Extends + +- [`DeclarationStatement`](DeclarationStatement.md).[`JSDocContainer`](JSDocContainer.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`_declarationBrand`](DeclarationStatement.md#_declarationbrand) + +*** + +### \_statementBrand + +> **\_statementBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1471 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`_statementBrand`](DeclarationStatement.md#_statementbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`decorators`](DeclarationStatement.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`end`](DeclarationStatement.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`flags`](DeclarationStatement.md#flags) + +*** + +### heritageClauses? + +> `readonly` `optional` **heritageClauses**: [`NodeArray`](NodeArray.md)\<[`HeritageClause`](HeritageClause.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1646 + +*** + +### kind + +> `readonly` **kind**: [`InterfaceDeclaration`](../enumerations/SyntaxKind.md#interfacedeclaration) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1642 + +#### Overrides + +[`DeclarationStatement`](DeclarationStatement.md).[`kind`](DeclarationStatement.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`locals`](DeclarationStatement.md#locals) + +*** + +### members + +> `readonly` **members**: [`NodeArray`](NodeArray.md)\<[`TypeElement`](TypeElement.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1647 + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`Modifier`](../type-aliases/Modifier.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1643 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Overrides + +[`DeclarationStatement`](DeclarationStatement.md).[`modifiers`](DeclarationStatement.md#modifiers) + +*** + +### name + +> `readonly` **name**: [`Identifier`](Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1644 + +#### Overrides + +[`DeclarationStatement`](DeclarationStatement.md).[`name`](DeclarationStatement.md#name) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`parent`](DeclarationStatement.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`pos`](DeclarationStatement.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`skipCheck`](DeclarationStatement.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`symbol`](DeclarationStatement.md#symbol) + +*** + +### typeParameters? + +> `readonly` `optional` **typeParameters**: [`NodeArray`](NodeArray.md)\<[`TypeParameterDeclaration`](TypeParameterDeclaration.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1645 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`forEachChild`](DeclarationStatement.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getChildAt`](DeclarationStatement.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getChildCount`](DeclarationStatement.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getChildren`](DeclarationStatement.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getEnd`](DeclarationStatement.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getFirstToken`](DeclarationStatement.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getFullStart`](DeclarationStatement.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getFullText`](DeclarationStatement.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getFullWidth`](DeclarationStatement.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getLastToken`](DeclarationStatement.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getLeadingTriviaWidth`](DeclarationStatement.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getSourceFile`](DeclarationStatement.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getStart`](DeclarationStatement.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getText`](DeclarationStatement.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getWidth`](DeclarationStatement.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/InterfaceType.md b/docs/api_docs/namespaces/ts/interfaces/InterfaceType.md new file mode 100644 index 0000000000000000000000000000000000000000..2effaa0ecc798c59ccdf97209fc2d7ed37d70963 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/InterfaceType.md @@ -0,0 +1,498 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / InterfaceType + +# Interface: InterfaceType + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2821 + +Class and interface types (ObjectFlags.Class and ObjectFlags.Interface). + +## Extends + +- [`ObjectType`](ObjectType.md) + +## Extended by + +- [`InterfaceTypeWithDeclaredMembers`](InterfaceTypeWithDeclaredMembers.md) +- [`GenericType`](GenericType.md) + +## Properties + +### aliasSymbol? + +> `optional` **aliasSymbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2773 + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`aliasSymbol`](ObjectType.md#aliassymbol) + +*** + +### aliasTypeArguments? + +> `optional` **aliasTypeArguments**: readonly [`Type`](Type.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2774 + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`aliasTypeArguments`](ObjectType.md#aliastypearguments) + +*** + +### flags + +> **flags**: [`TypeFlags`](../enumerations/TypeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2770 + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`flags`](ObjectType.md#flags) + +*** + +### localTypeParameters + +> **localTypeParameters**: `undefined` \| [`TypeParameter`](TypeParameter.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2824 + +*** + +### objectFlags + +> **objectFlags**: [`ObjectFlags`](../enumerations/ObjectFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2818 + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`objectFlags`](ObjectType.md#objectflags) + +*** + +### outerTypeParameters + +> **outerTypeParameters**: `undefined` \| [`TypeParameter`](TypeParameter.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2823 + +*** + +### pattern? + +> `optional` **pattern**: [`DestructuringPattern`](../type-aliases/DestructuringPattern.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2772 + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`pattern`](ObjectType.md#pattern) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2771 + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`symbol`](ObjectType.md#symbol) + +*** + +### thisType + +> **thisType**: `undefined` \| [`TypeParameter`](TypeParameter.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2825 + +*** + +### typeParameters + +> **typeParameters**: `undefined` \| [`TypeParameter`](TypeParameter.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2822 + +## Methods + +### getApparentProperties() + +> **getApparentProperties**(): [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6124 + +#### Returns + +[`Symbol`](Symbol.md)[] + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`getApparentProperties`](ObjectType.md#getapparentproperties) + +*** + +### getBaseTypes() + +> **getBaseTypes**(): `undefined` \| [`BaseType`](../type-aliases/BaseType.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6129 + +#### Returns + +`undefined` \| [`BaseType`](../type-aliases/BaseType.md)[] + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`getBaseTypes`](ObjectType.md#getbasetypes) + +*** + +### getCallSignatures() + +> **getCallSignatures**(): readonly [`Signature`](Signature.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6125 + +#### Returns + +readonly [`Signature`](Signature.md)[] + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`getCallSignatures`](ObjectType.md#getcallsignatures) + +*** + +### getConstraint() + +> **getConstraint**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6131 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`getConstraint`](ObjectType.md#getconstraint) + +*** + +### getConstructSignatures() + +> **getConstructSignatures**(): readonly [`Signature`](Signature.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6126 + +#### Returns + +readonly [`Signature`](Signature.md)[] + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`getConstructSignatures`](ObjectType.md#getconstructsignatures) + +*** + +### getDefault() + +> **getDefault**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6132 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`getDefault`](ObjectType.md#getdefault) + +*** + +### getFlags() + +> **getFlags**(): [`TypeFlags`](../enumerations/TypeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6120 + +#### Returns + +[`TypeFlags`](../enumerations/TypeFlags.md) + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`getFlags`](ObjectType.md#getflags) + +*** + +### getNonNullableType() + +> **getNonNullableType**(): [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6130 + +#### Returns + +[`Type`](Type.md) + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`getNonNullableType`](ObjectType.md#getnonnullabletype) + +*** + +### getNumberIndexType() + +> **getNumberIndexType**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6128 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`getNumberIndexType`](ObjectType.md#getnumberindextype) + +*** + +### getProperties() + +> **getProperties**(): [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6122 + +#### Returns + +[`Symbol`](Symbol.md)[] + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`getProperties`](ObjectType.md#getproperties) + +*** + +### getProperty() + +> **getProperty**(`propertyName`): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6123 + +#### Parameters + +##### propertyName + +`string` + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`getProperty`](ObjectType.md#getproperty) + +*** + +### getStringIndexType() + +> **getStringIndexType**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6127 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`getStringIndexType`](ObjectType.md#getstringindextype) + +*** + +### getSymbol() + +> **getSymbol**(): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6121 + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`getSymbol`](ObjectType.md#getsymbol) + +*** + +### isClass() + +> **isClass**(): `this is InterfaceType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6141 + +#### Returns + +`this is InterfaceType` + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`isClass`](ObjectType.md#isclass) + +*** + +### isClassOrInterface() + +> **isClassOrInterface**(): `this is InterfaceType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6140 + +#### Returns + +`this is InterfaceType` + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`isClassOrInterface`](ObjectType.md#isclassorinterface) + +*** + +### isIndexType() + +> **isIndexType**(): `this is IndexType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6142 + +#### Returns + +`this is IndexType` + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`isIndexType`](ObjectType.md#isindextype) + +*** + +### isIntersection() + +> **isIntersection**(): `this is IntersectionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6134 + +#### Returns + +`this is IntersectionType` + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`isIntersection`](ObjectType.md#isintersection) + +*** + +### isLiteral() + +> **isLiteral**(): `this is LiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6136 + +#### Returns + +`this is LiteralType` + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`isLiteral`](ObjectType.md#isliteral) + +*** + +### isNumberLiteral() + +> **isNumberLiteral**(): `this is NumberLiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6138 + +#### Returns + +`this is NumberLiteralType` + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`isNumberLiteral`](ObjectType.md#isnumberliteral) + +*** + +### isStringLiteral() + +> **isStringLiteral**(): `this is StringLiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6137 + +#### Returns + +`this is StringLiteralType` + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`isStringLiteral`](ObjectType.md#isstringliteral) + +*** + +### isTypeParameter() + +> **isTypeParameter**(): `this is TypeParameter` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6139 + +#### Returns + +`this is TypeParameter` + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`isTypeParameter`](ObjectType.md#istypeparameter) + +*** + +### isUnion() + +> **isUnion**(): `this is UnionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6133 + +#### Returns + +`this is UnionType` + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`isUnion`](ObjectType.md#isunion) + +*** + +### isUnionOrIntersection() + +> **isUnionOrIntersection**(): `this is UnionOrIntersectionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6135 + +#### Returns + +`this is UnionOrIntersectionType` + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`isUnionOrIntersection`](ObjectType.md#isunionorintersection) diff --git a/docs/api_docs/namespaces/ts/interfaces/InterfaceTypeWithDeclaredMembers.md b/docs/api_docs/namespaces/ts/interfaces/InterfaceTypeWithDeclaredMembers.md new file mode 100644 index 0000000000000000000000000000000000000000..856cad72f0c6dca9a6052b9607fa067cba1eb477 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/InterfaceTypeWithDeclaredMembers.md @@ -0,0 +1,541 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / InterfaceTypeWithDeclaredMembers + +# Interface: InterfaceTypeWithDeclaredMembers + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2828 + +Class and interface types (ObjectFlags.Class and ObjectFlags.Interface). + +## Extends + +- [`InterfaceType`](InterfaceType.md) + +## Properties + +### aliasSymbol? + +> `optional` **aliasSymbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2773 + +#### Inherited from + +[`InterfaceType`](InterfaceType.md).[`aliasSymbol`](InterfaceType.md#aliassymbol) + +*** + +### aliasTypeArguments? + +> `optional` **aliasTypeArguments**: readonly [`Type`](Type.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2774 + +#### Inherited from + +[`InterfaceType`](InterfaceType.md).[`aliasTypeArguments`](InterfaceType.md#aliastypearguments) + +*** + +### declaredCallSignatures + +> **declaredCallSignatures**: [`Signature`](Signature.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2830 + +*** + +### declaredConstructSignatures + +> **declaredConstructSignatures**: [`Signature`](Signature.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2831 + +*** + +### declaredIndexInfos + +> **declaredIndexInfos**: [`IndexInfo`](IndexInfo.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2832 + +*** + +### declaredProperties + +> **declaredProperties**: [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2829 + +*** + +### flags + +> **flags**: [`TypeFlags`](../enumerations/TypeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2770 + +#### Inherited from + +[`InterfaceType`](InterfaceType.md).[`flags`](InterfaceType.md#flags) + +*** + +### localTypeParameters + +> **localTypeParameters**: `undefined` \| [`TypeParameter`](TypeParameter.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2824 + +#### Inherited from + +[`InterfaceType`](InterfaceType.md).[`localTypeParameters`](InterfaceType.md#localtypeparameters) + +*** + +### objectFlags + +> **objectFlags**: [`ObjectFlags`](../enumerations/ObjectFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2818 + +#### Inherited from + +[`InterfaceType`](InterfaceType.md).[`objectFlags`](InterfaceType.md#objectflags) + +*** + +### outerTypeParameters + +> **outerTypeParameters**: `undefined` \| [`TypeParameter`](TypeParameter.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2823 + +#### Inherited from + +[`InterfaceType`](InterfaceType.md).[`outerTypeParameters`](InterfaceType.md#outertypeparameters) + +*** + +### pattern? + +> `optional` **pattern**: [`DestructuringPattern`](../type-aliases/DestructuringPattern.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2772 + +#### Inherited from + +[`InterfaceType`](InterfaceType.md).[`pattern`](InterfaceType.md#pattern) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2771 + +#### Inherited from + +[`InterfaceType`](InterfaceType.md).[`symbol`](InterfaceType.md#symbol) + +*** + +### thisType + +> **thisType**: `undefined` \| [`TypeParameter`](TypeParameter.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2825 + +#### Inherited from + +[`InterfaceType`](InterfaceType.md).[`thisType`](InterfaceType.md#thistype) + +*** + +### typeParameters + +> **typeParameters**: `undefined` \| [`TypeParameter`](TypeParameter.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2822 + +#### Inherited from + +[`InterfaceType`](InterfaceType.md).[`typeParameters`](InterfaceType.md#typeparameters) + +## Methods + +### getApparentProperties() + +> **getApparentProperties**(): [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6124 + +#### Returns + +[`Symbol`](Symbol.md)[] + +#### Inherited from + +[`InterfaceType`](InterfaceType.md).[`getApparentProperties`](InterfaceType.md#getapparentproperties) + +*** + +### getBaseTypes() + +> **getBaseTypes**(): `undefined` \| [`BaseType`](../type-aliases/BaseType.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6129 + +#### Returns + +`undefined` \| [`BaseType`](../type-aliases/BaseType.md)[] + +#### Inherited from + +[`InterfaceType`](InterfaceType.md).[`getBaseTypes`](InterfaceType.md#getbasetypes) + +*** + +### getCallSignatures() + +> **getCallSignatures**(): readonly [`Signature`](Signature.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6125 + +#### Returns + +readonly [`Signature`](Signature.md)[] + +#### Inherited from + +[`InterfaceType`](InterfaceType.md).[`getCallSignatures`](InterfaceType.md#getcallsignatures) + +*** + +### getConstraint() + +> **getConstraint**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6131 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`InterfaceType`](InterfaceType.md).[`getConstraint`](InterfaceType.md#getconstraint) + +*** + +### getConstructSignatures() + +> **getConstructSignatures**(): readonly [`Signature`](Signature.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6126 + +#### Returns + +readonly [`Signature`](Signature.md)[] + +#### Inherited from + +[`InterfaceType`](InterfaceType.md).[`getConstructSignatures`](InterfaceType.md#getconstructsignatures) + +*** + +### getDefault() + +> **getDefault**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6132 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`InterfaceType`](InterfaceType.md).[`getDefault`](InterfaceType.md#getdefault) + +*** + +### getFlags() + +> **getFlags**(): [`TypeFlags`](../enumerations/TypeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6120 + +#### Returns + +[`TypeFlags`](../enumerations/TypeFlags.md) + +#### Inherited from + +[`InterfaceType`](InterfaceType.md).[`getFlags`](InterfaceType.md#getflags) + +*** + +### getNonNullableType() + +> **getNonNullableType**(): [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6130 + +#### Returns + +[`Type`](Type.md) + +#### Inherited from + +[`InterfaceType`](InterfaceType.md).[`getNonNullableType`](InterfaceType.md#getnonnullabletype) + +*** + +### getNumberIndexType() + +> **getNumberIndexType**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6128 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`InterfaceType`](InterfaceType.md).[`getNumberIndexType`](InterfaceType.md#getnumberindextype) + +*** + +### getProperties() + +> **getProperties**(): [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6122 + +#### Returns + +[`Symbol`](Symbol.md)[] + +#### Inherited from + +[`InterfaceType`](InterfaceType.md).[`getProperties`](InterfaceType.md#getproperties) + +*** + +### getProperty() + +> **getProperty**(`propertyName`): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6123 + +#### Parameters + +##### propertyName + +`string` + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +#### Inherited from + +[`InterfaceType`](InterfaceType.md).[`getProperty`](InterfaceType.md#getproperty) + +*** + +### getStringIndexType() + +> **getStringIndexType**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6127 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`InterfaceType`](InterfaceType.md).[`getStringIndexType`](InterfaceType.md#getstringindextype) + +*** + +### getSymbol() + +> **getSymbol**(): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6121 + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +#### Inherited from + +[`InterfaceType`](InterfaceType.md).[`getSymbol`](InterfaceType.md#getsymbol) + +*** + +### isClass() + +> **isClass**(): `this is InterfaceType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6141 + +#### Returns + +`this is InterfaceType` + +#### Inherited from + +[`InterfaceType`](InterfaceType.md).[`isClass`](InterfaceType.md#isclass) + +*** + +### isClassOrInterface() + +> **isClassOrInterface**(): `this is InterfaceType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6140 + +#### Returns + +`this is InterfaceType` + +#### Inherited from + +[`InterfaceType`](InterfaceType.md).[`isClassOrInterface`](InterfaceType.md#isclassorinterface) + +*** + +### isIndexType() + +> **isIndexType**(): `this is IndexType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6142 + +#### Returns + +`this is IndexType` + +#### Inherited from + +[`InterfaceType`](InterfaceType.md).[`isIndexType`](InterfaceType.md#isindextype) + +*** + +### isIntersection() + +> **isIntersection**(): `this is IntersectionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6134 + +#### Returns + +`this is IntersectionType` + +#### Inherited from + +[`InterfaceType`](InterfaceType.md).[`isIntersection`](InterfaceType.md#isintersection) + +*** + +### isLiteral() + +> **isLiteral**(): `this is LiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6136 + +#### Returns + +`this is LiteralType` + +#### Inherited from + +[`InterfaceType`](InterfaceType.md).[`isLiteral`](InterfaceType.md#isliteral) + +*** + +### isNumberLiteral() + +> **isNumberLiteral**(): `this is NumberLiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6138 + +#### Returns + +`this is NumberLiteralType` + +#### Inherited from + +[`InterfaceType`](InterfaceType.md).[`isNumberLiteral`](InterfaceType.md#isnumberliteral) + +*** + +### isStringLiteral() + +> **isStringLiteral**(): `this is StringLiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6137 + +#### Returns + +`this is StringLiteralType` + +#### Inherited from + +[`InterfaceType`](InterfaceType.md).[`isStringLiteral`](InterfaceType.md#isstringliteral) + +*** + +### isTypeParameter() + +> **isTypeParameter**(): `this is TypeParameter` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6139 + +#### Returns + +`this is TypeParameter` + +#### Inherited from + +[`InterfaceType`](InterfaceType.md).[`isTypeParameter`](InterfaceType.md#istypeparameter) + +*** + +### isUnion() + +> **isUnion**(): `this is UnionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6133 + +#### Returns + +`this is UnionType` + +#### Inherited from + +[`InterfaceType`](InterfaceType.md).[`isUnion`](InterfaceType.md#isunion) + +*** + +### isUnionOrIntersection() + +> **isUnionOrIntersection**(): `this is UnionOrIntersectionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6135 + +#### Returns + +`this is UnionOrIntersectionType` + +#### Inherited from + +[`InterfaceType`](InterfaceType.md).[`isUnionOrIntersection`](InterfaceType.md#isunionorintersection) diff --git a/docs/api_docs/namespaces/ts/interfaces/IntersectionType.md b/docs/api_docs/namespaces/ts/interfaces/IntersectionType.md new file mode 100644 index 0000000000000000000000000000000000000000..bf1811e9d9c9bcdbb7d1340b328d2ccc95d39309 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/IntersectionType.md @@ -0,0 +1,459 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / IntersectionType + +# Interface: IntersectionType + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2879 + +## Extends + +- [`UnionOrIntersectionType`](UnionOrIntersectionType.md) + +## Properties + +### aliasSymbol? + +> `optional` **aliasSymbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2773 + +#### Inherited from + +[`UnionOrIntersectionType`](UnionOrIntersectionType.md).[`aliasSymbol`](UnionOrIntersectionType.md#aliassymbol) + +*** + +### aliasTypeArguments? + +> `optional` **aliasTypeArguments**: readonly [`Type`](Type.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2774 + +#### Inherited from + +[`UnionOrIntersectionType`](UnionOrIntersectionType.md).[`aliasTypeArguments`](UnionOrIntersectionType.md#aliastypearguments) + +*** + +### flags + +> **flags**: [`TypeFlags`](../enumerations/TypeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2770 + +#### Inherited from + +[`UnionOrIntersectionType`](UnionOrIntersectionType.md).[`flags`](UnionOrIntersectionType.md#flags) + +*** + +### pattern? + +> `optional` **pattern**: [`DestructuringPattern`](../type-aliases/DestructuringPattern.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2772 + +#### Inherited from + +[`UnionOrIntersectionType`](UnionOrIntersectionType.md).[`pattern`](UnionOrIntersectionType.md#pattern) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2771 + +#### Inherited from + +[`UnionOrIntersectionType`](UnionOrIntersectionType.md).[`symbol`](UnionOrIntersectionType.md#symbol) + +*** + +### types + +> **types**: [`Type`](Type.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2875 + +#### Inherited from + +[`UnionOrIntersectionType`](UnionOrIntersectionType.md).[`types`](UnionOrIntersectionType.md#types) + +## Methods + +### getApparentProperties() + +> **getApparentProperties**(): [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6124 + +#### Returns + +[`Symbol`](Symbol.md)[] + +#### Inherited from + +[`UnionOrIntersectionType`](UnionOrIntersectionType.md).[`getApparentProperties`](UnionOrIntersectionType.md#getapparentproperties) + +*** + +### getBaseTypes() + +> **getBaseTypes**(): `undefined` \| [`BaseType`](../type-aliases/BaseType.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6129 + +#### Returns + +`undefined` \| [`BaseType`](../type-aliases/BaseType.md)[] + +#### Inherited from + +[`UnionOrIntersectionType`](UnionOrIntersectionType.md).[`getBaseTypes`](UnionOrIntersectionType.md#getbasetypes) + +*** + +### getCallSignatures() + +> **getCallSignatures**(): readonly [`Signature`](Signature.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6125 + +#### Returns + +readonly [`Signature`](Signature.md)[] + +#### Inherited from + +[`UnionOrIntersectionType`](UnionOrIntersectionType.md).[`getCallSignatures`](UnionOrIntersectionType.md#getcallsignatures) + +*** + +### getConstraint() + +> **getConstraint**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6131 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`UnionOrIntersectionType`](UnionOrIntersectionType.md).[`getConstraint`](UnionOrIntersectionType.md#getconstraint) + +*** + +### getConstructSignatures() + +> **getConstructSignatures**(): readonly [`Signature`](Signature.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6126 + +#### Returns + +readonly [`Signature`](Signature.md)[] + +#### Inherited from + +[`UnionOrIntersectionType`](UnionOrIntersectionType.md).[`getConstructSignatures`](UnionOrIntersectionType.md#getconstructsignatures) + +*** + +### getDefault() + +> **getDefault**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6132 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`UnionOrIntersectionType`](UnionOrIntersectionType.md).[`getDefault`](UnionOrIntersectionType.md#getdefault) + +*** + +### getFlags() + +> **getFlags**(): [`TypeFlags`](../enumerations/TypeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6120 + +#### Returns + +[`TypeFlags`](../enumerations/TypeFlags.md) + +#### Inherited from + +[`UnionOrIntersectionType`](UnionOrIntersectionType.md).[`getFlags`](UnionOrIntersectionType.md#getflags) + +*** + +### getNonNullableType() + +> **getNonNullableType**(): [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6130 + +#### Returns + +[`Type`](Type.md) + +#### Inherited from + +[`UnionOrIntersectionType`](UnionOrIntersectionType.md).[`getNonNullableType`](UnionOrIntersectionType.md#getnonnullabletype) + +*** + +### getNumberIndexType() + +> **getNumberIndexType**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6128 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`UnionOrIntersectionType`](UnionOrIntersectionType.md).[`getNumberIndexType`](UnionOrIntersectionType.md#getnumberindextype) + +*** + +### getProperties() + +> **getProperties**(): [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6122 + +#### Returns + +[`Symbol`](Symbol.md)[] + +#### Inherited from + +[`UnionOrIntersectionType`](UnionOrIntersectionType.md).[`getProperties`](UnionOrIntersectionType.md#getproperties) + +*** + +### getProperty() + +> **getProperty**(`propertyName`): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6123 + +#### Parameters + +##### propertyName + +`string` + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +#### Inherited from + +[`UnionOrIntersectionType`](UnionOrIntersectionType.md).[`getProperty`](UnionOrIntersectionType.md#getproperty) + +*** + +### getStringIndexType() + +> **getStringIndexType**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6127 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`UnionOrIntersectionType`](UnionOrIntersectionType.md).[`getStringIndexType`](UnionOrIntersectionType.md#getstringindextype) + +*** + +### getSymbol() + +> **getSymbol**(): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6121 + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +#### Inherited from + +[`UnionOrIntersectionType`](UnionOrIntersectionType.md).[`getSymbol`](UnionOrIntersectionType.md#getsymbol) + +*** + +### isClass() + +> **isClass**(): `this is InterfaceType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6141 + +#### Returns + +`this is InterfaceType` + +#### Inherited from + +[`UnionOrIntersectionType`](UnionOrIntersectionType.md).[`isClass`](UnionOrIntersectionType.md#isclass) + +*** + +### isClassOrInterface() + +> **isClassOrInterface**(): `this is InterfaceType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6140 + +#### Returns + +`this is InterfaceType` + +#### Inherited from + +[`UnionOrIntersectionType`](UnionOrIntersectionType.md).[`isClassOrInterface`](UnionOrIntersectionType.md#isclassorinterface) + +*** + +### isIndexType() + +> **isIndexType**(): `this is IndexType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6142 + +#### Returns + +`this is IndexType` + +#### Inherited from + +[`UnionOrIntersectionType`](UnionOrIntersectionType.md).[`isIndexType`](UnionOrIntersectionType.md#isindextype) + +*** + +### isIntersection() + +> **isIntersection**(): `this is IntersectionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6134 + +#### Returns + +`this is IntersectionType` + +#### Inherited from + +[`UnionOrIntersectionType`](UnionOrIntersectionType.md).[`isIntersection`](UnionOrIntersectionType.md#isintersection) + +*** + +### isLiteral() + +> **isLiteral**(): `this is LiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6136 + +#### Returns + +`this is LiteralType` + +#### Inherited from + +[`UnionOrIntersectionType`](UnionOrIntersectionType.md).[`isLiteral`](UnionOrIntersectionType.md#isliteral) + +*** + +### isNumberLiteral() + +> **isNumberLiteral**(): `this is NumberLiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6138 + +#### Returns + +`this is NumberLiteralType` + +#### Inherited from + +[`UnionOrIntersectionType`](UnionOrIntersectionType.md).[`isNumberLiteral`](UnionOrIntersectionType.md#isnumberliteral) + +*** + +### isStringLiteral() + +> **isStringLiteral**(): `this is StringLiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6137 + +#### Returns + +`this is StringLiteralType` + +#### Inherited from + +[`UnionOrIntersectionType`](UnionOrIntersectionType.md).[`isStringLiteral`](UnionOrIntersectionType.md#isstringliteral) + +*** + +### isTypeParameter() + +> **isTypeParameter**(): `this is TypeParameter` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6139 + +#### Returns + +`this is TypeParameter` + +#### Inherited from + +[`UnionOrIntersectionType`](UnionOrIntersectionType.md).[`isTypeParameter`](UnionOrIntersectionType.md#istypeparameter) + +*** + +### isUnion() + +> **isUnion**(): `this is UnionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6133 + +#### Returns + +`this is UnionType` + +#### Inherited from + +[`UnionOrIntersectionType`](UnionOrIntersectionType.md).[`isUnion`](UnionOrIntersectionType.md#isunion) + +*** + +### isUnionOrIntersection() + +> **isUnionOrIntersection**(): `this is UnionOrIntersectionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6135 + +#### Returns + +`this is UnionOrIntersectionType` + +#### Inherited from + +[`UnionOrIntersectionType`](UnionOrIntersectionType.md).[`isUnionOrIntersection`](UnionOrIntersectionType.md#isunionorintersection) diff --git a/docs/api_docs/namespaces/ts/interfaces/IntersectionTypeNode.md b/docs/api_docs/namespaces/ts/interfaces/IntersectionTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..459237eed0b5d41cf2bf4398308d534a9484dcdf --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/IntersectionTypeNode.md @@ -0,0 +1,497 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / IntersectionTypeNode + +# Interface: IntersectionTypeNode + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:996 + +## Extends + +- [`TypeNode`](TypeNode.md) + +## Properties + +### \_typeNodeBrand + +> **\_typeNodeBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:912 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`_typeNodeBrand`](TypeNode.md#_typenodebrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`decorators`](TypeNode.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`end`](TypeNode.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`flags`](TypeNode.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`IntersectionType`](../enumerations/SyntaxKind.md#intersectiontype) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:997 + +#### Overrides + +[`TypeNode`](TypeNode.md).[`kind`](TypeNode.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`locals`](TypeNode.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`modifiers`](TypeNode.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`parent`](TypeNode.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`pos`](TypeNode.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`skipCheck`](TypeNode.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`symbol`](TypeNode.md#symbol) + +*** + +### types + +> `readonly` **types**: [`NodeArray`](NodeArray.md)\<[`TypeNode`](TypeNode.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:998 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`forEachChild`](TypeNode.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getChildAt`](TypeNode.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getChildCount`](TypeNode.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getChildren`](TypeNode.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getEnd`](TypeNode.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFirstToken`](TypeNode.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFullStart`](TypeNode.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFullText`](TypeNode.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFullWidth`](TypeNode.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getLastToken`](TypeNode.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getLeadingTriviaWidth`](TypeNode.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getSourceFile`](TypeNode.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getStart`](TypeNode.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getText`](TypeNode.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getWidth`](TypeNode.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/InvalidatedProjectBase.md b/docs/api_docs/namespaces/ts/interfaces/InvalidatedProjectBase.md new file mode 100644 index 0000000000000000000000000000000000000000..160e5c260f1acd35b7362f5efca9effc1c8cf09a --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/InvalidatedProjectBase.md @@ -0,0 +1,83 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / InvalidatedProjectBase + +# Interface: InvalidatedProjectBase + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5976 + +## Extended by + +- [`UpdateOutputFileStampsProject`](UpdateOutputFileStampsProject.md) +- [`BuildInvalidedProject`](BuildInvalidedProject.md) +- [`UpdateBundleProject`](UpdateBundleProject.md) + +## Properties + +### kind + +> `readonly` **kind**: [`InvalidatedProjectKind`](../enumerations/InvalidatedProjectKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5977 + +*** + +### project + +> `readonly` **project**: [`ResolvedConfigFileName`](../type-aliases/ResolvedConfigFileName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5978 + +## Methods + +### done() + +> **done**(`cancellationToken`?, `writeFile`?, `customTransformers`?): [`ExitStatus`](../enumerations/ExitStatus.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5982 + +To dispose this project and ensure that all the necessary actions are taken and state is updated accordingly + +#### Parameters + +##### cancellationToken? + +[`CancellationToken`](CancellationToken.md) + +##### writeFile? + +[`WriteFileCallback`](../type-aliases/WriteFileCallback.md) + +##### customTransformers? + +[`CustomTransformers`](CustomTransformers.md) + +#### Returns + +[`ExitStatus`](../enumerations/ExitStatus.md) + +*** + +### getCompilerOptions() + +> **getCompilerOptions**(): [`CompilerOptions`](CompilerOptions.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5983 + +#### Returns + +[`CompilerOptions`](CompilerOptions.md) + +*** + +### getCurrentDirectory() + +> **getCurrentDirectory**(): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5984 + +#### Returns + +`string` diff --git a/docs/api_docs/namespaces/ts/interfaces/IterationStatement.md b/docs/api_docs/namespaces/ts/interfaces/IterationStatement.md new file mode 100644 index 0000000000000000000000000000000000000000..a3d3a465faf2d4a5e21e841dbe2655a44ddbd887 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/IterationStatement.md @@ -0,0 +1,505 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / IterationStatement + +# Interface: IterationStatement + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1513 + +## Extends + +- [`Statement`](Statement.md) + +## Extended by + +- [`DoStatement`](DoStatement.md) +- [`WhileStatement`](WhileStatement.md) +- [`ForStatement`](ForStatement.md) +- [`ForInStatement`](ForInStatement.md) +- [`ForOfStatement`](ForOfStatement.md) + +## Properties + +### \_statementBrand + +> **\_statementBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1471 + +#### Inherited from + +[`Statement`](Statement.md).[`_statementBrand`](Statement.md#_statementbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Statement`](Statement.md).[`decorators`](Statement.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Statement`](Statement.md).[`end`](Statement.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Statement`](Statement.md).[`flags`](Statement.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`SyntaxKind`](../enumerations/SyntaxKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:598 + +#### Inherited from + +[`Statement`](Statement.md).[`kind`](Statement.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Statement`](Statement.md).[`locals`](Statement.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Statement`](Statement.md).[`modifiers`](Statement.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`Statement`](Statement.md).[`parent`](Statement.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Statement`](Statement.md).[`pos`](Statement.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Statement`](Statement.md).[`skipCheck`](Statement.md#skipcheck) + +*** + +### statement + +> `readonly` **statement**: [`Statement`](Statement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1514 + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Statement`](Statement.md).[`symbol`](Statement.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Statement`](Statement.md).[`forEachChild`](Statement.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getChildAt`](Statement.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getChildCount`](Statement.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Statement`](Statement.md).[`getChildren`](Statement.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getEnd`](Statement.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getFirstToken`](Statement.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getFullStart`](Statement.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Statement`](Statement.md).[`getFullText`](Statement.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getFullWidth`](Statement.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getLastToken`](Statement.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getLeadingTriviaWidth`](Statement.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getSourceFile`](Statement.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getStart`](Statement.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Statement`](Statement.md).[`getText`](Statement.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getWidth`](Statement.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/Iterator.md b/docs/api_docs/namespaces/ts/interfaces/Iterator.md new file mode 100644 index 0000000000000000000000000000000000000000..349c4f8587c60f9e9efbab0feb5d3dbc548b5849 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/Iterator.md @@ -0,0 +1,27 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / Iterator + +# Interface: Iterator\ + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:79 + +ES6 Iterator type. + +## Type Parameters + +• **T** + +## Methods + +### next() + +> **next**(): \{ `done`: `false`; `value`: `T`; \} \| \{ `done`: `true`; `value`: `void`; \} + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:80 + +#### Returns + +\{ `done`: `false`; `value`: `T`; \} \| \{ `done`: `true`; `value`: `void`; \} diff --git a/docs/api_docs/namespaces/ts/interfaces/JSDoc.md b/docs/api_docs/namespaces/ts/interfaces/JSDoc.md new file mode 100644 index 0000000000000000000000000000000000000000..2502bdb4c3cfd32bfccb93509b3ae8f136b7f796 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JSDoc.md @@ -0,0 +1,493 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JSDoc + +# Interface: JSDoc + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1905 + +## Extends + +- [`Node`](Node.md) + +## Properties + +### comment? + +> `readonly` `optional` **comment**: `string` \| [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1909 + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`decorators`](Node.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Node`](Node.md).[`end`](Node.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Node`](Node.md).[`flags`](Node.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`JSDoc`](../enumerations/SyntaxKind.md#jsdoc) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1906 + +#### Overrides + +[`Node`](Node.md).[`kind`](Node.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Node`](Node.md).[`locals`](Node.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`modifiers`](Node.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`HasJSDoc`](../type-aliases/HasJSDoc.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1907 + +#### Overrides + +[`Node`](Node.md).[`parent`](Node.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Node`](Node.md).[`pos`](Node.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Node`](Node.md).[`skipCheck`](Node.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Node`](Node.md).[`symbol`](Node.md#symbol) + +*** + +### tags? + +> `readonly` `optional` **tags**: [`NodeArray`](NodeArray.md)\<[`JSDocTag`](JSDocTag.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1908 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Node`](Node.md).[`forEachChild`](Node.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getChildAt`](Node.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getChildCount`](Node.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Node`](Node.md).[`getChildren`](Node.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getEnd`](Node.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getFirstToken`](Node.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullStart`](Node.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getFullText`](Node.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullWidth`](Node.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getLastToken`](Node.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getLeadingTriviaWidth`](Node.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Node`](Node.md).[`getSourceFile`](Node.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getStart`](Node.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getText`](Node.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getWidth`](Node.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/JSDocAllType.md b/docs/api_docs/namespaces/ts/interfaces/JSDocAllType.md new file mode 100644 index 0000000000000000000000000000000000000000..d962f4d15efd7bc4f491fa2f18de2a569b8b134c --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JSDocAllType.md @@ -0,0 +1,501 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JSDocAllType + +# Interface: JSDocAllType + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1873 + +## Extends + +- [`JSDocType`](JSDocType.md) + +## Properties + +### \_jsDocTypeBrand + +> **\_jsDocTypeBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1871 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`_jsDocTypeBrand`](JSDocType.md#_jsdoctypebrand) + +*** + +### \_typeNodeBrand + +> **\_typeNodeBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:912 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`_typeNodeBrand`](JSDocType.md#_typenodebrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`decorators`](JSDocType.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`end`](JSDocType.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`flags`](JSDocType.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`JSDocAllType`](../enumerations/SyntaxKind.md#jsdocalltype) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1874 + +#### Overrides + +[`JSDocType`](JSDocType.md).[`kind`](JSDocType.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`locals`](JSDocType.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`modifiers`](JSDocType.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`parent`](JSDocType.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`pos`](JSDocType.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`skipCheck`](JSDocType.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`symbol`](JSDocType.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`forEachChild`](JSDocType.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getChildAt`](JSDocType.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getChildCount`](JSDocType.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getChildren`](JSDocType.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getEnd`](JSDocType.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getFirstToken`](JSDocType.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getFullStart`](JSDocType.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getFullText`](JSDocType.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getFullWidth`](JSDocType.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getLastToken`](JSDocType.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getLeadingTriviaWidth`](JSDocType.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getSourceFile`](JSDocType.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getStart`](JSDocType.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getText`](JSDocType.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getWidth`](JSDocType.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/JSDocAugmentsTag.md b/docs/api_docs/namespaces/ts/interfaces/JSDocAugmentsTag.md new file mode 100644 index 0000000000000000000000000000000000000000..dd0a4b563235aae43011b76b3f2776dd737f06ba --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JSDocAugmentsTag.md @@ -0,0 +1,518 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JSDocAugmentsTag + +# Interface: JSDocAugmentsTag + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1943 + +Note that `@extends` is a synonym of `@augments`. +Both tags are represented by this interface. + +## Extends + +- [`JSDocTag`](JSDocTag.md) + +## Properties + +### class + +> `readonly` **class**: [`ExpressionWithTypeArguments`](ExpressionWithTypeArguments.md) & `object` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1945 + +#### Type declaration + +##### expression + +> `readonly` **expression**: [`Identifier`](Identifier.md) \| [`PropertyAccessEntityNameExpression`](PropertyAccessEntityNameExpression.md) + +*** + +### comment? + +> `readonly` `optional` **comment**: `string` \| [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1914 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`comment`](JSDocTag.md#comment) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`decorators`](JSDocTag.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`end`](JSDocTag.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`flags`](JSDocTag.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`JSDocAugmentsTag`](../enumerations/SyntaxKind.md#jsdocaugmentstag) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1944 + +#### Overrides + +[`JSDocTag`](JSDocTag.md).[`kind`](JSDocTag.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`locals`](JSDocTag.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`modifiers`](JSDocTag.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`JSDoc`](JSDoc.md) \| [`JSDocTypeLiteral`](JSDocTypeLiteral.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1912 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`parent`](JSDocTag.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`pos`](JSDocTag.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`skipCheck`](JSDocTag.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`symbol`](JSDocTag.md#symbol) + +*** + +### tagName + +> `readonly` **tagName**: [`Identifier`](Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1913 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`tagName`](JSDocTag.md#tagname) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`forEachChild`](JSDocTag.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getChildAt`](JSDocTag.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getChildCount`](JSDocTag.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getChildren`](JSDocTag.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getEnd`](JSDocTag.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFirstToken`](JSDocTag.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFullStart`](JSDocTag.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFullText`](JSDocTag.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFullWidth`](JSDocTag.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getLastToken`](JSDocTag.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getLeadingTriviaWidth`](JSDocTag.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getSourceFile`](JSDocTag.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getStart`](JSDocTag.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getText`](JSDocTag.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getWidth`](JSDocTag.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/JSDocAuthorTag.md b/docs/api_docs/namespaces/ts/interfaces/JSDocAuthorTag.md new file mode 100644 index 0000000000000000000000000000000000000000..9a5c326d260f14ca404d3ecf594a28e3a66009d9 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JSDocAuthorTag.md @@ -0,0 +1,501 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JSDocAuthorTag + +# Interface: JSDocAuthorTag + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1955 + +## Extends + +- [`JSDocTag`](JSDocTag.md) + +## Properties + +### comment? + +> `readonly` `optional` **comment**: `string` \| [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1914 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`comment`](JSDocTag.md#comment) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`decorators`](JSDocTag.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`end`](JSDocTag.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`flags`](JSDocTag.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`JSDocAuthorTag`](../enumerations/SyntaxKind.md#jsdocauthortag) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1956 + +#### Overrides + +[`JSDocTag`](JSDocTag.md).[`kind`](JSDocTag.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`locals`](JSDocTag.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`modifiers`](JSDocTag.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`JSDoc`](JSDoc.md) \| [`JSDocTypeLiteral`](JSDocTypeLiteral.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1912 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`parent`](JSDocTag.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`pos`](JSDocTag.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`skipCheck`](JSDocTag.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`symbol`](JSDocTag.md#symbol) + +*** + +### tagName + +> `readonly` **tagName**: [`Identifier`](Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1913 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`tagName`](JSDocTag.md#tagname) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`forEachChild`](JSDocTag.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getChildAt`](JSDocTag.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getChildCount`](JSDocTag.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getChildren`](JSDocTag.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getEnd`](JSDocTag.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFirstToken`](JSDocTag.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFullStart`](JSDocTag.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFullText`](JSDocTag.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFullWidth`](JSDocTag.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getLastToken`](JSDocTag.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getLeadingTriviaWidth`](JSDocTag.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getSourceFile`](JSDocTag.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getStart`](JSDocTag.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getText`](JSDocTag.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getWidth`](JSDocTag.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/JSDocCallbackTag.md b/docs/api_docs/namespaces/ts/interfaces/JSDocCallbackTag.md new file mode 100644 index 0000000000000000000000000000000000000000..97520bbb25eb4f2b62c3d524ea750e5a02fba4fd --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JSDocCallbackTag.md @@ -0,0 +1,541 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JSDocCallbackTag + +# Interface: JSDocCallbackTag + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2012 + +## Extends + +- [`JSDocTag`](JSDocTag.md).[`NamedDeclaration`](NamedDeclaration.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`_declarationBrand`](NamedDeclaration.md#_declarationbrand) + +*** + +### comment? + +> `readonly` `optional` **comment**: `string` \| [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1914 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`comment`](JSDocTag.md#comment) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`decorators`](NamedDeclaration.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`end`](NamedDeclaration.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`flags`](NamedDeclaration.md#flags) + +*** + +### fullName? + +> `readonly` `optional` **fullName**: [`Identifier`](Identifier.md) \| [`JSDocNamespaceDeclaration`](JSDocNamespaceDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2015 + +*** + +### kind + +> `readonly` **kind**: [`JSDocCallbackTag`](../enumerations/SyntaxKind.md#jsdoccallbacktag) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2013 + +#### Overrides + +[`NamedDeclaration`](NamedDeclaration.md).[`kind`](NamedDeclaration.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`locals`](NamedDeclaration.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`modifiers`](NamedDeclaration.md#modifiers) + +*** + +### name? + +> `readonly` `optional` **name**: [`Identifier`](Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2016 + +#### Overrides + +[`NamedDeclaration`](NamedDeclaration.md).[`name`](NamedDeclaration.md#name) + +*** + +### parent + +> `readonly` **parent**: [`JSDoc`](JSDoc.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2014 + +#### Overrides + +[`NamedDeclaration`](NamedDeclaration.md).[`parent`](NamedDeclaration.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`pos`](NamedDeclaration.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`skipCheck`](NamedDeclaration.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`symbol`](NamedDeclaration.md#symbol) + +*** + +### tagName + +> `readonly` **tagName**: [`Identifier`](Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1913 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`tagName`](JSDocTag.md#tagname) + +*** + +### typeExpression + +> `readonly` **typeExpression**: [`JSDocSignature`](JSDocSignature.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2017 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`forEachChild`](NamedDeclaration.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getChildAt`](NamedDeclaration.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getChildCount`](NamedDeclaration.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getChildren`](NamedDeclaration.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getEnd`](NamedDeclaration.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFirstToken`](NamedDeclaration.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFullStart`](NamedDeclaration.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFullText`](NamedDeclaration.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFullWidth`](NamedDeclaration.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getLastToken`](NamedDeclaration.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getLeadingTriviaWidth`](NamedDeclaration.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getSourceFile`](NamedDeclaration.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getStart`](NamedDeclaration.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getText`](NamedDeclaration.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getWidth`](NamedDeclaration.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/JSDocClassTag.md b/docs/api_docs/namespaces/ts/interfaces/JSDocClassTag.md new file mode 100644 index 0000000000000000000000000000000000000000..f9010a3cdb829b1189a0cb9f65aaf5cd80e83caf --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JSDocClassTag.md @@ -0,0 +1,501 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JSDocClassTag + +# Interface: JSDocClassTag + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1961 + +## Extends + +- [`JSDocTag`](JSDocTag.md) + +## Properties + +### comment? + +> `readonly` `optional` **comment**: `string` \| [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1914 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`comment`](JSDocTag.md#comment) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`decorators`](JSDocTag.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`end`](JSDocTag.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`flags`](JSDocTag.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`JSDocClassTag`](../enumerations/SyntaxKind.md#jsdocclasstag) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1962 + +#### Overrides + +[`JSDocTag`](JSDocTag.md).[`kind`](JSDocTag.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`locals`](JSDocTag.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`modifiers`](JSDocTag.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`JSDoc`](JSDoc.md) \| [`JSDocTypeLiteral`](JSDocTypeLiteral.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1912 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`parent`](JSDocTag.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`pos`](JSDocTag.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`skipCheck`](JSDocTag.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`symbol`](JSDocTag.md#symbol) + +*** + +### tagName + +> `readonly` **tagName**: [`Identifier`](Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1913 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`tagName`](JSDocTag.md#tagname) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`forEachChild`](JSDocTag.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getChildAt`](JSDocTag.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getChildCount`](JSDocTag.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getChildren`](JSDocTag.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getEnd`](JSDocTag.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFirstToken`](JSDocTag.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFullStart`](JSDocTag.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFullText`](JSDocTag.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFullWidth`](JSDocTag.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getLastToken`](JSDocTag.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getLeadingTriviaWidth`](JSDocTag.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getSourceFile`](JSDocTag.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getStart`](JSDocTag.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getText`](JSDocTag.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getWidth`](JSDocTag.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/JSDocContainer.md b/docs/api_docs/namespaces/ts/interfaces/JSDocContainer.md new file mode 100644 index 0000000000000000000000000000000000000000..2cb2025b648320207990b944290f7c89edde51b9 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JSDocContainer.md @@ -0,0 +1,42 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JSDocContainer + +# Interface: JSDocContainer + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:605 + +## Extended by + +- [`SignatureDeclarationBase`](SignatureDeclarationBase.md) +- [`VariableDeclaration`](VariableDeclaration.md) +- [`ParameterDeclaration`](ParameterDeclaration.md) +- [`PropertySignature`](PropertySignature.md) +- [`PropertyDeclaration`](PropertyDeclaration.md) +- [`PropertyAssignment`](PropertyAssignment.md) +- [`ShorthandPropertyAssignment`](ShorthandPropertyAssignment.md) +- [`SpreadAssignment`](SpreadAssignment.md) +- [`MethodDeclaration`](MethodDeclaration.md) +- [`ConstructorDeclaration`](ConstructorDeclaration.md) +- [`GetAccessorDeclaration`](GetAccessorDeclaration.md) +- [`SetAccessorDeclaration`](SetAccessorDeclaration.md) +- [`ClassStaticBlockDeclaration`](ClassStaticBlockDeclaration.md) +- [`NamedTupleMember`](NamedTupleMember.md) +- [`FunctionExpression`](FunctionExpression.md) +- [`ArrowFunction`](ArrowFunction.md) +- [`ParenthesizedExpression`](ParenthesizedExpression.md) +- [`Statement`](Statement.md) +- [`CaseClause`](CaseClause.md) +- [`ClassLikeDeclarationBase`](ClassLikeDeclarationBase.md) +- [`InterfaceDeclaration`](InterfaceDeclaration.md) +- [`TypeAliasDeclaration`](TypeAliasDeclaration.md) +- [`EnumMember`](EnumMember.md) +- [`EnumDeclaration`](EnumDeclaration.md) +- [`ModuleDeclaration`](ModuleDeclaration.md) +- [`ImportEqualsDeclaration`](ImportEqualsDeclaration.md) +- [`NamespaceExportDeclaration`](NamespaceExportDeclaration.md) +- [`ExportDeclaration`](ExportDeclaration.md) +- [`ExportSpecifier`](ExportSpecifier.md) +- [`ExportAssignment`](ExportAssignment.md) diff --git a/docs/api_docs/namespaces/ts/interfaces/JSDocDeprecatedTag.md b/docs/api_docs/namespaces/ts/interfaces/JSDocDeprecatedTag.md new file mode 100644 index 0000000000000000000000000000000000000000..dec8f25eeb3e9556f730a8126ffecd4e47754f55 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JSDocDeprecatedTag.md @@ -0,0 +1,501 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JSDocDeprecatedTag + +# Interface: JSDocDeprecatedTag + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1958 + +## Extends + +- [`JSDocTag`](JSDocTag.md) + +## Properties + +### comment? + +> `readonly` `optional` **comment**: `string` \| [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1914 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`comment`](JSDocTag.md#comment) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`decorators`](JSDocTag.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`end`](JSDocTag.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`flags`](JSDocTag.md#flags) + +*** + +### kind + +> **kind**: [`JSDocDeprecatedTag`](../enumerations/SyntaxKind.md#jsdocdeprecatedtag) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1959 + +#### Overrides + +[`JSDocTag`](JSDocTag.md).[`kind`](JSDocTag.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`locals`](JSDocTag.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`modifiers`](JSDocTag.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`JSDoc`](JSDoc.md) \| [`JSDocTypeLiteral`](JSDocTypeLiteral.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1912 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`parent`](JSDocTag.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`pos`](JSDocTag.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`skipCheck`](JSDocTag.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`symbol`](JSDocTag.md#symbol) + +*** + +### tagName + +> `readonly` **tagName**: [`Identifier`](Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1913 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`tagName`](JSDocTag.md#tagname) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`forEachChild`](JSDocTag.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getChildAt`](JSDocTag.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getChildCount`](JSDocTag.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getChildren`](JSDocTag.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getEnd`](JSDocTag.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFirstToken`](JSDocTag.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFullStart`](JSDocTag.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFullText`](JSDocTag.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFullWidth`](JSDocTag.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getLastToken`](JSDocTag.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getLeadingTriviaWidth`](JSDocTag.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getSourceFile`](JSDocTag.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getStart`](JSDocTag.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getText`](JSDocTag.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getWidth`](JSDocTag.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/JSDocEnumTag.md b/docs/api_docs/namespaces/ts/interfaces/JSDocEnumTag.md new file mode 100644 index 0000000000000000000000000000000000000000..b58e039cab34909884396f759947011876aee7ef --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JSDocEnumTag.md @@ -0,0 +1,521 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JSDocEnumTag + +# Interface: JSDocEnumTag + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1979 + +## Extends + +- [`JSDocTag`](JSDocTag.md).[`Declaration`](Declaration.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`Declaration`](Declaration.md).[`_declarationBrand`](Declaration.md#_declarationbrand) + +*** + +### comment? + +> `readonly` `optional` **comment**: `string` \| [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1914 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`comment`](JSDocTag.md#comment) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Declaration`](Declaration.md).[`decorators`](Declaration.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Declaration`](Declaration.md).[`end`](Declaration.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Declaration`](Declaration.md).[`flags`](Declaration.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`JSDocEnumTag`](../enumerations/SyntaxKind.md#jsdocenumtag) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1980 + +#### Overrides + +[`Declaration`](Declaration.md).[`kind`](Declaration.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Declaration`](Declaration.md).[`locals`](Declaration.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Declaration`](Declaration.md).[`modifiers`](Declaration.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`JSDoc`](JSDoc.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1981 + +#### Overrides + +[`Declaration`](Declaration.md).[`parent`](Declaration.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Declaration`](Declaration.md).[`pos`](Declaration.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Declaration`](Declaration.md).[`skipCheck`](Declaration.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Declaration`](Declaration.md).[`symbol`](Declaration.md#symbol) + +*** + +### tagName + +> `readonly` **tagName**: [`Identifier`](Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1913 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`tagName`](JSDocTag.md#tagname) + +*** + +### typeExpression + +> `readonly` **typeExpression**: [`JSDocTypeExpression`](JSDocTypeExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1982 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Declaration`](Declaration.md).[`forEachChild`](Declaration.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getChildAt`](Declaration.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getChildCount`](Declaration.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Declaration`](Declaration.md).[`getChildren`](Declaration.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getEnd`](Declaration.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFirstToken`](Declaration.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFullStart`](Declaration.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFullText`](Declaration.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFullWidth`](Declaration.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getLastToken`](Declaration.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getLeadingTriviaWidth`](Declaration.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getSourceFile`](Declaration.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getStart`](Declaration.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getText`](Declaration.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getWidth`](Declaration.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/JSDocFunctionType.md b/docs/api_docs/namespaces/ts/interfaces/JSDocFunctionType.md new file mode 100644 index 0000000000000000000000000000000000000000..b3f2c3395a94d76516db4bbca203321d1f92fb94 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JSDocFunctionType.md @@ -0,0 +1,561 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JSDocFunctionType + +# Interface: JSDocFunctionType + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1893 + +## Extends + +- [`JSDocType`](JSDocType.md).[`SignatureDeclarationBase`](SignatureDeclarationBase.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`_declarationBrand`](SignatureDeclarationBase.md#_declarationbrand) + +*** + +### \_jsDocTypeBrand + +> **\_jsDocTypeBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1871 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`_jsDocTypeBrand`](JSDocType.md#_jsdoctypebrand) + +*** + +### \_typeNodeBrand + +> **\_typeNodeBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:912 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`_typeNodeBrand`](JSDocType.md#_typenodebrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`decorators`](SignatureDeclarationBase.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`end`](SignatureDeclarationBase.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`flags`](SignatureDeclarationBase.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`JSDocFunctionType`](../enumerations/SyntaxKind.md#jsdocfunctiontype) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1894 + +#### Overrides + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`kind`](SignatureDeclarationBase.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`locals`](SignatureDeclarationBase.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`modifiers`](SignatureDeclarationBase.md#modifiers) + +*** + +### name? + +> `readonly` `optional` **name**: [`PropertyName`](../type-aliases/PropertyName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:733 + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`name`](SignatureDeclarationBase.md#name) + +*** + +### parameters + +> `readonly` **parameters**: [`NodeArray`](NodeArray.md)\<[`ParameterDeclaration`](ParameterDeclaration.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:735 + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`parameters`](SignatureDeclarationBase.md#parameters) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`parent`](SignatureDeclarationBase.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`pos`](SignatureDeclarationBase.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`skipCheck`](SignatureDeclarationBase.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`symbol`](SignatureDeclarationBase.md#symbol) + +*** + +### type? + +> `readonly` `optional` **type**: [`TypeNode`](TypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:736 + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`type`](SignatureDeclarationBase.md#type) + +*** + +### typeParameters? + +> `readonly` `optional` **typeParameters**: [`NodeArray`](NodeArray.md)\<[`TypeParameterDeclaration`](TypeParameterDeclaration.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:734 + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`typeParameters`](SignatureDeclarationBase.md#typeparameters) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`forEachChild`](SignatureDeclarationBase.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`getChildAt`](SignatureDeclarationBase.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`getChildCount`](SignatureDeclarationBase.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`getChildren`](SignatureDeclarationBase.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`getEnd`](SignatureDeclarationBase.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`getFirstToken`](SignatureDeclarationBase.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`getFullStart`](SignatureDeclarationBase.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`getFullText`](SignatureDeclarationBase.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`getFullWidth`](SignatureDeclarationBase.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`getLastToken`](SignatureDeclarationBase.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`getLeadingTriviaWidth`](SignatureDeclarationBase.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`getSourceFile`](SignatureDeclarationBase.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`getStart`](SignatureDeclarationBase.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`getText`](SignatureDeclarationBase.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`getWidth`](SignatureDeclarationBase.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/JSDocImplementsTag.md b/docs/api_docs/namespaces/ts/interfaces/JSDocImplementsTag.md new file mode 100644 index 0000000000000000000000000000000000000000..31d22bc2c278521c7a408f576afc16828deaa3fe --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JSDocImplementsTag.md @@ -0,0 +1,515 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JSDocImplementsTag + +# Interface: JSDocImplementsTag + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1949 + +## Extends + +- [`JSDocTag`](JSDocTag.md) + +## Properties + +### class + +> `readonly` **class**: [`ExpressionWithTypeArguments`](ExpressionWithTypeArguments.md) & `object` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1951 + +#### Type declaration + +##### expression + +> `readonly` **expression**: [`Identifier`](Identifier.md) \| [`PropertyAccessEntityNameExpression`](PropertyAccessEntityNameExpression.md) + +*** + +### comment? + +> `readonly` `optional` **comment**: `string` \| [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1914 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`comment`](JSDocTag.md#comment) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`decorators`](JSDocTag.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`end`](JSDocTag.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`flags`](JSDocTag.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`JSDocImplementsTag`](../enumerations/SyntaxKind.md#jsdocimplementstag) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1950 + +#### Overrides + +[`JSDocTag`](JSDocTag.md).[`kind`](JSDocTag.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`locals`](JSDocTag.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`modifiers`](JSDocTag.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`JSDoc`](JSDoc.md) \| [`JSDocTypeLiteral`](JSDocTypeLiteral.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1912 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`parent`](JSDocTag.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`pos`](JSDocTag.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`skipCheck`](JSDocTag.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`symbol`](JSDocTag.md#symbol) + +*** + +### tagName + +> `readonly` **tagName**: [`Identifier`](Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1913 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`tagName`](JSDocTag.md#tagname) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`forEachChild`](JSDocTag.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getChildAt`](JSDocTag.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getChildCount`](JSDocTag.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getChildren`](JSDocTag.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getEnd`](JSDocTag.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFirstToken`](JSDocTag.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFullStart`](JSDocTag.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFullText`](JSDocTag.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFullWidth`](JSDocTag.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getLastToken`](JSDocTag.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getLeadingTriviaWidth`](JSDocTag.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getSourceFile`](JSDocTag.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getStart`](JSDocTag.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getText`](JSDocTag.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getWidth`](JSDocTag.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/JSDocLink.md b/docs/api_docs/namespaces/ts/interfaces/JSDocLink.md new file mode 100644 index 0000000000000000000000000000000000000000..527134e936a2137921d4bc61e365105a43f95709 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JSDocLink.md @@ -0,0 +1,493 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JSDocLink + +# Interface: JSDocLink + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1916 + +## Extends + +- [`Node`](Node.md) + +## Properties + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`decorators`](Node.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Node`](Node.md).[`end`](Node.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Node`](Node.md).[`flags`](Node.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`JSDocLink`](../enumerations/SyntaxKind.md#jsdoclink) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1917 + +#### Overrides + +[`Node`](Node.md).[`kind`](Node.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Node`](Node.md).[`locals`](Node.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`modifiers`](Node.md#modifiers) + +*** + +### name? + +> `readonly` `optional` **name**: [`EntityName`](../type-aliases/EntityName.md) \| [`JSDocMemberName`](JSDocMemberName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1918 + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`Node`](Node.md).[`parent`](Node.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Node`](Node.md).[`pos`](Node.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Node`](Node.md).[`skipCheck`](Node.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Node`](Node.md).[`symbol`](Node.md#symbol) + +*** + +### text + +> **text**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1919 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Node`](Node.md).[`forEachChild`](Node.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getChildAt`](Node.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getChildCount`](Node.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Node`](Node.md).[`getChildren`](Node.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getEnd`](Node.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getFirstToken`](Node.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullStart`](Node.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getFullText`](Node.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullWidth`](Node.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getLastToken`](Node.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getLeadingTriviaWidth`](Node.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Node`](Node.md).[`getSourceFile`](Node.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getStart`](Node.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getText`](Node.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getWidth`](Node.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/JSDocLinkCode.md b/docs/api_docs/namespaces/ts/interfaces/JSDocLinkCode.md new file mode 100644 index 0000000000000000000000000000000000000000..dd73889ee638f122d98d477a44b2161df103cf67 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JSDocLinkCode.md @@ -0,0 +1,493 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JSDocLinkCode + +# Interface: JSDocLinkCode + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1921 + +## Extends + +- [`Node`](Node.md) + +## Properties + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`decorators`](Node.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Node`](Node.md).[`end`](Node.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Node`](Node.md).[`flags`](Node.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`JSDocLinkCode`](../enumerations/SyntaxKind.md#jsdoclinkcode) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1922 + +#### Overrides + +[`Node`](Node.md).[`kind`](Node.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Node`](Node.md).[`locals`](Node.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`modifiers`](Node.md#modifiers) + +*** + +### name? + +> `readonly` `optional` **name**: [`EntityName`](../type-aliases/EntityName.md) \| [`JSDocMemberName`](JSDocMemberName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1923 + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`Node`](Node.md).[`parent`](Node.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Node`](Node.md).[`pos`](Node.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Node`](Node.md).[`skipCheck`](Node.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Node`](Node.md).[`symbol`](Node.md#symbol) + +*** + +### text + +> **text**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1924 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Node`](Node.md).[`forEachChild`](Node.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getChildAt`](Node.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getChildCount`](Node.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Node`](Node.md).[`getChildren`](Node.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getEnd`](Node.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getFirstToken`](Node.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullStart`](Node.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getFullText`](Node.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullWidth`](Node.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getLastToken`](Node.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getLeadingTriviaWidth`](Node.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Node`](Node.md).[`getSourceFile`](Node.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getStart`](Node.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getText`](Node.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getWidth`](Node.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/JSDocLinkDisplayPart.md b/docs/api_docs/namespaces/ts/interfaces/JSDocLinkDisplayPart.md new file mode 100644 index 0000000000000000000000000000000000000000..0ade30e558db3d171c5dd19b4973dfd780f9282b --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JSDocLinkDisplayPart.md @@ -0,0 +1,45 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JSDocLinkDisplayPart + +# Interface: JSDocLinkDisplayPart + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6873 + +## Extends + +- [`SymbolDisplayPart`](SymbolDisplayPart.md) + +## Properties + +### kind + +> **kind**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2267 + +#### Inherited from + +[`SymbolDisplayPart`](SymbolDisplayPart.md).[`kind`](SymbolDisplayPart.md#kind) + +*** + +### target + +> **target**: [`DocumentSpan`](DocumentSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6874 + +*** + +### text + +> **text**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2266 + +#### Inherited from + +[`SymbolDisplayPart`](SymbolDisplayPart.md).[`text`](SymbolDisplayPart.md#text) diff --git a/docs/api_docs/namespaces/ts/interfaces/JSDocLinkPlain.md b/docs/api_docs/namespaces/ts/interfaces/JSDocLinkPlain.md new file mode 100644 index 0000000000000000000000000000000000000000..a4d72dd25069543730f10eb1135596c87bce116c --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JSDocLinkPlain.md @@ -0,0 +1,493 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JSDocLinkPlain + +# Interface: JSDocLinkPlain + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1926 + +## Extends + +- [`Node`](Node.md) + +## Properties + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`decorators`](Node.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Node`](Node.md).[`end`](Node.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Node`](Node.md).[`flags`](Node.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`JSDocLinkPlain`](../enumerations/SyntaxKind.md#jsdoclinkplain) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1927 + +#### Overrides + +[`Node`](Node.md).[`kind`](Node.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Node`](Node.md).[`locals`](Node.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`modifiers`](Node.md#modifiers) + +*** + +### name? + +> `readonly` `optional` **name**: [`EntityName`](../type-aliases/EntityName.md) \| [`JSDocMemberName`](JSDocMemberName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1928 + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`Node`](Node.md).[`parent`](Node.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Node`](Node.md).[`pos`](Node.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Node`](Node.md).[`skipCheck`](Node.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Node`](Node.md).[`symbol`](Node.md#symbol) + +*** + +### text + +> **text**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1929 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Node`](Node.md).[`forEachChild`](Node.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getChildAt`](Node.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getChildCount`](Node.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Node`](Node.md).[`getChildren`](Node.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getEnd`](Node.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getFirstToken`](Node.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullStart`](Node.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getFullText`](Node.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullWidth`](Node.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getLastToken`](Node.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getLeadingTriviaWidth`](Node.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Node`](Node.md).[`getSourceFile`](Node.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getStart`](Node.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getText`](Node.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getWidth`](Node.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/JSDocMemberName.md b/docs/api_docs/namespaces/ts/interfaces/JSDocMemberName.md new file mode 100644 index 0000000000000000000000000000000000000000..7c1306213f1b5253d284b50e24f90e1ad4150900 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JSDocMemberName.md @@ -0,0 +1,495 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JSDocMemberName + +# Interface: JSDocMemberName + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1865 + +Class#method reference in JSDoc + +## Extends + +- [`Node`](Node.md) + +## Properties + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`decorators`](Node.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Node`](Node.md).[`end`](Node.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Node`](Node.md).[`flags`](Node.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`JSDocMemberName`](../enumerations/SyntaxKind.md#jsdocmembername) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1866 + +#### Overrides + +[`Node`](Node.md).[`kind`](Node.md#kind) + +*** + +### left + +> `readonly` **left**: [`EntityName`](../type-aliases/EntityName.md) \| [`JSDocMemberName`](JSDocMemberName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1867 + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Node`](Node.md).[`locals`](Node.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`modifiers`](Node.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`Node`](Node.md).[`parent`](Node.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Node`](Node.md).[`pos`](Node.md#pos) + +*** + +### right + +> `readonly` **right**: [`Identifier`](Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1868 + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Node`](Node.md).[`skipCheck`](Node.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Node`](Node.md).[`symbol`](Node.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Node`](Node.md).[`forEachChild`](Node.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getChildAt`](Node.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getChildCount`](Node.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Node`](Node.md).[`getChildren`](Node.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getEnd`](Node.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getFirstToken`](Node.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullStart`](Node.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getFullText`](Node.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullWidth`](Node.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getLastToken`](Node.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getLeadingTriviaWidth`](Node.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Node`](Node.md).[`getSourceFile`](Node.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getStart`](Node.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getText`](Node.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getWidth`](Node.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/JSDocNameReference.md b/docs/api_docs/namespaces/ts/interfaces/JSDocNameReference.md new file mode 100644 index 0000000000000000000000000000000000000000..42b70059a2957bf1b05d66f8d4704db88c245611 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JSDocNameReference.md @@ -0,0 +1,485 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JSDocNameReference + +# Interface: JSDocNameReference + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1860 + +## Extends + +- [`Node`](Node.md) + +## Properties + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`decorators`](Node.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Node`](Node.md).[`end`](Node.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Node`](Node.md).[`flags`](Node.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`JSDocNameReference`](../enumerations/SyntaxKind.md#jsdocnamereference) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1861 + +#### Overrides + +[`Node`](Node.md).[`kind`](Node.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Node`](Node.md).[`locals`](Node.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`modifiers`](Node.md#modifiers) + +*** + +### name + +> `readonly` **name**: [`EntityName`](../type-aliases/EntityName.md) \| [`JSDocMemberName`](JSDocMemberName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1862 + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`Node`](Node.md).[`parent`](Node.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Node`](Node.md).[`pos`](Node.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Node`](Node.md).[`skipCheck`](Node.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Node`](Node.md).[`symbol`](Node.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Node`](Node.md).[`forEachChild`](Node.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getChildAt`](Node.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getChildCount`](Node.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Node`](Node.md).[`getChildren`](Node.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getEnd`](Node.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getFirstToken`](Node.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullStart`](Node.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getFullText`](Node.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullWidth`](Node.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getLastToken`](Node.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getLeadingTriviaWidth`](Node.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Node`](Node.md).[`getSourceFile`](Node.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getStart`](Node.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getText`](Node.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getWidth`](Node.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/JSDocNamepathType.md b/docs/api_docs/namespaces/ts/interfaces/JSDocNamepathType.md new file mode 100644 index 0000000000000000000000000000000000000000..6605526b58bbb8a44ebd779cbaa3a9c70dda21ed --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JSDocNamepathType.md @@ -0,0 +1,509 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JSDocNamepathType + +# Interface: JSDocNamepathType + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1900 + +## Extends + +- [`JSDocType`](JSDocType.md) + +## Properties + +### \_jsDocTypeBrand + +> **\_jsDocTypeBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1871 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`_jsDocTypeBrand`](JSDocType.md#_jsdoctypebrand) + +*** + +### \_typeNodeBrand + +> **\_typeNodeBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:912 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`_typeNodeBrand`](JSDocType.md#_typenodebrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`decorators`](JSDocType.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`end`](JSDocType.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`flags`](JSDocType.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`JSDocNamepathType`](../enumerations/SyntaxKind.md#jsdocnamepathtype) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1901 + +#### Overrides + +[`JSDocType`](JSDocType.md).[`kind`](JSDocType.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`locals`](JSDocType.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`modifiers`](JSDocType.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`parent`](JSDocType.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`pos`](JSDocType.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`skipCheck`](JSDocType.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`symbol`](JSDocType.md#symbol) + +*** + +### type + +> `readonly` **type**: [`TypeNode`](TypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1902 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`forEachChild`](JSDocType.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getChildAt`](JSDocType.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getChildCount`](JSDocType.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getChildren`](JSDocType.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getEnd`](JSDocType.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getFirstToken`](JSDocType.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getFullStart`](JSDocType.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getFullText`](JSDocType.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getFullWidth`](JSDocType.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getLastToken`](JSDocType.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getLeadingTriviaWidth`](JSDocType.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getSourceFile`](JSDocType.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getStart`](JSDocType.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getText`](JSDocType.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getWidth`](JSDocType.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/JSDocNamespaceDeclaration.md b/docs/api_docs/namespaces/ts/interfaces/JSDocNamespaceDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..b6abaaea2815b9f714dbe5dead7b94b8d70e92be --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JSDocNamespaceDeclaration.md @@ -0,0 +1,525 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JSDocNamespaceDeclaration + +# Interface: JSDocNamespaceDeclaration + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1689 + +## Extends + +- [`ModuleDeclaration`](ModuleDeclaration.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`ModuleDeclaration`](ModuleDeclaration.md).[`_declarationBrand`](ModuleDeclaration.md#_declarationbrand) + +*** + +### \_statementBrand + +> **\_statementBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1471 + +#### Inherited from + +[`ModuleDeclaration`](ModuleDeclaration.md).[`_statementBrand`](ModuleDeclaration.md#_statementbrand) + +*** + +### body? + +> `readonly` `optional` **body**: [`JSDocNamespaceBody`](../type-aliases/JSDocNamespaceBody.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1691 + +#### Overrides + +[`ModuleDeclaration`](ModuleDeclaration.md).[`body`](ModuleDeclaration.md#body) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`ModuleDeclaration`](ModuleDeclaration.md).[`decorators`](ModuleDeclaration.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`ModuleDeclaration`](ModuleDeclaration.md).[`end`](ModuleDeclaration.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`ModuleDeclaration`](ModuleDeclaration.md).[`flags`](ModuleDeclaration.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`ModuleDeclaration`](../enumerations/SyntaxKind.md#moduledeclaration) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1677 + +#### Inherited from + +[`ModuleDeclaration`](ModuleDeclaration.md).[`kind`](ModuleDeclaration.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`ModuleDeclaration`](ModuleDeclaration.md).[`locals`](ModuleDeclaration.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`Modifier`](../type-aliases/Modifier.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1679 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`ModuleDeclaration`](ModuleDeclaration.md).[`modifiers`](ModuleDeclaration.md#modifiers) + +*** + +### name + +> `readonly` **name**: [`Identifier`](Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1690 + +#### Overrides + +[`ModuleDeclaration`](ModuleDeclaration.md).[`name`](ModuleDeclaration.md#name) + +*** + +### parent + +> `readonly` **parent**: [`SourceFile`](SourceFile.md) \| [`ModuleBody`](../type-aliases/ModuleBody.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1678 + +#### Inherited from + +[`ModuleDeclaration`](ModuleDeclaration.md).[`parent`](ModuleDeclaration.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`ModuleDeclaration`](ModuleDeclaration.md).[`pos`](ModuleDeclaration.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`ModuleDeclaration`](ModuleDeclaration.md).[`skipCheck`](ModuleDeclaration.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`ModuleDeclaration`](ModuleDeclaration.md).[`symbol`](ModuleDeclaration.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`ModuleDeclaration`](ModuleDeclaration.md).[`forEachChild`](ModuleDeclaration.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`ModuleDeclaration`](ModuleDeclaration.md).[`getChildAt`](ModuleDeclaration.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`ModuleDeclaration`](ModuleDeclaration.md).[`getChildCount`](ModuleDeclaration.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`ModuleDeclaration`](ModuleDeclaration.md).[`getChildren`](ModuleDeclaration.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`ModuleDeclaration`](ModuleDeclaration.md).[`getEnd`](ModuleDeclaration.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`ModuleDeclaration`](ModuleDeclaration.md).[`getFirstToken`](ModuleDeclaration.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`ModuleDeclaration`](ModuleDeclaration.md).[`getFullStart`](ModuleDeclaration.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`ModuleDeclaration`](ModuleDeclaration.md).[`getFullText`](ModuleDeclaration.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`ModuleDeclaration`](ModuleDeclaration.md).[`getFullWidth`](ModuleDeclaration.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`ModuleDeclaration`](ModuleDeclaration.md).[`getLastToken`](ModuleDeclaration.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`ModuleDeclaration`](ModuleDeclaration.md).[`getLeadingTriviaWidth`](ModuleDeclaration.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`ModuleDeclaration`](ModuleDeclaration.md).[`getSourceFile`](ModuleDeclaration.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`ModuleDeclaration`](ModuleDeclaration.md).[`getStart`](ModuleDeclaration.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`ModuleDeclaration`](ModuleDeclaration.md).[`getText`](ModuleDeclaration.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`ModuleDeclaration`](ModuleDeclaration.md).[`getWidth`](ModuleDeclaration.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/JSDocNonNullableType.md b/docs/api_docs/namespaces/ts/interfaces/JSDocNonNullableType.md new file mode 100644 index 0000000000000000000000000000000000000000..08d9feb6f38d7494a4783716d5950a8c959ac738 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JSDocNonNullableType.md @@ -0,0 +1,517 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JSDocNonNullableType + +# Interface: JSDocNonNullableType + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1879 + +## Extends + +- [`JSDocType`](JSDocType.md) + +## Properties + +### \_jsDocTypeBrand + +> **\_jsDocTypeBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1871 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`_jsDocTypeBrand`](JSDocType.md#_jsdoctypebrand) + +*** + +### \_typeNodeBrand + +> **\_typeNodeBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:912 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`_typeNodeBrand`](JSDocType.md#_typenodebrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`decorators`](JSDocType.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`end`](JSDocType.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`flags`](JSDocType.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`JSDocNonNullableType`](../enumerations/SyntaxKind.md#jsdocnonnullabletype) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1880 + +#### Overrides + +[`JSDocType`](JSDocType.md).[`kind`](JSDocType.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`locals`](JSDocType.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`modifiers`](JSDocType.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`parent`](JSDocType.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`pos`](JSDocType.md#pos) + +*** + +### postfix + +> `readonly` **postfix**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1882 + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`skipCheck`](JSDocType.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`symbol`](JSDocType.md#symbol) + +*** + +### type + +> `readonly` **type**: [`TypeNode`](TypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1881 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`forEachChild`](JSDocType.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getChildAt`](JSDocType.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getChildCount`](JSDocType.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getChildren`](JSDocType.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getEnd`](JSDocType.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getFirstToken`](JSDocType.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getFullStart`](JSDocType.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getFullText`](JSDocType.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getFullWidth`](JSDocType.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getLastToken`](JSDocType.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getLeadingTriviaWidth`](JSDocType.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getSourceFile`](JSDocType.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getStart`](JSDocType.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getText`](JSDocType.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getWidth`](JSDocType.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/JSDocNullableType.md b/docs/api_docs/namespaces/ts/interfaces/JSDocNullableType.md new file mode 100644 index 0000000000000000000000000000000000000000..f446dfaf894c464cf744cb2f98e320ec5f2075fc --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JSDocNullableType.md @@ -0,0 +1,517 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JSDocNullableType + +# Interface: JSDocNullableType + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1884 + +## Extends + +- [`JSDocType`](JSDocType.md) + +## Properties + +### \_jsDocTypeBrand + +> **\_jsDocTypeBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1871 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`_jsDocTypeBrand`](JSDocType.md#_jsdoctypebrand) + +*** + +### \_typeNodeBrand + +> **\_typeNodeBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:912 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`_typeNodeBrand`](JSDocType.md#_typenodebrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`decorators`](JSDocType.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`end`](JSDocType.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`flags`](JSDocType.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`JSDocNullableType`](../enumerations/SyntaxKind.md#jsdocnullabletype) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1885 + +#### Overrides + +[`JSDocType`](JSDocType.md).[`kind`](JSDocType.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`locals`](JSDocType.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`modifiers`](JSDocType.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`parent`](JSDocType.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`pos`](JSDocType.md#pos) + +*** + +### postfix + +> `readonly` **postfix**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1887 + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`skipCheck`](JSDocType.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`symbol`](JSDocType.md#symbol) + +*** + +### type + +> `readonly` **type**: [`TypeNode`](TypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1886 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`forEachChild`](JSDocType.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getChildAt`](JSDocType.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getChildCount`](JSDocType.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getChildren`](JSDocType.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getEnd`](JSDocType.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getFirstToken`](JSDocType.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getFullStart`](JSDocType.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getFullText`](JSDocType.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getFullWidth`](JSDocType.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getLastToken`](JSDocType.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getLeadingTriviaWidth`](JSDocType.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getSourceFile`](JSDocType.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getStart`](JSDocType.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getText`](JSDocType.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getWidth`](JSDocType.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/JSDocOptionalType.md b/docs/api_docs/namespaces/ts/interfaces/JSDocOptionalType.md new file mode 100644 index 0000000000000000000000000000000000000000..17da92894df08d80470582e95c7f716c7ff69fb2 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JSDocOptionalType.md @@ -0,0 +1,509 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JSDocOptionalType + +# Interface: JSDocOptionalType + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1889 + +## Extends + +- [`JSDocType`](JSDocType.md) + +## Properties + +### \_jsDocTypeBrand + +> **\_jsDocTypeBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1871 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`_jsDocTypeBrand`](JSDocType.md#_jsdoctypebrand) + +*** + +### \_typeNodeBrand + +> **\_typeNodeBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:912 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`_typeNodeBrand`](JSDocType.md#_typenodebrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`decorators`](JSDocType.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`end`](JSDocType.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`flags`](JSDocType.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`JSDocOptionalType`](../enumerations/SyntaxKind.md#jsdocoptionaltype) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1890 + +#### Overrides + +[`JSDocType`](JSDocType.md).[`kind`](JSDocType.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`locals`](JSDocType.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`modifiers`](JSDocType.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`parent`](JSDocType.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`pos`](JSDocType.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`skipCheck`](JSDocType.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`symbol`](JSDocType.md#symbol) + +*** + +### type + +> `readonly` **type**: [`TypeNode`](TypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1891 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`forEachChild`](JSDocType.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getChildAt`](JSDocType.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getChildCount`](JSDocType.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getChildren`](JSDocType.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getEnd`](JSDocType.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getFirstToken`](JSDocType.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getFullStart`](JSDocType.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getFullText`](JSDocType.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getFullWidth`](JSDocType.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getLastToken`](JSDocType.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getLeadingTriviaWidth`](JSDocType.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getSourceFile`](JSDocType.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getStart`](JSDocType.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getText`](JSDocType.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getWidth`](JSDocType.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/JSDocOverrideTag.md b/docs/api_docs/namespaces/ts/interfaces/JSDocOverrideTag.md new file mode 100644 index 0000000000000000000000000000000000000000..4ef758f3e53456d8e7c1afe696da78f83e139d45 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JSDocOverrideTag.md @@ -0,0 +1,501 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JSDocOverrideTag + +# Interface: JSDocOverrideTag + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1976 + +## Extends + +- [`JSDocTag`](JSDocTag.md) + +## Properties + +### comment? + +> `readonly` `optional` **comment**: `string` \| [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1914 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`comment`](JSDocTag.md#comment) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`decorators`](JSDocTag.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`end`](JSDocTag.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`flags`](JSDocTag.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`JSDocOverrideTag`](../enumerations/SyntaxKind.md#jsdocoverridetag) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1977 + +#### Overrides + +[`JSDocTag`](JSDocTag.md).[`kind`](JSDocTag.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`locals`](JSDocTag.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`modifiers`](JSDocTag.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`JSDoc`](JSDoc.md) \| [`JSDocTypeLiteral`](JSDocTypeLiteral.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1912 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`parent`](JSDocTag.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`pos`](JSDocTag.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`skipCheck`](JSDocTag.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`symbol`](JSDocTag.md#symbol) + +*** + +### tagName + +> `readonly` **tagName**: [`Identifier`](Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1913 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`tagName`](JSDocTag.md#tagname) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`forEachChild`](JSDocTag.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getChildAt`](JSDocTag.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getChildCount`](JSDocTag.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getChildren`](JSDocTag.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getEnd`](JSDocTag.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFirstToken`](JSDocTag.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFullStart`](JSDocTag.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFullText`](JSDocTag.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFullWidth`](JSDocTag.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getLastToken`](JSDocTag.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getLeadingTriviaWidth`](JSDocTag.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getSourceFile`](JSDocTag.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getStart`](JSDocTag.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getText`](JSDocTag.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getWidth`](JSDocTag.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/JSDocParameterTag.md b/docs/api_docs/namespaces/ts/interfaces/JSDocParameterTag.md new file mode 100644 index 0000000000000000000000000000000000000000..17dc62eedc203bfe512a80598b01cc0d227485e8 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JSDocParameterTag.md @@ -0,0 +1,563 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JSDocParameterTag + +# Interface: JSDocParameterTag + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2036 + +## Extends + +- [`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`_declarationBrand`](JSDocPropertyLikeTag.md#_declarationbrand) + +*** + +### comment? + +> `readonly` `optional` **comment**: `string` \| [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1914 + +#### Inherited from + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`comment`](JSDocPropertyLikeTag.md#comment) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`decorators`](JSDocPropertyLikeTag.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`end`](JSDocPropertyLikeTag.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`flags`](JSDocPropertyLikeTag.md#flags) + +*** + +### isBracketed + +> `readonly` **isBracketed**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2031 + +#### Inherited from + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`isBracketed`](JSDocPropertyLikeTag.md#isbracketed) + +*** + +### isNameFirst + +> `readonly` **isNameFirst**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2030 + +Whether the property name came before the type -- non-standard for JSDoc, but Typescript-like + +#### Inherited from + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`isNameFirst`](JSDocPropertyLikeTag.md#isnamefirst) + +*** + +### kind + +> `readonly` **kind**: [`JSDocParameterTag`](../enumerations/SyntaxKind.md#jsdocparametertag) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2037 + +#### Overrides + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`kind`](JSDocPropertyLikeTag.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`locals`](JSDocPropertyLikeTag.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`modifiers`](JSDocPropertyLikeTag.md#modifiers) + +*** + +### name + +> `readonly` **name**: [`EntityName`](../type-aliases/EntityName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2027 + +#### Inherited from + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`name`](JSDocPropertyLikeTag.md#name) + +*** + +### parent + +> `readonly` **parent**: [`JSDoc`](JSDoc.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2026 + +#### Inherited from + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`parent`](JSDocPropertyLikeTag.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`pos`](JSDocPropertyLikeTag.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`skipCheck`](JSDocPropertyLikeTag.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`symbol`](JSDocPropertyLikeTag.md#symbol) + +*** + +### tagName + +> `readonly` **tagName**: [`Identifier`](Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1913 + +#### Inherited from + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`tagName`](JSDocPropertyLikeTag.md#tagname) + +*** + +### typeExpression? + +> `readonly` `optional` **typeExpression**: [`JSDocTypeExpression`](JSDocTypeExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2028 + +#### Inherited from + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`typeExpression`](JSDocPropertyLikeTag.md#typeexpression) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`forEachChild`](JSDocPropertyLikeTag.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`getChildAt`](JSDocPropertyLikeTag.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`getChildCount`](JSDocPropertyLikeTag.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`getChildren`](JSDocPropertyLikeTag.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`getEnd`](JSDocPropertyLikeTag.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`getFirstToken`](JSDocPropertyLikeTag.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`getFullStart`](JSDocPropertyLikeTag.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`getFullText`](JSDocPropertyLikeTag.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`getFullWidth`](JSDocPropertyLikeTag.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`getLastToken`](JSDocPropertyLikeTag.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`getLeadingTriviaWidth`](JSDocPropertyLikeTag.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`getSourceFile`](JSDocPropertyLikeTag.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`getStart`](JSDocPropertyLikeTag.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`getText`](JSDocPropertyLikeTag.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`getWidth`](JSDocPropertyLikeTag.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/JSDocPrivateTag.md b/docs/api_docs/namespaces/ts/interfaces/JSDocPrivateTag.md new file mode 100644 index 0000000000000000000000000000000000000000..7483972338dcce0d679e146e2da7c6dfb423860b --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JSDocPrivateTag.md @@ -0,0 +1,501 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JSDocPrivateTag + +# Interface: JSDocPrivateTag + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1967 + +## Extends + +- [`JSDocTag`](JSDocTag.md) + +## Properties + +### comment? + +> `readonly` `optional` **comment**: `string` \| [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1914 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`comment`](JSDocTag.md#comment) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`decorators`](JSDocTag.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`end`](JSDocTag.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`flags`](JSDocTag.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`JSDocPrivateTag`](../enumerations/SyntaxKind.md#jsdocprivatetag) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1968 + +#### Overrides + +[`JSDocTag`](JSDocTag.md).[`kind`](JSDocTag.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`locals`](JSDocTag.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`modifiers`](JSDocTag.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`JSDoc`](JSDoc.md) \| [`JSDocTypeLiteral`](JSDocTypeLiteral.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1912 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`parent`](JSDocTag.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`pos`](JSDocTag.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`skipCheck`](JSDocTag.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`symbol`](JSDocTag.md#symbol) + +*** + +### tagName + +> `readonly` **tagName**: [`Identifier`](Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1913 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`tagName`](JSDocTag.md#tagname) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`forEachChild`](JSDocTag.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getChildAt`](JSDocTag.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getChildCount`](JSDocTag.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getChildren`](JSDocTag.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getEnd`](JSDocTag.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFirstToken`](JSDocTag.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFullStart`](JSDocTag.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFullText`](JSDocTag.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFullWidth`](JSDocTag.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getLastToken`](JSDocTag.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getLeadingTriviaWidth`](JSDocTag.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getSourceFile`](JSDocTag.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getStart`](JSDocTag.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getText`](JSDocTag.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getWidth`](JSDocTag.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/JSDocPropertyLikeTag.md b/docs/api_docs/namespaces/ts/interfaces/JSDocPropertyLikeTag.md new file mode 100644 index 0000000000000000000000000000000000000000..5d21cdb70308dc9de4a6815ffe465880503f44fc --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JSDocPropertyLikeTag.md @@ -0,0 +1,552 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JSDocPropertyLikeTag + +# Interface: JSDocPropertyLikeTag + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2025 + +## Extends + +- [`JSDocTag`](JSDocTag.md).[`Declaration`](Declaration.md) + +## Extended by + +- [`JSDocPropertyTag`](JSDocPropertyTag.md) +- [`JSDocParameterTag`](JSDocParameterTag.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`Declaration`](Declaration.md).[`_declarationBrand`](Declaration.md#_declarationbrand) + +*** + +### comment? + +> `readonly` `optional` **comment**: `string` \| [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1914 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`comment`](JSDocTag.md#comment) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Declaration`](Declaration.md).[`decorators`](Declaration.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Declaration`](Declaration.md).[`end`](Declaration.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Declaration`](Declaration.md).[`flags`](Declaration.md#flags) + +*** + +### isBracketed + +> `readonly` **isBracketed**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2031 + +*** + +### isNameFirst + +> `readonly` **isNameFirst**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2030 + +Whether the property name came before the type -- non-standard for JSDoc, but Typescript-like + +*** + +### kind + +> `readonly` **kind**: [`SyntaxKind`](../enumerations/SyntaxKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:598 + +#### Inherited from + +[`Declaration`](Declaration.md).[`kind`](Declaration.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Declaration`](Declaration.md).[`locals`](Declaration.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Declaration`](Declaration.md).[`modifiers`](Declaration.md#modifiers) + +*** + +### name + +> `readonly` **name**: [`EntityName`](../type-aliases/EntityName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2027 + +*** + +### parent + +> `readonly` **parent**: [`JSDoc`](JSDoc.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2026 + +#### Overrides + +[`Declaration`](Declaration.md).[`parent`](Declaration.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Declaration`](Declaration.md).[`pos`](Declaration.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Declaration`](Declaration.md).[`skipCheck`](Declaration.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Declaration`](Declaration.md).[`symbol`](Declaration.md#symbol) + +*** + +### tagName + +> `readonly` **tagName**: [`Identifier`](Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1913 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`tagName`](JSDocTag.md#tagname) + +*** + +### typeExpression? + +> `readonly` `optional` **typeExpression**: [`JSDocTypeExpression`](JSDocTypeExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2028 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Declaration`](Declaration.md).[`forEachChild`](Declaration.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getChildAt`](Declaration.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getChildCount`](Declaration.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Declaration`](Declaration.md).[`getChildren`](Declaration.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getEnd`](Declaration.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFirstToken`](Declaration.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFullStart`](Declaration.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFullText`](Declaration.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFullWidth`](Declaration.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getLastToken`](Declaration.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getLeadingTriviaWidth`](Declaration.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getSourceFile`](Declaration.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getStart`](Declaration.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getText`](Declaration.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getWidth`](Declaration.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/JSDocPropertyTag.md b/docs/api_docs/namespaces/ts/interfaces/JSDocPropertyTag.md new file mode 100644 index 0000000000000000000000000000000000000000..5bb72c9ba710bd04948443a2a140e5bbd2d2329d --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JSDocPropertyTag.md @@ -0,0 +1,563 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JSDocPropertyTag + +# Interface: JSDocPropertyTag + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2033 + +## Extends + +- [`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`_declarationBrand`](JSDocPropertyLikeTag.md#_declarationbrand) + +*** + +### comment? + +> `readonly` `optional` **comment**: `string` \| [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1914 + +#### Inherited from + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`comment`](JSDocPropertyLikeTag.md#comment) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`decorators`](JSDocPropertyLikeTag.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`end`](JSDocPropertyLikeTag.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`flags`](JSDocPropertyLikeTag.md#flags) + +*** + +### isBracketed + +> `readonly` **isBracketed**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2031 + +#### Inherited from + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`isBracketed`](JSDocPropertyLikeTag.md#isbracketed) + +*** + +### isNameFirst + +> `readonly` **isNameFirst**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2030 + +Whether the property name came before the type -- non-standard for JSDoc, but Typescript-like + +#### Inherited from + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`isNameFirst`](JSDocPropertyLikeTag.md#isnamefirst) + +*** + +### kind + +> `readonly` **kind**: [`JSDocPropertyTag`](../enumerations/SyntaxKind.md#jsdocpropertytag) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2034 + +#### Overrides + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`kind`](JSDocPropertyLikeTag.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`locals`](JSDocPropertyLikeTag.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`modifiers`](JSDocPropertyLikeTag.md#modifiers) + +*** + +### name + +> `readonly` **name**: [`EntityName`](../type-aliases/EntityName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2027 + +#### Inherited from + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`name`](JSDocPropertyLikeTag.md#name) + +*** + +### parent + +> `readonly` **parent**: [`JSDoc`](JSDoc.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2026 + +#### Inherited from + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`parent`](JSDocPropertyLikeTag.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`pos`](JSDocPropertyLikeTag.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`skipCheck`](JSDocPropertyLikeTag.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`symbol`](JSDocPropertyLikeTag.md#symbol) + +*** + +### tagName + +> `readonly` **tagName**: [`Identifier`](Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1913 + +#### Inherited from + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`tagName`](JSDocPropertyLikeTag.md#tagname) + +*** + +### typeExpression? + +> `readonly` `optional` **typeExpression**: [`JSDocTypeExpression`](JSDocTypeExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2028 + +#### Inherited from + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`typeExpression`](JSDocPropertyLikeTag.md#typeexpression) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`forEachChild`](JSDocPropertyLikeTag.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`getChildAt`](JSDocPropertyLikeTag.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`getChildCount`](JSDocPropertyLikeTag.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`getChildren`](JSDocPropertyLikeTag.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`getEnd`](JSDocPropertyLikeTag.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`getFirstToken`](JSDocPropertyLikeTag.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`getFullStart`](JSDocPropertyLikeTag.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`getFullText`](JSDocPropertyLikeTag.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`getFullWidth`](JSDocPropertyLikeTag.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`getLastToken`](JSDocPropertyLikeTag.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`getLeadingTriviaWidth`](JSDocPropertyLikeTag.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`getSourceFile`](JSDocPropertyLikeTag.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`getStart`](JSDocPropertyLikeTag.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`getText`](JSDocPropertyLikeTag.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md).[`getWidth`](JSDocPropertyLikeTag.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/JSDocProtectedTag.md b/docs/api_docs/namespaces/ts/interfaces/JSDocProtectedTag.md new file mode 100644 index 0000000000000000000000000000000000000000..af30852c6cfbbd3981c32fdd812a8f276e53c707 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JSDocProtectedTag.md @@ -0,0 +1,501 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JSDocProtectedTag + +# Interface: JSDocProtectedTag + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1970 + +## Extends + +- [`JSDocTag`](JSDocTag.md) + +## Properties + +### comment? + +> `readonly` `optional` **comment**: `string` \| [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1914 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`comment`](JSDocTag.md#comment) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`decorators`](JSDocTag.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`end`](JSDocTag.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`flags`](JSDocTag.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`JSDocProtectedTag`](../enumerations/SyntaxKind.md#jsdocprotectedtag) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1971 + +#### Overrides + +[`JSDocTag`](JSDocTag.md).[`kind`](JSDocTag.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`locals`](JSDocTag.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`modifiers`](JSDocTag.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`JSDoc`](JSDoc.md) \| [`JSDocTypeLiteral`](JSDocTypeLiteral.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1912 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`parent`](JSDocTag.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`pos`](JSDocTag.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`skipCheck`](JSDocTag.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`symbol`](JSDocTag.md#symbol) + +*** + +### tagName + +> `readonly` **tagName**: [`Identifier`](Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1913 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`tagName`](JSDocTag.md#tagname) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`forEachChild`](JSDocTag.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getChildAt`](JSDocTag.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getChildCount`](JSDocTag.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getChildren`](JSDocTag.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getEnd`](JSDocTag.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFirstToken`](JSDocTag.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFullStart`](JSDocTag.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFullText`](JSDocTag.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFullWidth`](JSDocTag.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getLastToken`](JSDocTag.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getLeadingTriviaWidth`](JSDocTag.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getSourceFile`](JSDocTag.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getStart`](JSDocTag.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getText`](JSDocTag.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getWidth`](JSDocTag.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/JSDocPublicTag.md b/docs/api_docs/namespaces/ts/interfaces/JSDocPublicTag.md new file mode 100644 index 0000000000000000000000000000000000000000..5f3480d197f2bbd4a6774f5d5d5d847635b8d01f --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JSDocPublicTag.md @@ -0,0 +1,501 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JSDocPublicTag + +# Interface: JSDocPublicTag + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1964 + +## Extends + +- [`JSDocTag`](JSDocTag.md) + +## Properties + +### comment? + +> `readonly` `optional` **comment**: `string` \| [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1914 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`comment`](JSDocTag.md#comment) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`decorators`](JSDocTag.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`end`](JSDocTag.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`flags`](JSDocTag.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`JSDocPublicTag`](../enumerations/SyntaxKind.md#jsdocpublictag) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1965 + +#### Overrides + +[`JSDocTag`](JSDocTag.md).[`kind`](JSDocTag.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`locals`](JSDocTag.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`modifiers`](JSDocTag.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`JSDoc`](JSDoc.md) \| [`JSDocTypeLiteral`](JSDocTypeLiteral.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1912 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`parent`](JSDocTag.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`pos`](JSDocTag.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`skipCheck`](JSDocTag.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`symbol`](JSDocTag.md#symbol) + +*** + +### tagName + +> `readonly` **tagName**: [`Identifier`](Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1913 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`tagName`](JSDocTag.md#tagname) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`forEachChild`](JSDocTag.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getChildAt`](JSDocTag.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getChildCount`](JSDocTag.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getChildren`](JSDocTag.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getEnd`](JSDocTag.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFirstToken`](JSDocTag.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFullStart`](JSDocTag.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFullText`](JSDocTag.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFullWidth`](JSDocTag.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getLastToken`](JSDocTag.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getLeadingTriviaWidth`](JSDocTag.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getSourceFile`](JSDocTag.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getStart`](JSDocTag.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getText`](JSDocTag.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getWidth`](JSDocTag.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/JSDocReadonlyTag.md b/docs/api_docs/namespaces/ts/interfaces/JSDocReadonlyTag.md new file mode 100644 index 0000000000000000000000000000000000000000..94bc5091984ccd56fcee9faaa937d725f82b24cb --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JSDocReadonlyTag.md @@ -0,0 +1,501 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JSDocReadonlyTag + +# Interface: JSDocReadonlyTag + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1973 + +## Extends + +- [`JSDocTag`](JSDocTag.md) + +## Properties + +### comment? + +> `readonly` `optional` **comment**: `string` \| [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1914 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`comment`](JSDocTag.md#comment) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`decorators`](JSDocTag.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`end`](JSDocTag.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`flags`](JSDocTag.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`JSDocReadonlyTag`](../enumerations/SyntaxKind.md#jsdocreadonlytag) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1974 + +#### Overrides + +[`JSDocTag`](JSDocTag.md).[`kind`](JSDocTag.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`locals`](JSDocTag.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`modifiers`](JSDocTag.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`JSDoc`](JSDoc.md) \| [`JSDocTypeLiteral`](JSDocTypeLiteral.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1912 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`parent`](JSDocTag.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`pos`](JSDocTag.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`skipCheck`](JSDocTag.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`symbol`](JSDocTag.md#symbol) + +*** + +### tagName + +> `readonly` **tagName**: [`Identifier`](Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1913 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`tagName`](JSDocTag.md#tagname) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`forEachChild`](JSDocTag.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getChildAt`](JSDocTag.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getChildCount`](JSDocTag.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getChildren`](JSDocTag.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getEnd`](JSDocTag.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFirstToken`](JSDocTag.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFullStart`](JSDocTag.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFullText`](JSDocTag.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFullWidth`](JSDocTag.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getLastToken`](JSDocTag.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getLeadingTriviaWidth`](JSDocTag.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getSourceFile`](JSDocTag.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getStart`](JSDocTag.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getText`](JSDocTag.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getWidth`](JSDocTag.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/JSDocReturnTag.md b/docs/api_docs/namespaces/ts/interfaces/JSDocReturnTag.md new file mode 100644 index 0000000000000000000000000000000000000000..c7517973e75a7a9cd9e918ffa4b0a69aa2772308 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JSDocReturnTag.md @@ -0,0 +1,509 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JSDocReturnTag + +# Interface: JSDocReturnTag + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1997 + +## Extends + +- [`JSDocTag`](JSDocTag.md) + +## Properties + +### comment? + +> `readonly` `optional` **comment**: `string` \| [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1914 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`comment`](JSDocTag.md#comment) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`decorators`](JSDocTag.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`end`](JSDocTag.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`flags`](JSDocTag.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`JSDocReturnTag`](../enumerations/SyntaxKind.md#jsdocreturntag) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1998 + +#### Overrides + +[`JSDocTag`](JSDocTag.md).[`kind`](JSDocTag.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`locals`](JSDocTag.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`modifiers`](JSDocTag.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`JSDoc`](JSDoc.md) \| [`JSDocTypeLiteral`](JSDocTypeLiteral.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1912 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`parent`](JSDocTag.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`pos`](JSDocTag.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`skipCheck`](JSDocTag.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`symbol`](JSDocTag.md#symbol) + +*** + +### tagName + +> `readonly` **tagName**: [`Identifier`](Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1913 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`tagName`](JSDocTag.md#tagname) + +*** + +### typeExpression? + +> `readonly` `optional` **typeExpression**: [`JSDocTypeExpression`](JSDocTypeExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1999 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`forEachChild`](JSDocTag.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getChildAt`](JSDocTag.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getChildCount`](JSDocTag.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getChildren`](JSDocTag.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getEnd`](JSDocTag.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFirstToken`](JSDocTag.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFullStart`](JSDocTag.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFullText`](JSDocTag.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFullWidth`](JSDocTag.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getLastToken`](JSDocTag.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getLeadingTriviaWidth`](JSDocTag.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getSourceFile`](JSDocTag.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getStart`](JSDocTag.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getText`](JSDocTag.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getWidth`](JSDocTag.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/JSDocSeeTag.md b/docs/api_docs/namespaces/ts/interfaces/JSDocSeeTag.md new file mode 100644 index 0000000000000000000000000000000000000000..c7fad5fe3ac9e39e9bd7668940b0ee3a73788619 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JSDocSeeTag.md @@ -0,0 +1,509 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JSDocSeeTag + +# Interface: JSDocSeeTag + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1993 + +## Extends + +- [`JSDocTag`](JSDocTag.md) + +## Properties + +### comment? + +> `readonly` `optional` **comment**: `string` \| [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1914 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`comment`](JSDocTag.md#comment) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`decorators`](JSDocTag.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`end`](JSDocTag.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`flags`](JSDocTag.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`JSDocSeeTag`](../enumerations/SyntaxKind.md#jsdocseetag) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1994 + +#### Overrides + +[`JSDocTag`](JSDocTag.md).[`kind`](JSDocTag.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`locals`](JSDocTag.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`modifiers`](JSDocTag.md#modifiers) + +*** + +### name? + +> `readonly` `optional` **name**: [`JSDocNameReference`](JSDocNameReference.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1995 + +*** + +### parent + +> `readonly` **parent**: [`JSDoc`](JSDoc.md) \| [`JSDocTypeLiteral`](JSDocTypeLiteral.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1912 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`parent`](JSDocTag.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`pos`](JSDocTag.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`skipCheck`](JSDocTag.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`symbol`](JSDocTag.md#symbol) + +*** + +### tagName + +> `readonly` **tagName**: [`Identifier`](Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1913 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`tagName`](JSDocTag.md#tagname) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`forEachChild`](JSDocTag.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getChildAt`](JSDocTag.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getChildCount`](JSDocTag.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getChildren`](JSDocTag.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getEnd`](JSDocTag.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFirstToken`](JSDocTag.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFullStart`](JSDocTag.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFullText`](JSDocTag.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFullWidth`](JSDocTag.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getLastToken`](JSDocTag.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getLeadingTriviaWidth`](JSDocTag.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getSourceFile`](JSDocTag.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getStart`](JSDocTag.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getText`](JSDocTag.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getWidth`](JSDocTag.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/JSDocSignature.md b/docs/api_docs/namespaces/ts/interfaces/JSDocSignature.md new file mode 100644 index 0000000000000000000000000000000000000000..4124a8a0e8bce91690e45723512f779d33cdcd74 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JSDocSignature.md @@ -0,0 +1,537 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JSDocSignature + +# Interface: JSDocSignature + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2019 + +## Extends + +- [`JSDocType`](JSDocType.md).[`Declaration`](Declaration.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`Declaration`](Declaration.md).[`_declarationBrand`](Declaration.md#_declarationbrand) + +*** + +### \_jsDocTypeBrand + +> **\_jsDocTypeBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1871 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`_jsDocTypeBrand`](JSDocType.md#_jsdoctypebrand) + +*** + +### \_typeNodeBrand + +> **\_typeNodeBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:912 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`_typeNodeBrand`](JSDocType.md#_typenodebrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Declaration`](Declaration.md).[`decorators`](Declaration.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Declaration`](Declaration.md).[`end`](Declaration.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Declaration`](Declaration.md).[`flags`](Declaration.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`JSDocSignature`](../enumerations/SyntaxKind.md#jsdocsignature) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2020 + +#### Overrides + +[`Declaration`](Declaration.md).[`kind`](Declaration.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Declaration`](Declaration.md).[`locals`](Declaration.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Declaration`](Declaration.md).[`modifiers`](Declaration.md#modifiers) + +*** + +### parameters + +> `readonly` **parameters**: readonly [`JSDocParameterTag`](JSDocParameterTag.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2022 + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`Declaration`](Declaration.md).[`parent`](Declaration.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Declaration`](Declaration.md).[`pos`](Declaration.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Declaration`](Declaration.md).[`skipCheck`](Declaration.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Declaration`](Declaration.md).[`symbol`](Declaration.md#symbol) + +*** + +### type + +> `readonly` **type**: `undefined` \| [`JSDocReturnTag`](JSDocReturnTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2023 + +*** + +### typeParameters? + +> `readonly` `optional` **typeParameters**: readonly [`JSDocTemplateTag`](JSDocTemplateTag.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2021 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Declaration`](Declaration.md).[`forEachChild`](Declaration.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getChildAt`](Declaration.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getChildCount`](Declaration.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Declaration`](Declaration.md).[`getChildren`](Declaration.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getEnd`](Declaration.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFirstToken`](Declaration.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFullStart`](Declaration.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFullText`](Declaration.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFullWidth`](Declaration.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getLastToken`](Declaration.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getLeadingTriviaWidth`](Declaration.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getSourceFile`](Declaration.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getStart`](Declaration.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getText`](Declaration.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getWidth`](Declaration.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/JSDocTag.md b/docs/api_docs/namespaces/ts/interfaces/JSDocTag.md new file mode 100644 index 0000000000000000000000000000000000000000..c7bb5044c299388a8ca4cb36c54c637cabd85bce --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JSDocTag.md @@ -0,0 +1,516 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JSDocTag + +# Interface: JSDocTag + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1911 + +## Extends + +- [`Node`](Node.md) + +## Extended by + +- [`JSDocUnknownTag`](JSDocUnknownTag.md) +- [`JSDocAugmentsTag`](JSDocAugmentsTag.md) +- [`JSDocImplementsTag`](JSDocImplementsTag.md) +- [`JSDocAuthorTag`](JSDocAuthorTag.md) +- [`JSDocDeprecatedTag`](JSDocDeprecatedTag.md) +- [`JSDocClassTag`](JSDocClassTag.md) +- [`JSDocPublicTag`](JSDocPublicTag.md) +- [`JSDocPrivateTag`](JSDocPrivateTag.md) +- [`JSDocProtectedTag`](JSDocProtectedTag.md) +- [`JSDocReadonlyTag`](JSDocReadonlyTag.md) +- [`JSDocOverrideTag`](JSDocOverrideTag.md) +- [`JSDocEnumTag`](JSDocEnumTag.md) +- [`JSDocThisTag`](JSDocThisTag.md) +- [`JSDocTemplateTag`](JSDocTemplateTag.md) +- [`JSDocSeeTag`](JSDocSeeTag.md) +- [`JSDocReturnTag`](JSDocReturnTag.md) +- [`JSDocTypeTag`](JSDocTypeTag.md) +- [`JSDocTypedefTag`](JSDocTypedefTag.md) +- [`JSDocCallbackTag`](JSDocCallbackTag.md) +- [`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md) + +## Properties + +### comment? + +> `readonly` `optional` **comment**: `string` \| [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1914 + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`decorators`](Node.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Node`](Node.md).[`end`](Node.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Node`](Node.md).[`flags`](Node.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`SyntaxKind`](../enumerations/SyntaxKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:598 + +#### Inherited from + +[`Node`](Node.md).[`kind`](Node.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Node`](Node.md).[`locals`](Node.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`modifiers`](Node.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`JSDoc`](JSDoc.md) \| [`JSDocTypeLiteral`](JSDocTypeLiteral.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1912 + +#### Overrides + +[`Node`](Node.md).[`parent`](Node.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Node`](Node.md).[`pos`](Node.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Node`](Node.md).[`skipCheck`](Node.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Node`](Node.md).[`symbol`](Node.md#symbol) + +*** + +### tagName + +> `readonly` **tagName**: [`Identifier`](Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1913 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Node`](Node.md).[`forEachChild`](Node.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getChildAt`](Node.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getChildCount`](Node.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Node`](Node.md).[`getChildren`](Node.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getEnd`](Node.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getFirstToken`](Node.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullStart`](Node.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getFullText`](Node.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullWidth`](Node.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getLastToken`](Node.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getLeadingTriviaWidth`](Node.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Node`](Node.md).[`getSourceFile`](Node.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getStart`](Node.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getText`](Node.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getWidth`](Node.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/JSDocTagInfo-1.md b/docs/api_docs/namespaces/ts/interfaces/JSDocTagInfo-1.md new file mode 100644 index 0000000000000000000000000000000000000000..fd90af659b1b101eaf477a4da31cc41c89daa6ef --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JSDocTagInfo-1.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JSDocTagInfo + +# Interface: JSDocTagInfo + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6876 + +## Properties + +### index? + +> `optional` **index**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6879 + +*** + +### name + +> **name**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6877 + +*** + +### text? + +> `optional` **text**: `string` \| [`SymbolDisplayPart`](SymbolDisplayPart.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6878 diff --git a/docs/api_docs/namespaces/ts/interfaces/JSDocTemplateTag.md b/docs/api_docs/namespaces/ts/interfaces/JSDocTemplateTag.md new file mode 100644 index 0000000000000000000000000000000000000000..14db8dcaeea028b66364ae29f60a4da0e2b466c6 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JSDocTemplateTag.md @@ -0,0 +1,517 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JSDocTemplateTag + +# Interface: JSDocTemplateTag + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1988 + +## Extends + +- [`JSDocTag`](JSDocTag.md) + +## Properties + +### comment? + +> `readonly` `optional` **comment**: `string` \| [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1914 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`comment`](JSDocTag.md#comment) + +*** + +### constraint + +> `readonly` **constraint**: `undefined` \| [`JSDocTypeExpression`](JSDocTypeExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1990 + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`decorators`](JSDocTag.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`end`](JSDocTag.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`flags`](JSDocTag.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`JSDocTemplateTag`](../enumerations/SyntaxKind.md#jsdoctemplatetag) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1989 + +#### Overrides + +[`JSDocTag`](JSDocTag.md).[`kind`](JSDocTag.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`locals`](JSDocTag.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`modifiers`](JSDocTag.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`JSDoc`](JSDoc.md) \| [`JSDocTypeLiteral`](JSDocTypeLiteral.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1912 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`parent`](JSDocTag.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`pos`](JSDocTag.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`skipCheck`](JSDocTag.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`symbol`](JSDocTag.md#symbol) + +*** + +### tagName + +> `readonly` **tagName**: [`Identifier`](Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1913 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`tagName`](JSDocTag.md#tagname) + +*** + +### typeParameters + +> `readonly` **typeParameters**: [`NodeArray`](NodeArray.md)\<[`TypeParameterDeclaration`](TypeParameterDeclaration.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1991 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`forEachChild`](JSDocTag.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getChildAt`](JSDocTag.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getChildCount`](JSDocTag.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getChildren`](JSDocTag.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getEnd`](JSDocTag.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFirstToken`](JSDocTag.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFullStart`](JSDocTag.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFullText`](JSDocTag.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFullWidth`](JSDocTag.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getLastToken`](JSDocTag.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getLeadingTriviaWidth`](JSDocTag.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getSourceFile`](JSDocTag.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getStart`](JSDocTag.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getText`](JSDocTag.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getWidth`](JSDocTag.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/JSDocText.md b/docs/api_docs/namespaces/ts/interfaces/JSDocText.md new file mode 100644 index 0000000000000000000000000000000000000000..b1303e97242bdf9cd0a264ef090ea1cb1f24f847 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JSDocText.md @@ -0,0 +1,485 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JSDocText + +# Interface: JSDocText + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1932 + +## Extends + +- [`Node`](Node.md) + +## Properties + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`decorators`](Node.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Node`](Node.md).[`end`](Node.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Node`](Node.md).[`flags`](Node.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`JSDocText`](../enumerations/SyntaxKind.md#jsdoctext) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1933 + +#### Overrides + +[`Node`](Node.md).[`kind`](Node.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Node`](Node.md).[`locals`](Node.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`modifiers`](Node.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`Node`](Node.md).[`parent`](Node.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Node`](Node.md).[`pos`](Node.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Node`](Node.md).[`skipCheck`](Node.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Node`](Node.md).[`symbol`](Node.md#symbol) + +*** + +### text + +> **text**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1934 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Node`](Node.md).[`forEachChild`](Node.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getChildAt`](Node.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getChildCount`](Node.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Node`](Node.md).[`getChildren`](Node.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getEnd`](Node.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getFirstToken`](Node.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullStart`](Node.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getFullText`](Node.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullWidth`](Node.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getLastToken`](Node.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getLeadingTriviaWidth`](Node.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Node`](Node.md).[`getSourceFile`](Node.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getStart`](Node.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getText`](Node.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getWidth`](Node.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/JSDocThisTag.md b/docs/api_docs/namespaces/ts/interfaces/JSDocThisTag.md new file mode 100644 index 0000000000000000000000000000000000000000..88ba25e02ddcd201a3a4f578145ac016872ed443 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JSDocThisTag.md @@ -0,0 +1,509 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JSDocThisTag + +# Interface: JSDocThisTag + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1984 + +## Extends + +- [`JSDocTag`](JSDocTag.md) + +## Properties + +### comment? + +> `readonly` `optional` **comment**: `string` \| [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1914 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`comment`](JSDocTag.md#comment) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`decorators`](JSDocTag.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`end`](JSDocTag.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`flags`](JSDocTag.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`JSDocThisTag`](../enumerations/SyntaxKind.md#jsdocthistag) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1985 + +#### Overrides + +[`JSDocTag`](JSDocTag.md).[`kind`](JSDocTag.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`locals`](JSDocTag.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`modifiers`](JSDocTag.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`JSDoc`](JSDoc.md) \| [`JSDocTypeLiteral`](JSDocTypeLiteral.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1912 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`parent`](JSDocTag.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`pos`](JSDocTag.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`skipCheck`](JSDocTag.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`symbol`](JSDocTag.md#symbol) + +*** + +### tagName + +> `readonly` **tagName**: [`Identifier`](Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1913 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`tagName`](JSDocTag.md#tagname) + +*** + +### typeExpression + +> `readonly` **typeExpression**: [`JSDocTypeExpression`](JSDocTypeExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1986 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`forEachChild`](JSDocTag.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getChildAt`](JSDocTag.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getChildCount`](JSDocTag.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getChildren`](JSDocTag.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getEnd`](JSDocTag.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFirstToken`](JSDocTag.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFullStart`](JSDocTag.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFullText`](JSDocTag.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFullWidth`](JSDocTag.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getLastToken`](JSDocTag.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getLeadingTriviaWidth`](JSDocTag.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getSourceFile`](JSDocTag.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getStart`](JSDocTag.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getText`](JSDocTag.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getWidth`](JSDocTag.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/JSDocType.md b/docs/api_docs/namespaces/ts/interfaces/JSDocType.md new file mode 100644 index 0000000000000000000000000000000000000000..79bec9a47cb4d6522057d6922bc74daef6d02019 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JSDocType.md @@ -0,0 +1,510 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JSDocType + +# Interface: JSDocType + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1870 + +## Extends + +- [`TypeNode`](TypeNode.md) + +## Extended by + +- [`JSDocAllType`](JSDocAllType.md) +- [`JSDocUnknownType`](JSDocUnknownType.md) +- [`JSDocNonNullableType`](JSDocNonNullableType.md) +- [`JSDocNullableType`](JSDocNullableType.md) +- [`JSDocOptionalType`](JSDocOptionalType.md) +- [`JSDocFunctionType`](JSDocFunctionType.md) +- [`JSDocVariadicType`](JSDocVariadicType.md) +- [`JSDocNamepathType`](JSDocNamepathType.md) +- [`JSDocSignature`](JSDocSignature.md) +- [`JSDocTypeLiteral`](JSDocTypeLiteral.md) + +## Properties + +### \_jsDocTypeBrand + +> **\_jsDocTypeBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1871 + +*** + +### \_typeNodeBrand + +> **\_typeNodeBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:912 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`_typeNodeBrand`](TypeNode.md#_typenodebrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`decorators`](TypeNode.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`end`](TypeNode.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`flags`](TypeNode.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`SyntaxKind`](../enumerations/SyntaxKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:598 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`kind`](TypeNode.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`locals`](TypeNode.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`modifiers`](TypeNode.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`parent`](TypeNode.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`pos`](TypeNode.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`skipCheck`](TypeNode.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`symbol`](TypeNode.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`forEachChild`](TypeNode.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getChildAt`](TypeNode.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getChildCount`](TypeNode.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getChildren`](TypeNode.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getEnd`](TypeNode.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFirstToken`](TypeNode.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFullStart`](TypeNode.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFullText`](TypeNode.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFullWidth`](TypeNode.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getLastToken`](TypeNode.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getLeadingTriviaWidth`](TypeNode.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getSourceFile`](TypeNode.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getStart`](TypeNode.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getText`](TypeNode.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getWidth`](TypeNode.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/JSDocTypeExpression.md b/docs/api_docs/namespaces/ts/interfaces/JSDocTypeExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..4255a4eedbdcffff2597b18a539bb73fe5c52564 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JSDocTypeExpression.md @@ -0,0 +1,497 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JSDocTypeExpression + +# Interface: JSDocTypeExpression + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1856 + +## Extends + +- [`TypeNode`](TypeNode.md) + +## Properties + +### \_typeNodeBrand + +> **\_typeNodeBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:912 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`_typeNodeBrand`](TypeNode.md#_typenodebrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`decorators`](TypeNode.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`end`](TypeNode.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`flags`](TypeNode.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`JSDocTypeExpression`](../enumerations/SyntaxKind.md#jsdoctypeexpression) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1857 + +#### Overrides + +[`TypeNode`](TypeNode.md).[`kind`](TypeNode.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`locals`](TypeNode.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`modifiers`](TypeNode.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`parent`](TypeNode.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`pos`](TypeNode.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`skipCheck`](TypeNode.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`symbol`](TypeNode.md#symbol) + +*** + +### type + +> `readonly` **type**: [`TypeNode`](TypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1858 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`forEachChild`](TypeNode.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getChildAt`](TypeNode.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getChildCount`](TypeNode.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getChildren`](TypeNode.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getEnd`](TypeNode.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFirstToken`](TypeNode.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFullStart`](TypeNode.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFullText`](TypeNode.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFullWidth`](TypeNode.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getLastToken`](TypeNode.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getLeadingTriviaWidth`](TypeNode.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getSourceFile`](TypeNode.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getStart`](TypeNode.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getText`](TypeNode.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getWidth`](TypeNode.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/JSDocTypeLiteral.md b/docs/api_docs/namespaces/ts/interfaces/JSDocTypeLiteral.md new file mode 100644 index 0000000000000000000000000000000000000000..1ad259974d3366337f145a9b483c45d86ca43227 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JSDocTypeLiteral.md @@ -0,0 +1,519 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JSDocTypeLiteral + +# Interface: JSDocTypeLiteral + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2039 + +## Extends + +- [`JSDocType`](JSDocType.md) + +## Properties + +### \_jsDocTypeBrand + +> **\_jsDocTypeBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1871 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`_jsDocTypeBrand`](JSDocType.md#_jsdoctypebrand) + +*** + +### \_typeNodeBrand + +> **\_typeNodeBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:912 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`_typeNodeBrand`](JSDocType.md#_typenodebrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`decorators`](JSDocType.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`end`](JSDocType.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`flags`](JSDocType.md#flags) + +*** + +### isArrayType + +> `readonly` **isArrayType**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2043 + +If true, then this type literal represents an *array* of its type. + +*** + +### jsDocPropertyTags? + +> `readonly` `optional` **jsDocPropertyTags**: readonly [`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2041 + +*** + +### kind + +> `readonly` **kind**: [`JSDocTypeLiteral`](../enumerations/SyntaxKind.md#jsdoctypeliteral) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2040 + +#### Overrides + +[`JSDocType`](JSDocType.md).[`kind`](JSDocType.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`locals`](JSDocType.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`modifiers`](JSDocType.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`parent`](JSDocType.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`pos`](JSDocType.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`skipCheck`](JSDocType.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`symbol`](JSDocType.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`forEachChild`](JSDocType.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getChildAt`](JSDocType.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getChildCount`](JSDocType.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getChildren`](JSDocType.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getEnd`](JSDocType.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getFirstToken`](JSDocType.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getFullStart`](JSDocType.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getFullText`](JSDocType.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getFullWidth`](JSDocType.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getLastToken`](JSDocType.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getLeadingTriviaWidth`](JSDocType.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getSourceFile`](JSDocType.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getStart`](JSDocType.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getText`](JSDocType.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getWidth`](JSDocType.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/JSDocTypeTag.md b/docs/api_docs/namespaces/ts/interfaces/JSDocTypeTag.md new file mode 100644 index 0000000000000000000000000000000000000000..ca0269339810aed5e90512c9f80f479d0acdd2ab --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JSDocTypeTag.md @@ -0,0 +1,509 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JSDocTypeTag + +# Interface: JSDocTypeTag + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2001 + +## Extends + +- [`JSDocTag`](JSDocTag.md) + +## Properties + +### comment? + +> `readonly` `optional` **comment**: `string` \| [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1914 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`comment`](JSDocTag.md#comment) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`decorators`](JSDocTag.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`end`](JSDocTag.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`flags`](JSDocTag.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`JSDocTypeTag`](../enumerations/SyntaxKind.md#jsdoctypetag) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2002 + +#### Overrides + +[`JSDocTag`](JSDocTag.md).[`kind`](JSDocTag.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`locals`](JSDocTag.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`modifiers`](JSDocTag.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`JSDoc`](JSDoc.md) \| [`JSDocTypeLiteral`](JSDocTypeLiteral.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1912 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`parent`](JSDocTag.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`pos`](JSDocTag.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`skipCheck`](JSDocTag.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`symbol`](JSDocTag.md#symbol) + +*** + +### tagName + +> `readonly` **tagName**: [`Identifier`](Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1913 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`tagName`](JSDocTag.md#tagname) + +*** + +### typeExpression + +> `readonly` **typeExpression**: [`JSDocTypeExpression`](JSDocTypeExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2003 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`forEachChild`](JSDocTag.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getChildAt`](JSDocTag.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getChildCount`](JSDocTag.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getChildren`](JSDocTag.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getEnd`](JSDocTag.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFirstToken`](JSDocTag.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFullStart`](JSDocTag.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFullText`](JSDocTag.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFullWidth`](JSDocTag.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getLastToken`](JSDocTag.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getLeadingTriviaWidth`](JSDocTag.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getSourceFile`](JSDocTag.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getStart`](JSDocTag.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getText`](JSDocTag.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getWidth`](JSDocTag.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/JSDocTypedefTag.md b/docs/api_docs/namespaces/ts/interfaces/JSDocTypedefTag.md new file mode 100644 index 0000000000000000000000000000000000000000..f8a77a14b602703333a289017e4b9ef6b5be95bf --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JSDocTypedefTag.md @@ -0,0 +1,541 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JSDocTypedefTag + +# Interface: JSDocTypedefTag + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2005 + +## Extends + +- [`JSDocTag`](JSDocTag.md).[`NamedDeclaration`](NamedDeclaration.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`_declarationBrand`](NamedDeclaration.md#_declarationbrand) + +*** + +### comment? + +> `readonly` `optional` **comment**: `string` \| [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1914 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`comment`](JSDocTag.md#comment) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`decorators`](NamedDeclaration.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`end`](NamedDeclaration.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`flags`](NamedDeclaration.md#flags) + +*** + +### fullName? + +> `readonly` `optional` **fullName**: [`Identifier`](Identifier.md) \| [`JSDocNamespaceDeclaration`](JSDocNamespaceDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2008 + +*** + +### kind + +> `readonly` **kind**: [`JSDocTypedefTag`](../enumerations/SyntaxKind.md#jsdoctypedeftag) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2006 + +#### Overrides + +[`NamedDeclaration`](NamedDeclaration.md).[`kind`](NamedDeclaration.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`locals`](NamedDeclaration.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`modifiers`](NamedDeclaration.md#modifiers) + +*** + +### name? + +> `readonly` `optional` **name**: [`Identifier`](Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2009 + +#### Overrides + +[`NamedDeclaration`](NamedDeclaration.md).[`name`](NamedDeclaration.md#name) + +*** + +### parent + +> `readonly` **parent**: [`JSDoc`](JSDoc.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2007 + +#### Overrides + +[`NamedDeclaration`](NamedDeclaration.md).[`parent`](NamedDeclaration.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`pos`](NamedDeclaration.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`skipCheck`](NamedDeclaration.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`symbol`](NamedDeclaration.md#symbol) + +*** + +### tagName + +> `readonly` **tagName**: [`Identifier`](Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1913 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`tagName`](JSDocTag.md#tagname) + +*** + +### typeExpression? + +> `readonly` `optional` **typeExpression**: [`JSDocTypeLiteral`](JSDocTypeLiteral.md) \| [`JSDocTypeExpression`](JSDocTypeExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2010 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`forEachChild`](NamedDeclaration.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getChildAt`](NamedDeclaration.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getChildCount`](NamedDeclaration.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getChildren`](NamedDeclaration.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getEnd`](NamedDeclaration.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFirstToken`](NamedDeclaration.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFullStart`](NamedDeclaration.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFullText`](NamedDeclaration.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFullWidth`](NamedDeclaration.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getLastToken`](NamedDeclaration.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getLeadingTriviaWidth`](NamedDeclaration.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getSourceFile`](NamedDeclaration.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getStart`](NamedDeclaration.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getText`](NamedDeclaration.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getWidth`](NamedDeclaration.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/JSDocUnknownTag.md b/docs/api_docs/namespaces/ts/interfaces/JSDocUnknownTag.md new file mode 100644 index 0000000000000000000000000000000000000000..9ec0c11f0946649cb89152892cbd6fc452a7d6b6 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JSDocUnknownTag.md @@ -0,0 +1,501 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JSDocUnknownTag + +# Interface: JSDocUnknownTag + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1936 + +## Extends + +- [`JSDocTag`](JSDocTag.md) + +## Properties + +### comment? + +> `readonly` `optional` **comment**: `string` \| [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1914 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`comment`](JSDocTag.md#comment) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`decorators`](JSDocTag.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`end`](JSDocTag.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`flags`](JSDocTag.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`JSDocTag`](../enumerations/SyntaxKind.md#jsdoctag) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1937 + +#### Overrides + +[`JSDocTag`](JSDocTag.md).[`kind`](JSDocTag.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`locals`](JSDocTag.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`modifiers`](JSDocTag.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`JSDoc`](JSDoc.md) \| [`JSDocTypeLiteral`](JSDocTypeLiteral.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1912 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`parent`](JSDocTag.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`pos`](JSDocTag.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`skipCheck`](JSDocTag.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`symbol`](JSDocTag.md#symbol) + +*** + +### tagName + +> `readonly` **tagName**: [`Identifier`](Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1913 + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`tagName`](JSDocTag.md#tagname) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`forEachChild`](JSDocTag.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getChildAt`](JSDocTag.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getChildCount`](JSDocTag.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getChildren`](JSDocTag.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getEnd`](JSDocTag.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFirstToken`](JSDocTag.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFullStart`](JSDocTag.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFullText`](JSDocTag.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getFullWidth`](JSDocTag.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getLastToken`](JSDocTag.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getLeadingTriviaWidth`](JSDocTag.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getSourceFile`](JSDocTag.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getStart`](JSDocTag.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getText`](JSDocTag.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocTag`](JSDocTag.md).[`getWidth`](JSDocTag.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/JSDocUnknownType.md b/docs/api_docs/namespaces/ts/interfaces/JSDocUnknownType.md new file mode 100644 index 0000000000000000000000000000000000000000..9d0b922082645d4d23e6f77873dbf0e60c0d7d31 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JSDocUnknownType.md @@ -0,0 +1,501 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JSDocUnknownType + +# Interface: JSDocUnknownType + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1876 + +## Extends + +- [`JSDocType`](JSDocType.md) + +## Properties + +### \_jsDocTypeBrand + +> **\_jsDocTypeBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1871 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`_jsDocTypeBrand`](JSDocType.md#_jsdoctypebrand) + +*** + +### \_typeNodeBrand + +> **\_typeNodeBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:912 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`_typeNodeBrand`](JSDocType.md#_typenodebrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`decorators`](JSDocType.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`end`](JSDocType.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`flags`](JSDocType.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`JSDocUnknownType`](../enumerations/SyntaxKind.md#jsdocunknowntype) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1877 + +#### Overrides + +[`JSDocType`](JSDocType.md).[`kind`](JSDocType.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`locals`](JSDocType.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`modifiers`](JSDocType.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`parent`](JSDocType.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`pos`](JSDocType.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`skipCheck`](JSDocType.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`symbol`](JSDocType.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`forEachChild`](JSDocType.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getChildAt`](JSDocType.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getChildCount`](JSDocType.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getChildren`](JSDocType.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getEnd`](JSDocType.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getFirstToken`](JSDocType.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getFullStart`](JSDocType.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getFullText`](JSDocType.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getFullWidth`](JSDocType.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getLastToken`](JSDocType.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getLeadingTriviaWidth`](JSDocType.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getSourceFile`](JSDocType.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getStart`](JSDocType.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getText`](JSDocType.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getWidth`](JSDocType.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/JSDocVariadicType.md b/docs/api_docs/namespaces/ts/interfaces/JSDocVariadicType.md new file mode 100644 index 0000000000000000000000000000000000000000..8a14505bbb6e0d698430dec884a6f45da72bcfe0 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JSDocVariadicType.md @@ -0,0 +1,509 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JSDocVariadicType + +# Interface: JSDocVariadicType + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1896 + +## Extends + +- [`JSDocType`](JSDocType.md) + +## Properties + +### \_jsDocTypeBrand + +> **\_jsDocTypeBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1871 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`_jsDocTypeBrand`](JSDocType.md#_jsdoctypebrand) + +*** + +### \_typeNodeBrand + +> **\_typeNodeBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:912 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`_typeNodeBrand`](JSDocType.md#_typenodebrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`decorators`](JSDocType.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`end`](JSDocType.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`flags`](JSDocType.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`JSDocVariadicType`](../enumerations/SyntaxKind.md#jsdocvariadictype) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1897 + +#### Overrides + +[`JSDocType`](JSDocType.md).[`kind`](JSDocType.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`locals`](JSDocType.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`modifiers`](JSDocType.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`parent`](JSDocType.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`pos`](JSDocType.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`skipCheck`](JSDocType.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`symbol`](JSDocType.md#symbol) + +*** + +### type + +> `readonly` **type**: [`TypeNode`](TypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1898 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`forEachChild`](JSDocType.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getChildAt`](JSDocType.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getChildCount`](JSDocType.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getChildren`](JSDocType.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getEnd`](JSDocType.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getFirstToken`](JSDocType.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getFullStart`](JSDocType.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getFullText`](JSDocType.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getFullWidth`](JSDocType.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getLastToken`](JSDocType.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getLeadingTriviaWidth`](JSDocType.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getSourceFile`](JSDocType.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getStart`](JSDocType.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getText`](JSDocType.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`JSDocType`](JSDocType.md).[`getWidth`](JSDocType.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/JsDocNodeCheckConfig.md b/docs/api_docs/namespaces/ts/interfaces/JsDocNodeCheckConfig.md new file mode 100644 index 0000000000000000000000000000000000000000..76790bcdb3c87942db1d2521d5e6dc293459be32 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JsDocNodeCheckConfig.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JsDocNodeCheckConfig + +# Interface: JsDocNodeCheckConfig + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3444 + +## Properties + +### checkConfig + +> **checkConfig**: [`JsDocNodeCheckConfigItem`](JsDocNodeCheckConfigItem.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3446 + +*** + +### nodeNeedCheck + +> **nodeNeedCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3445 diff --git a/docs/api_docs/namespaces/ts/interfaces/JsDocNodeCheckConfigItem.md b/docs/api_docs/namespaces/ts/interfaces/JsDocNodeCheckConfigItem.md new file mode 100644 index 0000000000000000000000000000000000000000..dcdaecea0297c18932e3bebabfae5d0f95411bad --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JsDocNodeCheckConfigItem.md @@ -0,0 +1,101 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JsDocNodeCheckConfigItem + +# Interface: JsDocNodeCheckConfigItem + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3448 + +## Properties + +### checkJsDocSpecialValidCallback()? + +> `optional` **checkJsDocSpecialValidCallback**: (`jsDocTags`, `config`) => `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3456 + +#### Parameters + +##### jsDocTags + +readonly [`JSDocTag`](JSDocTag.md)[] + +##### config + +[`JsDocNodeCheckConfigItem`](JsDocNodeCheckConfigItem.md) + +#### Returns + +`boolean` + +*** + +### checkValidCallback()? + +> `optional` **checkValidCallback**: (`jsDocTag`, `config`) => `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3455 + +#### Parameters + +##### jsDocTag + +[`JSDocTag`](JSDocTag.md) + +##### config + +[`JsDocNodeCheckConfigItem`](JsDocNodeCheckConfigItem.md) + +#### Returns + +`boolean` + +*** + +### message + +> **message**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3450 + +*** + +### needConditionCheck + +> **needConditionCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3451 + +*** + +### specifyCheckConditionFuncName + +> **specifyCheckConditionFuncName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3453 + +*** + +### tagName + +> **tagName**: `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3449 + +*** + +### tagNameShouldExisted + +> **tagNameShouldExisted**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3454 + +*** + +### type + +> **type**: [`DiagnosticCategory`](../enumerations/DiagnosticCategory.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3452 diff --git a/docs/api_docs/namespaces/ts/interfaces/JsDocTagInfo.md b/docs/api_docs/namespaces/ts/interfaces/JsDocTagInfo.md new file mode 100644 index 0000000000000000000000000000000000000000..b42fa193b4b700b966e5ed5910ca2a8acb795c21 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JsDocTagInfo.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JsDocTagInfo + +# Interface: JsDocTagInfo + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2269 + +## Properties + +### name + +> **name**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2270 + +*** + +### text? + +> `optional` **text**: `string` \| [`SymbolDisplayPart`](SymbolDisplayPart.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2271 diff --git a/docs/api_docs/namespaces/ts/interfaces/JsonMinusNumericLiteral.md b/docs/api_docs/namespaces/ts/interfaces/JsonMinusNumericLiteral.md new file mode 100644 index 0000000000000000000000000000000000000000..3803b5ee9101353e10be7a278c4aa5dcf345014a --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JsonMinusNumericLiteral.md @@ -0,0 +1,537 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JsonMinusNumericLiteral + +# Interface: JsonMinusNumericLiteral + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2221 + +## Extends + +- [`PrefixUnaryExpression`](PrefixUnaryExpression.md) + +## Properties + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`PrefixUnaryExpression`](PrefixUnaryExpression.md).[`_expressionBrand`](PrefixUnaryExpression.md#_expressionbrand) + +*** + +### \_unaryExpressionBrand + +> **\_unaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1066 + +#### Inherited from + +[`PrefixUnaryExpression`](PrefixUnaryExpression.md).[`_unaryExpressionBrand`](PrefixUnaryExpression.md#_unaryexpressionbrand) + +*** + +### \_updateExpressionBrand + +> **\_updateExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1071 + +#### Inherited from + +[`PrefixUnaryExpression`](PrefixUnaryExpression.md).[`_updateExpressionBrand`](PrefixUnaryExpression.md#_updateexpressionbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`PrefixUnaryExpression`](PrefixUnaryExpression.md).[`decorators`](PrefixUnaryExpression.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`PrefixUnaryExpression`](PrefixUnaryExpression.md).[`end`](PrefixUnaryExpression.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`PrefixUnaryExpression`](PrefixUnaryExpression.md).[`flags`](PrefixUnaryExpression.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`PrefixUnaryExpression`](../enumerations/SyntaxKind.md#prefixunaryexpression) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2222 + +#### Overrides + +[`PrefixUnaryExpression`](PrefixUnaryExpression.md).[`kind`](PrefixUnaryExpression.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`PrefixUnaryExpression`](PrefixUnaryExpression.md).[`locals`](PrefixUnaryExpression.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`PrefixUnaryExpression`](PrefixUnaryExpression.md).[`modifiers`](PrefixUnaryExpression.md#modifiers) + +*** + +### operand + +> `readonly` **operand**: [`NumericLiteral`](NumericLiteral.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2224 + +#### Overrides + +[`PrefixUnaryExpression`](PrefixUnaryExpression.md).[`operand`](PrefixUnaryExpression.md#operand) + +*** + +### operator + +> `readonly` **operator**: [`MinusToken`](../enumerations/SyntaxKind.md#minustoken) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2223 + +#### Overrides + +[`PrefixUnaryExpression`](PrefixUnaryExpression.md).[`operator`](PrefixUnaryExpression.md#operator) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`PrefixUnaryExpression`](PrefixUnaryExpression.md).[`parent`](PrefixUnaryExpression.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`PrefixUnaryExpression`](PrefixUnaryExpression.md).[`pos`](PrefixUnaryExpression.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`PrefixUnaryExpression`](PrefixUnaryExpression.md).[`skipCheck`](PrefixUnaryExpression.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`PrefixUnaryExpression`](PrefixUnaryExpression.md).[`symbol`](PrefixUnaryExpression.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`PrefixUnaryExpression`](PrefixUnaryExpression.md).[`forEachChild`](PrefixUnaryExpression.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`PrefixUnaryExpression`](PrefixUnaryExpression.md).[`getChildAt`](PrefixUnaryExpression.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`PrefixUnaryExpression`](PrefixUnaryExpression.md).[`getChildCount`](PrefixUnaryExpression.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`PrefixUnaryExpression`](PrefixUnaryExpression.md).[`getChildren`](PrefixUnaryExpression.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`PrefixUnaryExpression`](PrefixUnaryExpression.md).[`getEnd`](PrefixUnaryExpression.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`PrefixUnaryExpression`](PrefixUnaryExpression.md).[`getFirstToken`](PrefixUnaryExpression.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`PrefixUnaryExpression`](PrefixUnaryExpression.md).[`getFullStart`](PrefixUnaryExpression.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`PrefixUnaryExpression`](PrefixUnaryExpression.md).[`getFullText`](PrefixUnaryExpression.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`PrefixUnaryExpression`](PrefixUnaryExpression.md).[`getFullWidth`](PrefixUnaryExpression.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`PrefixUnaryExpression`](PrefixUnaryExpression.md).[`getLastToken`](PrefixUnaryExpression.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`PrefixUnaryExpression`](PrefixUnaryExpression.md).[`getLeadingTriviaWidth`](PrefixUnaryExpression.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`PrefixUnaryExpression`](PrefixUnaryExpression.md).[`getSourceFile`](PrefixUnaryExpression.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`PrefixUnaryExpression`](PrefixUnaryExpression.md).[`getStart`](PrefixUnaryExpression.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`PrefixUnaryExpression`](PrefixUnaryExpression.md).[`getText`](PrefixUnaryExpression.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`PrefixUnaryExpression`](PrefixUnaryExpression.md).[`getWidth`](PrefixUnaryExpression.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/JsonObjectExpressionStatement.md b/docs/api_docs/namespaces/ts/interfaces/JsonObjectExpressionStatement.md new file mode 100644 index 0000000000000000000000000000000000000000..643f4506c905c184a71f99a064ecd62f1907ae15 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JsonObjectExpressionStatement.md @@ -0,0 +1,501 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JsonObjectExpressionStatement + +# Interface: JsonObjectExpressionStatement + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2227 + +## Extends + +- [`ExpressionStatement`](ExpressionStatement.md) + +## Properties + +### \_statementBrand + +> **\_statementBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1471 + +#### Inherited from + +[`ExpressionStatement`](ExpressionStatement.md).[`_statementBrand`](ExpressionStatement.md#_statementbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`ExpressionStatement`](ExpressionStatement.md).[`decorators`](ExpressionStatement.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`ExpressionStatement`](ExpressionStatement.md).[`end`](ExpressionStatement.md#end) + +*** + +### expression + +> `readonly` **expression**: [`JsonObjectExpression`](../type-aliases/JsonObjectExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2228 + +#### Overrides + +[`ExpressionStatement`](ExpressionStatement.md).[`expression`](ExpressionStatement.md#expression) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`ExpressionStatement`](ExpressionStatement.md).[`flags`](ExpressionStatement.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`ExpressionStatement`](../enumerations/SyntaxKind.md#expressionstatement) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1504 + +#### Inherited from + +[`ExpressionStatement`](ExpressionStatement.md).[`kind`](ExpressionStatement.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`ExpressionStatement`](ExpressionStatement.md).[`locals`](ExpressionStatement.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`ExpressionStatement`](ExpressionStatement.md).[`modifiers`](ExpressionStatement.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`ExpressionStatement`](ExpressionStatement.md).[`parent`](ExpressionStatement.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`ExpressionStatement`](ExpressionStatement.md).[`pos`](ExpressionStatement.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`ExpressionStatement`](ExpressionStatement.md).[`skipCheck`](ExpressionStatement.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`ExpressionStatement`](ExpressionStatement.md).[`symbol`](ExpressionStatement.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`ExpressionStatement`](ExpressionStatement.md).[`forEachChild`](ExpressionStatement.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`ExpressionStatement`](ExpressionStatement.md).[`getChildAt`](ExpressionStatement.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`ExpressionStatement`](ExpressionStatement.md).[`getChildCount`](ExpressionStatement.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`ExpressionStatement`](ExpressionStatement.md).[`getChildren`](ExpressionStatement.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`ExpressionStatement`](ExpressionStatement.md).[`getEnd`](ExpressionStatement.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`ExpressionStatement`](ExpressionStatement.md).[`getFirstToken`](ExpressionStatement.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`ExpressionStatement`](ExpressionStatement.md).[`getFullStart`](ExpressionStatement.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`ExpressionStatement`](ExpressionStatement.md).[`getFullText`](ExpressionStatement.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`ExpressionStatement`](ExpressionStatement.md).[`getFullWidth`](ExpressionStatement.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`ExpressionStatement`](ExpressionStatement.md).[`getLastToken`](ExpressionStatement.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`ExpressionStatement`](ExpressionStatement.md).[`getLeadingTriviaWidth`](ExpressionStatement.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`ExpressionStatement`](ExpressionStatement.md).[`getSourceFile`](ExpressionStatement.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`ExpressionStatement`](ExpressionStatement.md).[`getStart`](ExpressionStatement.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`ExpressionStatement`](ExpressionStatement.md).[`getText`](ExpressionStatement.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`ExpressionStatement`](ExpressionStatement.md).[`getWidth`](ExpressionStatement.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/JsonSourceFile.md b/docs/api_docs/namespaces/ts/interfaces/JsonSourceFile.md new file mode 100644 index 0000000000000000000000000000000000000000..49a92b7cc60972ac93bfe1ee7984a80ac1a24385 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JsonSourceFile.md @@ -0,0 +1,796 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JsonSourceFile + +# Interface: JsonSourceFile + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2215 + +## Extends + +- [`SourceFile`](SourceFile.md) + +## Extended by + +- [`TsConfigSourceFile`](TsConfigSourceFile.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`SourceFile`](SourceFile.md).[`_declarationBrand`](SourceFile.md#_declarationbrand) + +*** + +### amdDependencies + +> **amdDependencies**: readonly [`AmdDependency`](AmdDependency.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2122 + +#### Inherited from + +[`SourceFile`](SourceFile.md).[`amdDependencies`](SourceFile.md#amddependencies) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`SourceFile`](SourceFile.md).[`decorators`](SourceFile.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`SourceFile`](SourceFile.md).[`end`](SourceFile.md#end) + +*** + +### endOfFileToken + +> `readonly` **endOfFileToken**: [`Token`](Token.md)\<[`EndOfFileToken`](../enumerations/SyntaxKind.md#endoffiletoken)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2119 + +#### Inherited from + +[`SourceFile`](SourceFile.md).[`endOfFileToken`](SourceFile.md#endoffiletoken) + +*** + +### fileName + +> **fileName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2120 + +#### Inherited from + +[`SourceFile`](SourceFile.md).[`fileName`](SourceFile.md#filename) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`SourceFile`](SourceFile.md).[`flags`](SourceFile.md#flags) + +*** + +### hasNoDefaultLib + +> **hasNoDefaultLib**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2137 + +lib.d.ts should have a reference comment like + + /// + +If any other file has this comment, it signals not to include lib.d.ts +because this containing file is intended to act as a default library. + +#### Inherited from + +[`SourceFile`](SourceFile.md).[`hasNoDefaultLib`](SourceFile.md#hasnodefaultlib) + +*** + +### impliedNodeFormat? + +> `optional` **impliedNodeFormat**: [`CommonJS`](../enumerations/ModuleKind.md#commonjs) \| [`ESNext`](../enumerations/ModuleKind.md#esnext) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2156 + +When `module` is `Node16` or `NodeNext`, this field controls whether the +source file in question is an ESNext-output-format file, or a CommonJS-output-format +module. This is derived by the module resolver as it looks up the file, since +it is derived from either the file extension of the module, or the containing +`package.json` context, and affects both checking and emit. + +It is _public_ so that (pre)transformers can set this field, +since it switches the builtin `node` module transform. Generally speaking, if unset, +the field is treated as though it is `ModuleKind.CommonJS`. + +Note that this field is only set by the module resolution process when +`moduleResolution` is `Node16` or `NodeNext`, which is implied by the `module` setting +of `Node16` or `NodeNext`, respectively, but may be overriden (eg, by a `moduleResolution` +of `node`). If so, this field will be unset and source files will be considered to be +CommonJS-output-format by the node module transformer and type checker, regardless of extension or context. + +#### Inherited from + +[`SourceFile`](SourceFile.md).[`impliedNodeFormat`](SourceFile.md#impliednodeformat) + +*** + +### isDeclarationFile + +> **isDeclarationFile**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2128 + +#### Inherited from + +[`SourceFile`](SourceFile.md).[`isDeclarationFile`](SourceFile.md#isdeclarationfile) + +*** + +### kind + +> `readonly` **kind**: [`SourceFile`](../enumerations/SyntaxKind.md#sourcefile) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2117 + +#### Inherited from + +[`SourceFile`](SourceFile.md).[`kind`](SourceFile.md#kind) + +*** + +### languageVariant + +> **languageVariant**: [`LanguageVariant`](../enumerations/LanguageVariant.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2127 + +#### Inherited from + +[`SourceFile`](SourceFile.md).[`languageVariant`](SourceFile.md#languagevariant) + +*** + +### languageVersion + +> **languageVersion**: [`ScriptTarget`](../enumerations/ScriptTarget.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2138 + +#### Inherited from + +[`SourceFile`](SourceFile.md).[`languageVersion`](SourceFile.md#languageversion) + +*** + +### libReferenceDirectives + +> **libReferenceDirectives**: readonly [`FileReference`](FileReference.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2126 + +#### Inherited from + +[`SourceFile`](SourceFile.md).[`libReferenceDirectives`](SourceFile.md#libreferencedirectives) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`SourceFile`](SourceFile.md).[`locals`](SourceFile.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`SourceFile`](SourceFile.md).[`modifiers`](SourceFile.md#modifiers) + +*** + +### moduleName? + +> `optional` **moduleName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2123 + +#### Inherited from + +[`SourceFile`](SourceFile.md).[`moduleName`](SourceFile.md#modulename) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`SourceFile`](SourceFile.md).[`parent`](SourceFile.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`SourceFile`](SourceFile.md).[`pos`](SourceFile.md#pos) + +*** + +### referencedFiles + +> **referencedFiles**: readonly [`FileReference`](FileReference.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2124 + +#### Inherited from + +[`SourceFile`](SourceFile.md).[`referencedFiles`](SourceFile.md#referencedfiles) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`SourceFile`](SourceFile.md).[`skipCheck`](SourceFile.md#skipcheck) + +*** + +### statements + +> `readonly` **statements**: [`NodeArray`](NodeArray.md)\<[`JsonObjectExpressionStatement`](JsonObjectExpressionStatement.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2216 + +#### Overrides + +[`SourceFile`](SourceFile.md).[`statements`](SourceFile.md#statements) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`SourceFile`](SourceFile.md).[`symbol`](SourceFile.md#symbol) + +*** + +### text + +> **text**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2121 + +#### Inherited from + +[`SourceFile`](SourceFile.md).[`text`](SourceFile.md#text) + +*** + +### typeReferenceDirectives + +> **typeReferenceDirectives**: readonly [`FileReference`](FileReference.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2125 + +#### Inherited from + +[`SourceFile`](SourceFile.md).[`typeReferenceDirectives`](SourceFile.md#typereferencedirectives) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`SourceFile`](SourceFile.md).[`forEachChild`](SourceFile.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`SourceFile`](SourceFile.md).[`getChildAt`](SourceFile.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`SourceFile`](SourceFile.md).[`getChildCount`](SourceFile.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`SourceFile`](SourceFile.md).[`getChildren`](SourceFile.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`SourceFile`](SourceFile.md).[`getEnd`](SourceFile.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`SourceFile`](SourceFile.md).[`getFirstToken`](SourceFile.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`SourceFile`](SourceFile.md).[`getFullStart`](SourceFile.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`SourceFile`](SourceFile.md).[`getFullText`](SourceFile.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`SourceFile`](SourceFile.md).[`getFullWidth`](SourceFile.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`SourceFile`](SourceFile.md).[`getLastToken`](SourceFile.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`SourceFile`](SourceFile.md).[`getLeadingTriviaWidth`](SourceFile.md#getleadingtriviawidth) + +*** + +### getLineAndCharacterOfPosition() + +> **getLineAndCharacterOfPosition**(`pos`): [`LineAndCharacter`](LineAndCharacter.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6157 + +#### Parameters + +##### pos + +`number` + +#### Returns + +[`LineAndCharacter`](LineAndCharacter.md) + +#### Inherited from + +[`SourceFile`](SourceFile.md).[`getLineAndCharacterOfPosition`](SourceFile.md#getlineandcharacterofposition) + +*** + +### getLineEndOfPosition() + +> **getLineEndOfPosition**(`pos`): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6158 + +#### Parameters + +##### pos + +`number` + +#### Returns + +`number` + +#### Inherited from + +[`SourceFile`](SourceFile.md).[`getLineEndOfPosition`](SourceFile.md#getlineendofposition) + +*** + +### getLineStarts() + +> **getLineStarts**(): readonly `number`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6159 + +#### Returns + +readonly `number`[] + +#### Inherited from + +[`SourceFile`](SourceFile.md).[`getLineStarts`](SourceFile.md#getlinestarts) + +*** + +### getPositionOfLineAndCharacter() + +> **getPositionOfLineAndCharacter**(`line`, `character`): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6160 + +#### Parameters + +##### line + +`number` + +##### character + +`number` + +#### Returns + +`number` + +#### Inherited from + +[`SourceFile`](SourceFile.md).[`getPositionOfLineAndCharacter`](SourceFile.md#getpositionoflineandcharacter) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`SourceFile`](SourceFile.md).[`getSourceFile`](SourceFile.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`SourceFile`](SourceFile.md).[`getStart`](SourceFile.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`SourceFile`](SourceFile.md).[`getText`](SourceFile.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`SourceFile`](SourceFile.md).[`getWidth`](SourceFile.md#getwidth) + +*** + +### update() + +> **update**(`newText`, `textChangeRange`): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6161 + +#### Parameters + +##### newText + +`string` + +##### textChangeRange + +[`TextChangeRange`](TextChangeRange.md) + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`SourceFile`](SourceFile.md).[`update`](SourceFile.md#update) diff --git a/docs/api_docs/namespaces/ts/interfaces/JsxAttribute.md b/docs/api_docs/namespaces/ts/interfaces/JsxAttribute.md new file mode 100644 index 0000000000000000000000000000000000000000..4822ed23eee67890e3ca1d2360f97bdd0897609e --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JsxAttribute.md @@ -0,0 +1,521 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JsxAttribute + +# Interface: JsxAttribute + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1441 + +## Extends + +- [`ObjectLiteralElement`](ObjectLiteralElement.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`_declarationBrand`](ObjectLiteralElement.md#_declarationbrand) + +*** + +### \_objectLiteralBrand + +> **\_objectLiteralBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:798 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`_objectLiteralBrand`](ObjectLiteralElement.md#_objectliteralbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`decorators`](ObjectLiteralElement.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`end`](ObjectLiteralElement.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`flags`](ObjectLiteralElement.md#flags) + +*** + +### initializer? + +> `readonly` `optional` **initializer**: [`JsxAttributeValue`](../type-aliases/JsxAttributeValue.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1445 + +*** + +### kind + +> `readonly` **kind**: [`JsxAttribute`](../enumerations/SyntaxKind.md#jsxattribute) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1442 + +#### Overrides + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`kind`](ObjectLiteralElement.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`locals`](ObjectLiteralElement.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`modifiers`](ObjectLiteralElement.md#modifiers) + +*** + +### name + +> `readonly` **name**: [`Identifier`](Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1444 + +#### Overrides + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`name`](ObjectLiteralElement.md#name) + +*** + +### parent + +> `readonly` **parent**: [`JsxAttributes`](JsxAttributes.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1443 + +#### Overrides + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`parent`](ObjectLiteralElement.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`pos`](ObjectLiteralElement.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`skipCheck`](ObjectLiteralElement.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`symbol`](ObjectLiteralElement.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`forEachChild`](ObjectLiteralElement.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getChildAt`](ObjectLiteralElement.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getChildCount`](ObjectLiteralElement.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getChildren`](ObjectLiteralElement.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getEnd`](ObjectLiteralElement.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getFirstToken`](ObjectLiteralElement.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getFullStart`](ObjectLiteralElement.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getFullText`](ObjectLiteralElement.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getFullWidth`](ObjectLiteralElement.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getLastToken`](ObjectLiteralElement.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getLeadingTriviaWidth`](ObjectLiteralElement.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getSourceFile`](ObjectLiteralElement.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getStart`](ObjectLiteralElement.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getText`](ObjectLiteralElement.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getWidth`](ObjectLiteralElement.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/JsxAttributes.md b/docs/api_docs/namespaces/ts/interfaces/JsxAttributes.md new file mode 100644 index 0000000000000000000000000000000000000000..c020bdf72acfd06a11965cc85d06427208c0b606 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JsxAttributes.md @@ -0,0 +1,578 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JsxAttributes + +# Interface: JsxAttributes + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1410 + +This interface is a base interface for ObjectLiteralExpression and JSXAttributes to extend from. JSXAttributes is similar to +ObjectLiteralExpression in that it contains array of properties; however, JSXAttributes' properties can only be +JSXAttribute or JSXSpreadAttribute. ObjectLiteralExpression, on the other hand, can only have properties of type +ObjectLiteralElement (e.g. PropertyAssignment, ShorthandPropertyAssignment etc.) + +## Extends + +- [`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md)\<[`JsxAttributeLike`](../type-aliases/JsxAttributeLike.md)\> + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`_declarationBrand`](ObjectLiteralExpressionBase.md#_declarationbrand) + +*** + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`_expressionBrand`](ObjectLiteralExpressionBase.md#_expressionbrand) + +*** + +### \_leftHandSideExpressionBrand + +> **\_leftHandSideExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1086 + +#### Inherited from + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`_leftHandSideExpressionBrand`](ObjectLiteralExpressionBase.md#_lefthandsideexpressionbrand) + +*** + +### \_memberExpressionBrand + +> **\_memberExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1089 + +#### Inherited from + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`_memberExpressionBrand`](ObjectLiteralExpressionBase.md#_memberexpressionbrand) + +*** + +### \_primaryExpressionBrand + +> **\_primaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1092 + +#### Inherited from + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`_primaryExpressionBrand`](ObjectLiteralExpressionBase.md#_primaryexpressionbrand) + +*** + +### \_unaryExpressionBrand + +> **\_unaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1066 + +#### Inherited from + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`_unaryExpressionBrand`](ObjectLiteralExpressionBase.md#_unaryexpressionbrand) + +*** + +### \_updateExpressionBrand + +> **\_updateExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1071 + +#### Inherited from + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`_updateExpressionBrand`](ObjectLiteralExpressionBase.md#_updateexpressionbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`decorators`](ObjectLiteralExpressionBase.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`end`](ObjectLiteralExpressionBase.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`flags`](ObjectLiteralExpressionBase.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`JsxAttributes`](../enumerations/SyntaxKind.md#jsxattributes) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1411 + +#### Overrides + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`kind`](ObjectLiteralExpressionBase.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`locals`](ObjectLiteralExpressionBase.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`modifiers`](ObjectLiteralExpressionBase.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`JsxOpeningLikeElement`](../type-aliases/JsxOpeningLikeElement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1412 + +#### Overrides + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`parent`](ObjectLiteralExpressionBase.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`pos`](ObjectLiteralExpressionBase.md#pos) + +*** + +### properties + +> `readonly` **properties**: [`NodeArray`](NodeArray.md)\<[`JsxAttributeLike`](../type-aliases/JsxAttributeLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1296 + +#### Inherited from + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`properties`](ObjectLiteralExpressionBase.md#properties) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`skipCheck`](ObjectLiteralExpressionBase.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`symbol`](ObjectLiteralExpressionBase.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`forEachChild`](ObjectLiteralExpressionBase.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`getChildAt`](ObjectLiteralExpressionBase.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`getChildCount`](ObjectLiteralExpressionBase.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`getChildren`](ObjectLiteralExpressionBase.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`getEnd`](ObjectLiteralExpressionBase.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`getFirstToken`](ObjectLiteralExpressionBase.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`getFullStart`](ObjectLiteralExpressionBase.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`getFullText`](ObjectLiteralExpressionBase.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`getFullWidth`](ObjectLiteralExpressionBase.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`getLastToken`](ObjectLiteralExpressionBase.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`getLeadingTriviaWidth`](ObjectLiteralExpressionBase.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`getSourceFile`](ObjectLiteralExpressionBase.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`getStart`](ObjectLiteralExpressionBase.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`getText`](ObjectLiteralExpressionBase.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`getWidth`](ObjectLiteralExpressionBase.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/JsxClosingElement.md b/docs/api_docs/namespaces/ts/interfaces/JsxClosingElement.md new file mode 100644 index 0000000000000000000000000000000000000000..577c8d11822c60bb0af4b379e0362359c5dde1b2 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JsxClosingElement.md @@ -0,0 +1,485 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JsxClosingElement + +# Interface: JsxClosingElement + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1453 + +## Extends + +- [`Node`](Node.md) + +## Properties + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`decorators`](Node.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Node`](Node.md).[`end`](Node.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Node`](Node.md).[`flags`](Node.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`JsxClosingElement`](../enumerations/SyntaxKind.md#jsxclosingelement) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1454 + +#### Overrides + +[`Node`](Node.md).[`kind`](Node.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Node`](Node.md).[`locals`](Node.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`modifiers`](Node.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`JsxElement`](JsxElement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1455 + +#### Overrides + +[`Node`](Node.md).[`parent`](Node.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Node`](Node.md).[`pos`](Node.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Node`](Node.md).[`skipCheck`](Node.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Node`](Node.md).[`symbol`](Node.md#symbol) + +*** + +### tagName + +> `readonly` **tagName**: [`JsxTagNameExpression`](../type-aliases/JsxTagNameExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1456 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Node`](Node.md).[`forEachChild`](Node.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getChildAt`](Node.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getChildCount`](Node.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Node`](Node.md).[`getChildren`](Node.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getEnd`](Node.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getFirstToken`](Node.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullStart`](Node.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getFullText`](Node.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullWidth`](Node.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getLastToken`](Node.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getLeadingTriviaWidth`](Node.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Node`](Node.md).[`getSourceFile`](Node.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getStart`](Node.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getText`](Node.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getWidth`](Node.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/JsxClosingFragment.md b/docs/api_docs/namespaces/ts/interfaces/JsxClosingFragment.md new file mode 100644 index 0000000000000000000000000000000000000000..66a1e59dcc7a4abe2510be5348e4dae54dfcb503 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JsxClosingFragment.md @@ -0,0 +1,489 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JsxClosingFragment + +# Interface: JsxClosingFragment + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1437 + +## Extends + +- [`Expression`](Expression.md) + +## Properties + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`Expression`](Expression.md).[`_expressionBrand`](Expression.md#_expressionbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Expression`](Expression.md).[`decorators`](Expression.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Expression`](Expression.md).[`end`](Expression.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Expression`](Expression.md).[`flags`](Expression.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`JsxClosingFragment`](../enumerations/SyntaxKind.md#jsxclosingfragment) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1438 + +#### Overrides + +[`Expression`](Expression.md).[`kind`](Expression.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Expression`](Expression.md).[`locals`](Expression.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Expression`](Expression.md).[`modifiers`](Expression.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`JsxFragment`](JsxFragment.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1439 + +#### Overrides + +[`Expression`](Expression.md).[`parent`](Expression.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Expression`](Expression.md).[`pos`](Expression.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Expression`](Expression.md).[`skipCheck`](Expression.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Expression`](Expression.md).[`symbol`](Expression.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Expression`](Expression.md).[`forEachChild`](Expression.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Expression`](Expression.md).[`getChildAt`](Expression.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getChildCount`](Expression.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Expression`](Expression.md).[`getChildren`](Expression.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getEnd`](Expression.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Expression`](Expression.md).[`getFirstToken`](Expression.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getFullStart`](Expression.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Expression`](Expression.md).[`getFullText`](Expression.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getFullWidth`](Expression.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Expression`](Expression.md).[`getLastToken`](Expression.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getLeadingTriviaWidth`](Expression.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Expression`](Expression.md).[`getSourceFile`](Expression.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getStart`](Expression.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Expression`](Expression.md).[`getText`](Expression.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getWidth`](Expression.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/JsxClosingTagInfo.md b/docs/api_docs/namespaces/ts/interfaces/JsxClosingTagInfo.md new file mode 100644 index 0000000000000000000000000000000000000000..e1a0d78586e5d1ff05023aecfbadcb91c47f9fd0 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JsxClosingTagInfo.md @@ -0,0 +1,17 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JsxClosingTagInfo + +# Interface: JsxClosingTagInfo + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6435 + +## Properties + +### newText + +> `readonly` **newText**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6436 diff --git a/docs/api_docs/namespaces/ts/interfaces/JsxElement.md b/docs/api_docs/namespaces/ts/interfaces/JsxElement.md new file mode 100644 index 0000000000000000000000000000000000000000..5ac5a8caeff93f45592567dd2ce54292be447de2 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JsxElement.md @@ -0,0 +1,573 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JsxElement + +# Interface: JsxElement + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1398 + +## Extends + +- [`PrimaryExpression`](PrimaryExpression.md) + +## Properties + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_expressionBrand`](PrimaryExpression.md#_expressionbrand) + +*** + +### \_leftHandSideExpressionBrand + +> **\_leftHandSideExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1086 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_leftHandSideExpressionBrand`](PrimaryExpression.md#_lefthandsideexpressionbrand) + +*** + +### \_memberExpressionBrand + +> **\_memberExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1089 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_memberExpressionBrand`](PrimaryExpression.md#_memberexpressionbrand) + +*** + +### \_primaryExpressionBrand + +> **\_primaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1092 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_primaryExpressionBrand`](PrimaryExpression.md#_primaryexpressionbrand) + +*** + +### \_unaryExpressionBrand + +> **\_unaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1066 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_unaryExpressionBrand`](PrimaryExpression.md#_unaryexpressionbrand) + +*** + +### \_updateExpressionBrand + +> **\_updateExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1071 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_updateExpressionBrand`](PrimaryExpression.md#_updateexpressionbrand) + +*** + +### children + +> `readonly` **children**: [`NodeArray`](NodeArray.md)\<[`JsxChild`](../type-aliases/JsxChild.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1401 + +*** + +### closingElement + +> `readonly` **closingElement**: [`JsxClosingElement`](JsxClosingElement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1402 + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`decorators`](PrimaryExpression.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`end`](PrimaryExpression.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`flags`](PrimaryExpression.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`JsxElement`](../enumerations/SyntaxKind.md#jsxelement) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1399 + +#### Overrides + +[`PrimaryExpression`](PrimaryExpression.md).[`kind`](PrimaryExpression.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`locals`](PrimaryExpression.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`modifiers`](PrimaryExpression.md#modifiers) + +*** + +### openingElement + +> `readonly` **openingElement**: [`JsxOpeningElement`](JsxOpeningElement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1400 + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`parent`](PrimaryExpression.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`pos`](PrimaryExpression.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`skipCheck`](PrimaryExpression.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`symbol`](PrimaryExpression.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`forEachChild`](PrimaryExpression.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getChildAt`](PrimaryExpression.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getChildCount`](PrimaryExpression.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getChildren`](PrimaryExpression.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getEnd`](PrimaryExpression.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFirstToken`](PrimaryExpression.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFullStart`](PrimaryExpression.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFullText`](PrimaryExpression.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFullWidth`](PrimaryExpression.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getLastToken`](PrimaryExpression.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getLeadingTriviaWidth`](PrimaryExpression.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getSourceFile`](PrimaryExpression.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getStart`](PrimaryExpression.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getText`](PrimaryExpression.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getWidth`](PrimaryExpression.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/JsxExpression.md b/docs/api_docs/namespaces/ts/interfaces/JsxExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..3c23c5b7fe4dd1c5dda241a9cdf2de8110fda644 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JsxExpression.md @@ -0,0 +1,505 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JsxExpression + +# Interface: JsxExpression + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1458 + +## Extends + +- [`Expression`](Expression.md) + +## Properties + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`Expression`](Expression.md).[`_expressionBrand`](Expression.md#_expressionbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Expression`](Expression.md).[`decorators`](Expression.md#decorators) + +*** + +### dotDotDotToken? + +> `readonly` `optional` **dotDotDotToken**: [`Token`](Token.md)\<[`DotDotDotToken`](../enumerations/SyntaxKind.md#dotdotdottoken)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1461 + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Expression`](Expression.md).[`end`](Expression.md#end) + +*** + +### expression? + +> `readonly` `optional` **expression**: [`Expression`](Expression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1462 + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Expression`](Expression.md).[`flags`](Expression.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`JsxExpression`](../enumerations/SyntaxKind.md#jsxexpression) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1459 + +#### Overrides + +[`Expression`](Expression.md).[`kind`](Expression.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Expression`](Expression.md).[`locals`](Expression.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Expression`](Expression.md).[`modifiers`](Expression.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`JsxElement`](JsxElement.md) \| [`JsxFragment`](JsxFragment.md) \| [`JsxAttributeLike`](../type-aliases/JsxAttributeLike.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1460 + +#### Overrides + +[`Expression`](Expression.md).[`parent`](Expression.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Expression`](Expression.md).[`pos`](Expression.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Expression`](Expression.md).[`skipCheck`](Expression.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Expression`](Expression.md).[`symbol`](Expression.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Expression`](Expression.md).[`forEachChild`](Expression.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Expression`](Expression.md).[`getChildAt`](Expression.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getChildCount`](Expression.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Expression`](Expression.md).[`getChildren`](Expression.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getEnd`](Expression.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Expression`](Expression.md).[`getFirstToken`](Expression.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getFullStart`](Expression.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Expression`](Expression.md).[`getFullText`](Expression.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getFullWidth`](Expression.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Expression`](Expression.md).[`getLastToken`](Expression.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getLeadingTriviaWidth`](Expression.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Expression`](Expression.md).[`getSourceFile`](Expression.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getStart`](Expression.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Expression`](Expression.md).[`getText`](Expression.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getWidth`](Expression.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/JsxFragment.md b/docs/api_docs/namespaces/ts/interfaces/JsxFragment.md new file mode 100644 index 0000000000000000000000000000000000000000..027216b01a3059bbf31ff092f8364d3d80662c62 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JsxFragment.md @@ -0,0 +1,573 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JsxFragment + +# Interface: JsxFragment + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1427 + +## Extends + +- [`PrimaryExpression`](PrimaryExpression.md) + +## Properties + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_expressionBrand`](PrimaryExpression.md#_expressionbrand) + +*** + +### \_leftHandSideExpressionBrand + +> **\_leftHandSideExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1086 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_leftHandSideExpressionBrand`](PrimaryExpression.md#_lefthandsideexpressionbrand) + +*** + +### \_memberExpressionBrand + +> **\_memberExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1089 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_memberExpressionBrand`](PrimaryExpression.md#_memberexpressionbrand) + +*** + +### \_primaryExpressionBrand + +> **\_primaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1092 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_primaryExpressionBrand`](PrimaryExpression.md#_primaryexpressionbrand) + +*** + +### \_unaryExpressionBrand + +> **\_unaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1066 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_unaryExpressionBrand`](PrimaryExpression.md#_unaryexpressionbrand) + +*** + +### \_updateExpressionBrand + +> **\_updateExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1071 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_updateExpressionBrand`](PrimaryExpression.md#_updateexpressionbrand) + +*** + +### children + +> `readonly` **children**: [`NodeArray`](NodeArray.md)\<[`JsxChild`](../type-aliases/JsxChild.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1430 + +*** + +### closingFragment + +> `readonly` **closingFragment**: [`JsxClosingFragment`](JsxClosingFragment.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1431 + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`decorators`](PrimaryExpression.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`end`](PrimaryExpression.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`flags`](PrimaryExpression.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`JsxFragment`](../enumerations/SyntaxKind.md#jsxfragment) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1428 + +#### Overrides + +[`PrimaryExpression`](PrimaryExpression.md).[`kind`](PrimaryExpression.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`locals`](PrimaryExpression.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`modifiers`](PrimaryExpression.md#modifiers) + +*** + +### openingFragment + +> `readonly` **openingFragment**: [`JsxOpeningFragment`](JsxOpeningFragment.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1429 + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`parent`](PrimaryExpression.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`pos`](PrimaryExpression.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`skipCheck`](PrimaryExpression.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`symbol`](PrimaryExpression.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`forEachChild`](PrimaryExpression.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getChildAt`](PrimaryExpression.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getChildCount`](PrimaryExpression.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getChildren`](PrimaryExpression.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getEnd`](PrimaryExpression.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFirstToken`](PrimaryExpression.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFullStart`](PrimaryExpression.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFullText`](PrimaryExpression.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFullWidth`](PrimaryExpression.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getLastToken`](PrimaryExpression.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getLeadingTriviaWidth`](PrimaryExpression.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getSourceFile`](PrimaryExpression.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getStart`](PrimaryExpression.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getText`](PrimaryExpression.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getWidth`](PrimaryExpression.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/JsxOpeningElement.md b/docs/api_docs/namespaces/ts/interfaces/JsxOpeningElement.md new file mode 100644 index 0000000000000000000000000000000000000000..eb16d1d95466a3609ed877476a9604d6da23d1ca --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JsxOpeningElement.md @@ -0,0 +1,513 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JsxOpeningElement + +# Interface: JsxOpeningElement + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1414 + +## Extends + +- [`Expression`](Expression.md) + +## Properties + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`Expression`](Expression.md).[`_expressionBrand`](Expression.md#_expressionbrand) + +*** + +### attributes + +> `readonly` **attributes**: [`JsxAttributes`](JsxAttributes.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1419 + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Expression`](Expression.md).[`decorators`](Expression.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Expression`](Expression.md).[`end`](Expression.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Expression`](Expression.md).[`flags`](Expression.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`JsxOpeningElement`](../enumerations/SyntaxKind.md#jsxopeningelement) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1415 + +#### Overrides + +[`Expression`](Expression.md).[`kind`](Expression.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Expression`](Expression.md).[`locals`](Expression.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Expression`](Expression.md).[`modifiers`](Expression.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`JsxElement`](JsxElement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1416 + +#### Overrides + +[`Expression`](Expression.md).[`parent`](Expression.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Expression`](Expression.md).[`pos`](Expression.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Expression`](Expression.md).[`skipCheck`](Expression.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Expression`](Expression.md).[`symbol`](Expression.md#symbol) + +*** + +### tagName + +> `readonly` **tagName**: [`JsxTagNameExpression`](../type-aliases/JsxTagNameExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1417 + +*** + +### typeArguments? + +> `readonly` `optional` **typeArguments**: [`NodeArray`](NodeArray.md)\<[`TypeNode`](TypeNode.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1418 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Expression`](Expression.md).[`forEachChild`](Expression.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Expression`](Expression.md).[`getChildAt`](Expression.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getChildCount`](Expression.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Expression`](Expression.md).[`getChildren`](Expression.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getEnd`](Expression.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Expression`](Expression.md).[`getFirstToken`](Expression.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getFullStart`](Expression.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Expression`](Expression.md).[`getFullText`](Expression.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getFullWidth`](Expression.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Expression`](Expression.md).[`getLastToken`](Expression.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getLeadingTriviaWidth`](Expression.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Expression`](Expression.md).[`getSourceFile`](Expression.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getStart`](Expression.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Expression`](Expression.md).[`getText`](Expression.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getWidth`](Expression.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/JsxOpeningFragment.md b/docs/api_docs/namespaces/ts/interfaces/JsxOpeningFragment.md new file mode 100644 index 0000000000000000000000000000000000000000..5e800aa5f32796a35cc4c8826132d63b8d7e8670 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JsxOpeningFragment.md @@ -0,0 +1,489 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JsxOpeningFragment + +# Interface: JsxOpeningFragment + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1433 + +## Extends + +- [`Expression`](Expression.md) + +## Properties + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`Expression`](Expression.md).[`_expressionBrand`](Expression.md#_expressionbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Expression`](Expression.md).[`decorators`](Expression.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Expression`](Expression.md).[`end`](Expression.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Expression`](Expression.md).[`flags`](Expression.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`JsxOpeningFragment`](../enumerations/SyntaxKind.md#jsxopeningfragment) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1434 + +#### Overrides + +[`Expression`](Expression.md).[`kind`](Expression.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Expression`](Expression.md).[`locals`](Expression.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Expression`](Expression.md).[`modifiers`](Expression.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`JsxFragment`](JsxFragment.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1435 + +#### Overrides + +[`Expression`](Expression.md).[`parent`](Expression.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Expression`](Expression.md).[`pos`](Expression.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Expression`](Expression.md).[`skipCheck`](Expression.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Expression`](Expression.md).[`symbol`](Expression.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Expression`](Expression.md).[`forEachChild`](Expression.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Expression`](Expression.md).[`getChildAt`](Expression.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getChildCount`](Expression.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Expression`](Expression.md).[`getChildren`](Expression.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getEnd`](Expression.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Expression`](Expression.md).[`getFirstToken`](Expression.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getFullStart`](Expression.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Expression`](Expression.md).[`getFullText`](Expression.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getFullWidth`](Expression.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Expression`](Expression.md).[`getLastToken`](Expression.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getLeadingTriviaWidth`](Expression.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Expression`](Expression.md).[`getSourceFile`](Expression.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getStart`](Expression.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Expression`](Expression.md).[`getText`](Expression.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getWidth`](Expression.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/JsxSelfClosingElement.md b/docs/api_docs/namespaces/ts/interfaces/JsxSelfClosingElement.md new file mode 100644 index 0000000000000000000000000000000000000000..48b7d8b00625d9a5b1962b3af00ef925e7859245 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JsxSelfClosingElement.md @@ -0,0 +1,573 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JsxSelfClosingElement + +# Interface: JsxSelfClosingElement + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1421 + +## Extends + +- [`PrimaryExpression`](PrimaryExpression.md) + +## Properties + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_expressionBrand`](PrimaryExpression.md#_expressionbrand) + +*** + +### \_leftHandSideExpressionBrand + +> **\_leftHandSideExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1086 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_leftHandSideExpressionBrand`](PrimaryExpression.md#_lefthandsideexpressionbrand) + +*** + +### \_memberExpressionBrand + +> **\_memberExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1089 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_memberExpressionBrand`](PrimaryExpression.md#_memberexpressionbrand) + +*** + +### \_primaryExpressionBrand + +> **\_primaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1092 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_primaryExpressionBrand`](PrimaryExpression.md#_primaryexpressionbrand) + +*** + +### \_unaryExpressionBrand + +> **\_unaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1066 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_unaryExpressionBrand`](PrimaryExpression.md#_unaryexpressionbrand) + +*** + +### \_updateExpressionBrand + +> **\_updateExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1071 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_updateExpressionBrand`](PrimaryExpression.md#_updateexpressionbrand) + +*** + +### attributes + +> `readonly` **attributes**: [`JsxAttributes`](JsxAttributes.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1425 + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`decorators`](PrimaryExpression.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`end`](PrimaryExpression.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`flags`](PrimaryExpression.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`JsxSelfClosingElement`](../enumerations/SyntaxKind.md#jsxselfclosingelement) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1422 + +#### Overrides + +[`PrimaryExpression`](PrimaryExpression.md).[`kind`](PrimaryExpression.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`locals`](PrimaryExpression.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`modifiers`](PrimaryExpression.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`parent`](PrimaryExpression.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`pos`](PrimaryExpression.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`skipCheck`](PrimaryExpression.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`symbol`](PrimaryExpression.md#symbol) + +*** + +### tagName + +> `readonly` **tagName**: [`JsxTagNameExpression`](../type-aliases/JsxTagNameExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1423 + +*** + +### typeArguments? + +> `readonly` `optional` **typeArguments**: [`NodeArray`](NodeArray.md)\<[`TypeNode`](TypeNode.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1424 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`forEachChild`](PrimaryExpression.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getChildAt`](PrimaryExpression.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getChildCount`](PrimaryExpression.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getChildren`](PrimaryExpression.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getEnd`](PrimaryExpression.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFirstToken`](PrimaryExpression.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFullStart`](PrimaryExpression.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFullText`](PrimaryExpression.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFullWidth`](PrimaryExpression.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getLastToken`](PrimaryExpression.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getLeadingTriviaWidth`](PrimaryExpression.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getSourceFile`](PrimaryExpression.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getStart`](PrimaryExpression.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getText`](PrimaryExpression.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getWidth`](PrimaryExpression.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/JsxSpreadAttribute.md b/docs/api_docs/namespaces/ts/interfaces/JsxSpreadAttribute.md new file mode 100644 index 0000000000000000000000000000000000000000..85de16688c5c042556363eacb7df3f018a0612ab --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JsxSpreadAttribute.md @@ -0,0 +1,521 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JsxSpreadAttribute + +# Interface: JsxSpreadAttribute + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1448 + +## Extends + +- [`ObjectLiteralElement`](ObjectLiteralElement.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`_declarationBrand`](ObjectLiteralElement.md#_declarationbrand) + +*** + +### \_objectLiteralBrand + +> **\_objectLiteralBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:798 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`_objectLiteralBrand`](ObjectLiteralElement.md#_objectliteralbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`decorators`](ObjectLiteralElement.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`end`](ObjectLiteralElement.md#end) + +*** + +### expression + +> `readonly` **expression**: [`Expression`](Expression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1451 + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`flags`](ObjectLiteralElement.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`JsxSpreadAttribute`](../enumerations/SyntaxKind.md#jsxspreadattribute) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1449 + +#### Overrides + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`kind`](ObjectLiteralElement.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`locals`](ObjectLiteralElement.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`modifiers`](ObjectLiteralElement.md#modifiers) + +*** + +### name? + +> `readonly` `optional` **name**: [`PropertyName`](../type-aliases/PropertyName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:799 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`name`](ObjectLiteralElement.md#name) + +*** + +### parent + +> `readonly` **parent**: [`JsxAttributes`](JsxAttributes.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1450 + +#### Overrides + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`parent`](ObjectLiteralElement.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`pos`](ObjectLiteralElement.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`skipCheck`](ObjectLiteralElement.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`symbol`](ObjectLiteralElement.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`forEachChild`](ObjectLiteralElement.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getChildAt`](ObjectLiteralElement.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getChildCount`](ObjectLiteralElement.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getChildren`](ObjectLiteralElement.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getEnd`](ObjectLiteralElement.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getFirstToken`](ObjectLiteralElement.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getFullStart`](ObjectLiteralElement.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getFullText`](ObjectLiteralElement.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getFullWidth`](ObjectLiteralElement.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getLastToken`](ObjectLiteralElement.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getLeadingTriviaWidth`](ObjectLiteralElement.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getSourceFile`](ObjectLiteralElement.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getStart`](ObjectLiteralElement.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getText`](ObjectLiteralElement.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getWidth`](ObjectLiteralElement.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/JsxTagNamePropertyAccess.md b/docs/api_docs/namespaces/ts/interfaces/JsxTagNamePropertyAccess.md new file mode 100644 index 0000000000000000000000000000000000000000..aae34af8d9c0bf16da03ecb45d9792dedcd35747 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JsxTagNamePropertyAccess.md @@ -0,0 +1,585 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JsxTagNamePropertyAccess + +# Interface: JsxTagNamePropertyAccess + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1407 + +## Extends + +- [`PropertyAccessExpression`](PropertyAccessExpression.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`_declarationBrand`](PropertyAccessExpression.md#_declarationbrand) + +*** + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`_expressionBrand`](PropertyAccessExpression.md#_expressionbrand) + +*** + +### \_leftHandSideExpressionBrand + +> **\_leftHandSideExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1086 + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`_leftHandSideExpressionBrand`](PropertyAccessExpression.md#_lefthandsideexpressionbrand) + +*** + +### \_memberExpressionBrand + +> **\_memberExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1089 + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`_memberExpressionBrand`](PropertyAccessExpression.md#_memberexpressionbrand) + +*** + +### \_unaryExpressionBrand + +> **\_unaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1066 + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`_unaryExpressionBrand`](PropertyAccessExpression.md#_unaryexpressionbrand) + +*** + +### \_updateExpressionBrand + +> **\_updateExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1071 + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`_updateExpressionBrand`](PropertyAccessExpression.md#_updateexpressionbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`decorators`](PropertyAccessExpression.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`end`](PropertyAccessExpression.md#end) + +*** + +### expression + +> `readonly` **expression**: [`JsxTagNameExpression`](../type-aliases/JsxTagNameExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1408 + +#### Overrides + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`expression`](PropertyAccessExpression.md#expression) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`flags`](PropertyAccessExpression.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`PropertyAccessExpression`](../enumerations/SyntaxKind.md#propertyaccessexpression) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1305 + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`kind`](PropertyAccessExpression.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`locals`](PropertyAccessExpression.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`modifiers`](PropertyAccessExpression.md#modifiers) + +*** + +### name + +> `readonly` **name**: [`MemberName`](../type-aliases/MemberName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1308 + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`name`](PropertyAccessExpression.md#name) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`parent`](PropertyAccessExpression.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`pos`](PropertyAccessExpression.md#pos) + +*** + +### questionDotToken? + +> `readonly` `optional` **questionDotToken**: [`QuestionDotToken`](../type-aliases/QuestionDotToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1307 + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`questionDotToken`](PropertyAccessExpression.md#questiondottoken) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`skipCheck`](PropertyAccessExpression.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`symbol`](PropertyAccessExpression.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`forEachChild`](PropertyAccessExpression.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`getChildAt`](PropertyAccessExpression.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`getChildCount`](PropertyAccessExpression.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`getChildren`](PropertyAccessExpression.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`getEnd`](PropertyAccessExpression.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`getFirstToken`](PropertyAccessExpression.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`getFullStart`](PropertyAccessExpression.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`getFullText`](PropertyAccessExpression.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`getFullWidth`](PropertyAccessExpression.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`getLastToken`](PropertyAccessExpression.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`getLeadingTriviaWidth`](PropertyAccessExpression.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`getSourceFile`](PropertyAccessExpression.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`getStart`](PropertyAccessExpression.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`getText`](PropertyAccessExpression.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`getWidth`](PropertyAccessExpression.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/JsxText.md b/docs/api_docs/namespaces/ts/interfaces/JsxText.md new file mode 100644 index 0000000000000000000000000000000000000000..4cbdcf4841c308343753f0d6537c1a9048de4c85 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/JsxText.md @@ -0,0 +1,521 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JsxText + +# Interface: JsxText + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1464 + +## Extends + +- [`LiteralLikeNode`](LiteralLikeNode.md) + +## Properties + +### containsOnlyTriviaWhiteSpaces + +> `readonly` **containsOnlyTriviaWhiteSpaces**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1467 + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`LiteralLikeNode`](LiteralLikeNode.md).[`decorators`](LiteralLikeNode.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`LiteralLikeNode`](LiteralLikeNode.md).[`end`](LiteralLikeNode.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`LiteralLikeNode`](LiteralLikeNode.md).[`flags`](LiteralLikeNode.md#flags) + +*** + +### hasExtendedUnicodeEscape? + +> `optional` **hasExtendedUnicodeEscape**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1221 + +#### Inherited from + +[`LiteralLikeNode`](LiteralLikeNode.md).[`hasExtendedUnicodeEscape`](LiteralLikeNode.md#hasextendedunicodeescape) + +*** + +### isUnterminated? + +> `optional` **isUnterminated**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1220 + +#### Inherited from + +[`LiteralLikeNode`](LiteralLikeNode.md).[`isUnterminated`](LiteralLikeNode.md#isunterminated) + +*** + +### kind + +> `readonly` **kind**: [`JsxText`](../enumerations/SyntaxKind.md#jsxtext) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1465 + +#### Overrides + +[`LiteralLikeNode`](LiteralLikeNode.md).[`kind`](LiteralLikeNode.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`LiteralLikeNode`](LiteralLikeNode.md).[`locals`](LiteralLikeNode.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`LiteralLikeNode`](LiteralLikeNode.md).[`modifiers`](LiteralLikeNode.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`JsxElement`](JsxElement.md) \| [`JsxFragment`](JsxFragment.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1466 + +#### Overrides + +[`LiteralLikeNode`](LiteralLikeNode.md).[`parent`](LiteralLikeNode.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`LiteralLikeNode`](LiteralLikeNode.md).[`pos`](LiteralLikeNode.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`LiteralLikeNode`](LiteralLikeNode.md).[`skipCheck`](LiteralLikeNode.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`LiteralLikeNode`](LiteralLikeNode.md).[`symbol`](LiteralLikeNode.md#symbol) + +*** + +### text + +> **text**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1219 + +#### Inherited from + +[`LiteralLikeNode`](LiteralLikeNode.md).[`text`](LiteralLikeNode.md#text) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`LiteralLikeNode`](LiteralLikeNode.md).[`forEachChild`](LiteralLikeNode.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`LiteralLikeNode`](LiteralLikeNode.md).[`getChildAt`](LiteralLikeNode.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`LiteralLikeNode`](LiteralLikeNode.md).[`getChildCount`](LiteralLikeNode.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`LiteralLikeNode`](LiteralLikeNode.md).[`getChildren`](LiteralLikeNode.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`LiteralLikeNode`](LiteralLikeNode.md).[`getEnd`](LiteralLikeNode.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`LiteralLikeNode`](LiteralLikeNode.md).[`getFirstToken`](LiteralLikeNode.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`LiteralLikeNode`](LiteralLikeNode.md).[`getFullStart`](LiteralLikeNode.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`LiteralLikeNode`](LiteralLikeNode.md).[`getFullText`](LiteralLikeNode.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`LiteralLikeNode`](LiteralLikeNode.md).[`getFullWidth`](LiteralLikeNode.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`LiteralLikeNode`](LiteralLikeNode.md).[`getLastToken`](LiteralLikeNode.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`LiteralLikeNode`](LiteralLikeNode.md).[`getLeadingTriviaWidth`](LiteralLikeNode.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`LiteralLikeNode`](LiteralLikeNode.md).[`getSourceFile`](LiteralLikeNode.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`LiteralLikeNode`](LiteralLikeNode.md).[`getStart`](LiteralLikeNode.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`LiteralLikeNode`](LiteralLikeNode.md).[`getText`](LiteralLikeNode.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`LiteralLikeNode`](LiteralLikeNode.md).[`getWidth`](LiteralLikeNode.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/KeywordToken.md b/docs/api_docs/namespaces/ts/interfaces/KeywordToken.md new file mode 100644 index 0000000000000000000000000000000000000000..76acb03fbb0ef0789a176a98bc667c42fecf3c9b --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/KeywordToken.md @@ -0,0 +1,486 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / KeywordToken + +# Interface: KeywordToken\ + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:635 + +## Extends + +- [`Token`](Token.md)\<`TKind`\> + +## Extended by + +- [`ModifierToken`](ModifierToken.md) +- [`KeywordTypeNode`](KeywordTypeNode.md) + +## Type Parameters + +• **TKind** *extends* [`KeywordSyntaxKind`](../type-aliases/KeywordSyntaxKind.md) + +## Properties + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Token`](Token.md).[`decorators`](Token.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Token`](Token.md).[`end`](Token.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Token`](Token.md).[`flags`](Token.md#flags) + +*** + +### kind + +> `readonly` **kind**: `TKind` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:619 + +#### Inherited from + +[`Token`](Token.md).[`kind`](Token.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Token`](Token.md).[`locals`](Token.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Token`](Token.md).[`modifiers`](Token.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`Token`](Token.md).[`parent`](Token.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Token`](Token.md).[`pos`](Token.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Token`](Token.md).[`skipCheck`](Token.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Token`](Token.md).[`symbol`](Token.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Token`](Token.md).[`forEachChild`](Token.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Token`](Token.md).[`getChildAt`](Token.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Token`](Token.md).[`getChildCount`](Token.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Token`](Token.md).[`getChildren`](Token.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Token`](Token.md).[`getEnd`](Token.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Token`](Token.md).[`getFirstToken`](Token.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Token`](Token.md).[`getFullStart`](Token.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Token`](Token.md).[`getFullText`](Token.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Token`](Token.md).[`getFullWidth`](Token.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Token`](Token.md).[`getLastToken`](Token.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Token`](Token.md).[`getLeadingTriviaWidth`](Token.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Token`](Token.md).[`getSourceFile`](Token.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Token`](Token.md).[`getStart`](Token.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Token`](Token.md).[`getText`](Token.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Token`](Token.md).[`getWidth`](Token.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/KeywordTypeNode.md b/docs/api_docs/namespaces/ts/interfaces/KeywordTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..dc1144d969e9bec9276db368a37f95d351f4f5f0 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/KeywordTypeNode.md @@ -0,0 +1,493 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / KeywordTypeNode + +# Interface: KeywordTypeNode\ + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:914 + +## Extends + +- [`KeywordToken`](KeywordToken.md)\<`TKind`\>.[`TypeNode`](TypeNode.md) + +## Type Parameters + +• **TKind** *extends* [`KeywordTypeSyntaxKind`](../type-aliases/KeywordTypeSyntaxKind.md) = [`KeywordTypeSyntaxKind`](../type-aliases/KeywordTypeSyntaxKind.md) + +## Properties + +### \_typeNodeBrand + +> **\_typeNodeBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:912 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`_typeNodeBrand`](TypeNode.md#_typenodebrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`decorators`](TypeNode.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`end`](TypeNode.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`flags`](TypeNode.md#flags) + +*** + +### kind + +> `readonly` **kind**: `TKind` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:915 + +#### Overrides + +[`TypeNode`](TypeNode.md).[`kind`](TypeNode.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`locals`](TypeNode.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`modifiers`](TypeNode.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`parent`](TypeNode.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`pos`](TypeNode.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`skipCheck`](TypeNode.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`symbol`](TypeNode.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`forEachChild`](TypeNode.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getChildAt`](TypeNode.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getChildCount`](TypeNode.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getChildren`](TypeNode.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getEnd`](TypeNode.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFirstToken`](TypeNode.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFullStart`](TypeNode.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFullText`](TypeNode.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFullWidth`](TypeNode.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getLastToken`](TypeNode.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getLeadingTriviaWidth`](TypeNode.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getSourceFile`](TypeNode.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getStart`](TypeNode.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getText`](TypeNode.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getWidth`](TypeNode.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/LabeledStatement.md b/docs/api_docs/namespaces/ts/interfaces/LabeledStatement.md new file mode 100644 index 0000000000000000000000000000000000000000..81cf71962c8fe43a9c50b91dfb58e6606af53238 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/LabeledStatement.md @@ -0,0 +1,505 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / LabeledStatement + +# Interface: LabeledStatement + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1584 + +## Extends + +- [`Statement`](Statement.md) + +## Properties + +### \_statementBrand + +> **\_statementBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1471 + +#### Inherited from + +[`Statement`](Statement.md).[`_statementBrand`](Statement.md#_statementbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Statement`](Statement.md).[`decorators`](Statement.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Statement`](Statement.md).[`end`](Statement.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Statement`](Statement.md).[`flags`](Statement.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`LabeledStatement`](../enumerations/SyntaxKind.md#labeledstatement) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1585 + +#### Overrides + +[`Statement`](Statement.md).[`kind`](Statement.md#kind) + +*** + +### label + +> `readonly` **label**: [`Identifier`](Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1586 + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Statement`](Statement.md).[`locals`](Statement.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Statement`](Statement.md).[`modifiers`](Statement.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`Statement`](Statement.md).[`parent`](Statement.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Statement`](Statement.md).[`pos`](Statement.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Statement`](Statement.md).[`skipCheck`](Statement.md#skipcheck) + +*** + +### statement + +> `readonly` **statement**: [`Statement`](Statement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1587 + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Statement`](Statement.md).[`symbol`](Statement.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Statement`](Statement.md).[`forEachChild`](Statement.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getChildAt`](Statement.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getChildCount`](Statement.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Statement`](Statement.md).[`getChildren`](Statement.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getEnd`](Statement.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getFirstToken`](Statement.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getFullStart`](Statement.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Statement`](Statement.md).[`getFullText`](Statement.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getFullWidth`](Statement.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getLastToken`](Statement.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getLeadingTriviaWidth`](Statement.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getSourceFile`](Statement.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getStart`](Statement.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Statement`](Statement.md).[`getText`](Statement.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getWidth`](Statement.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/LanguageService.md b/docs/api_docs/namespaces/ts/interfaces/LanguageService.md new file mode 100644 index 0000000000000000000000000000000000000000..dd7c422910831deb6f41e8330bef0d0045012e63 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/LanguageService.md @@ -0,0 +1,1797 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / LanguageService + +# Interface: LanguageService + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6270 + +## Methods + +### applyCodeActionCommand() + +#### Call Signature + +> **applyCodeActionCommand**(`action`, `formatSettings`?): `Promise`\<[`ApplyCodeActionCommandResult`](ApplyCodeActionCommandResult.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6411 + +##### Parameters + +###### action + +[`InstallPackageAction`](InstallPackageAction.md) + +###### formatSettings? + +[`FormatCodeSettings`](FormatCodeSettings.md) + +##### Returns + +`Promise`\<[`ApplyCodeActionCommandResult`](ApplyCodeActionCommandResult.md)\> + +#### Call Signature + +> **applyCodeActionCommand**(`action`, `formatSettings`?): `Promise`\<[`ApplyCodeActionCommandResult`](ApplyCodeActionCommandResult.md)[]\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6412 + +##### Parameters + +###### action + +[`InstallPackageAction`](InstallPackageAction.md)[] + +###### formatSettings? + +[`FormatCodeSettings`](FormatCodeSettings.md) + +##### Returns + +`Promise`\<[`ApplyCodeActionCommandResult`](ApplyCodeActionCommandResult.md)[]\> + +#### Call Signature + +> **applyCodeActionCommand**(`action`, `formatSettings`?): `Promise`\<[`ApplyCodeActionCommandResult`](ApplyCodeActionCommandResult.md) \| [`ApplyCodeActionCommandResult`](ApplyCodeActionCommandResult.md)[]\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6413 + +##### Parameters + +###### action + +[`InstallPackageAction`](InstallPackageAction.md) | [`InstallPackageAction`](InstallPackageAction.md)[] + +###### formatSettings? + +[`FormatCodeSettings`](FormatCodeSettings.md) + +##### Returns + +`Promise`\<[`ApplyCodeActionCommandResult`](ApplyCodeActionCommandResult.md) \| [`ApplyCodeActionCommandResult`](ApplyCodeActionCommandResult.md)[]\> + +#### Call Signature + +> **applyCodeActionCommand**(`fileName`, `action`): `Promise`\<[`ApplyCodeActionCommandResult`](ApplyCodeActionCommandResult.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6415 + +##### Parameters + +###### fileName + +`string` + +###### action + +[`InstallPackageAction`](InstallPackageAction.md) + +##### Returns + +`Promise`\<[`ApplyCodeActionCommandResult`](ApplyCodeActionCommandResult.md)\> + +##### Deprecated + +`fileName` will be ignored + +#### Call Signature + +> **applyCodeActionCommand**(`fileName`, `action`): `Promise`\<[`ApplyCodeActionCommandResult`](ApplyCodeActionCommandResult.md)[]\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6417 + +##### Parameters + +###### fileName + +`string` + +###### action + +[`InstallPackageAction`](InstallPackageAction.md)[] + +##### Returns + +`Promise`\<[`ApplyCodeActionCommandResult`](ApplyCodeActionCommandResult.md)[]\> + +##### Deprecated + +`fileName` will be ignored + +#### Call Signature + +> **applyCodeActionCommand**(`fileName`, `action`): `Promise`\<[`ApplyCodeActionCommandResult`](ApplyCodeActionCommandResult.md) \| [`ApplyCodeActionCommandResult`](ApplyCodeActionCommandResult.md)[]\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6419 + +##### Parameters + +###### fileName + +`string` + +###### action + +[`InstallPackageAction`](InstallPackageAction.md) | [`InstallPackageAction`](InstallPackageAction.md)[] + +##### Returns + +`Promise`\<[`ApplyCodeActionCommandResult`](ApplyCodeActionCommandResult.md) \| [`ApplyCodeActionCommandResult`](ApplyCodeActionCommandResult.md)[]\> + +##### Deprecated + +`fileName` will be ignored + +*** + +### cleanupSemanticCache() + +> **cleanupSemanticCache**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6272 + +This is used as a part of restarting the language service. + +#### Returns + +`void` + +*** + +### commentSelection() + +> **commentSelection**(`fileName`, `textRange`): [`TextChange`](TextChange.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6429 + +#### Parameters + +##### fileName + +`string` + +##### textRange + +[`TextRange`](TextRange.md) + +#### Returns + +[`TextChange`](TextChange.md)[] + +*** + +### dispose() + +> **dispose**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6431 + +#### Returns + +`void` + +*** + +### findReferences() + +> **findReferences**(`fileName`, `position`): `undefined` \| [`ReferencedSymbol`](ReferencedSymbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6381 + +#### Parameters + +##### fileName + +`string` + +##### position + +`number` + +#### Returns + +`undefined` \| [`ReferencedSymbol`](ReferencedSymbol.md)[] + +*** + +### findRenameLocations() + +> **findRenameLocations**(`fileName`, `position`, `findInStrings`, `findInComments`, `providePrefixAndSuffixTextForRename`?): `undefined` \| readonly [`RenameLocation`](RenameLocation.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6374 + +#### Parameters + +##### fileName + +`string` + +##### position + +`number` + +##### findInStrings + +`boolean` + +##### findInComments + +`boolean` + +##### providePrefixAndSuffixTextForRename? + +`boolean` + +#### Returns + +`undefined` \| readonly [`RenameLocation`](RenameLocation.md)[] + +*** + +### getApplicableRefactors() + +> **getApplicableRefactors**(`fileName`, `positionOrRange`, `preferences`, `triggerReason`?, `kind`?): [`ApplicableRefactorInfo`](ApplicableRefactorInfo.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6420 + +#### Parameters + +##### fileName + +`string` + +##### positionOrRange + +`number` | [`TextRange`](TextRange.md) + +##### preferences + +`undefined` | [`UserPreferences`](UserPreferences.md) + +##### triggerReason? + +[`RefactorTriggerReason`](../type-aliases/RefactorTriggerReason.md) + +##### kind? + +`string` + +#### Returns + +[`ApplicableRefactorInfo`](ApplicableRefactorInfo.md)[] + +*** + +### getBraceMatchingAtPosition() + +> **getBraceMatchingAtPosition**(`fileName`, `position`): [`TextSpan`](TextSpan.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6395 + +#### Parameters + +##### fileName + +`string` + +##### position + +`number` + +#### Returns + +[`TextSpan`](TextSpan.md)[] + +*** + +### getBreakpointStatementAtPosition() + +> **getBreakpointStatementAtPosition**(`fileName`, `position`): `undefined` \| [`TextSpan`](TextSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6369 + +#### Parameters + +##### fileName + +`string` + +##### position + +`number` + +#### Returns + +`undefined` \| [`TextSpan`](TextSpan.md) + +*** + +### getBuilderProgram() + +> **getBuilderProgram**(): `undefined` \| [`BuilderProgram`](BuilderProgram.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6426 + +#### Returns + +`undefined` \| [`BuilderProgram`](BuilderProgram.md) + +*** + +### getCodeFixesAtPosition() + +> **getCodeFixesAtPosition**(`fileName`, `start`, `end`, `errorCodes`, `formatOptions`, `preferences`): readonly [`CodeFixAction`](CodeFixAction.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6409 + +#### Parameters + +##### fileName + +`string` + +##### start + +`number` + +##### end + +`number` + +##### errorCodes + +readonly `number`[] + +##### formatOptions + +[`FormatCodeSettings`](FormatCodeSettings.md) + +##### preferences + +[`UserPreferences`](UserPreferences.md) + +#### Returns + +readonly [`CodeFixAction`](CodeFixAction.md)[] + +*** + +### getCombinedCodeFix() + +> **getCombinedCodeFix**(`scope`, `fixId`, `formatOptions`, `preferences`): [`CombinedCodeActions`](CombinedCodeActions.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6410 + +#### Parameters + +##### scope + +[`CombinedCodeFixScope`](CombinedCodeFixScope.md) + +##### fixId + +##### formatOptions + +[`FormatCodeSettings`](FormatCodeSettings.md) + +##### preferences + +[`UserPreferences`](UserPreferences.md) + +#### Returns + +[`CombinedCodeActions`](CombinedCodeActions.md) + +*** + +### getCompilerOptionsDiagnostics() + +> **getCompilerOptionsDiagnostics**(): [`Diagnostic`](Diagnostic.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6318 + +Gets global diagnostics related to the program configuration and compiler options. + +#### Returns + +[`Diagnostic`](Diagnostic.md)[] + +*** + +### getCompletionEntryDetails() + +> **getCompletionEntryDetails**(`fileName`, `position`, `entryName`, `formatOptions`, `source`, `preferences`, `data`): `undefined` \| [`CompletionEntryDetails`](CompletionEntryDetails.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6358 + +Gets the extended details for a completion entry retrieved from `getCompletionsAtPosition`. + +#### Parameters + +##### fileName + +`string` + +The path to the file + +##### position + +`number` + +A zero based index of the character where you want the entries + +##### entryName + +`string` + +The `name` from an existing completion which came from `getCompletionsAtPosition` + +##### formatOptions + +How should code samples in the completions be formatted, can be undefined for backwards compatibility + +`undefined` | [`FormatCodeSettings`](FormatCodeSettings.md) | [`FormatCodeOptions`](FormatCodeOptions.md) + +##### source + +`source` property from the completion entry + +`undefined` | `string` + +##### preferences + +User settings, can be undefined for backwards compatibility + +`undefined` | [`UserPreferences`](UserPreferences.md) + +##### data + +`data` property from the completion entry + +`undefined` | [`CompletionEntryData`](../type-aliases/CompletionEntryData.md) + +#### Returns + +`undefined` \| [`CompletionEntryDetails`](CompletionEntryDetails.md) + +*** + +### getCompletionEntrySymbol() + +> **getCompletionEntrySymbol**(`fileName`, `position`, `name`, `source`): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6359 + +#### Parameters + +##### fileName + +`string` + +##### position + +`number` + +##### name + +`string` + +##### source + +`undefined` | `string` + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +*** + +### getCompletionsAtPosition() + +> **getCompletionsAtPosition**(`fileName`, `position`, `options`, `formattingSettings`?): `undefined` \| [`WithMetadata`](../type-aliases/WithMetadata.md)\<[`CompletionInfo`](CompletionInfo.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6346 + +Gets completion entries at a particular position in a file. + +#### Parameters + +##### fileName + +`string` + +The path to the file + +##### position + +`number` + +A zero-based index of the character where you want the entries + +##### options + +An object describing how the request was triggered and what kinds +of code actions can be returned with the completions. + +`undefined` | [`GetCompletionsAtPositionOptions`](GetCompletionsAtPositionOptions.md) + +##### formattingSettings? + +[`FormatCodeSettings`](FormatCodeSettings.md) + +settings needed for calling formatting functions. + +#### Returns + +`undefined` \| [`WithMetadata`](../type-aliases/WithMetadata.md)\<[`CompletionInfo`](CompletionInfo.md)\> + +*** + +### getDefinitionAndBoundSpan() + +> **getDefinitionAndBoundSpan**(`fileName`, `position`): `undefined` \| [`DefinitionInfoAndBoundSpan`](DefinitionInfoAndBoundSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6377 + +#### Parameters + +##### fileName + +`string` + +##### position + +`number` + +#### Returns + +`undefined` \| [`DefinitionInfoAndBoundSpan`](DefinitionInfoAndBoundSpan.md) + +*** + +### getDefinitionAtPosition() + +> **getDefinitionAtPosition**(`fileName`, `position`): `undefined` \| readonly [`DefinitionInfo`](DefinitionInfo.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6376 + +#### Parameters + +##### fileName + +`string` + +##### position + +`number` + +#### Returns + +`undefined` \| readonly [`DefinitionInfo`](DefinitionInfo.md)[] + +*** + +### getDocCommentTemplateAtPosition() + +> **getDocCommentTemplateAtPosition**(`fileName`, `position`, `options`?): `undefined` \| [`TextInsertion`](TextInsertion.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6400 + +#### Parameters + +##### fileName + +`string` + +##### position + +`number` + +##### options? + +[`DocCommentTemplateOptions`](DocCommentTemplateOptions.md) + +#### Returns + +`undefined` \| [`TextInsertion`](TextInsertion.md) + +*** + +### getDocumentHighlights() + +> **getDocumentHighlights**(`fileName`, `position`, `filesToSearch`): `undefined` \| [`DocumentHighlights`](DocumentHighlights.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6382 + +#### Parameters + +##### fileName + +`string` + +##### position + +`number` + +##### filesToSearch + +`string`[] + +#### Returns + +`undefined` \| [`DocumentHighlights`](DocumentHighlights.md)[] + +*** + +### getEditsForFileRename() + +> **getEditsForFileRename**(`oldFilePath`, `newFilePath`, `formatOptions`, `preferences`): readonly [`FileTextChanges`](FileTextChanges.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6423 + +#### Parameters + +##### oldFilePath + +`string` + +##### newFilePath + +`string` + +##### formatOptions + +[`FormatCodeSettings`](FormatCodeSettings.md) + +##### preferences + +`undefined` | [`UserPreferences`](UserPreferences.md) + +#### Returns + +readonly [`FileTextChanges`](FileTextChanges.md)[] + +*** + +### getEditsForRefactor() + +> **getEditsForRefactor**(`fileName`, `formatOptions`, `positionOrRange`, `refactorName`, `actionName`, `preferences`): `undefined` \| [`RefactorEditInfo`](RefactorEditInfo.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6421 + +#### Parameters + +##### fileName + +`string` + +##### formatOptions + +[`FormatCodeSettings`](FormatCodeSettings.md) + +##### positionOrRange + +`number` | [`TextRange`](TextRange.md) + +##### refactorName + +`string` + +##### actionName + +`string` + +##### preferences + +`undefined` | [`UserPreferences`](UserPreferences.md) + +#### Returns + +`undefined` \| [`RefactorEditInfo`](RefactorEditInfo.md) + +*** + +### getEmitOutput() + +> **getEmitOutput**(`fileName`, `emitOnlyDtsFiles`?, `forceDtsEmit`?): [`EmitOutput`](EmitOutput.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6424 + +#### Parameters + +##### fileName + +`string` + +##### emitOnlyDtsFiles? + +`boolean` + +##### forceDtsEmit? + +`boolean` + +#### Returns + +[`EmitOutput`](EmitOutput.md) + +*** + +### getEncodedSemanticClassifications() + +> **getEncodedSemanticClassifications**(`fileName`, `span`, `format`?): [`Classifications`](Classifications.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6336 + +Gets semantic highlights information for a particular file. Has two formats, an older +version used by VS and a format used by VS Code. + +#### Parameters + +##### fileName + +`string` + +The path to the file + +##### span + +[`TextSpan`](TextSpan.md) + +##### format? + +[`SemanticClassificationFormat`](../enumerations/SemanticClassificationFormat.md) + +Which format to use, defaults to "original" + +#### Returns + +[`Classifications`](Classifications.md) + +a number array encoded as triples of [start, length, ClassificationType, ...]. + +*** + +### getEncodedSyntacticClassifications() + +> **getEncodedSyntacticClassifications**(`fileName`, `span`): [`Classifications`](Classifications.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6326 + +Encoded as triples of [start, length, ClassificationType]. + +#### Parameters + +##### fileName + +`string` + +##### span + +[`TextSpan`](TextSpan.md) + +#### Returns + +[`Classifications`](Classifications.md) + +*** + +### getFileReferences() + +> **getFileReferences**(`fileName`): [`ReferenceEntry`](ReferenceEntry.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6383 + +#### Parameters + +##### fileName + +`string` + +#### Returns + +[`ReferenceEntry`](ReferenceEntry.md)[] + +*** + +### getFormattingEditsAfterKeystroke() + +> **getFormattingEditsAfterKeystroke**(`fileName`, `position`, `key`, `options`): [`TextChange`](TextChange.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6399 + +#### Parameters + +##### fileName + +`string` + +##### position + +`number` + +##### key + +`string` + +##### options + +[`FormatCodeSettings`](FormatCodeSettings.md) | [`FormatCodeOptions`](FormatCodeOptions.md) + +#### Returns + +[`TextChange`](TextChange.md)[] + +*** + +### getFormattingEditsForDocument() + +> **getFormattingEditsForDocument**(`fileName`, `options`): [`TextChange`](TextChange.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6398 + +#### Parameters + +##### fileName + +`string` + +##### options + +[`FormatCodeSettings`](FormatCodeSettings.md) | [`FormatCodeOptions`](FormatCodeOptions.md) + +#### Returns + +[`TextChange`](TextChange.md)[] + +*** + +### getFormattingEditsForRange() + +> **getFormattingEditsForRange**(`fileName`, `start`, `end`, `options`): [`TextChange`](TextChange.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6397 + +#### Parameters + +##### fileName + +`string` + +##### start + +`number` + +##### end + +`number` + +##### options + +[`FormatCodeSettings`](FormatCodeSettings.md) | [`FormatCodeOptions`](FormatCodeOptions.md) + +#### Returns + +[`TextChange`](TextChange.md)[] + +*** + +### getImplementationAtPosition() + +> **getImplementationAtPosition**(`fileName`, `position`): `undefined` \| readonly [`ImplementationLocation`](ImplementationLocation.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6379 + +#### Parameters + +##### fileName + +`string` + +##### position + +`number` + +#### Returns + +`undefined` \| readonly [`ImplementationLocation`](ImplementationLocation.md)[] + +*** + +### getIndentationAtPosition() + +> **getIndentationAtPosition**(`fileName`, `position`, `options`): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6396 + +#### Parameters + +##### fileName + +`string` + +##### position + +`number` + +##### options + +[`EditorSettings`](EditorSettings.md) | [`EditorOptions`](EditorOptions.md) + +#### Returns + +`number` + +*** + +### getJsxClosingTagAtPosition() + +> **getJsxClosingTagAtPosition**(`fileName`, `position`): `undefined` \| [`JsxClosingTagInfo`](JsxClosingTagInfo.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6406 + +This will return a defined result if the position is after the `>` of the opening tag, or somewhere in the text, of a JSXElement with no closing tag. +Editors should call this after `>` is typed. + +#### Parameters + +##### fileName + +`string` + +##### position + +`number` + +#### Returns + +`undefined` \| [`JsxClosingTagInfo`](JsxClosingTagInfo.md) + +*** + +### getNameOrDottedNameSpan() + +> **getNameOrDottedNameSpan**(`fileName`, `startPos`, `endPos`): `undefined` \| [`TextSpan`](TextSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6368 + +#### Parameters + +##### fileName + +`string` + +##### startPos + +`number` + +##### endPos + +`number` + +#### Returns + +`undefined` \| [`TextSpan`](TextSpan.md) + +*** + +### getNavigateToItems() + +> **getNavigateToItems**(`searchValue`, `maxResultCount`?, `fileName`?, `excludeDtsFiles`?): [`NavigateToItem`](NavigateToItem.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6386 + +#### Parameters + +##### searchValue + +`string` + +##### maxResultCount? + +`number` + +##### fileName? + +`string` + +##### excludeDtsFiles? + +`boolean` + +#### Returns + +[`NavigateToItem`](NavigateToItem.md)[] + +*** + +### getNavigationBarItems() + +> **getNavigationBarItems**(`fileName`): [`NavigationBarItem`](NavigationBarItem.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6387 + +#### Parameters + +##### fileName + +`string` + +#### Returns + +[`NavigationBarItem`](NavigationBarItem.md)[] + +*** + +### getNavigationTree() + +> **getNavigationTree**(`fileName`): [`NavigationTree`](NavigationTree.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6388 + +#### Parameters + +##### fileName + +`string` + +#### Returns + +[`NavigationTree`](NavigationTree.md) + +*** + +### ~~getOccurrencesAtPosition()~~ + +> **getOccurrencesAtPosition**(`fileName`, `position`): `undefined` \| readonly [`ReferenceEntry`](ReferenceEntry.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6385 + +#### Parameters + +##### fileName + +`string` + +##### position + +`number` + +#### Returns + +`undefined` \| readonly [`ReferenceEntry`](ReferenceEntry.md)[] + +#### Deprecated + +*** + +### getOutliningSpans() + +> **getOutliningSpans**(`fileName`): [`OutliningSpan`](OutliningSpan.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6393 + +#### Parameters + +##### fileName + +`string` + +#### Returns + +[`OutliningSpan`](OutliningSpan.md)[] + +*** + +### getProgram() + +> **getProgram**(): `undefined` \| [`Program`](Program.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6425 + +#### Returns + +`undefined` \| [`Program`](Program.md) + +*** + +### getProps()? + +> `optional` **getProps**(): `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6433 + +#### Returns + +`string`[] + +*** + +### getQuickInfoAtPosition() + +> **getQuickInfoAtPosition**(`fileName`, `position`): `undefined` \| [`QuickInfo`](QuickInfo.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6367 + +Gets semantic information about the identifier at a particular position in a +file. Quick info is what you typically see when you hover in an editor. + +#### Parameters + +##### fileName + +`string` + +The path to the file + +##### position + +`number` + +A zero-based index of the character where you want the quick info + +#### Returns + +`undefined` \| [`QuickInfo`](QuickInfo.md) + +*** + +### getReferencesAtPosition() + +> **getReferencesAtPosition**(`fileName`, `position`): `undefined` \| [`ReferenceEntry`](ReferenceEntry.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6380 + +#### Parameters + +##### fileName + +`string` + +##### position + +`number` + +#### Returns + +`undefined` \| [`ReferenceEntry`](ReferenceEntry.md)[] + +*** + +### getRenameInfo() + +#### Call Signature + +> **getRenameInfo**(`fileName`, `position`, `preferences`): [`RenameInfo`](../type-aliases/RenameInfo.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6371 + +##### Parameters + +###### fileName + +`string` + +###### position + +`number` + +###### preferences + +[`UserPreferences`](UserPreferences.md) + +##### Returns + +[`RenameInfo`](../type-aliases/RenameInfo.md) + +#### Call Signature + +> **getRenameInfo**(`fileName`, `position`, `options`?): [`RenameInfo`](../type-aliases/RenameInfo.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6373 + +##### Parameters + +###### fileName + +`string` + +###### position + +`number` + +###### options? + +[`RenameInfoOptions`](RenameInfoOptions.md) + +##### Returns + +[`RenameInfo`](../type-aliases/RenameInfo.md) + +##### Deprecated + +Use the signature with `UserPreferences` instead. + +*** + +### getSemanticClassifications() + +#### Call Signature + +> **getSemanticClassifications**(`fileName`, `span`): [`ClassifiedSpan`](ClassifiedSpan.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6323 + +##### Parameters + +###### fileName + +`string` + +###### span + +[`TextSpan`](TextSpan.md) + +##### Returns + +[`ClassifiedSpan`](ClassifiedSpan.md)[] + +##### Deprecated + +Use getEncodedSemanticClassifications instead. + +#### Call Signature + +> **getSemanticClassifications**(`fileName`, `span`, `format`): [`ClassifiedSpan`](ClassifiedSpan.md)[] \| [`ClassifiedSpan2020`](ClassifiedSpan2020.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6324 + +##### Parameters + +###### fileName + +`string` + +###### span + +[`TextSpan`](TextSpan.md) + +###### format + +[`SemanticClassificationFormat`](../enumerations/SemanticClassificationFormat.md) + +##### Returns + +[`ClassifiedSpan`](ClassifiedSpan.md)[] \| [`ClassifiedSpan2020`](ClassifiedSpan2020.md)[] + +*** + +### getSemanticDiagnostics() + +> **getSemanticDiagnostics**(`fileName`): [`Diagnostic`](Diagnostic.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6306 + +Gets warnings or errors indicating type system issues in a given file. +Requesting semantic diagnostics may start up the type system and +run deferred work, so the first call may take longer than subsequent calls. + +Unlike the other get*Diagnostics functions, these diagnostics can potentially not +include a reference to a source file. Specifically, the first time this is called, +it will return global diagnostics with no associated location. + +To contrast the differences between semantic and syntactic diagnostics, consider the +sentence: "The sun is green." is syntactically correct; those are real English words with +correct sentence structure. However, it is semantically invalid, because it is not true. + +#### Parameters + +##### fileName + +`string` + +A path to the file you want semantic diagnostics for + +#### Returns + +[`Diagnostic`](Diagnostic.md)[] + +*** + +### getSignatureHelpItems() + +> **getSignatureHelpItems**(`fileName`, `position`, `options`): `undefined` \| [`SignatureHelpItems`](SignatureHelpItems.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6370 + +#### Parameters + +##### fileName + +`string` + +##### position + +`number` + +##### options + +`undefined` | [`SignatureHelpItemsOptions`](SignatureHelpItemsOptions.md) + +#### Returns + +`undefined` \| [`SignatureHelpItems`](SignatureHelpItems.md) + +*** + +### getSmartSelectionRange() + +> **getSmartSelectionRange**(`fileName`, `position`): [`SelectionRange`](SelectionRange.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6375 + +#### Parameters + +##### fileName + +`string` + +##### position + +`number` + +#### Returns + +[`SelectionRange`](SelectionRange.md) + +*** + +### getSpanOfEnclosingComment() + +> **getSpanOfEnclosingComment**(`fileName`, `position`, `onlyMultiLine`): `undefined` \| [`TextSpan`](TextSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6407 + +#### Parameters + +##### fileName + +`string` + +##### position + +`number` + +##### onlyMultiLine + +`boolean` + +#### Returns + +`undefined` \| [`TextSpan`](TextSpan.md) + +*** + +### getSuggestionDiagnostics() + +> **getSuggestionDiagnostics**(`fileName`): [`DiagnosticWithLocation`](DiagnosticWithLocation.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6314 + +Gets suggestion diagnostics for a specific file. These diagnostics tend to +proactively suggest refactors, as opposed to diagnostics that indicate +potentially incorrect runtime behavior. + +#### Parameters + +##### fileName + +`string` + +A path to the file you want semantic diagnostics for + +#### Returns + +[`DiagnosticWithLocation`](DiagnosticWithLocation.md)[] + +*** + +### getSyntacticClassifications() + +#### Call Signature + +> **getSyntacticClassifications**(`fileName`, `span`): [`ClassifiedSpan`](ClassifiedSpan.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6320 + +##### Parameters + +###### fileName + +`string` + +###### span + +[`TextSpan`](TextSpan.md) + +##### Returns + +[`ClassifiedSpan`](ClassifiedSpan.md)[] + +##### Deprecated + +Use getEncodedSyntacticClassifications instead. + +#### Call Signature + +> **getSyntacticClassifications**(`fileName`, `span`, `format`): [`ClassifiedSpan`](ClassifiedSpan.md)[] \| [`ClassifiedSpan2020`](ClassifiedSpan2020.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6321 + +##### Parameters + +###### fileName + +`string` + +###### span + +[`TextSpan`](TextSpan.md) + +###### format + +[`SemanticClassificationFormat`](../enumerations/SemanticClassificationFormat.md) + +##### Returns + +[`ClassifiedSpan`](ClassifiedSpan.md)[] \| [`ClassifiedSpan2020`](ClassifiedSpan2020.md)[] + +*** + +### getSyntacticDiagnostics() + +> **getSyntacticDiagnostics**(`fileName`): [`DiagnosticWithLocation`](DiagnosticWithLocation.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6290 + +Gets errors indicating invalid syntax in a file. + +In English, "this cdeo have, erorrs" is syntactically invalid because it has typos, +grammatical errors, and misplaced punctuation. Likewise, examples of syntax +errors in TypeScript are missing parentheses in an `if` statement, mismatched +curly braces, and using a reserved keyword as a variable name. + +These diagnostics are inexpensive to compute and don't require knowledge of +other files. Note that a non-empty result increases the likelihood of false positives +from `getSemanticDiagnostics`. + +While these represent the majority of syntax-related diagnostics, there are some +that require the type system, which will be present in `getSemanticDiagnostics`. + +#### Parameters + +##### fileName + +`string` + +A path to the file you want syntactic diagnostics for + +#### Returns + +[`DiagnosticWithLocation`](DiagnosticWithLocation.md)[] + +*** + +### getTodoComments() + +> **getTodoComments**(`fileName`, `descriptors`): [`TodoComment`](TodoComment.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6394 + +#### Parameters + +##### fileName + +`string` + +##### descriptors + +[`TodoCommentDescriptor`](TodoCommentDescriptor.md)[] + +#### Returns + +[`TodoComment`](TodoComment.md)[] + +*** + +### getTypeDefinitionAtPosition() + +> **getTypeDefinitionAtPosition**(`fileName`, `position`): `undefined` \| readonly [`DefinitionInfo`](DefinitionInfo.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6378 + +#### Parameters + +##### fileName + +`string` + +##### position + +`number` + +#### Returns + +`undefined` \| readonly [`DefinitionInfo`](DefinitionInfo.md)[] + +*** + +### isValidBraceCompletionAtPosition() + +> **isValidBraceCompletionAtPosition**(`fileName`, `position`, `openingBrace`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6401 + +#### Parameters + +##### fileName + +`string` + +##### position + +`number` + +##### openingBrace + +`number` + +#### Returns + +`boolean` + +*** + +### organizeImports() + +> **organizeImports**(`args`, `formatOptions`, `preferences`): readonly [`FileTextChanges`](FileTextChanges.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6422 + +#### Parameters + +##### args + +[`OrganizeImportsArgs`](OrganizeImportsArgs.md) + +##### formatOptions + +[`FormatCodeSettings`](FormatCodeSettings.md) + +##### preferences + +`undefined` | [`UserPreferences`](UserPreferences.md) + +#### Returns + +readonly [`FileTextChanges`](FileTextChanges.md)[] + +*** + +### prepareCallHierarchy() + +> **prepareCallHierarchy**(`fileName`, `position`): `undefined` \| [`CallHierarchyItem`](CallHierarchyItem.md) \| [`CallHierarchyItem`](CallHierarchyItem.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6389 + +#### Parameters + +##### fileName + +`string` + +##### position + +`number` + +#### Returns + +`undefined` \| [`CallHierarchyItem`](CallHierarchyItem.md) \| [`CallHierarchyItem`](CallHierarchyItem.md)[] + +*** + +### provideCallHierarchyIncomingCalls() + +> **provideCallHierarchyIncomingCalls**(`fileName`, `position`): [`CallHierarchyIncomingCall`](CallHierarchyIncomingCall.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6390 + +#### Parameters + +##### fileName + +`string` + +##### position + +`number` + +#### Returns + +[`CallHierarchyIncomingCall`](CallHierarchyIncomingCall.md)[] + +*** + +### provideCallHierarchyOutgoingCalls() + +> **provideCallHierarchyOutgoingCalls**(`fileName`, `position`): [`CallHierarchyOutgoingCall`](CallHierarchyOutgoingCall.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6391 + +#### Parameters + +##### fileName + +`string` + +##### position + +`number` + +#### Returns + +[`CallHierarchyOutgoingCall`](CallHierarchyOutgoingCall.md)[] + +*** + +### provideInlayHints() + +> **provideInlayHints**(`fileName`, `span`, `preferences`): [`InlayHint`](InlayHint.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6392 + +#### Parameters + +##### fileName + +`string` + +##### span + +[`TextSpan`](TextSpan.md) + +##### preferences + +`undefined` | [`UserPreferences`](UserPreferences.md) + +#### Returns + +[`InlayHint`](InlayHint.md)[] + +*** + +### toggleLineComment() + +> **toggleLineComment**(`fileName`, `textRange`): [`TextChange`](TextChange.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6427 + +#### Parameters + +##### fileName + +`string` + +##### textRange + +[`TextRange`](TextRange.md) + +#### Returns + +[`TextChange`](TextChange.md)[] + +*** + +### toggleMultilineComment() + +> **toggleMultilineComment**(`fileName`, `textRange`): [`TextChange`](TextChange.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6428 + +#### Parameters + +##### fileName + +`string` + +##### textRange + +[`TextRange`](TextRange.md) + +#### Returns + +[`TextChange`](TextChange.md)[] + +*** + +### toLineColumnOffset()? + +> `optional` **toLineColumnOffset**(`fileName`, `position`): [`LineAndCharacter`](LineAndCharacter.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6408 + +#### Parameters + +##### fileName + +`string` + +##### position + +`number` + +#### Returns + +[`LineAndCharacter`](LineAndCharacter.md) + +*** + +### uncommentSelection() + +> **uncommentSelection**(`fileName`, `textRange`): [`TextChange`](TextChange.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6430 + +#### Parameters + +##### fileName + +`string` + +##### textRange + +[`TextRange`](TextRange.md) + +#### Returns + +[`TextChange`](TextChange.md)[] + +*** + +### updateRootFiles()? + +> `optional` **updateRootFiles**(`rootFiles`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6432 + +#### Parameters + +##### rootFiles + +`string`[] + +#### Returns + +`void` diff --git a/docs/api_docs/namespaces/ts/interfaces/LanguageServiceHost.md b/docs/api_docs/namespaces/ts/interfaces/LanguageServiceHost.md new file mode 100644 index 0000000000000000000000000000000000000000..a1c48abf7ffd534a5a265d2557a26afeb2c77c4d --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/LanguageServiceHost.md @@ -0,0 +1,737 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / LanguageServiceHost + +# Interface: LanguageServiceHost + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6222 + +Used by services to specify the minimum host area required to set up source files under any compilation settings + +## Extends + +- [`GetEffectiveTypeRootsHost`](GetEffectiveTypeRootsHost.md).[`MinimalResolutionCacheHost`](MinimalResolutionCacheHost.md) + +## Properties + +### shouldCompletionSortCustom? + +> `optional` **shouldCompletionSortCustom**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6259 + +*** + +### uiProps? + +> `optional` **uiProps**: `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6260 + +## Methods + +### clearProps()? + +> `optional` **clearProps**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6261 + +#### Returns + +`void` + +*** + +### directoryExists()? + +> `optional` **directoryExists**(`directoryName`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4337 + +#### Parameters + +##### directoryName + +`string` + +#### Returns + +`boolean` + +#### Inherited from + +[`MinimalResolutionCacheHost`](MinimalResolutionCacheHost.md).[`directoryExists`](MinimalResolutionCacheHost.md#directoryexists) + +*** + +### error()? + +> `optional` **error**(`s`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6237 + +#### Parameters + +##### s + +`string` + +#### Returns + +`void` + +*** + +### fileExists() + +> **fileExists**(`path`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6242 + +#### Parameters + +##### path + +`string` + +#### Returns + +`boolean` + +#### Overrides + +[`MinimalResolutionCacheHost`](MinimalResolutionCacheHost.md).[`fileExists`](MinimalResolutionCacheHost.md#fileexists) + +*** + +### getCancellationToken()? + +> `optional` **getCancellationToken**(): [`HostCancellationToken`](HostCancellationToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6232 + +#### Returns + +[`HostCancellationToken`](HostCancellationToken.md) + +*** + +### getCompilationSettings() + +> **getCompilationSettings**(): [`CompilerOptions`](CompilerOptions.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6223 + +#### Returns + +[`CompilerOptions`](CompilerOptions.md) + +#### Overrides + +[`MinimalResolutionCacheHost`](MinimalResolutionCacheHost.md).[`getCompilationSettings`](MinimalResolutionCacheHost.md#getcompilationsettings) + +*** + +### getCompilerHost()? + +> `optional` **getCompilerHost**(): `undefined` \| [`CompilerHost`](CompilerHost.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3361 + +#### Returns + +`undefined` \| [`CompilerHost`](CompilerHost.md) + +#### Inherited from + +[`MinimalResolutionCacheHost`](MinimalResolutionCacheHost.md).[`getCompilerHost`](MinimalResolutionCacheHost.md#getcompilerhost) + +*** + +### getCurrentDirectory() + +> **getCurrentDirectory**(): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6233 + +#### Returns + +`string` + +#### Overrides + +[`MinimalResolutionCacheHost`](MinimalResolutionCacheHost.md).[`getCurrentDirectory`](MinimalResolutionCacheHost.md#getcurrentdirectory) + +*** + +### getCustomTransformers()? + +> `optional` **getCustomTransformers**(): `undefined` \| [`CustomTransformers`](CustomTransformers.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6251 + +Gets a set of custom transformers to use during emit. + +#### Returns + +`undefined` \| [`CustomTransformers`](CustomTransformers.md) + +*** + +### getDefaultLibFileName() + +> **getDefaultLibFileName**(`options`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6234 + +#### Parameters + +##### options + +[`CompilerOptions`](CompilerOptions.md) + +#### Returns + +`string` + +*** + +### getDirectories()? + +> `optional` **getDirectories**(`directoryName`): `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6247 + +#### Parameters + +##### directoryName + +`string` + +#### Returns + +`string`[] + +#### Overrides + +[`MinimalResolutionCacheHost`](MinimalResolutionCacheHost.md).[`getDirectories`](MinimalResolutionCacheHost.md#getdirectories) + +*** + +### getFileCheckedModuleInfo()? + +> `optional` **getFileCheckedModuleInfo**(`containFilePath`): [`FileCheckModuleInfo`](FileCheckModuleInfo.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6258 + +#### Parameters + +##### containFilePath + +`string` + +#### Returns + +[`FileCheckModuleInfo`](FileCheckModuleInfo.md) + +#### Overrides + +[`MinimalResolutionCacheHost`](MinimalResolutionCacheHost.md).[`getFileCheckedModuleInfo`](MinimalResolutionCacheHost.md#getfilecheckedmoduleinfo) + +*** + +### getJsDocNodeCheckedConfig()? + +> `optional` **getJsDocNodeCheckedConfig**(`jsDocFileCheckInfo`, `symbolSourceFilePath`): [`JsDocNodeCheckConfig`](JsDocNodeCheckConfig.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6256 + +#### Parameters + +##### jsDocFileCheckInfo + +[`FileCheckModuleInfo`](FileCheckModuleInfo.md) + +##### symbolSourceFilePath + +`string` + +#### Returns + +[`JsDocNodeCheckConfig`](JsDocNodeCheckConfig.md) + +#### Overrides + +[`MinimalResolutionCacheHost`](MinimalResolutionCacheHost.md).[`getJsDocNodeCheckedConfig`](MinimalResolutionCacheHost.md#getjsdocnodecheckedconfig) + +*** + +### getJsDocNodeConditionCheckedResult()? + +> `optional` **getJsDocNodeConditionCheckedResult**(`jsDocFileCheckedInfo`, `jsDocs`): [`ConditionCheckResult`](ConditionCheckResult.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6257 + +#### Parameters + +##### jsDocFileCheckedInfo + +[`FileCheckModuleInfo`](FileCheckModuleInfo.md) + +##### jsDocs + +[`JsDocTagInfo`](JsDocTagInfo.md)[] + +#### Returns + +[`ConditionCheckResult`](ConditionCheckResult.md) + +#### Overrides + +[`MinimalResolutionCacheHost`](MinimalResolutionCacheHost.md).[`getJsDocNodeConditionCheckedResult`](MinimalResolutionCacheHost.md#getjsdocnodeconditioncheckedresult) + +*** + +### getLocalizedDiagnosticMessages()? + +> `optional` **getLocalizedDiagnosticMessages**(): `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6231 + +#### Returns + +`any` + +*** + +### getNewLine()? + +> `optional` **getNewLine**(): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6224 + +#### Returns + +`string` + +*** + +### getParsedCommandLine()? + +> `optional` **getParsedCommandLine**(`fileName`): `undefined` \| [`ParsedCommandLine`](ParsedCommandLine.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6255 + +#### Parameters + +##### fileName + +`string` + +#### Returns + +`undefined` \| [`ParsedCommandLine`](ParsedCommandLine.md) + +*** + +### getProjectReferences()? + +> `optional` **getProjectReferences**(): `undefined` \| readonly [`ProjectReference`](ProjectReference.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6230 + +#### Returns + +`undefined` \| readonly [`ProjectReference`](ProjectReference.md)[] + +*** + +### getProjectVersion()? + +> `optional` **getProjectVersion**(): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6225 + +#### Returns + +`string` + +*** + +### getResolvedModuleWithFailedLookupLocationsFromCache()? + +> `optional` **getResolvedModuleWithFailedLookupLocationsFromCache**(`modulename`, `containingFile`, `resolutionMode`?): `undefined` \| [`ResolvedModuleWithFailedLookupLocations`](ResolvedModuleWithFailedLookupLocations.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6245 + +#### Parameters + +##### modulename + +`string` + +##### containingFile + +`string` + +##### resolutionMode? + +[`CommonJS`](../enumerations/ModuleKind.md#commonjs) | [`ESNext`](../enumerations/ModuleKind.md#esnext) + +#### Returns + +`undefined` \| [`ResolvedModuleWithFailedLookupLocations`](ResolvedModuleWithFailedLookupLocations.md) + +*** + +### getScriptFileNames() + +> **getScriptFileNames**(): `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6226 + +#### Returns + +`string`[] + +*** + +### getScriptKind()? + +> `optional` **getScriptKind**(`fileName`): [`ScriptKind`](../enumerations/ScriptKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6227 + +#### Parameters + +##### fileName + +`string` + +#### Returns + +[`ScriptKind`](../enumerations/ScriptKind.md) + +*** + +### getScriptSnapshot() + +> **getScriptSnapshot**(`fileName`): `undefined` \| [`IScriptSnapshot`](IScriptSnapshot.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6229 + +#### Parameters + +##### fileName + +`string` + +#### Returns + +`undefined` \| [`IScriptSnapshot`](IScriptSnapshot.md) + +*** + +### getScriptVersion() + +> **getScriptVersion**(`fileName`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6228 + +#### Parameters + +##### fileName + +`string` + +#### Returns + +`string` + +*** + +### getTypeRootsVersion()? + +> `optional` **getTypeRootsVersion**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6243 + +#### Returns + +`number` + +*** + +### installPackage()? + +> `optional` **installPackage**(`options`): `Promise`\<[`ApplyCodeActionCommandResult`](ApplyCodeActionCommandResult.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6253 + +#### Parameters + +##### options + +[`InstallPackageOptions`](InstallPackageOptions.md) + +#### Returns + +`Promise`\<[`ApplyCodeActionCommandResult`](ApplyCodeActionCommandResult.md)\> + +*** + +### isKnownTypesPackageName()? + +> `optional` **isKnownTypesPackageName**(`name`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6252 + +#### Parameters + +##### name + +`string` + +#### Returns + +`boolean` + +*** + +### log()? + +> `optional` **log**(`s`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6235 + +#### Parameters + +##### s + +`string` + +#### Returns + +`void` + +*** + +### readDirectory()? + +> `optional` **readDirectory**(`path`, `extensions`?, `exclude`?, `include`?, `depth`?): `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6239 + +#### Parameters + +##### path + +`string` + +##### extensions? + +readonly `string`[] + +##### exclude? + +readonly `string`[] + +##### include? + +readonly `string`[] + +##### depth? + +`number` + +#### Returns + +`string`[] + +*** + +### readFile() + +> **readFile**(`path`, `encoding`?): `undefined` \| `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6241 + +#### Parameters + +##### path + +`string` + +##### encoding? + +`string` + +#### Returns + +`undefined` \| `string` + +#### Overrides + +[`MinimalResolutionCacheHost`](MinimalResolutionCacheHost.md).[`readFile`](MinimalResolutionCacheHost.md#readfile) + +*** + +### realpath()? + +> `optional` **realpath**(`path`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6240 + +Resolve a symbolic link. + +#### Parameters + +##### path + +`string` + +#### Returns + +`string` + +#### See + +https://nodejs.org/api/fs.html#fs_fs_realpathsync_path_options + +#### Overrides + +[`MinimalResolutionCacheHost`](MinimalResolutionCacheHost.md).[`realpath`](MinimalResolutionCacheHost.md#realpath) + +*** + +### resolveModuleNames()? + +> `optional` **resolveModuleNames**(`moduleNames`, `containingFile`, `reusedNames`, `redirectedReference`, `options`, `containingSourceFile`?): (`undefined` \| [`ResolvedModule`](ResolvedModule.md))[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6244 + +#### Parameters + +##### moduleNames + +`string`[] + +##### containingFile + +`string` + +##### reusedNames + +`undefined` | `string`[] + +##### redirectedReference + +`undefined` | [`ResolvedProjectReference`](ResolvedProjectReference.md) + +##### options + +[`CompilerOptions`](CompilerOptions.md) + +##### containingSourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +(`undefined` \| [`ResolvedModule`](ResolvedModule.md))[] + +*** + +### resolveTypeReferenceDirectives()? + +> `optional` **resolveTypeReferenceDirectives**(`typeDirectiveNames`, `containingFile`, `redirectedReference`, `options`, `containingFileMode`?): (`undefined` \| [`ResolvedTypeReferenceDirective`](ResolvedTypeReferenceDirective.md))[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6246 + +#### Parameters + +##### typeDirectiveNames + +`string`[] | [`FileReference`](FileReference.md)[] + +##### containingFile + +`string` + +##### redirectedReference + +`undefined` | [`ResolvedProjectReference`](ResolvedProjectReference.md) + +##### options + +[`CompilerOptions`](CompilerOptions.md) + +##### containingFileMode? + +[`CommonJS`](../enumerations/ModuleKind.md#commonjs) | [`ESNext`](../enumerations/ModuleKind.md#esnext) + +#### Returns + +(`undefined` \| [`ResolvedTypeReferenceDirective`](ResolvedTypeReferenceDirective.md))[] + +*** + +### trace()? + +> `optional` **trace**(`s`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6236 + +#### Parameters + +##### s + +`string` + +#### Returns + +`void` + +#### Overrides + +[`MinimalResolutionCacheHost`](MinimalResolutionCacheHost.md).[`trace`](MinimalResolutionCacheHost.md#trace) + +*** + +### useCaseSensitiveFileNames()? + +> `optional` **useCaseSensitiveFileNames**(): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6238 + +#### Returns + +`boolean` + +#### Overrides + +`MinimalResolutionCacheHost.useCaseSensitiveFileNames` + +*** + +### writeFile()? + +> `optional` **writeFile**(`fileName`, `content`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6254 + +#### Parameters + +##### fileName + +`string` + +##### content + +`string` + +#### Returns + +`void` diff --git a/docs/api_docs/namespaces/ts/interfaces/LeftHandSideExpression.md b/docs/api_docs/namespaces/ts/interfaces/LeftHandSideExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..4140541ab3440a1bcdf7329fcb3a463d52474cc8 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/LeftHandSideExpression.md @@ -0,0 +1,528 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / LeftHandSideExpression + +# Interface: LeftHandSideExpression + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1085 + +## Extends + +- [`UpdateExpression`](UpdateExpression.md) + +## Extended by + +- [`PartiallyEmittedExpression`](PartiallyEmittedExpression.md) +- [`MemberExpression`](MemberExpression.md) +- [`CallExpression`](CallExpression.md) +- [`NonNullExpression`](NonNullExpression.md) + +## Properties + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`_expressionBrand`](UpdateExpression.md#_expressionbrand) + +*** + +### \_leftHandSideExpressionBrand + +> **\_leftHandSideExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1086 + +*** + +### \_unaryExpressionBrand + +> **\_unaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1066 + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`_unaryExpressionBrand`](UpdateExpression.md#_unaryexpressionbrand) + +*** + +### \_updateExpressionBrand + +> **\_updateExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1071 + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`_updateExpressionBrand`](UpdateExpression.md#_updateexpressionbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`decorators`](UpdateExpression.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`end`](UpdateExpression.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`flags`](UpdateExpression.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`SyntaxKind`](../enumerations/SyntaxKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:598 + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`kind`](UpdateExpression.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`locals`](UpdateExpression.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`modifiers`](UpdateExpression.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`parent`](UpdateExpression.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`pos`](UpdateExpression.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`skipCheck`](UpdateExpression.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`symbol`](UpdateExpression.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`forEachChild`](UpdateExpression.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`getChildAt`](UpdateExpression.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`getChildCount`](UpdateExpression.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`getChildren`](UpdateExpression.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`getEnd`](UpdateExpression.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`getFirstToken`](UpdateExpression.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`getFullStart`](UpdateExpression.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`getFullText`](UpdateExpression.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`getFullWidth`](UpdateExpression.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`getLastToken`](UpdateExpression.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`getLeadingTriviaWidth`](UpdateExpression.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`getSourceFile`](UpdateExpression.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`getStart`](UpdateExpression.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`getText`](UpdateExpression.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`getWidth`](UpdateExpression.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/LineAndCharacter.md b/docs/api_docs/namespaces/ts/interfaces/LineAndCharacter.md new file mode 100644 index 0000000000000000000000000000000000000000..8a3b93d302164d9e9bd751ab7c44380ae94494bc --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/LineAndCharacter.md @@ -0,0 +1,27 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / LineAndCharacter + +# Interface: LineAndCharacter + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3276 + +## Properties + +### character + +> **character**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3279 + +*** + +### line + +> **line**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3278 + +0-based. diff --git a/docs/api_docs/namespaces/ts/interfaces/LiteralExpression.md b/docs/api_docs/namespaces/ts/interfaces/LiteralExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..a64e6b64fe0277a2a32dd8286011d1b081c69d30 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/LiteralExpression.md @@ -0,0 +1,601 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / LiteralExpression + +# Interface: LiteralExpression + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1226 + +## Extends + +- [`LiteralLikeNode`](LiteralLikeNode.md).[`PrimaryExpression`](PrimaryExpression.md) + +## Extended by + +- [`StringLiteral`](StringLiteral.md) +- [`RegularExpressionLiteral`](RegularExpressionLiteral.md) +- [`NoSubstitutionTemplateLiteral`](NoSubstitutionTemplateLiteral.md) +- [`NumericLiteral`](NumericLiteral.md) +- [`BigIntLiteral`](BigIntLiteral.md) + +## Properties + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_expressionBrand`](PrimaryExpression.md#_expressionbrand) + +*** + +### \_leftHandSideExpressionBrand + +> **\_leftHandSideExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1086 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_leftHandSideExpressionBrand`](PrimaryExpression.md#_lefthandsideexpressionbrand) + +*** + +### \_literalExpressionBrand + +> **\_literalExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1227 + +*** + +### \_memberExpressionBrand + +> **\_memberExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1089 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_memberExpressionBrand`](PrimaryExpression.md#_memberexpressionbrand) + +*** + +### \_primaryExpressionBrand + +> **\_primaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1092 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_primaryExpressionBrand`](PrimaryExpression.md#_primaryexpressionbrand) + +*** + +### \_unaryExpressionBrand + +> **\_unaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1066 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_unaryExpressionBrand`](PrimaryExpression.md#_unaryexpressionbrand) + +*** + +### \_updateExpressionBrand + +> **\_updateExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1071 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_updateExpressionBrand`](PrimaryExpression.md#_updateexpressionbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`decorators`](PrimaryExpression.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`end`](PrimaryExpression.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`flags`](PrimaryExpression.md#flags) + +*** + +### hasExtendedUnicodeEscape? + +> `optional` **hasExtendedUnicodeEscape**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1221 + +#### Inherited from + +[`LiteralLikeNode`](LiteralLikeNode.md).[`hasExtendedUnicodeEscape`](LiteralLikeNode.md#hasextendedunicodeescape) + +*** + +### isUnterminated? + +> `optional` **isUnterminated**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1220 + +#### Inherited from + +[`LiteralLikeNode`](LiteralLikeNode.md).[`isUnterminated`](LiteralLikeNode.md#isunterminated) + +*** + +### kind + +> `readonly` **kind**: [`SyntaxKind`](../enumerations/SyntaxKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:598 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`kind`](PrimaryExpression.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`locals`](PrimaryExpression.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`modifiers`](PrimaryExpression.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`parent`](PrimaryExpression.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`pos`](PrimaryExpression.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`skipCheck`](PrimaryExpression.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`symbol`](PrimaryExpression.md#symbol) + +*** + +### text + +> **text**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1219 + +#### Inherited from + +[`LiteralLikeNode`](LiteralLikeNode.md).[`text`](LiteralLikeNode.md#text) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`forEachChild`](PrimaryExpression.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getChildAt`](PrimaryExpression.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getChildCount`](PrimaryExpression.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getChildren`](PrimaryExpression.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getEnd`](PrimaryExpression.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFirstToken`](PrimaryExpression.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFullStart`](PrimaryExpression.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFullText`](PrimaryExpression.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFullWidth`](PrimaryExpression.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getLastToken`](PrimaryExpression.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getLeadingTriviaWidth`](PrimaryExpression.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getSourceFile`](PrimaryExpression.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getStart`](PrimaryExpression.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getText`](PrimaryExpression.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getWidth`](PrimaryExpression.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/LiteralLikeNode.md b/docs/api_docs/namespaces/ts/interfaces/LiteralLikeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..17f9c5058aaff4e0fa4c48b22afbc995a7e5ca46 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/LiteralLikeNode.md @@ -0,0 +1,507 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / LiteralLikeNode + +# Interface: LiteralLikeNode + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1218 + +## Extends + +- [`Node`](Node.md) + +## Extended by + +- [`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md) +- [`LiteralExpression`](LiteralExpression.md) +- [`JsxText`](JsxText.md) + +## Properties + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`decorators`](Node.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Node`](Node.md).[`end`](Node.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Node`](Node.md).[`flags`](Node.md#flags) + +*** + +### hasExtendedUnicodeEscape? + +> `optional` **hasExtendedUnicodeEscape**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1221 + +*** + +### isUnterminated? + +> `optional` **isUnterminated**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1220 + +*** + +### kind + +> `readonly` **kind**: [`SyntaxKind`](../enumerations/SyntaxKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:598 + +#### Inherited from + +[`Node`](Node.md).[`kind`](Node.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Node`](Node.md).[`locals`](Node.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`modifiers`](Node.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`Node`](Node.md).[`parent`](Node.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Node`](Node.md).[`pos`](Node.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Node`](Node.md).[`skipCheck`](Node.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Node`](Node.md).[`symbol`](Node.md#symbol) + +*** + +### text + +> **text**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1219 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Node`](Node.md).[`forEachChild`](Node.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getChildAt`](Node.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getChildCount`](Node.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Node`](Node.md).[`getChildren`](Node.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getEnd`](Node.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getFirstToken`](Node.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullStart`](Node.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getFullText`](Node.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullWidth`](Node.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getLastToken`](Node.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getLeadingTriviaWidth`](Node.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Node`](Node.md).[`getSourceFile`](Node.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getStart`](Node.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getText`](Node.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getWidth`](Node.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/LiteralType.md b/docs/api_docs/namespaces/ts/interfaces/LiteralType.md new file mode 100644 index 0000000000000000000000000000000000000000..c25946eab876291e534d2791423b30d30b2936bc --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/LiteralType.md @@ -0,0 +1,477 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / LiteralType + +# Interface: LiteralType + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2776 + +## Extends + +- [`Type`](Type.md) + +## Extended by + +- [`StringLiteralType`](StringLiteralType.md) +- [`NumberLiteralType`](NumberLiteralType.md) +- [`BigIntLiteralType`](BigIntLiteralType.md) + +## Properties + +### aliasSymbol? + +> `optional` **aliasSymbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2773 + +#### Inherited from + +[`Type`](Type.md).[`aliasSymbol`](Type.md#aliassymbol) + +*** + +### aliasTypeArguments? + +> `optional` **aliasTypeArguments**: readonly [`Type`](Type.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2774 + +#### Inherited from + +[`Type`](Type.md).[`aliasTypeArguments`](Type.md#aliastypearguments) + +*** + +### flags + +> **flags**: [`TypeFlags`](../enumerations/TypeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2770 + +#### Inherited from + +[`Type`](Type.md).[`flags`](Type.md#flags) + +*** + +### freshType + +> **freshType**: [`LiteralType`](LiteralType.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2778 + +*** + +### pattern? + +> `optional` **pattern**: [`DestructuringPattern`](../type-aliases/DestructuringPattern.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2772 + +#### Inherited from + +[`Type`](Type.md).[`pattern`](Type.md#pattern) + +*** + +### regularType + +> **regularType**: [`LiteralType`](LiteralType.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2779 + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2771 + +#### Inherited from + +[`Type`](Type.md).[`symbol`](Type.md#symbol) + +*** + +### value + +> **value**: `string` \| `number` \| [`PseudoBigInt`](PseudoBigInt.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2777 + +## Methods + +### getApparentProperties() + +> **getApparentProperties**(): [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6124 + +#### Returns + +[`Symbol`](Symbol.md)[] + +#### Inherited from + +[`Type`](Type.md).[`getApparentProperties`](Type.md#getapparentproperties) + +*** + +### getBaseTypes() + +> **getBaseTypes**(): `undefined` \| [`BaseType`](../type-aliases/BaseType.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6129 + +#### Returns + +`undefined` \| [`BaseType`](../type-aliases/BaseType.md)[] + +#### Inherited from + +[`Type`](Type.md).[`getBaseTypes`](Type.md#getbasetypes) + +*** + +### getCallSignatures() + +> **getCallSignatures**(): readonly [`Signature`](Signature.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6125 + +#### Returns + +readonly [`Signature`](Signature.md)[] + +#### Inherited from + +[`Type`](Type.md).[`getCallSignatures`](Type.md#getcallsignatures) + +*** + +### getConstraint() + +> **getConstraint**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6131 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`Type`](Type.md).[`getConstraint`](Type.md#getconstraint) + +*** + +### getConstructSignatures() + +> **getConstructSignatures**(): readonly [`Signature`](Signature.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6126 + +#### Returns + +readonly [`Signature`](Signature.md)[] + +#### Inherited from + +[`Type`](Type.md).[`getConstructSignatures`](Type.md#getconstructsignatures) + +*** + +### getDefault() + +> **getDefault**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6132 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`Type`](Type.md).[`getDefault`](Type.md#getdefault) + +*** + +### getFlags() + +> **getFlags**(): [`TypeFlags`](../enumerations/TypeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6120 + +#### Returns + +[`TypeFlags`](../enumerations/TypeFlags.md) + +#### Inherited from + +[`Type`](Type.md).[`getFlags`](Type.md#getflags) + +*** + +### getNonNullableType() + +> **getNonNullableType**(): [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6130 + +#### Returns + +[`Type`](Type.md) + +#### Inherited from + +[`Type`](Type.md).[`getNonNullableType`](Type.md#getnonnullabletype) + +*** + +### getNumberIndexType() + +> **getNumberIndexType**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6128 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`Type`](Type.md).[`getNumberIndexType`](Type.md#getnumberindextype) + +*** + +### getProperties() + +> **getProperties**(): [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6122 + +#### Returns + +[`Symbol`](Symbol.md)[] + +#### Inherited from + +[`Type`](Type.md).[`getProperties`](Type.md#getproperties) + +*** + +### getProperty() + +> **getProperty**(`propertyName`): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6123 + +#### Parameters + +##### propertyName + +`string` + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +#### Inherited from + +[`Type`](Type.md).[`getProperty`](Type.md#getproperty) + +*** + +### getStringIndexType() + +> **getStringIndexType**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6127 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`Type`](Type.md).[`getStringIndexType`](Type.md#getstringindextype) + +*** + +### getSymbol() + +> **getSymbol**(): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6121 + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +#### Inherited from + +[`Type`](Type.md).[`getSymbol`](Type.md#getsymbol) + +*** + +### isClass() + +> **isClass**(): `this is InterfaceType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6141 + +#### Returns + +`this is InterfaceType` + +#### Inherited from + +[`Type`](Type.md).[`isClass`](Type.md#isclass) + +*** + +### isClassOrInterface() + +> **isClassOrInterface**(): `this is InterfaceType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6140 + +#### Returns + +`this is InterfaceType` + +#### Inherited from + +[`Type`](Type.md).[`isClassOrInterface`](Type.md#isclassorinterface) + +*** + +### isIndexType() + +> **isIndexType**(): `this is IndexType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6142 + +#### Returns + +`this is IndexType` + +#### Inherited from + +[`Type`](Type.md).[`isIndexType`](Type.md#isindextype) + +*** + +### isIntersection() + +> **isIntersection**(): `this is IntersectionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6134 + +#### Returns + +`this is IntersectionType` + +#### Inherited from + +[`Type`](Type.md).[`isIntersection`](Type.md#isintersection) + +*** + +### isLiteral() + +> **isLiteral**(): `this is LiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6136 + +#### Returns + +`this is LiteralType` + +#### Inherited from + +[`Type`](Type.md).[`isLiteral`](Type.md#isliteral) + +*** + +### isNumberLiteral() + +> **isNumberLiteral**(): `this is NumberLiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6138 + +#### Returns + +`this is NumberLiteralType` + +#### Inherited from + +[`Type`](Type.md).[`isNumberLiteral`](Type.md#isnumberliteral) + +*** + +### isStringLiteral() + +> **isStringLiteral**(): `this is StringLiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6137 + +#### Returns + +`this is StringLiteralType` + +#### Inherited from + +[`Type`](Type.md).[`isStringLiteral`](Type.md#isstringliteral) + +*** + +### isTypeParameter() + +> **isTypeParameter**(): `this is TypeParameter` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6139 + +#### Returns + +`this is TypeParameter` + +#### Inherited from + +[`Type`](Type.md).[`isTypeParameter`](Type.md#istypeparameter) + +*** + +### isUnion() + +> **isUnion**(): `this is UnionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6133 + +#### Returns + +`this is UnionType` + +#### Inherited from + +[`Type`](Type.md).[`isUnion`](Type.md#isunion) + +*** + +### isUnionOrIntersection() + +> **isUnionOrIntersection**(): `this is UnionOrIntersectionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6135 + +#### Returns + +`this is UnionOrIntersectionType` + +#### Inherited from + +[`Type`](Type.md).[`isUnionOrIntersection`](Type.md#isunionorintersection) diff --git a/docs/api_docs/namespaces/ts/interfaces/LiteralTypeNode.md b/docs/api_docs/namespaces/ts/interfaces/LiteralTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..c91e750dbf91756831157a8e09ce3b43061f9689 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/LiteralTypeNode.md @@ -0,0 +1,497 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / LiteralTypeNode + +# Interface: LiteralTypeNode + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1035 + +## Extends + +- [`TypeNode`](TypeNode.md) + +## Properties + +### \_typeNodeBrand + +> **\_typeNodeBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:912 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`_typeNodeBrand`](TypeNode.md#_typenodebrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`decorators`](TypeNode.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`end`](TypeNode.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`flags`](TypeNode.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`LiteralType`](../enumerations/SyntaxKind.md#literaltype) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1036 + +#### Overrides + +[`TypeNode`](TypeNode.md).[`kind`](TypeNode.md#kind) + +*** + +### literal + +> `readonly` **literal**: [`LiteralExpression`](LiteralExpression.md) \| [`PrefixUnaryExpression`](PrefixUnaryExpression.md) \| [`NullLiteral`](NullLiteral.md) \| [`BooleanLiteral`](../type-aliases/BooleanLiteral.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1037 + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`locals`](TypeNode.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`modifiers`](TypeNode.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`parent`](TypeNode.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`pos`](TypeNode.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`skipCheck`](TypeNode.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`symbol`](TypeNode.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`forEachChild`](TypeNode.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getChildAt`](TypeNode.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getChildCount`](TypeNode.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getChildren`](TypeNode.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getEnd`](TypeNode.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFirstToken`](TypeNode.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFullStart`](TypeNode.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFullText`](TypeNode.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFullWidth`](TypeNode.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getLastToken`](TypeNode.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getLeadingTriviaWidth`](TypeNode.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getSourceFile`](TypeNode.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getStart`](TypeNode.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getText`](TypeNode.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getWidth`](TypeNode.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/Map.md b/docs/api_docs/namespaces/ts/interfaces/Map.md new file mode 100644 index 0000000000000000000000000000000000000000..01f3c12d32c206c468250f2c9fecd7dba69435d1 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/Map.md @@ -0,0 +1,209 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / Map + +# Interface: Map\ + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:64 + +ES6 Map interface. + +## Extends + +- [`ESMap`](ESMap.md)\<`string`, `T`\> + +## Type Parameters + +• **T** + +## Properties + +### size + +> `readonly` **size**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:36 + +#### Inherited from + +[`ESMap`](ESMap.md).[`size`](ESMap.md#size) + +## Methods + +### clear() + +> **clear**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:43 + +#### Returns + +`void` + +#### Inherited from + +[`ESMap`](ESMap.md).[`clear`](ESMap.md#clear) + +*** + +### delete() + +> **delete**(`key`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:42 + +#### Parameters + +##### key + +`string` + +#### Returns + +`boolean` + +#### Inherited from + +[`ESMap`](ESMap.md).[`delete`](ESMap.md#delete) + +*** + +### entries() + +> **entries**(): [`Iterator`](Iterator.md)\<\[`string`, `T`\]\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:49 + +#### Returns + +[`Iterator`](Iterator.md)\<\[`string`, `T`\]\> + +#### Inherited from + +[`ESMap`](ESMap.md).[`entries`](ESMap.md#entries) + +*** + +### forEach() + +> **forEach**(`action`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:50 + +#### Parameters + +##### action + +(`value`, `key`) => `void` + +#### Returns + +`void` + +#### Inherited from + +[`ESMap`](ESMap.md).[`forEach`](ESMap.md#foreach) + +*** + +### get() + +> **get**(`key`): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:47 + +#### Parameters + +##### key + +`string` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`ESMap`](ESMap.md).[`get`](ESMap.md#get) + +*** + +### has() + +> **has**(`key`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:37 + +#### Parameters + +##### key + +`string` + +#### Returns + +`boolean` + +#### Inherited from + +[`ESMap`](ESMap.md).[`has`](ESMap.md#has) + +*** + +### keys() + +> **keys**(): [`Iterator`](Iterator.md)\<`string`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:38 + +#### Returns + +[`Iterator`](Iterator.md)\<`string`\> + +#### Inherited from + +[`ESMap`](ESMap.md).[`keys`](ESMap.md#keys) + +*** + +### set() + +> **set**(`key`, `value`): `this` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:59 + +#### Parameters + +##### key + +`string` + +##### value + +`T` + +#### Returns + +`this` + +#### Inherited from + +[`ESMap`](ESMap.md).[`set`](ESMap.md#set) + +*** + +### values() + +> **values**(): [`Iterator`](Iterator.md)\<`T`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:48 + +#### Returns + +[`Iterator`](Iterator.md)\<`T`\> + +#### Inherited from + +[`ESMap`](ESMap.md).[`values`](ESMap.md#values) diff --git a/docs/api_docs/namespaces/ts/interfaces/MapLike.md b/docs/api_docs/namespaces/ts/interfaces/MapLike.md new file mode 100644 index 0000000000000000000000000000000000000000..8da99b5f6ab07df41e9af8718840408ba9e0cc90 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/MapLike.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / MapLike + +# Interface: MapLike\ + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:25 + +Type of objects whose values are all of the same type. +The `in` and `for-in` operators can *not* be safely used, +since `Object.prototype` may be modified by outside code. + +## Type Parameters + +• **T** + +## Indexable + +\[`index`: `string`\]: `T` diff --git a/docs/api_docs/namespaces/ts/interfaces/MappedTypeNode.md b/docs/api_docs/namespaces/ts/interfaces/MappedTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..3b9b68655e40c603815a4773d75f36a6a2111795 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/MappedTypeNode.md @@ -0,0 +1,551 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / MappedTypeNode + +# Interface: MappedTypeNode + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1025 + +## Extends + +- [`TypeNode`](TypeNode.md).[`Declaration`](Declaration.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`Declaration`](Declaration.md).[`_declarationBrand`](Declaration.md#_declarationbrand) + +*** + +### \_typeNodeBrand + +> **\_typeNodeBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:912 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`_typeNodeBrand`](TypeNode.md#_typenodebrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Declaration`](Declaration.md).[`decorators`](Declaration.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Declaration`](Declaration.md).[`end`](Declaration.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Declaration`](Declaration.md).[`flags`](Declaration.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`MappedType`](../enumerations/SyntaxKind.md#mappedtype) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1026 + +#### Overrides + +[`Declaration`](Declaration.md).[`kind`](Declaration.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Declaration`](Declaration.md).[`locals`](Declaration.md#locals) + +*** + +### members? + +> `readonly` `optional` **members**: [`NodeArray`](NodeArray.md)\<[`TypeElement`](TypeElement.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1033 + +Used only to produce grammar errors + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Declaration`](Declaration.md).[`modifiers`](Declaration.md#modifiers) + +*** + +### nameType? + +> `readonly` `optional` **nameType**: [`TypeNode`](TypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1029 + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`Declaration`](Declaration.md).[`parent`](Declaration.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Declaration`](Declaration.md).[`pos`](Declaration.md#pos) + +*** + +### questionToken? + +> `readonly` `optional` **questionToken**: [`QuestionToken`](../type-aliases/QuestionToken.md) \| [`PlusToken`](../type-aliases/PlusToken.md) \| [`MinusToken`](../type-aliases/MinusToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1030 + +*** + +### readonlyToken? + +> `readonly` `optional` **readonlyToken**: [`ReadonlyKeyword`](../type-aliases/ReadonlyKeyword.md) \| [`PlusToken`](../type-aliases/PlusToken.md) \| [`MinusToken`](../type-aliases/MinusToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1027 + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Declaration`](Declaration.md).[`skipCheck`](Declaration.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Declaration`](Declaration.md).[`symbol`](Declaration.md#symbol) + +*** + +### type? + +> `readonly` `optional` **type**: [`TypeNode`](TypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1031 + +*** + +### typeParameter + +> `readonly` **typeParameter**: [`TypeParameterDeclaration`](TypeParameterDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1028 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Declaration`](Declaration.md).[`forEachChild`](Declaration.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getChildAt`](Declaration.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getChildCount`](Declaration.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Declaration`](Declaration.md).[`getChildren`](Declaration.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getEnd`](Declaration.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFirstToken`](Declaration.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFullStart`](Declaration.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFullText`](Declaration.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFullWidth`](Declaration.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getLastToken`](Declaration.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getLeadingTriviaWidth`](Declaration.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getSourceFile`](Declaration.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getStart`](Declaration.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getText`](Declaration.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getWidth`](Declaration.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/MemberExpression.md b/docs/api_docs/namespaces/ts/interfaces/MemberExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..b2d9debd9e53c35c2980003cb09f904369884905 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/MemberExpression.md @@ -0,0 +1,541 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / MemberExpression + +# Interface: MemberExpression + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1088 + +## Extends + +- [`LeftHandSideExpression`](LeftHandSideExpression.md) + +## Extended by + +- [`PrimaryExpression`](PrimaryExpression.md) +- [`PropertyAccessExpression`](PropertyAccessExpression.md) +- [`ElementAccessExpression`](ElementAccessExpression.md) +- [`ExpressionWithTypeArguments`](ExpressionWithTypeArguments.md) +- [`TaggedTemplateExpression`](TaggedTemplateExpression.md) + +## Properties + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`_expressionBrand`](LeftHandSideExpression.md#_expressionbrand) + +*** + +### \_leftHandSideExpressionBrand + +> **\_leftHandSideExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1086 + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`_leftHandSideExpressionBrand`](LeftHandSideExpression.md#_lefthandsideexpressionbrand) + +*** + +### \_memberExpressionBrand + +> **\_memberExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1089 + +*** + +### \_unaryExpressionBrand + +> **\_unaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1066 + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`_unaryExpressionBrand`](LeftHandSideExpression.md#_unaryexpressionbrand) + +*** + +### \_updateExpressionBrand + +> **\_updateExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1071 + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`_updateExpressionBrand`](LeftHandSideExpression.md#_updateexpressionbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`decorators`](LeftHandSideExpression.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`end`](LeftHandSideExpression.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`flags`](LeftHandSideExpression.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`SyntaxKind`](../enumerations/SyntaxKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:598 + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`kind`](LeftHandSideExpression.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`locals`](LeftHandSideExpression.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`modifiers`](LeftHandSideExpression.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`parent`](LeftHandSideExpression.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`pos`](LeftHandSideExpression.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`skipCheck`](LeftHandSideExpression.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`symbol`](LeftHandSideExpression.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`forEachChild`](LeftHandSideExpression.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`getChildAt`](LeftHandSideExpression.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`getChildCount`](LeftHandSideExpression.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`getChildren`](LeftHandSideExpression.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`getEnd`](LeftHandSideExpression.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`getFirstToken`](LeftHandSideExpression.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`getFullStart`](LeftHandSideExpression.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`getFullText`](LeftHandSideExpression.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`getFullWidth`](LeftHandSideExpression.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`getLastToken`](LeftHandSideExpression.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`getLeadingTriviaWidth`](LeftHandSideExpression.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`getSourceFile`](LeftHandSideExpression.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`getStart`](LeftHandSideExpression.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`getText`](LeftHandSideExpression.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`getWidth`](LeftHandSideExpression.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/MetaProperty.md b/docs/api_docs/namespaces/ts/interfaces/MetaProperty.md new file mode 100644 index 0000000000000000000000000000000000000000..9bc530b500066eacd5464a38ad50c7cc5bb58ccd --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/MetaProperty.md @@ -0,0 +1,565 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / MetaProperty + +# Interface: MetaProperty + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1393 + +## Extends + +- [`PrimaryExpression`](PrimaryExpression.md) + +## Properties + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_expressionBrand`](PrimaryExpression.md#_expressionbrand) + +*** + +### \_leftHandSideExpressionBrand + +> **\_leftHandSideExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1086 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_leftHandSideExpressionBrand`](PrimaryExpression.md#_lefthandsideexpressionbrand) + +*** + +### \_memberExpressionBrand + +> **\_memberExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1089 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_memberExpressionBrand`](PrimaryExpression.md#_memberexpressionbrand) + +*** + +### \_primaryExpressionBrand + +> **\_primaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1092 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_primaryExpressionBrand`](PrimaryExpression.md#_primaryexpressionbrand) + +*** + +### \_unaryExpressionBrand + +> **\_unaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1066 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_unaryExpressionBrand`](PrimaryExpression.md#_unaryexpressionbrand) + +*** + +### \_updateExpressionBrand + +> **\_updateExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1071 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_updateExpressionBrand`](PrimaryExpression.md#_updateexpressionbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`decorators`](PrimaryExpression.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`end`](PrimaryExpression.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`flags`](PrimaryExpression.md#flags) + +*** + +### keywordToken + +> `readonly` **keywordToken**: [`ImportKeyword`](../enumerations/SyntaxKind.md#importkeyword) \| [`NewKeyword`](../enumerations/SyntaxKind.md#newkeyword) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1395 + +*** + +### kind + +> `readonly` **kind**: [`MetaProperty`](../enumerations/SyntaxKind.md#metaproperty) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1394 + +#### Overrides + +[`PrimaryExpression`](PrimaryExpression.md).[`kind`](PrimaryExpression.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`locals`](PrimaryExpression.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`modifiers`](PrimaryExpression.md#modifiers) + +*** + +### name + +> `readonly` **name**: [`Identifier`](Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1396 + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`parent`](PrimaryExpression.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`pos`](PrimaryExpression.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`skipCheck`](PrimaryExpression.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`symbol`](PrimaryExpression.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`forEachChild`](PrimaryExpression.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getChildAt`](PrimaryExpression.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getChildCount`](PrimaryExpression.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getChildren`](PrimaryExpression.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getEnd`](PrimaryExpression.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFirstToken`](PrimaryExpression.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFullStart`](PrimaryExpression.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFullText`](PrimaryExpression.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFullWidth`](PrimaryExpression.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getLastToken`](PrimaryExpression.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getLeadingTriviaWidth`](PrimaryExpression.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getSourceFile`](PrimaryExpression.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getStart`](PrimaryExpression.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getText`](PrimaryExpression.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getWidth`](PrimaryExpression.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/MethodDeclaration.md b/docs/api_docs/namespaces/ts/interfaces/MethodDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..3f35e7e9f02806f8013d1ce3e35d7de35c658e13 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/MethodDeclaration.md @@ -0,0 +1,628 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / MethodDeclaration + +# Interface: MethodDeclaration + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:867 + +Several node kinds share function-like features such as a signature, +a name, and a body. These nodes should extend FunctionLikeDeclarationBase. +Examples: +- FunctionDeclaration +- MethodDeclaration +- AccessorDeclaration + +## Extends + +- [`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`ClassElement`](ClassElement.md).[`ObjectLiteralElement`](ObjectLiteralElement.md).[`JSDocContainer`](JSDocContainer.md) + +## Properties + +### \_classElementBrand + +> **\_classElementBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1633 + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`_classElementBrand`](ClassElement.md#_classelementbrand) + +*** + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`_declarationBrand`](ObjectLiteralElement.md#_declarationbrand) + +*** + +### \_functionLikeDeclarationBrand + +> **\_functionLikeDeclarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:846 + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`_functionLikeDeclarationBrand`](FunctionLikeDeclarationBase.md#_functionlikedeclarationbrand) + +*** + +### \_objectLiteralBrand + +> **\_objectLiteralBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:798 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`_objectLiteralBrand`](ObjectLiteralElement.md#_objectliteralbrand) + +*** + +### asteriskToken? + +> `readonly` `optional` **asteriskToken**: [`AsteriskToken`](../type-aliases/AsteriskToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:847 + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`asteriskToken`](FunctionLikeDeclarationBase.md#asterisktoken) + +*** + +### body? + +> `readonly` `optional` **body**: [`Block`](Block.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:872 + +#### Overrides + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`body`](FunctionLikeDeclarationBase.md#body) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`decorators`](ObjectLiteralElement.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`end`](ObjectLiteralElement.md#end) + +*** + +### exclamationToken? + +> `readonly` `optional` **exclamationToken**: [`ExclamationToken`](../type-aliases/ExclamationToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:849 + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`exclamationToken`](FunctionLikeDeclarationBase.md#exclamationtoken) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`flags`](ObjectLiteralElement.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`MethodDeclaration`](../enumerations/SyntaxKind.md#methoddeclaration) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:868 + +#### Overrides + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`kind`](ObjectLiteralElement.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`locals`](ObjectLiteralElement.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:870 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Overrides + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`modifiers`](ObjectLiteralElement.md#modifiers) + +*** + +### name + +> `readonly` **name**: [`PropertyName`](../type-aliases/PropertyName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:871 + +#### Overrides + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`name`](ObjectLiteralElement.md#name) + +*** + +### parameters + +> `readonly` **parameters**: [`NodeArray`](NodeArray.md)\<[`ParameterDeclaration`](ParameterDeclaration.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:735 + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`parameters`](FunctionLikeDeclarationBase.md#parameters) + +*** + +### parent + +> `readonly` **parent**: [`ClassLikeDeclaration`](../type-aliases/ClassLikeDeclaration.md) \| [`ObjectLiteralExpression`](ObjectLiteralExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:869 + +#### Overrides + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`parent`](ObjectLiteralElement.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`pos`](ObjectLiteralElement.md#pos) + +*** + +### questionToken? + +> `readonly` `optional` **questionToken**: [`QuestionToken`](../type-aliases/QuestionToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:848 + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`questionToken`](FunctionLikeDeclarationBase.md#questiontoken) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`skipCheck`](ObjectLiteralElement.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`symbol`](ObjectLiteralElement.md#symbol) + +*** + +### type? + +> `readonly` `optional` **type**: [`TypeNode`](TypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:736 + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`type`](FunctionLikeDeclarationBase.md#type) + +*** + +### typeParameters? + +> `readonly` `optional` **typeParameters**: [`NodeArray`](NodeArray.md)\<[`TypeParameterDeclaration`](TypeParameterDeclaration.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:734 + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`typeParameters`](FunctionLikeDeclarationBase.md#typeparameters) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`forEachChild`](ObjectLiteralElement.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getChildAt`](ObjectLiteralElement.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getChildCount`](ObjectLiteralElement.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getChildren`](ObjectLiteralElement.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getEnd`](ObjectLiteralElement.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getFirstToken`](ObjectLiteralElement.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getFullStart`](ObjectLiteralElement.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getFullText`](ObjectLiteralElement.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getFullWidth`](ObjectLiteralElement.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getLastToken`](ObjectLiteralElement.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getLeadingTriviaWidth`](ObjectLiteralElement.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getSourceFile`](ObjectLiteralElement.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getStart`](ObjectLiteralElement.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getText`](ObjectLiteralElement.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getWidth`](ObjectLiteralElement.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/MethodSignature.md b/docs/api_docs/namespaces/ts/interfaces/MethodSignature.md new file mode 100644 index 0000000000000000000000000000000000000000..75767815bc2d58a673abae47cdcbb630dd1ec131 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/MethodSignature.md @@ -0,0 +1,561 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / MethodSignature + +# Interface: MethodSignature + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:861 + +## Extends + +- [`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`TypeElement`](TypeElement.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`_declarationBrand`](TypeElement.md#_declarationbrand) + +*** + +### \_typeElementBrand + +> **\_typeElementBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1637 + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`_typeElementBrand`](TypeElement.md#_typeelementbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`decorators`](TypeElement.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`end`](TypeElement.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`flags`](TypeElement.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`MethodSignature`](../enumerations/SyntaxKind.md#methodsignature) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:862 + +#### Overrides + +[`TypeElement`](TypeElement.md).[`kind`](TypeElement.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`locals`](TypeElement.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`Modifier`](../type-aliases/Modifier.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:864 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Overrides + +[`TypeElement`](TypeElement.md).[`modifiers`](TypeElement.md#modifiers) + +*** + +### name + +> `readonly` **name**: [`PropertyName`](../type-aliases/PropertyName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:865 + +#### Overrides + +[`TypeElement`](TypeElement.md).[`name`](TypeElement.md#name) + +*** + +### parameters + +> `readonly` **parameters**: [`NodeArray`](NodeArray.md)\<[`ParameterDeclaration`](ParameterDeclaration.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:735 + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`parameters`](SignatureDeclarationBase.md#parameters) + +*** + +### parent + +> `readonly` **parent**: [`ObjectTypeDeclaration`](../type-aliases/ObjectTypeDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:863 + +#### Overrides + +[`TypeElement`](TypeElement.md).[`parent`](TypeElement.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`pos`](TypeElement.md#pos) + +*** + +### questionToken? + +> `readonly` `optional` **questionToken**: [`QuestionToken`](../type-aliases/QuestionToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1639 + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`questionToken`](TypeElement.md#questiontoken) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`skipCheck`](TypeElement.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`symbol`](TypeElement.md#symbol) + +*** + +### type? + +> `readonly` `optional` **type**: [`TypeNode`](TypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:736 + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`type`](SignatureDeclarationBase.md#type) + +*** + +### typeParameters? + +> `readonly` `optional` **typeParameters**: [`NodeArray`](NodeArray.md)\<[`TypeParameterDeclaration`](TypeParameterDeclaration.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:734 + +#### Inherited from + +[`SignatureDeclarationBase`](SignatureDeclarationBase.md).[`typeParameters`](SignatureDeclarationBase.md#typeparameters) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`forEachChild`](TypeElement.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getChildAt`](TypeElement.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getChildCount`](TypeElement.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getChildren`](TypeElement.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getEnd`](TypeElement.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getFirstToken`](TypeElement.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getFullStart`](TypeElement.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getFullText`](TypeElement.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getFullWidth`](TypeElement.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getLastToken`](TypeElement.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getLeadingTriviaWidth`](TypeElement.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getSourceFile`](TypeElement.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getStart`](TypeElement.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getText`](TypeElement.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getWidth`](TypeElement.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/MinimalResolutionCacheHost.md b/docs/api_docs/namespaces/ts/interfaces/MinimalResolutionCacheHost.md new file mode 100644 index 0000000000000000000000000000000000000000..6caaee61ce5b51e43a8c0bf74f8989faddd599e4 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/MinimalResolutionCacheHost.md @@ -0,0 +1,283 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / MinimalResolutionCacheHost + +# Interface: MinimalResolutionCacheHost + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3359 + +Used by services to specify the minimum host area required to set up source files under any compilation settings + +## Extends + +- [`ModuleResolutionHost`](ModuleResolutionHost.md) + +## Extended by + +- [`LanguageServiceHost`](LanguageServiceHost.md) + +## Properties + +### useCaseSensitiveFileNames? + +> `optional` **useCaseSensitiveFileNames**: `boolean` \| () => `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3351 + +#### Inherited from + +[`ModuleResolutionHost`](ModuleResolutionHost.md).[`useCaseSensitiveFileNames`](ModuleResolutionHost.md#usecasesensitivefilenames) + +## Methods + +### directoryExists()? + +> `optional` **directoryExists**(`directoryName`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3343 + +#### Parameters + +##### directoryName + +`string` + +#### Returns + +`boolean` + +#### Inherited from + +[`ModuleResolutionHost`](ModuleResolutionHost.md).[`directoryExists`](ModuleResolutionHost.md#directoryexists) + +*** + +### fileExists() + +> **fileExists**(`fileName`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3340 + +#### Parameters + +##### fileName + +`string` + +#### Returns + +`boolean` + +#### Inherited from + +[`ModuleResolutionHost`](ModuleResolutionHost.md).[`fileExists`](ModuleResolutionHost.md#fileexists) + +*** + +### getCompilationSettings() + +> **getCompilationSettings**(): [`CompilerOptions`](CompilerOptions.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3360 + +#### Returns + +[`CompilerOptions`](CompilerOptions.md) + +*** + +### getCompilerHost()? + +> `optional` **getCompilerHost**(): `undefined` \| [`CompilerHost`](CompilerHost.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3361 + +#### Returns + +`undefined` \| [`CompilerHost`](CompilerHost.md) + +*** + +### getCurrentDirectory()? + +> `optional` **getCurrentDirectory**(): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3349 + +#### Returns + +`string` + +#### Inherited from + +[`ModuleResolutionHost`](ModuleResolutionHost.md).[`getCurrentDirectory`](ModuleResolutionHost.md#getcurrentdirectory) + +*** + +### getDirectories()? + +> `optional` **getDirectories**(`path`): `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3350 + +#### Parameters + +##### path + +`string` + +#### Returns + +`string`[] + +#### Inherited from + +[`ModuleResolutionHost`](ModuleResolutionHost.md).[`getDirectories`](ModuleResolutionHost.md#getdirectories) + +*** + +### getFileCheckedModuleInfo()? + +> `optional` **getFileCheckedModuleInfo**(`containFilePath`): [`FileCheckModuleInfo`](FileCheckModuleInfo.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3354 + +#### Parameters + +##### containFilePath + +`string` + +#### Returns + +[`FileCheckModuleInfo`](FileCheckModuleInfo.md) + +#### Inherited from + +[`ModuleResolutionHost`](ModuleResolutionHost.md).[`getFileCheckedModuleInfo`](ModuleResolutionHost.md#getfilecheckedmoduleinfo) + +*** + +### getJsDocNodeCheckedConfig()? + +> `optional` **getJsDocNodeCheckedConfig**(`jsDocFileCheckInfo`, `symbolSourceFilePath`): [`JsDocNodeCheckConfig`](JsDocNodeCheckConfig.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3352 + +#### Parameters + +##### jsDocFileCheckInfo + +[`FileCheckModuleInfo`](FileCheckModuleInfo.md) + +##### symbolSourceFilePath + +`string` + +#### Returns + +[`JsDocNodeCheckConfig`](JsDocNodeCheckConfig.md) + +#### Inherited from + +[`ModuleResolutionHost`](ModuleResolutionHost.md).[`getJsDocNodeCheckedConfig`](ModuleResolutionHost.md#getjsdocnodecheckedconfig) + +*** + +### getJsDocNodeConditionCheckedResult()? + +> `optional` **getJsDocNodeConditionCheckedResult**(`jsDocFileCheckedInfo`, `jsDocs`): [`ConditionCheckResult`](ConditionCheckResult.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3353 + +#### Parameters + +##### jsDocFileCheckedInfo + +[`FileCheckModuleInfo`](FileCheckModuleInfo.md) + +##### jsDocs + +[`JsDocTagInfo`](JsDocTagInfo.md)[] + +#### Returns + +[`ConditionCheckResult`](ConditionCheckResult.md) + +#### Inherited from + +[`ModuleResolutionHost`](ModuleResolutionHost.md).[`getJsDocNodeConditionCheckedResult`](ModuleResolutionHost.md#getjsdocnodeconditioncheckedresult) + +*** + +### readFile() + +> **readFile**(`fileName`): `undefined` \| `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3341 + +#### Parameters + +##### fileName + +`string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[`ModuleResolutionHost`](ModuleResolutionHost.md).[`readFile`](ModuleResolutionHost.md#readfile) + +*** + +### realpath()? + +> `optional` **realpath**(`path`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3348 + +Resolve a symbolic link. + +#### Parameters + +##### path + +`string` + +#### Returns + +`string` + +#### See + +https://nodejs.org/api/fs.html#fs_fs_realpathsync_path_options + +#### Inherited from + +[`ModuleResolutionHost`](ModuleResolutionHost.md).[`realpath`](ModuleResolutionHost.md#realpath) + +*** + +### trace()? + +> `optional` **trace**(`s`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3342 + +#### Parameters + +##### s + +`string` + +#### Returns + +`void` + +#### Inherited from + +[`ModuleResolutionHost`](ModuleResolutionHost.md).[`trace`](ModuleResolutionHost.md#trace) diff --git a/docs/api_docs/namespaces/ts/interfaces/MissingDeclaration.md b/docs/api_docs/namespaces/ts/interfaces/MissingDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..83be9b77fc067d0bd155e63fc2f4ebbbf49baecf --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/MissingDeclaration.md @@ -0,0 +1,513 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / MissingDeclaration + +# Interface: MissingDeclaration + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1489 + +## Extends + +- [`DeclarationStatement`](DeclarationStatement.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`_declarationBrand`](DeclarationStatement.md#_declarationbrand) + +*** + +### \_statementBrand + +> **\_statementBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1471 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`_statementBrand`](DeclarationStatement.md#_statementbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`decorators`](DeclarationStatement.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`end`](DeclarationStatement.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`flags`](DeclarationStatement.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`MissingDeclaration`](../enumerations/SyntaxKind.md#missingdeclaration) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1490 + +#### Overrides + +[`DeclarationStatement`](DeclarationStatement.md).[`kind`](DeclarationStatement.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`locals`](DeclarationStatement.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`modifiers`](DeclarationStatement.md#modifiers) + +*** + +### name? + +> `readonly` `optional` **name**: [`Identifier`](Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1491 + +#### Overrides + +[`DeclarationStatement`](DeclarationStatement.md).[`name`](DeclarationStatement.md#name) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`parent`](DeclarationStatement.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`pos`](DeclarationStatement.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`skipCheck`](DeclarationStatement.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`symbol`](DeclarationStatement.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`forEachChild`](DeclarationStatement.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getChildAt`](DeclarationStatement.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getChildCount`](DeclarationStatement.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getChildren`](DeclarationStatement.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getEnd`](DeclarationStatement.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getFirstToken`](DeclarationStatement.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getFullStart`](DeclarationStatement.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getFullText`](DeclarationStatement.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getFullWidth`](DeclarationStatement.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getLastToken`](DeclarationStatement.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getLeadingTriviaWidth`](DeclarationStatement.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getSourceFile`](DeclarationStatement.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getStart`](DeclarationStatement.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getText`](DeclarationStatement.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getWidth`](DeclarationStatement.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/ModeAwareCache.md b/docs/api_docs/namespaces/ts/interfaces/ModeAwareCache.md new file mode 100644 index 0000000000000000000000000000000000000000..0fc34e14c759b43b8a47adf11e54d4e780305d0a --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ModeAwareCache.md @@ -0,0 +1,135 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ModeAwareCache + +# Interface: ModeAwareCache\ + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5364 + +## Type Parameters + +• **T** + +## Methods + +### delete() + +> **delete**(`key`, `mode`): `this` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5367 + +#### Parameters + +##### key + +`string` + +##### mode + +`undefined` | [`CommonJS`](../enumerations/ModuleKind.md#commonjs) | [`ESNext`](../enumerations/ModuleKind.md#esnext) + +#### Returns + +`this` + +*** + +### forEach() + +> **forEach**(`cb`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5369 + +#### Parameters + +##### cb + +(`elem`, `key`, `mode`) => `void` + +#### Returns + +`void` + +*** + +### get() + +> **get**(`key`, `mode`): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5365 + +#### Parameters + +##### key + +`string` + +##### mode + +`undefined` | [`CommonJS`](../enumerations/ModuleKind.md#commonjs) | [`ESNext`](../enumerations/ModuleKind.md#esnext) + +#### Returns + +`undefined` \| `T` + +*** + +### has() + +> **has**(`key`, `mode`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5368 + +#### Parameters + +##### key + +`string` + +##### mode + +`undefined` | [`CommonJS`](../enumerations/ModuleKind.md#commonjs) | [`ESNext`](../enumerations/ModuleKind.md#esnext) + +#### Returns + +`boolean` + +*** + +### set() + +> **set**(`key`, `mode`, `value`): `this` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5366 + +#### Parameters + +##### key + +`string` + +##### mode + +`undefined` | [`CommonJS`](../enumerations/ModuleKind.md#commonjs) | [`ESNext`](../enumerations/ModuleKind.md#esnext) + +##### value + +`T` + +#### Returns + +`this` + +*** + +### size() + +> **size**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5370 + +#### Returns + +`number` diff --git a/docs/api_docs/namespaces/ts/interfaces/ModifierToken.md b/docs/api_docs/namespaces/ts/interfaces/ModifierToken.md new file mode 100644 index 0000000000000000000000000000000000000000..14f36ad0cdd0abac7fc50b81f8d95d5147c16762 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ModifierToken.md @@ -0,0 +1,481 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ModifierToken + +# Interface: ModifierToken\ + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:644 + +## Extends + +- [`KeywordToken`](KeywordToken.md)\<`TKind`\> + +## Type Parameters + +• **TKind** *extends* [`ModifierSyntaxKind`](../type-aliases/ModifierSyntaxKind.md) + +## Properties + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`KeywordToken`](KeywordToken.md).[`decorators`](KeywordToken.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`KeywordToken`](KeywordToken.md).[`end`](KeywordToken.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`KeywordToken`](KeywordToken.md).[`flags`](KeywordToken.md#flags) + +*** + +### kind + +> `readonly` **kind**: `TKind` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:619 + +#### Inherited from + +[`KeywordToken`](KeywordToken.md).[`kind`](KeywordToken.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`KeywordToken`](KeywordToken.md).[`locals`](KeywordToken.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`KeywordToken`](KeywordToken.md).[`modifiers`](KeywordToken.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`KeywordToken`](KeywordToken.md).[`parent`](KeywordToken.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`KeywordToken`](KeywordToken.md).[`pos`](KeywordToken.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`KeywordToken`](KeywordToken.md).[`skipCheck`](KeywordToken.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`KeywordToken`](KeywordToken.md).[`symbol`](KeywordToken.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`KeywordToken`](KeywordToken.md).[`forEachChild`](KeywordToken.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`KeywordToken`](KeywordToken.md).[`getChildAt`](KeywordToken.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`KeywordToken`](KeywordToken.md).[`getChildCount`](KeywordToken.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`KeywordToken`](KeywordToken.md).[`getChildren`](KeywordToken.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`KeywordToken`](KeywordToken.md).[`getEnd`](KeywordToken.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`KeywordToken`](KeywordToken.md).[`getFirstToken`](KeywordToken.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`KeywordToken`](KeywordToken.md).[`getFullStart`](KeywordToken.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`KeywordToken`](KeywordToken.md).[`getFullText`](KeywordToken.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`KeywordToken`](KeywordToken.md).[`getFullWidth`](KeywordToken.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`KeywordToken`](KeywordToken.md).[`getLastToken`](KeywordToken.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`KeywordToken`](KeywordToken.md).[`getLeadingTriviaWidth`](KeywordToken.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`KeywordToken`](KeywordToken.md).[`getSourceFile`](KeywordToken.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`KeywordToken`](KeywordToken.md).[`getStart`](KeywordToken.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`KeywordToken`](KeywordToken.md).[`getText`](KeywordToken.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`KeywordToken`](KeywordToken.md).[`getWidth`](KeywordToken.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/ModuleBlock.md b/docs/api_docs/namespaces/ts/interfaces/ModuleBlock.md new file mode 100644 index 0000000000000000000000000000000000000000..29b105351d649ecf67d4af6061f7daa560fed270 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ModuleBlock.md @@ -0,0 +1,497 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ModuleBlock + +# Interface: ModuleBlock + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1693 + +## Extends + +- [`Node`](Node.md).[`Statement`](Statement.md) + +## Properties + +### \_statementBrand + +> **\_statementBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1471 + +#### Inherited from + +[`Statement`](Statement.md).[`_statementBrand`](Statement.md#_statementbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Statement`](Statement.md).[`decorators`](Statement.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Statement`](Statement.md).[`end`](Statement.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Statement`](Statement.md).[`flags`](Statement.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`ModuleBlock`](../enumerations/SyntaxKind.md#moduleblock) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1694 + +#### Overrides + +[`Statement`](Statement.md).[`kind`](Statement.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Statement`](Statement.md).[`locals`](Statement.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Statement`](Statement.md).[`modifiers`](Statement.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`ModuleDeclaration`](ModuleDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1695 + +#### Overrides + +[`Statement`](Statement.md).[`parent`](Statement.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Statement`](Statement.md).[`pos`](Statement.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Statement`](Statement.md).[`skipCheck`](Statement.md#skipcheck) + +*** + +### statements + +> `readonly` **statements**: [`NodeArray`](NodeArray.md)\<[`Statement`](Statement.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1696 + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Statement`](Statement.md).[`symbol`](Statement.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Statement`](Statement.md).[`forEachChild`](Statement.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getChildAt`](Statement.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getChildCount`](Statement.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Statement`](Statement.md).[`getChildren`](Statement.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getEnd`](Statement.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getFirstToken`](Statement.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getFullStart`](Statement.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Statement`](Statement.md).[`getFullText`](Statement.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getFullWidth`](Statement.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getLastToken`](Statement.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getLeadingTriviaWidth`](Statement.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getSourceFile`](Statement.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getStart`](Statement.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Statement`](Statement.md).[`getText`](Statement.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getWidth`](Statement.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/ModuleDeclaration.md b/docs/api_docs/namespaces/ts/interfaces/ModuleDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..1aa236f58b58d263a6b870304201da7a1a60d66a --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ModuleDeclaration.md @@ -0,0 +1,526 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ModuleDeclaration + +# Interface: ModuleDeclaration + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1676 + +## Extends + +- [`DeclarationStatement`](DeclarationStatement.md).[`JSDocContainer`](JSDocContainer.md) + +## Extended by + +- [`NamespaceDeclaration`](NamespaceDeclaration.md) +- [`JSDocNamespaceDeclaration`](JSDocNamespaceDeclaration.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`_declarationBrand`](DeclarationStatement.md#_declarationbrand) + +*** + +### \_statementBrand + +> **\_statementBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1471 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`_statementBrand`](DeclarationStatement.md#_statementbrand) + +*** + +### body? + +> `readonly` `optional` **body**: [`ModuleBody`](../type-aliases/ModuleBody.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1681 + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`decorators`](DeclarationStatement.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`end`](DeclarationStatement.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`flags`](DeclarationStatement.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`ModuleDeclaration`](../enumerations/SyntaxKind.md#moduledeclaration) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1677 + +#### Overrides + +[`DeclarationStatement`](DeclarationStatement.md).[`kind`](DeclarationStatement.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`locals`](DeclarationStatement.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`Modifier`](../type-aliases/Modifier.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1679 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Overrides + +[`DeclarationStatement`](DeclarationStatement.md).[`modifiers`](DeclarationStatement.md#modifiers) + +*** + +### name + +> `readonly` **name**: [`ModuleName`](../type-aliases/ModuleName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1680 + +#### Overrides + +[`DeclarationStatement`](DeclarationStatement.md).[`name`](DeclarationStatement.md#name) + +*** + +### parent + +> `readonly` **parent**: [`SourceFile`](SourceFile.md) \| [`ModuleBody`](../type-aliases/ModuleBody.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1678 + +#### Overrides + +[`DeclarationStatement`](DeclarationStatement.md).[`parent`](DeclarationStatement.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`pos`](DeclarationStatement.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`skipCheck`](DeclarationStatement.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`symbol`](DeclarationStatement.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`forEachChild`](DeclarationStatement.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getChildAt`](DeclarationStatement.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getChildCount`](DeclarationStatement.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getChildren`](DeclarationStatement.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getEnd`](DeclarationStatement.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getFirstToken`](DeclarationStatement.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getFullStart`](DeclarationStatement.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getFullText`](DeclarationStatement.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getFullWidth`](DeclarationStatement.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getLastToken`](DeclarationStatement.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getLeadingTriviaWidth`](DeclarationStatement.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getSourceFile`](DeclarationStatement.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getStart`](DeclarationStatement.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getText`](DeclarationStatement.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getWidth`](DeclarationStatement.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/ModulePath.md b/docs/api_docs/namespaces/ts/interfaces/ModulePath.md new file mode 100644 index 0000000000000000000000000000000000000000..62049c9841952ffc1bcafd781c55269251ad4ba9 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ModulePath.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ModulePath + +# Interface: ModulePath + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4355 + +## Properties + +### isInNodeModules + +> **isInNodeModules**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4357 + +*** + +### isRedirect + +> **isRedirect**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4358 + +*** + +### path + +> **path**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4356 diff --git a/docs/api_docs/namespaces/ts/interfaces/ModuleResolutionCache.md b/docs/api_docs/namespaces/ts/interfaces/ModuleResolutionCache.md new file mode 100644 index 0000000000000000000000000000000000000000..5b0ee6dc85fc33afeb9157ef75d0a06a5a6248cc --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ModuleResolutionCache.md @@ -0,0 +1,125 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ModuleResolutionCache + +# Interface: ModuleResolutionCache + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5385 + +Cached resolutions per containing directory. +This assumes that any module id will have the same resolution for sibling files located in the same folder. + +## Extends + +- [`PerDirectoryResolutionCache`](PerDirectoryResolutionCache.md)\<[`ResolvedModuleWithFailedLookupLocations`](ResolvedModuleWithFailedLookupLocations.md)\>.[`NonRelativeModuleNameResolutionCache`](NonRelativeModuleNameResolutionCache.md).[`PackageJsonInfoCache`](PackageJsonInfoCache.md) + +## Methods + +### clear() + +> **clear**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5378 + +#### Returns + +`void` + +#### Inherited from + +[`PackageJsonInfoCache`](PackageJsonInfoCache.md).[`clear`](PackageJsonInfoCache.md#clear) + +*** + +### getOrCreateCacheForDirectory() + +> **getOrCreateCacheForDirectory**(`directoryName`, `redirectedReference`?): [`ModeAwareCache`](ModeAwareCache.md)\<[`ResolvedModuleWithFailedLookupLocations`](ResolvedModuleWithFailedLookupLocations.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5377 + +#### Parameters + +##### directoryName + +`string` + +##### redirectedReference? + +[`ResolvedProjectReference`](ResolvedProjectReference.md) + +#### Returns + +[`ModeAwareCache`](ModeAwareCache.md)\<[`ResolvedModuleWithFailedLookupLocations`](ResolvedModuleWithFailedLookupLocations.md)\> + +#### Inherited from + +[`PerDirectoryResolutionCache`](PerDirectoryResolutionCache.md).[`getOrCreateCacheForDirectory`](PerDirectoryResolutionCache.md#getorcreatecachefordirectory) + +*** + +### getOrCreateCacheForModuleName() + +> **getOrCreateCacheForModuleName**(`nonRelativeModuleName`, `mode`, `redirectedReference`?): [`PerModuleNameCache`](PerModuleNameCache.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5393 + +#### Parameters + +##### nonRelativeModuleName + +`string` + +##### mode + +`undefined` | [`CommonJS`](../enumerations/ModuleKind.md#commonjs) | [`ESNext`](../enumerations/ModuleKind.md#esnext) + +##### redirectedReference? + +[`ResolvedProjectReference`](ResolvedProjectReference.md) + +#### Returns + +[`PerModuleNameCache`](PerModuleNameCache.md) + +#### Inherited from + +[`NonRelativeModuleNameResolutionCache`](NonRelativeModuleNameResolutionCache.md).[`getOrCreateCacheForModuleName`](NonRelativeModuleNameResolutionCache.md#getorcreatecacheformodulename) + +*** + +### getPackageJsonInfoCache() + +> **getPackageJsonInfoCache**(): [`PackageJsonInfoCache`](PackageJsonInfoCache.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5386 + +#### Returns + +[`PackageJsonInfoCache`](PackageJsonInfoCache.md) + +*** + +### update() + +> **update**(`options`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5383 + +Updates with the current compilerOptions the cache will operate with. + This updates the redirects map as well if needed so module resolutions are cached if they can across the projects + +#### Parameters + +##### options + +[`CompilerOptions`](CompilerOptions.md) + +#### Returns + +`void` + +#### Inherited from + +[`PerDirectoryResolutionCache`](PerDirectoryResolutionCache.md).[`update`](PerDirectoryResolutionCache.md#update) diff --git a/docs/api_docs/namespaces/ts/interfaces/ModuleResolutionHost.md b/docs/api_docs/namespaces/ts/interfaces/ModuleResolutionHost.md new file mode 100644 index 0000000000000000000000000000000000000000..4647fa003e8b08986df1022db98f6419ae5820f0 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ModuleResolutionHost.md @@ -0,0 +1,210 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ModuleResolutionHost + +# Interface: ModuleResolutionHost + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3339 + +## Extended by + +- [`MinimalResolutionCacheHost`](MinimalResolutionCacheHost.md) +- [`CompilerHost`](CompilerHost.md) + +## Properties + +### useCaseSensitiveFileNames? + +> `optional` **useCaseSensitiveFileNames**: `boolean` \| () => `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3351 + +## Methods + +### directoryExists()? + +> `optional` **directoryExists**(`directoryName`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3343 + +#### Parameters + +##### directoryName + +`string` + +#### Returns + +`boolean` + +*** + +### fileExists() + +> **fileExists**(`fileName`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3340 + +#### Parameters + +##### fileName + +`string` + +#### Returns + +`boolean` + +*** + +### getCurrentDirectory()? + +> `optional` **getCurrentDirectory**(): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3349 + +#### Returns + +`string` + +*** + +### getDirectories()? + +> `optional` **getDirectories**(`path`): `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3350 + +#### Parameters + +##### path + +`string` + +#### Returns + +`string`[] + +*** + +### getFileCheckedModuleInfo()? + +> `optional` **getFileCheckedModuleInfo**(`containFilePath`): [`FileCheckModuleInfo`](FileCheckModuleInfo.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3354 + +#### Parameters + +##### containFilePath + +`string` + +#### Returns + +[`FileCheckModuleInfo`](FileCheckModuleInfo.md) + +*** + +### getJsDocNodeCheckedConfig()? + +> `optional` **getJsDocNodeCheckedConfig**(`jsDocFileCheckInfo`, `symbolSourceFilePath`): [`JsDocNodeCheckConfig`](JsDocNodeCheckConfig.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3352 + +#### Parameters + +##### jsDocFileCheckInfo + +[`FileCheckModuleInfo`](FileCheckModuleInfo.md) + +##### symbolSourceFilePath + +`string` + +#### Returns + +[`JsDocNodeCheckConfig`](JsDocNodeCheckConfig.md) + +*** + +### getJsDocNodeConditionCheckedResult()? + +> `optional` **getJsDocNodeConditionCheckedResult**(`jsDocFileCheckedInfo`, `jsDocs`): [`ConditionCheckResult`](ConditionCheckResult.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3353 + +#### Parameters + +##### jsDocFileCheckedInfo + +[`FileCheckModuleInfo`](FileCheckModuleInfo.md) + +##### jsDocs + +[`JsDocTagInfo`](JsDocTagInfo.md)[] + +#### Returns + +[`ConditionCheckResult`](ConditionCheckResult.md) + +*** + +### readFile() + +> **readFile**(`fileName`): `undefined` \| `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3341 + +#### Parameters + +##### fileName + +`string` + +#### Returns + +`undefined` \| `string` + +*** + +### realpath()? + +> `optional` **realpath**(`path`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3348 + +Resolve a symbolic link. + +#### Parameters + +##### path + +`string` + +#### Returns + +`string` + +#### See + +https://nodejs.org/api/fs.html#fs_fs_realpathsync_path_options + +*** + +### trace()? + +> `optional` **trace**(`s`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3342 + +#### Parameters + +##### s + +`string` + +#### Returns + +`void` diff --git a/docs/api_docs/namespaces/ts/interfaces/ModuleSpecifierCache.md b/docs/api_docs/namespaces/ts/interfaces/ModuleSpecifierCache.md new file mode 100644 index 0000000000000000000000000000000000000000..92050abb2ef60ee5e099ffc393b4c4229416e1a7 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ModuleSpecifierCache.md @@ -0,0 +1,169 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ModuleSpecifierCache + +# Interface: ModuleSpecifierCache + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4368 + +## Methods + +### clear() + +> **clear**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4373 + +#### Returns + +`void` + +*** + +### count() + +> **count**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4374 + +#### Returns + +`number` + +*** + +### get() + +> **get**(`fromFileName`, `toFileName`, `preferences`, `options`): `undefined` \| `Readonly`\<[`ResolvedModuleSpecifierInfo`](ResolvedModuleSpecifierInfo.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4369 + +#### Parameters + +##### fromFileName + +[`Path`](../type-aliases/Path.md) + +##### toFileName + +[`Path`](../type-aliases/Path.md) + +##### preferences + +[`UserPreferences`](UserPreferences.md) + +##### options + +[`ModuleSpecifierOptions`](ModuleSpecifierOptions.md) + +#### Returns + +`undefined` \| `Readonly`\<[`ResolvedModuleSpecifierInfo`](ResolvedModuleSpecifierInfo.md)\> + +*** + +### set() + +> **set**(`fromFileName`, `toFileName`, `preferences`, `options`, `modulePaths`, `moduleSpecifiers`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4370 + +#### Parameters + +##### fromFileName + +[`Path`](../type-aliases/Path.md) + +##### toFileName + +[`Path`](../type-aliases/Path.md) + +##### preferences + +[`UserPreferences`](UserPreferences.md) + +##### options + +[`ModuleSpecifierOptions`](ModuleSpecifierOptions.md) + +##### modulePaths + +readonly [`ModulePath`](ModulePath.md)[] + +##### moduleSpecifiers + +readonly `string`[] + +#### Returns + +`void` + +*** + +### setBlockedByPackageJsonDependencies() + +> **setBlockedByPackageJsonDependencies**(`fromFileName`, `toFileName`, `preferences`, `options`, `isBlockedByPackageJsonDependencies`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4371 + +#### Parameters + +##### fromFileName + +[`Path`](../type-aliases/Path.md) + +##### toFileName + +[`Path`](../type-aliases/Path.md) + +##### preferences + +[`UserPreferences`](UserPreferences.md) + +##### options + +[`ModuleSpecifierOptions`](ModuleSpecifierOptions.md) + +##### isBlockedByPackageJsonDependencies + +`boolean` + +#### Returns + +`void` + +*** + +### setModulePaths() + +> **setModulePaths**(`fromFileName`, `toFileName`, `preferences`, `options`, `modulePaths`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4372 + +#### Parameters + +##### fromFileName + +[`Path`](../type-aliases/Path.md) + +##### toFileName + +[`Path`](../type-aliases/Path.md) + +##### preferences + +[`UserPreferences`](UserPreferences.md) + +##### options + +[`ModuleSpecifierOptions`](ModuleSpecifierOptions.md) + +##### modulePaths + +readonly [`ModulePath`](ModulePath.md)[] + +#### Returns + +`void` diff --git a/docs/api_docs/namespaces/ts/interfaces/ModuleSpecifierOptions.md b/docs/api_docs/namespaces/ts/interfaces/ModuleSpecifierOptions.md new file mode 100644 index 0000000000000000000000000000000000000000..9f4fed6a059cea5656720cee5cc10ce1a79fecfb --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ModuleSpecifierOptions.md @@ -0,0 +1,17 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ModuleSpecifierOptions + +# Interface: ModuleSpecifierOptions + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4365 + +## Properties + +### overrideImportMode? + +> `optional` **overrideImportMode**: [`CommonJS`](../enumerations/ModuleKind.md#commonjs) \| [`ESNext`](../enumerations/ModuleKind.md#esnext) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4366 diff --git a/docs/api_docs/namespaces/ts/interfaces/ModuleSpecifierResolutionHost.md b/docs/api_docs/namespaces/ts/interfaces/ModuleSpecifierResolutionHost.md new file mode 100644 index 0000000000000000000000000000000000000000..f9b01839a6157eb499612a41d11dd16eeda39538 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ModuleSpecifierResolutionHost.md @@ -0,0 +1,211 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ModuleSpecifierResolutionHost + +# Interface: ModuleSpecifierResolutionHost + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4340 + +## Extended by + +- [`EmitHost`](EmitHost.md) + +## Properties + +### redirectTargetsMap + +> `readonly` **redirectTargetsMap**: [`RedirectTargetsMap`](../type-aliases/RedirectTargetsMap.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4351 + +## Methods + +### directoryExists()? + +> `optional` **directoryExists**(`path`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4344 + +#### Parameters + +##### path + +`string` + +#### Returns + +`boolean` + +*** + +### fileExists() + +> **fileExists**(`path`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4342 + +#### Parameters + +##### path + +`string` + +#### Returns + +`boolean` + +*** + +### getCurrentDirectory() + +> **getCurrentDirectory**(): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4343 + +#### Returns + +`string` + +*** + +### getGlobalTypingsCacheLocation()? + +> `optional` **getGlobalTypingsCacheLocation**(): `undefined` \| `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4349 + +#### Returns + +`undefined` \| `string` + +*** + +### getModuleSpecifierCache()? + +> `optional` **getModuleSpecifierCache**(): [`ModuleSpecifierCache`](ModuleSpecifierCache.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4347 + +#### Returns + +[`ModuleSpecifierCache`](ModuleSpecifierCache.md) + +*** + +### getNearestAncestorDirectoryWithPackageJson()? + +> `optional` **getNearestAncestorDirectoryWithPackageJson**(`fileName`, `rootDir`?): `undefined` \| `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4350 + +#### Parameters + +##### fileName + +`string` + +##### rootDir? + +`string` + +#### Returns + +`undefined` \| `string` + +*** + +### getPackageJsonInfoCache()? + +> `optional` **getPackageJsonInfoCache**(): `undefined` \| [`PackageJsonInfoCache`](PackageJsonInfoCache.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4348 + +#### Returns + +`undefined` \| [`PackageJsonInfoCache`](PackageJsonInfoCache.md) + +*** + +### getProjectReferenceRedirect() + +> **getProjectReferenceRedirect**(`fileName`): `undefined` \| `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4352 + +#### Parameters + +##### fileName + +`string` + +#### Returns + +`undefined` \| `string` + +*** + +### isSourceOfProjectReferenceRedirect() + +> **isSourceOfProjectReferenceRedirect**(`fileName`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4353 + +#### Parameters + +##### fileName + +`string` + +#### Returns + +`boolean` + +*** + +### readFile()? + +> `optional` **readFile**(`path`): `undefined` \| `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4345 + +#### Parameters + +##### path + +`string` + +#### Returns + +`undefined` \| `string` + +*** + +### realpath()? + +> `optional` **realpath**(`path`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4346 + +#### Parameters + +##### path + +`string` + +#### Returns + +`string` + +*** + +### useCaseSensitiveFileNames()? + +> `optional` **useCaseSensitiveFileNames**(): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4341 + +#### Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/interfaces/NamedDeclaration.md b/docs/api_docs/namespaces/ts/interfaces/NamedDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..74cf8378f5341bc5e185da26c34cc45c5a903a1b --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/NamedDeclaration.md @@ -0,0 +1,520 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / NamedDeclaration + +# Interface: NamedDeclaration + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:701 + +## Extends + +- [`Declaration`](Declaration.md) + +## Extended by + +- [`DeclarationStatement`](DeclarationStatement.md) +- [`TypeParameterDeclaration`](TypeParameterDeclaration.md) +- [`SignatureDeclarationBase`](SignatureDeclarationBase.md) +- [`VariableDeclaration`](VariableDeclaration.md) +- [`ParameterDeclaration`](ParameterDeclaration.md) +- [`BindingElement`](BindingElement.md) +- [`ObjectLiteralElement`](ObjectLiteralElement.md) +- [`PropertyLikeDeclaration`](PropertyLikeDeclaration.md) +- [`PropertyAccessExpression`](PropertyAccessExpression.md) +- [`ClassLikeDeclarationBase`](ClassLikeDeclarationBase.md) +- [`ClassElement`](ClassElement.md) +- [`TypeElement`](TypeElement.md) +- [`EnumMember`](EnumMember.md) +- [`ImportClause`](ImportClause.md) +- [`NamespaceImport`](NamespaceImport.md) +- [`NamespaceExport`](NamespaceExport.md) +- [`ImportSpecifier`](ImportSpecifier.md) +- [`ExportSpecifier`](ExportSpecifier.md) +- [`JSDocTypedefTag`](JSDocTypedefTag.md) +- [`JSDocCallbackTag`](JSDocCallbackTag.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`Declaration`](Declaration.md).[`_declarationBrand`](Declaration.md#_declarationbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Declaration`](Declaration.md).[`decorators`](Declaration.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Declaration`](Declaration.md).[`end`](Declaration.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Declaration`](Declaration.md).[`flags`](Declaration.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`SyntaxKind`](../enumerations/SyntaxKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:598 + +#### Inherited from + +[`Declaration`](Declaration.md).[`kind`](Declaration.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Declaration`](Declaration.md).[`locals`](Declaration.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Declaration`](Declaration.md).[`modifiers`](Declaration.md#modifiers) + +*** + +### name? + +> `readonly` `optional` **name**: [`DeclarationName`](../type-aliases/DeclarationName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:702 + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`Declaration`](Declaration.md).[`parent`](Declaration.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Declaration`](Declaration.md).[`pos`](Declaration.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Declaration`](Declaration.md).[`skipCheck`](Declaration.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Declaration`](Declaration.md).[`symbol`](Declaration.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Declaration`](Declaration.md).[`forEachChild`](Declaration.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getChildAt`](Declaration.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getChildCount`](Declaration.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Declaration`](Declaration.md).[`getChildren`](Declaration.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getEnd`](Declaration.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFirstToken`](Declaration.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFullStart`](Declaration.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFullText`](Declaration.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFullWidth`](Declaration.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getLastToken`](Declaration.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getLeadingTriviaWidth`](Declaration.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getSourceFile`](Declaration.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getStart`](Declaration.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getText`](Declaration.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getWidth`](Declaration.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/NamedExports.md b/docs/api_docs/namespaces/ts/interfaces/NamedExports.md new file mode 100644 index 0000000000000000000000000000000000000000..591ce5a865f3fb4ced3d05d848b26103cace46de --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/NamedExports.md @@ -0,0 +1,485 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / NamedExports + +# Interface: NamedExports + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1779 + +## Extends + +- [`Node`](Node.md) + +## Properties + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`decorators`](Node.md#decorators) + +*** + +### elements + +> `readonly` **elements**: [`NodeArray`](NodeArray.md)\<[`ExportSpecifier`](ExportSpecifier.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1782 + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Node`](Node.md).[`end`](Node.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Node`](Node.md).[`flags`](Node.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`NamedExports`](../enumerations/SyntaxKind.md#namedexports) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1780 + +#### Overrides + +[`Node`](Node.md).[`kind`](Node.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Node`](Node.md).[`locals`](Node.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`modifiers`](Node.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`ExportDeclaration`](ExportDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1781 + +#### Overrides + +[`Node`](Node.md).[`parent`](Node.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Node`](Node.md).[`pos`](Node.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Node`](Node.md).[`skipCheck`](Node.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Node`](Node.md).[`symbol`](Node.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Node`](Node.md).[`forEachChild`](Node.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getChildAt`](Node.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getChildCount`](Node.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Node`](Node.md).[`getChildren`](Node.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getEnd`](Node.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getFirstToken`](Node.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullStart`](Node.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getFullText`](Node.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullWidth`](Node.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getLastToken`](Node.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getLeadingTriviaWidth`](Node.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Node`](Node.md).[`getSourceFile`](Node.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getStart`](Node.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getText`](Node.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getWidth`](Node.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/NamedImports.md b/docs/api_docs/namespaces/ts/interfaces/NamedImports.md new file mode 100644 index 0000000000000000000000000000000000000000..5cd4b0e03cfbe4dfe41e487a44389cc0a9bb1027 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/NamedImports.md @@ -0,0 +1,485 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / NamedImports + +# Interface: NamedImports + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1774 + +## Extends + +- [`Node`](Node.md) + +## Properties + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`decorators`](Node.md#decorators) + +*** + +### elements + +> `readonly` **elements**: [`NodeArray`](NodeArray.md)\<[`ImportSpecifier`](ImportSpecifier.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1777 + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Node`](Node.md).[`end`](Node.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Node`](Node.md).[`flags`](Node.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`NamedImports`](../enumerations/SyntaxKind.md#namedimports) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1775 + +#### Overrides + +[`Node`](Node.md).[`kind`](Node.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Node`](Node.md).[`locals`](Node.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`modifiers`](Node.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`ImportClause`](ImportClause.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1776 + +#### Overrides + +[`Node`](Node.md).[`parent`](Node.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Node`](Node.md).[`pos`](Node.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Node`](Node.md).[`skipCheck`](Node.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Node`](Node.md).[`symbol`](Node.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Node`](Node.md).[`forEachChild`](Node.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getChildAt`](Node.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getChildCount`](Node.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Node`](Node.md).[`getChildren`](Node.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getEnd`](Node.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getFirstToken`](Node.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullStart`](Node.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getFullText`](Node.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullWidth`](Node.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getLastToken`](Node.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getLeadingTriviaWidth`](Node.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Node`](Node.md).[`getSourceFile`](Node.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getStart`](Node.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getText`](Node.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getWidth`](Node.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/NamedTupleMember.md b/docs/api_docs/namespaces/ts/interfaces/NamedTupleMember.md new file mode 100644 index 0000000000000000000000000000000000000000..fa86d5d9045a02a9b5270bdb4e6d9964025e242d --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/NamedTupleMember.md @@ -0,0 +1,533 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / NamedTupleMember + +# Interface: NamedTupleMember + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:976 + +## Extends + +- [`TypeNode`](TypeNode.md).[`JSDocContainer`](JSDocContainer.md).[`Declaration`](Declaration.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`Declaration`](Declaration.md).[`_declarationBrand`](Declaration.md#_declarationbrand) + +*** + +### \_typeNodeBrand + +> **\_typeNodeBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:912 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`_typeNodeBrand`](TypeNode.md#_typenodebrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Declaration`](Declaration.md).[`decorators`](Declaration.md#decorators) + +*** + +### dotDotDotToken? + +> `readonly` `optional` **dotDotDotToken**: [`Token`](Token.md)\<[`DotDotDotToken`](../enumerations/SyntaxKind.md#dotdotdottoken)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:978 + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Declaration`](Declaration.md).[`end`](Declaration.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Declaration`](Declaration.md).[`flags`](Declaration.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`NamedTupleMember`](../enumerations/SyntaxKind.md#namedtuplemember) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:977 + +#### Overrides + +[`Declaration`](Declaration.md).[`kind`](Declaration.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Declaration`](Declaration.md).[`locals`](Declaration.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Declaration`](Declaration.md).[`modifiers`](Declaration.md#modifiers) + +*** + +### name + +> `readonly` **name**: [`Identifier`](Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:979 + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`Declaration`](Declaration.md).[`parent`](Declaration.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Declaration`](Declaration.md).[`pos`](Declaration.md#pos) + +*** + +### questionToken? + +> `readonly` `optional` **questionToken**: [`Token`](Token.md)\<[`QuestionToken`](../enumerations/SyntaxKind.md#questiontoken)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:980 + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Declaration`](Declaration.md).[`skipCheck`](Declaration.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Declaration`](Declaration.md).[`symbol`](Declaration.md#symbol) + +*** + +### type + +> `readonly` **type**: [`TypeNode`](TypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:981 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Declaration`](Declaration.md).[`forEachChild`](Declaration.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getChildAt`](Declaration.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getChildCount`](Declaration.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Declaration`](Declaration.md).[`getChildren`](Declaration.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getEnd`](Declaration.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFirstToken`](Declaration.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFullStart`](Declaration.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFullText`](Declaration.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFullWidth`](Declaration.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getLastToken`](Declaration.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getLeadingTriviaWidth`](Declaration.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getSourceFile`](Declaration.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getStart`](Declaration.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getText`](Declaration.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getWidth`](Declaration.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/NamespaceDeclaration.md b/docs/api_docs/namespaces/ts/interfaces/NamespaceDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..9059c5fc0dc8e682b74a1ade6cd2b89251eac20b --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/NamespaceDeclaration.md @@ -0,0 +1,525 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / NamespaceDeclaration + +# Interface: NamespaceDeclaration + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1684 + +## Extends + +- [`ModuleDeclaration`](ModuleDeclaration.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`ModuleDeclaration`](ModuleDeclaration.md).[`_declarationBrand`](ModuleDeclaration.md#_declarationbrand) + +*** + +### \_statementBrand + +> **\_statementBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1471 + +#### Inherited from + +[`ModuleDeclaration`](ModuleDeclaration.md).[`_statementBrand`](ModuleDeclaration.md#_statementbrand) + +*** + +### body + +> `readonly` **body**: [`NamespaceBody`](../type-aliases/NamespaceBody.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1686 + +#### Overrides + +[`ModuleDeclaration`](ModuleDeclaration.md).[`body`](ModuleDeclaration.md#body) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`ModuleDeclaration`](ModuleDeclaration.md).[`decorators`](ModuleDeclaration.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`ModuleDeclaration`](ModuleDeclaration.md).[`end`](ModuleDeclaration.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`ModuleDeclaration`](ModuleDeclaration.md).[`flags`](ModuleDeclaration.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`ModuleDeclaration`](../enumerations/SyntaxKind.md#moduledeclaration) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1677 + +#### Inherited from + +[`ModuleDeclaration`](ModuleDeclaration.md).[`kind`](ModuleDeclaration.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`ModuleDeclaration`](ModuleDeclaration.md).[`locals`](ModuleDeclaration.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`Modifier`](../type-aliases/Modifier.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1679 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`ModuleDeclaration`](ModuleDeclaration.md).[`modifiers`](ModuleDeclaration.md#modifiers) + +*** + +### name + +> `readonly` **name**: [`Identifier`](Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1685 + +#### Overrides + +[`ModuleDeclaration`](ModuleDeclaration.md).[`name`](ModuleDeclaration.md#name) + +*** + +### parent + +> `readonly` **parent**: [`SourceFile`](SourceFile.md) \| [`ModuleBody`](../type-aliases/ModuleBody.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1678 + +#### Inherited from + +[`ModuleDeclaration`](ModuleDeclaration.md).[`parent`](ModuleDeclaration.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`ModuleDeclaration`](ModuleDeclaration.md).[`pos`](ModuleDeclaration.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`ModuleDeclaration`](ModuleDeclaration.md).[`skipCheck`](ModuleDeclaration.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`ModuleDeclaration`](ModuleDeclaration.md).[`symbol`](ModuleDeclaration.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`ModuleDeclaration`](ModuleDeclaration.md).[`forEachChild`](ModuleDeclaration.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`ModuleDeclaration`](ModuleDeclaration.md).[`getChildAt`](ModuleDeclaration.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`ModuleDeclaration`](ModuleDeclaration.md).[`getChildCount`](ModuleDeclaration.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`ModuleDeclaration`](ModuleDeclaration.md).[`getChildren`](ModuleDeclaration.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`ModuleDeclaration`](ModuleDeclaration.md).[`getEnd`](ModuleDeclaration.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`ModuleDeclaration`](ModuleDeclaration.md).[`getFirstToken`](ModuleDeclaration.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`ModuleDeclaration`](ModuleDeclaration.md).[`getFullStart`](ModuleDeclaration.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`ModuleDeclaration`](ModuleDeclaration.md).[`getFullText`](ModuleDeclaration.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`ModuleDeclaration`](ModuleDeclaration.md).[`getFullWidth`](ModuleDeclaration.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`ModuleDeclaration`](ModuleDeclaration.md).[`getLastToken`](ModuleDeclaration.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`ModuleDeclaration`](ModuleDeclaration.md).[`getLeadingTriviaWidth`](ModuleDeclaration.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`ModuleDeclaration`](ModuleDeclaration.md).[`getSourceFile`](ModuleDeclaration.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`ModuleDeclaration`](ModuleDeclaration.md).[`getStart`](ModuleDeclaration.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`ModuleDeclaration`](ModuleDeclaration.md).[`getText`](ModuleDeclaration.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`ModuleDeclaration`](ModuleDeclaration.md).[`getWidth`](ModuleDeclaration.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/NamespaceExport.md b/docs/api_docs/namespaces/ts/interfaces/NamespaceExport.md new file mode 100644 index 0000000000000000000000000000000000000000..2ead3e1ffed85f8be8eee2c01797432119054a76 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/NamespaceExport.md @@ -0,0 +1,501 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / NamespaceExport + +# Interface: NamespaceExport + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1754 + +## Extends + +- [`NamedDeclaration`](NamedDeclaration.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`_declarationBrand`](NamedDeclaration.md#_declarationbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`decorators`](NamedDeclaration.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`end`](NamedDeclaration.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`flags`](NamedDeclaration.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`NamespaceExport`](../enumerations/SyntaxKind.md#namespaceexport) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1755 + +#### Overrides + +[`NamedDeclaration`](NamedDeclaration.md).[`kind`](NamedDeclaration.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`locals`](NamedDeclaration.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`modifiers`](NamedDeclaration.md#modifiers) + +*** + +### name + +> `readonly` **name**: [`Identifier`](Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1757 + +#### Overrides + +[`NamedDeclaration`](NamedDeclaration.md).[`name`](NamedDeclaration.md#name) + +*** + +### parent + +> `readonly` **parent**: [`ExportDeclaration`](ExportDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1756 + +#### Overrides + +[`NamedDeclaration`](NamedDeclaration.md).[`parent`](NamedDeclaration.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`pos`](NamedDeclaration.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`skipCheck`](NamedDeclaration.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`symbol`](NamedDeclaration.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`forEachChild`](NamedDeclaration.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getChildAt`](NamedDeclaration.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getChildCount`](NamedDeclaration.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getChildren`](NamedDeclaration.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getEnd`](NamedDeclaration.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFirstToken`](NamedDeclaration.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFullStart`](NamedDeclaration.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFullText`](NamedDeclaration.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFullWidth`](NamedDeclaration.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getLastToken`](NamedDeclaration.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getLeadingTriviaWidth`](NamedDeclaration.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getSourceFile`](NamedDeclaration.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getStart`](NamedDeclaration.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getText`](NamedDeclaration.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getWidth`](NamedDeclaration.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/NamespaceExportDeclaration.md b/docs/api_docs/namespaces/ts/interfaces/NamespaceExportDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..eaf67982dff2d0733b416a5af0caefea8e8eddde --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/NamespaceExportDeclaration.md @@ -0,0 +1,513 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / NamespaceExportDeclaration + +# Interface: NamespaceExportDeclaration + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1759 + +## Extends + +- [`DeclarationStatement`](DeclarationStatement.md).[`JSDocContainer`](JSDocContainer.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`_declarationBrand`](DeclarationStatement.md#_declarationbrand) + +*** + +### \_statementBrand + +> **\_statementBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1471 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`_statementBrand`](DeclarationStatement.md#_statementbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`decorators`](DeclarationStatement.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`end`](DeclarationStatement.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`flags`](DeclarationStatement.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`NamespaceExportDeclaration`](../enumerations/SyntaxKind.md#namespaceexportdeclaration) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1760 + +#### Overrides + +[`DeclarationStatement`](DeclarationStatement.md).[`kind`](DeclarationStatement.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`locals`](DeclarationStatement.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`modifiers`](DeclarationStatement.md#modifiers) + +*** + +### name + +> `readonly` **name**: [`Identifier`](Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1761 + +#### Overrides + +[`DeclarationStatement`](DeclarationStatement.md).[`name`](DeclarationStatement.md#name) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`parent`](DeclarationStatement.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`pos`](DeclarationStatement.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`skipCheck`](DeclarationStatement.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`symbol`](DeclarationStatement.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`forEachChild`](DeclarationStatement.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getChildAt`](DeclarationStatement.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getChildCount`](DeclarationStatement.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getChildren`](DeclarationStatement.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getEnd`](DeclarationStatement.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getFirstToken`](DeclarationStatement.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getFullStart`](DeclarationStatement.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getFullText`](DeclarationStatement.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getFullWidth`](DeclarationStatement.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getLastToken`](DeclarationStatement.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getLeadingTriviaWidth`](DeclarationStatement.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getSourceFile`](DeclarationStatement.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getStart`](DeclarationStatement.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getText`](DeclarationStatement.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getWidth`](DeclarationStatement.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/NamespaceImport.md b/docs/api_docs/namespaces/ts/interfaces/NamespaceImport.md new file mode 100644 index 0000000000000000000000000000000000000000..ffbb0049f35a9c64dbfcf0e3188df4400314871a --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/NamespaceImport.md @@ -0,0 +1,501 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / NamespaceImport + +# Interface: NamespaceImport + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1749 + +## Extends + +- [`NamedDeclaration`](NamedDeclaration.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`_declarationBrand`](NamedDeclaration.md#_declarationbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`decorators`](NamedDeclaration.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`end`](NamedDeclaration.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`flags`](NamedDeclaration.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`NamespaceImport`](../enumerations/SyntaxKind.md#namespaceimport) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1750 + +#### Overrides + +[`NamedDeclaration`](NamedDeclaration.md).[`kind`](NamedDeclaration.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`locals`](NamedDeclaration.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`modifiers`](NamedDeclaration.md#modifiers) + +*** + +### name + +> `readonly` **name**: [`Identifier`](Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1752 + +#### Overrides + +[`NamedDeclaration`](NamedDeclaration.md).[`name`](NamedDeclaration.md#name) + +*** + +### parent + +> `readonly` **parent**: [`ImportClause`](ImportClause.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1751 + +#### Overrides + +[`NamedDeclaration`](NamedDeclaration.md).[`parent`](NamedDeclaration.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`pos`](NamedDeclaration.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`skipCheck`](NamedDeclaration.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`symbol`](NamedDeclaration.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`forEachChild`](NamedDeclaration.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getChildAt`](NamedDeclaration.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getChildCount`](NamedDeclaration.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getChildren`](NamedDeclaration.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getEnd`](NamedDeclaration.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFirstToken`](NamedDeclaration.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFullStart`](NamedDeclaration.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFullText`](NamedDeclaration.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFullWidth`](NamedDeclaration.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getLastToken`](NamedDeclaration.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getLeadingTriviaWidth`](NamedDeclaration.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getSourceFile`](NamedDeclaration.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getStart`](NamedDeclaration.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getText`](NamedDeclaration.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getWidth`](NamedDeclaration.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/NavigateToItem.md b/docs/api_docs/namespaces/ts/interfaces/NavigateToItem.md new file mode 100644 index 0000000000000000000000000000000000000000..91dcc08f6ec5053db5617f55373f6c641f3db459 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/NavigateToItem.md @@ -0,0 +1,81 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / NavigateToItem + +# Interface: NavigateToItem + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6741 + +## Properties + +### containerKind + +> **containerKind**: [`ScriptElementKind`](../enumerations/ScriptElementKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6750 + +*** + +### containerName + +> **containerName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6749 + +*** + +### fileName + +> **fileName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6747 + +*** + +### isCaseSensitive + +> **isCaseSensitive**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6746 + +*** + +### kind + +> **kind**: [`ScriptElementKind`](../enumerations/ScriptElementKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6743 + +*** + +### kindModifiers + +> **kindModifiers**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6744 + +*** + +### matchKind + +> **matchKind**: `"substring"` \| `"exact"` \| `"prefix"` \| `"camelCase"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6745 + +*** + +### name + +> **name**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6742 + +*** + +### textSpan + +> **textSpan**: [`TextSpan`](TextSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6748 diff --git a/docs/api_docs/namespaces/ts/interfaces/NavigationBarItem.md b/docs/api_docs/namespaces/ts/interfaces/NavigationBarItem.md new file mode 100644 index 0000000000000000000000000000000000000000..a6ec4caaf0af4497c45c8d3066fcb19252854ddf --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/NavigationBarItem.md @@ -0,0 +1,78 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / NavigationBarItem + +# Interface: NavigationBarItem + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6532 + +Navigation bar interface designed for visual studio's dual-column layout. +This does not form a proper tree. +The navbar is returned as a list of top-level items, each of which has a list of child items. +Child items always have an empty array for their `childItems`. + +## Properties + +### bolded + +> **bolded**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6539 + +*** + +### childItems + +> **childItems**: [`NavigationBarItem`](NavigationBarItem.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6537 + +*** + +### grayed + +> **grayed**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6540 + +*** + +### indent + +> **indent**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6538 + +*** + +### kind + +> **kind**: [`ScriptElementKind`](../enumerations/ScriptElementKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6534 + +*** + +### kindModifiers + +> **kindModifiers**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6535 + +*** + +### spans + +> **spans**: [`TextSpan`](TextSpan.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6536 + +*** + +### text + +> **text**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6533 diff --git a/docs/api_docs/namespaces/ts/interfaces/NavigationTree.md b/docs/api_docs/namespaces/ts/interfaces/NavigationTree.md new file mode 100644 index 0000000000000000000000000000000000000000..c9b70afd9b325167fc0f4bda7eb10fc2a651150f --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/NavigationTree.md @@ -0,0 +1,69 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / NavigationTree + +# Interface: NavigationTree + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6546 + +Node in a tree of nested declarations in a file. +The top node is always a script or module node. + +## Properties + +### childItems? + +> `optional` **childItems**: [`NavigationTree`](NavigationTree.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6559 + +Present if non-empty + +*** + +### kind + +> **kind**: [`ScriptElementKind`](../enumerations/ScriptElementKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6549 + +*** + +### kindModifiers + +> **kindModifiers**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6551 + +ScriptElementKindModifier separated by commas, e.g. "public,abstract" + +*** + +### nameSpan + +> **nameSpan**: `undefined` \| [`TextSpan`](TextSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6557 + +*** + +### spans + +> **spans**: [`TextSpan`](TextSpan.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6556 + +Spans of the nodes that generated this declaration. +There will be more than one if this is the result of merging. + +*** + +### text + +> **text**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6548 + +Name of the declaration, or a short description, e.g. "". diff --git a/docs/api_docs/namespaces/ts/interfaces/NewExpression.md b/docs/api_docs/namespaces/ts/interfaces/NewExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..70cfdea9b92e9e2d3c24239b397f838c65e38342 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/NewExpression.md @@ -0,0 +1,585 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / NewExpression + +# Interface: NewExpression + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1357 + +## Extends + +- [`PrimaryExpression`](PrimaryExpression.md).[`Declaration`](Declaration.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`Declaration`](Declaration.md).[`_declarationBrand`](Declaration.md#_declarationbrand) + +*** + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_expressionBrand`](PrimaryExpression.md#_expressionbrand) + +*** + +### \_leftHandSideExpressionBrand + +> **\_leftHandSideExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1086 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_leftHandSideExpressionBrand`](PrimaryExpression.md#_lefthandsideexpressionbrand) + +*** + +### \_memberExpressionBrand + +> **\_memberExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1089 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_memberExpressionBrand`](PrimaryExpression.md#_memberexpressionbrand) + +*** + +### \_primaryExpressionBrand + +> **\_primaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1092 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_primaryExpressionBrand`](PrimaryExpression.md#_primaryexpressionbrand) + +*** + +### \_unaryExpressionBrand + +> **\_unaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1066 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_unaryExpressionBrand`](PrimaryExpression.md#_unaryexpressionbrand) + +*** + +### \_updateExpressionBrand + +> **\_updateExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1071 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_updateExpressionBrand`](PrimaryExpression.md#_updateexpressionbrand) + +*** + +### arguments? + +> `readonly` `optional` **arguments**: [`NodeArray`](NodeArray.md)\<[`Expression`](Expression.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1361 + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Declaration`](Declaration.md).[`decorators`](Declaration.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Declaration`](Declaration.md).[`end`](Declaration.md#end) + +*** + +### expression + +> `readonly` **expression**: [`LeftHandSideExpression`](LeftHandSideExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1359 + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Declaration`](Declaration.md).[`flags`](Declaration.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`NewExpression`](../enumerations/SyntaxKind.md#newexpression) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1358 + +#### Overrides + +[`Declaration`](Declaration.md).[`kind`](Declaration.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Declaration`](Declaration.md).[`locals`](Declaration.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Declaration`](Declaration.md).[`modifiers`](Declaration.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`Declaration`](Declaration.md).[`parent`](Declaration.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Declaration`](Declaration.md).[`pos`](Declaration.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Declaration`](Declaration.md).[`skipCheck`](Declaration.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Declaration`](Declaration.md).[`symbol`](Declaration.md#symbol) + +*** + +### typeArguments? + +> `readonly` `optional` **typeArguments**: [`NodeArray`](NodeArray.md)\<[`TypeNode`](TypeNode.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1360 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Declaration`](Declaration.md).[`forEachChild`](Declaration.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getChildAt`](Declaration.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getChildCount`](Declaration.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Declaration`](Declaration.md).[`getChildren`](Declaration.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getEnd`](Declaration.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFirstToken`](Declaration.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFullStart`](Declaration.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFullText`](Declaration.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFullWidth`](Declaration.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getLastToken`](Declaration.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getLeadingTriviaWidth`](Declaration.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getSourceFile`](Declaration.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getStart`](Declaration.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getText`](Declaration.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getWidth`](Declaration.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/NoSubstitutionTemplateLiteral.md b/docs/api_docs/namespaces/ts/interfaces/NoSubstitutionTemplateLiteral.md new file mode 100644 index 0000000000000000000000000000000000000000..1ff092e903576525e6a43c83e85ba2e514c67dd5 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/NoSubstitutionTemplateLiteral.md @@ -0,0 +1,621 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / NoSubstitutionTemplateLiteral + +# Interface: NoSubstitutionTemplateLiteral + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1232 + +## Extends + +- [`LiteralExpression`](LiteralExpression.md).[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`Declaration`](Declaration.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`Declaration`](Declaration.md).[`_declarationBrand`](Declaration.md#_declarationbrand) + +*** + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`_expressionBrand`](LiteralExpression.md#_expressionbrand) + +*** + +### \_leftHandSideExpressionBrand + +> **\_leftHandSideExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1086 + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`_leftHandSideExpressionBrand`](LiteralExpression.md#_lefthandsideexpressionbrand) + +*** + +### \_literalExpressionBrand + +> **\_literalExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1227 + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`_literalExpressionBrand`](LiteralExpression.md#_literalexpressionbrand) + +*** + +### \_memberExpressionBrand + +> **\_memberExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1089 + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`_memberExpressionBrand`](LiteralExpression.md#_memberexpressionbrand) + +*** + +### \_primaryExpressionBrand + +> **\_primaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1092 + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`_primaryExpressionBrand`](LiteralExpression.md#_primaryexpressionbrand) + +*** + +### \_unaryExpressionBrand + +> **\_unaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1066 + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`_unaryExpressionBrand`](LiteralExpression.md#_unaryexpressionbrand) + +*** + +### \_updateExpressionBrand + +> **\_updateExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1071 + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`_updateExpressionBrand`](LiteralExpression.md#_updateexpressionbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Declaration`](Declaration.md).[`decorators`](Declaration.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Declaration`](Declaration.md).[`end`](Declaration.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Declaration`](Declaration.md).[`flags`](Declaration.md#flags) + +*** + +### hasExtendedUnicodeEscape? + +> `optional` **hasExtendedUnicodeEscape**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1221 + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`hasExtendedUnicodeEscape`](TemplateLiteralLikeNode.md#hasextendedunicodeescape) + +*** + +### isUnterminated? + +> `optional` **isUnterminated**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1220 + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`isUnterminated`](TemplateLiteralLikeNode.md#isunterminated) + +*** + +### kind + +> `readonly` **kind**: [`NoSubstitutionTemplateLiteral`](../enumerations/SyntaxKind.md#nosubstitutiontemplateliteral) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1233 + +#### Overrides + +[`Declaration`](Declaration.md).[`kind`](Declaration.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Declaration`](Declaration.md).[`locals`](Declaration.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Declaration`](Declaration.md).[`modifiers`](Declaration.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`Declaration`](Declaration.md).[`parent`](Declaration.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Declaration`](Declaration.md).[`pos`](Declaration.md#pos) + +*** + +### rawText? + +> `optional` **rawText**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1224 + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`rawText`](TemplateLiteralLikeNode.md#rawtext) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Declaration`](Declaration.md).[`skipCheck`](Declaration.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Declaration`](Declaration.md).[`symbol`](Declaration.md#symbol) + +*** + +### text + +> **text**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1219 + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`text`](TemplateLiteralLikeNode.md#text) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Declaration`](Declaration.md).[`forEachChild`](Declaration.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getChildAt`](Declaration.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getChildCount`](Declaration.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Declaration`](Declaration.md).[`getChildren`](Declaration.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getEnd`](Declaration.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFirstToken`](Declaration.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFullStart`](Declaration.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFullText`](Declaration.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFullWidth`](Declaration.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getLastToken`](Declaration.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getLeadingTriviaWidth`](Declaration.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getSourceFile`](Declaration.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getStart`](Declaration.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getText`](Declaration.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getWidth`](Declaration.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/Node.md b/docs/api_docs/namespaces/ts/interfaces/Node.md new file mode 100644 index 0000000000000000000000000000000000000000..8e96d479ecc4de8ed3df76692cde6e1319df39e1 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/Node.md @@ -0,0 +1,427 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / Node + +# Interface: Node + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:597 + +## Extends + +- [`ReadonlyTextRange`](ReadonlyTextRange.md) + +## Extended by + +- [`Token`](Token.md) +- [`QualifiedName`](QualifiedName.md) +- [`Declaration`](Declaration.md) +- [`ComputedPropertyName`](ComputedPropertyName.md) +- [`Decorator`](Decorator.md) +- [`VariableDeclarationList`](VariableDeclarationList.md) +- [`ObjectBindingPattern`](ObjectBindingPattern.md) +- [`ArrayBindingPattern`](ArrayBindingPattern.md) +- [`TypeNode`](TypeNode.md) +- [`ImportTypeAssertionContainer`](ImportTypeAssertionContainer.md) +- [`Expression`](Expression.md) +- [`LiteralLikeNode`](LiteralLikeNode.md) +- [`TemplateSpan`](TemplateSpan.md) +- [`JsxClosingElement`](JsxClosingElement.md) +- [`Statement`](Statement.md) +- [`CaseBlock`](CaseBlock.md) +- [`CaseClause`](CaseClause.md) +- [`DefaultClause`](DefaultClause.md) +- [`CatchClause`](CatchClause.md) +- [`HeritageClause`](HeritageClause.md) +- [`ModuleBlock`](ModuleBlock.md) +- [`ExternalModuleReference`](ExternalModuleReference.md) +- [`AssertEntry`](AssertEntry.md) +- [`AssertClause`](AssertClause.md) +- [`NamedImports`](NamedImports.md) +- [`NamedExports`](NamedExports.md) +- [`JSDocNameReference`](JSDocNameReference.md) +- [`JSDocMemberName`](JSDocMemberName.md) +- [`JSDoc`](JSDoc.md) +- [`JSDocTag`](JSDocTag.md) +- [`JSDocLink`](JSDocLink.md) +- [`JSDocLinkCode`](JSDocLinkCode.md) +- [`JSDocLinkPlain`](JSDocLinkPlain.md) +- [`JSDocText`](JSDocText.md) +- [`Bundle`](Bundle.md) +- [`InputFiles`](InputFiles.md) +- [`UnparsedSource`](UnparsedSource.md) +- [`UnparsedSection`](UnparsedSection.md) +- [`SyntaxList`](SyntaxList.md) + +## Properties + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`ReadonlyTextRange`](ReadonlyTextRange.md).[`end`](ReadonlyTextRange.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +*** + +### kind + +> `readonly` **kind**: [`SyntaxKind`](../enumerations/SyntaxKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:598 + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`ReadonlyTextRange`](ReadonlyTextRange.md).[`pos`](ReadonlyTextRange.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` diff --git a/docs/api_docs/namespaces/ts/interfaces/NodeArray.md b/docs/api_docs/namespaces/ts/interfaces/NodeArray.md new file mode 100644 index 0000000000000000000000000000000000000000..5840186b2f7d3345225ec1a8eb9da2dac67a951a --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/NodeArray.md @@ -0,0 +1,1129 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / NodeArray + +# Interface: NodeArray\ + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:615 + +## Extends + +- `ReadonlyArray`\<`T`\>.[`ReadonlyTextRange`](ReadonlyTextRange.md) + +## Type Parameters + +• **T** *extends* [`Node`](Node.md) + +## Indexable + +\[`n`: `number`\]: `T` + +## Properties + +### \[unscopables\] + +> `readonly` **\[unscopables\]**: `object` + +Defined in: node\_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:107 + +Is an object whose properties have the value 'true' +when they will be absent when used in a 'with' statement. + +#### Index Signature + +\[`key`: `number`\]: `undefined` \| `boolean` + +#### \[iterator\]? + +> `optional` **\[iterator\]**: `boolean` + +#### \[unscopables\]? + +> `readonly` `optional` **\[unscopables\]**: `boolean` + +Is an object whose properties have the value 'true' +when they will be absent when used in a 'with' statement. + +#### at? + +> `optional` **at**: `boolean` + +#### concat? + +> `optional` **concat**: `boolean` + +#### entries? + +> `optional` **entries**: `boolean` + +#### every? + +> `optional` **every**: `boolean` + +#### filter? + +> `optional` **filter**: `boolean` + +#### find? + +> `optional` **find**: `boolean` + +#### findIndex? + +> `optional` **findIndex**: `boolean` + +#### flat? + +> `optional` **flat**: `boolean` + +#### flatMap? + +> `optional` **flatMap**: `boolean` + +#### forEach? + +> `optional` **forEach**: `boolean` + +#### includes? + +> `optional` **includes**: `boolean` + +#### indexOf? + +> `optional` **indexOf**: `boolean` + +#### join? + +> `optional` **join**: `boolean` + +#### keys? + +> `optional` **keys**: `boolean` + +#### lastIndexOf? + +> `optional` **lastIndexOf**: `boolean` + +#### length? + +> `readonly` `optional` **length**: `boolean` + +Gets the length of the array. This is a number one higher than the highest element defined in an array. + +#### map? + +> `optional` **map**: `boolean` + +#### reduce? + +> `optional` **reduce**: `boolean` + +#### reduceRight? + +> `optional` **reduceRight**: `boolean` + +#### slice? + +> `optional` **slice**: `boolean` + +#### some? + +> `optional` **some**: `boolean` + +#### toLocaleString? + +> `optional` **toLocaleString**: `boolean` + +#### toString? + +> `optional` **toString**: `boolean` + +#### values? + +> `optional` **values**: `boolean` + +#### Inherited from + +`ReadonlyArray.[unscopables]` + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`ReadonlyTextRange`](ReadonlyTextRange.md).[`end`](ReadonlyTextRange.md#end) + +*** + +### hasTrailingComma + +> `readonly` **hasTrailingComma**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:616 + +*** + +### length + +> `readonly` **length**: `number` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1192 + +Gets the length of the array. This is a number one higher than the highest element defined in an array. + +#### Inherited from + +`ReadonlyArray.length` + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`ReadonlyTextRange`](ReadonlyTextRange.md).[`pos`](ReadonlyTextRange.md#pos) + +## Methods + +### \[iterator\]() + +> **\[iterator\]**(): `IterableIterator`\<`T`\> + +Defined in: node\_modules/typescript/lib/lib.es2015.iterable.d.ts:94 + +Iterator of values in the array. + +#### Returns + +`IterableIterator`\<`T`\> + +#### Inherited from + +`ReadonlyArray.[iterator]` + +*** + +### at() + +> **at**(`index`): `undefined` \| `T` + +Defined in: node\_modules/@types/node/compatibility/indexable.d.ts:7 + +#### Parameters + +##### index + +`number` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +`ReadonlyArray.at` + +*** + +### concat() + +#### Call Signature + +> **concat**(...`items`): `T`[] + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1205 + +Combines two or more arrays. + +##### Parameters + +###### items + +...`ConcatArray`\<`T`\>[] + +Additional items to add to the end of array1. + +##### Returns + +`T`[] + +##### Inherited from + +`ReadonlyArray.concat` + +#### Call Signature + +> **concat**(...`items`): `T`[] + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1210 + +Combines two or more arrays. + +##### Parameters + +###### items + +...(`T` \| `ConcatArray`\<`T`\>)[] + +Additional items to add to the end of array1. + +##### Returns + +`T`[] + +##### Inherited from + +`ReadonlyArray.concat` + +*** + +### entries() + +> **entries**(): `IterableIterator`\<\[`number`, `T`\]\> + +Defined in: node\_modules/typescript/lib/lib.es2015.iterable.d.ts:99 + +Returns an iterable of key, value pairs for every entry in the array + +#### Returns + +`IterableIterator`\<\[`number`, `T`\]\> + +#### Inherited from + +`ReadonlyArray.entries` + +*** + +### every() + +#### Call Signature + +> **every**\<`S`\>(`predicate`, `thisArg`?): `this is readonly S[]` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1242 + +Determines whether all the members of an array satisfy the specified test. + +##### Type Parameters + +• **S** *extends* [`Node`](Node.md) + +##### Parameters + +###### predicate + +(`value`, `index`, `array`) => `value is S` + +A function that accepts up to three arguments. The every method calls +the predicate function for each element in the array until the predicate returns a value +which is coercible to the Boolean value false, or until the end of the array. + +###### thisArg? + +`any` + +An object to which the this keyword can refer in the predicate function. +If thisArg is omitted, undefined is used as the this value. + +##### Returns + +`this is readonly S[]` + +##### Inherited from + +`ReadonlyArray.every` + +#### Call Signature + +> **every**(`predicate`, `thisArg`?): `boolean` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1251 + +Determines whether all the members of an array satisfy the specified test. + +##### Parameters + +###### predicate + +(`value`, `index`, `array`) => `unknown` + +A function that accepts up to three arguments. The every method calls +the predicate function for each element in the array until the predicate returns a value +which is coercible to the Boolean value false, or until the end of the array. + +###### thisArg? + +`any` + +An object to which the this keyword can refer in the predicate function. +If thisArg is omitted, undefined is used as the this value. + +##### Returns + +`boolean` + +##### Inherited from + +`ReadonlyArray.every` + +*** + +### filter() + +#### Call Signature + +> **filter**\<`S`\>(`predicate`, `thisArg`?): `S`[] + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1278 + +Returns the elements of an array that meet the condition specified in a callback function. + +##### Type Parameters + +• **S** *extends* [`Node`](Node.md) + +##### Parameters + +###### predicate + +(`value`, `index`, `array`) => `value is S` + +A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array. + +###### thisArg? + +`any` + +An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value. + +##### Returns + +`S`[] + +##### Inherited from + +`ReadonlyArray.filter` + +#### Call Signature + +> **filter**(`predicate`, `thisArg`?): `T`[] + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1284 + +Returns the elements of an array that meet the condition specified in a callback function. + +##### Parameters + +###### predicate + +(`value`, `index`, `array`) => `unknown` + +A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array. + +###### thisArg? + +`any` + +An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value. + +##### Returns + +`T`[] + +##### Inherited from + +`ReadonlyArray.filter` + +*** + +### find() + +#### Call Signature + +> **find**\<`S`\>(`predicate`, `thisArg`?): `undefined` \| `S` + +Defined in: node\_modules/typescript/lib/lib.es2015.core.d.ts:350 + +Returns the value of the first element in the array where predicate is true, and undefined +otherwise. + +##### Type Parameters + +• **S** *extends* [`Node`](Node.md) + +##### Parameters + +###### predicate + +(`value`, `index`, `obj`) => `value is S` + +find calls predicate once for each element of the array, in ascending +order, until it finds one where predicate returns true. If such an element is found, find +immediately returns that element value. Otherwise, find returns undefined. + +###### thisArg? + +`any` + +If provided, it will be used as the this value for each invocation of +predicate. If it is not provided, undefined is used instead. + +##### Returns + +`undefined` \| `S` + +##### Inherited from + +`ReadonlyArray.find` + +#### Call Signature + +> **find**(`predicate`, `thisArg`?): `undefined` \| `T` + +Defined in: node\_modules/typescript/lib/lib.es2015.core.d.ts:351 + +##### Parameters + +###### predicate + +(`value`, `index`, `obj`) => `unknown` + +###### thisArg? + +`any` + +##### Returns + +`undefined` \| `T` + +##### Inherited from + +`ReadonlyArray.find` + +*** + +### findIndex() + +> **findIndex**(`predicate`, `thisArg`?): `number` + +Defined in: node\_modules/typescript/lib/lib.es2015.core.d.ts:362 + +Returns the index of the first element in the array where predicate is true, and -1 +otherwise. + +#### Parameters + +##### predicate + +(`value`, `index`, `obj`) => `unknown` + +find calls predicate once for each element of the array, in ascending +order, until it finds one where predicate returns true. If such an element is found, +findIndex immediately returns that element index. Otherwise, findIndex returns -1. + +##### thisArg? + +`any` + +If provided, it will be used as the this value for each invocation of +predicate. If it is not provided, undefined is used instead. + +#### Returns + +`number` + +#### Inherited from + +`ReadonlyArray.findIndex` + +*** + +### flat() + +> **flat**\<`A`, `D`\>(`this`, `depth`?): `FlatArray`\<`A`, `D`\>[] + +Defined in: node\_modules/typescript/lib/lib.es2019.array.d.ts:47 + +Returns a new array with all sub-array elements concatenated into it recursively up to the +specified depth. + +#### Type Parameters + +• **A** + +• **D** *extends* `number` = `1` + +#### Parameters + +##### this + +`A` + +##### depth? + +`D` + +The maximum recursion depth + +#### Returns + +`FlatArray`\<`A`, `D`\>[] + +#### Inherited from + +`ReadonlyArray.flat` + +*** + +### flatMap() + +> **flatMap**\<`U`, `This`\>(`callback`, `thisArg`?): `U`[] + +Defined in: node\_modules/typescript/lib/lib.es2019.array.d.ts:36 + +Calls a defined callback function on each element of an array. Then, flattens the result into +a new array. +This is identical to a map followed by flat with depth 1. + +#### Type Parameters + +• **U** + +• **This** = `undefined` + +#### Parameters + +##### callback + +(`this`, `value`, `index`, `array`) => `U` \| readonly `U`[] + +A function that accepts up to three arguments. The flatMap method calls the +callback function one time for each element in the array. + +##### thisArg? + +`This` + +An object to which the this keyword can refer in the callback function. If +thisArg is omitted, undefined is used as the this value. + +#### Returns + +`U`[] + +#### Inherited from + +`ReadonlyArray.flatMap` + +*** + +### forEach() + +> **forEach**(`callbackfn`, `thisArg`?): `void` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1266 + +Performs the specified action for each element in an array. + +#### Parameters + +##### callbackfn + +(`value`, `index`, `array`) => `void` + +A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. + +##### thisArg? + +`any` + +An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. + +#### Returns + +`void` + +#### Inherited from + +`ReadonlyArray.forEach` + +*** + +### includes() + +> **includes**(`searchElement`, `fromIndex`?): `boolean` + +Defined in: node\_modules/typescript/lib/lib.es2016.array.include.d.ts:34 + +Determines whether an array includes a certain element, returning true or false as appropriate. + +#### Parameters + +##### searchElement + +`T` + +The element to search for. + +##### fromIndex? + +`number` + +The position in this array at which to begin searching for searchElement. + +#### Returns + +`boolean` + +#### Inherited from + +`ReadonlyArray.includes` + +*** + +### indexOf() + +> **indexOf**(`searchElement`, `fromIndex`?): `number` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1227 + +Returns the index of the first occurrence of a value in an array. + +#### Parameters + +##### searchElement + +`T` + +The value to locate in the array. + +##### fromIndex? + +`number` + +The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. + +#### Returns + +`number` + +#### Inherited from + +`ReadonlyArray.indexOf` + +*** + +### join() + +> **join**(`separator`?): `string` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1215 + +Adds all the elements of an array separated by the specified separator string. + +#### Parameters + +##### separator? + +`string` + +A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. + +#### Returns + +`string` + +#### Inherited from + +`ReadonlyArray.join` + +*** + +### keys() + +> **keys**(): `IterableIterator`\<`number`\> + +Defined in: node\_modules/typescript/lib/lib.es2015.iterable.d.ts:104 + +Returns an iterable of keys in the array + +#### Returns + +`IterableIterator`\<`number`\> + +#### Inherited from + +`ReadonlyArray.keys` + +*** + +### lastIndexOf() + +> **lastIndexOf**(`searchElement`, `fromIndex`?): `number` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1233 + +Returns the index of the last occurrence of a specified value in an array. + +#### Parameters + +##### searchElement + +`T` + +The value to locate in the array. + +##### fromIndex? + +`number` + +The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array. + +#### Returns + +`number` + +#### Inherited from + +`ReadonlyArray.lastIndexOf` + +*** + +### map() + +> **map**\<`U`\>(`callbackfn`, `thisArg`?): `U`[] + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1272 + +Calls a defined callback function on each element of an array, and returns an array that contains the results. + +#### Type Parameters + +• **U** + +#### Parameters + +##### callbackfn + +(`value`, `index`, `array`) => `U` + +A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array. + +##### thisArg? + +`any` + +An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. + +#### Returns + +`U`[] + +#### Inherited from + +`ReadonlyArray.map` + +*** + +### reduce() + +#### Call Signature + +> **reduce**(`callbackfn`): `T` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1290 + +Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +##### Parameters + +###### callbackfn + +(`previousValue`, `currentValue`, `currentIndex`, `array`) => `T` + +A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. + +##### Returns + +`T` + +##### Inherited from + +`ReadonlyArray.reduce` + +#### Call Signature + +> **reduce**(`callbackfn`, `initialValue`): `T` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1291 + +##### Parameters + +###### callbackfn + +(`previousValue`, `currentValue`, `currentIndex`, `array`) => `T` + +###### initialValue + +`T` + +##### Returns + +`T` + +##### Inherited from + +`ReadonlyArray.reduce` + +#### Call Signature + +> **reduce**\<`U`\>(`callbackfn`, `initialValue`): `U` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1297 + +Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +##### Type Parameters + +• **U** + +##### Parameters + +###### callbackfn + +(`previousValue`, `currentValue`, `currentIndex`, `array`) => `U` + +A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. + +###### initialValue + +`U` + +If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. + +##### Returns + +`U` + +##### Inherited from + +`ReadonlyArray.reduce` + +*** + +### reduceRight() + +#### Call Signature + +> **reduceRight**(`callbackfn`): `T` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1303 + +Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +##### Parameters + +###### callbackfn + +(`previousValue`, `currentValue`, `currentIndex`, `array`) => `T` + +A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. + +##### Returns + +`T` + +##### Inherited from + +`ReadonlyArray.reduceRight` + +#### Call Signature + +> **reduceRight**(`callbackfn`, `initialValue`): `T` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1304 + +##### Parameters + +###### callbackfn + +(`previousValue`, `currentValue`, `currentIndex`, `array`) => `T` + +###### initialValue + +`T` + +##### Returns + +`T` + +##### Inherited from + +`ReadonlyArray.reduceRight` + +#### Call Signature + +> **reduceRight**\<`U`\>(`callbackfn`, `initialValue`): `U` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1310 + +Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +##### Type Parameters + +• **U** + +##### Parameters + +###### callbackfn + +(`previousValue`, `currentValue`, `currentIndex`, `array`) => `U` + +A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. + +###### initialValue + +`U` + +If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. + +##### Returns + +`U` + +##### Inherited from + +`ReadonlyArray.reduceRight` + +*** + +### slice() + +> **slice**(`start`?, `end`?): `T`[] + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1221 + +Returns a section of an array. + +#### Parameters + +##### start? + +`number` + +The beginning of the specified portion of the array. + +##### end? + +`number` + +The end of the specified portion of the array. This is exclusive of the element at the index 'end'. + +#### Returns + +`T`[] + +#### Inherited from + +`ReadonlyArray.slice` + +*** + +### some() + +> **some**(`predicate`, `thisArg`?): `boolean` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1260 + +Determines whether the specified callback function returns true for any element of an array. + +#### Parameters + +##### predicate + +(`value`, `index`, `array`) => `unknown` + +A function that accepts up to three arguments. The some method calls +the predicate function for each element in the array until the predicate returns a value +which is coercible to the Boolean value true, or until the end of the array. + +##### thisArg? + +`any` + +An object to which the this keyword can refer in the predicate function. +If thisArg is omitted, undefined is used as the this value. + +#### Returns + +`boolean` + +#### Inherited from + +`ReadonlyArray.some` + +*** + +### toLocaleString() + +> **toLocaleString**(): `string` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1200 + +Returns a string representation of an array. The elements are converted to string using their toLocaleString methods. + +#### Returns + +`string` + +#### Inherited from + +`ReadonlyArray.toLocaleString` + +*** + +### toString() + +> **toString**(): `string` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1196 + +Returns a string representation of an array. + +#### Returns + +`string` + +#### Inherited from + +`ReadonlyArray.toString` + +*** + +### values() + +> **values**(): `IterableIterator`\<`T`\> + +Defined in: node\_modules/typescript/lib/lib.es2015.iterable.d.ts:109 + +Returns an iterable of values in the array + +#### Returns + +`IterableIterator`\<`T`\> + +#### Inherited from + +`ReadonlyArray.values` diff --git a/docs/api_docs/namespaces/ts/interfaces/NodeFactory.md b/docs/api_docs/namespaces/ts/interfaces/NodeFactory.md new file mode 100644 index 0000000000000000000000000000000000000000..81769a11ae384f81da8618a10fad07ceca437a3d --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/NodeFactory.md @@ -0,0 +1,12895 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / NodeFactory + +# Interface: NodeFactory + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3609 + +## Methods + +### createAdd() + +> **createAdd**(`left`, `right`): [`BinaryExpression`](BinaryExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4055 + +#### Parameters + +##### left + +[`Expression`](Expression.md) + +##### right + +[`Expression`](Expression.md) + +#### Returns + +[`BinaryExpression`](BinaryExpression.md) + +*** + +### createArrayBindingPattern() + +> **createArrayBindingPattern**(`elements`): [`ArrayBindingPattern`](ArrayBindingPattern.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3740 + +#### Parameters + +##### elements + +readonly [`ArrayBindingElement`](../type-aliases/ArrayBindingElement.md)[] + +#### Returns + +[`ArrayBindingPattern`](ArrayBindingPattern.md) + +*** + +### createArrayLiteralExpression() + +> **createArrayLiteralExpression**(`elements`?, `multiLine`?): [`ArrayLiteralExpression`](ArrayLiteralExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3744 + +#### Parameters + +##### elements? + +readonly [`Expression`](Expression.md)[] + +##### multiLine? + +`boolean` + +#### Returns + +[`ArrayLiteralExpression`](ArrayLiteralExpression.md) + +*** + +### createArrayTypeNode() + +> **createArrayTypeNode**(`elementType`): [`ArrayTypeNode`](ArrayTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3705 + +#### Parameters + +##### elementType + +[`TypeNode`](TypeNode.md) + +#### Returns + +[`ArrayTypeNode`](ArrayTypeNode.md) + +*** + +### createArrowFunction() + +> **createArrowFunction**(`modifiers`, `typeParameters`, `parameters`, `type`, `equalsGreaterThanToken`, `body`): [`ArrowFunction`](ArrowFunction.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3770 + +#### Parameters + +##### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +##### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](TypeParameterDeclaration.md)[] + +##### parameters + +readonly [`ParameterDeclaration`](ParameterDeclaration.md)[] + +##### type + +`undefined` | [`TypeNode`](TypeNode.md) + +##### equalsGreaterThanToken + +`undefined` | [`EqualsGreaterThanToken`](../type-aliases/EqualsGreaterThanToken.md) + +##### body + +[`ConciseBody`](../type-aliases/ConciseBody.md) + +#### Returns + +[`ArrowFunction`](ArrowFunction.md) + +*** + +### createAsExpression() + +> **createAsExpression**(`expression`, `type`): [`AsExpression`](AsExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3810 + +#### Parameters + +##### expression + +[`Expression`](Expression.md) + +##### type + +[`TypeNode`](TypeNode.md) + +#### Returns + +[`AsExpression`](AsExpression.md) + +*** + +### createAssertClause() + +> **createAssertClause**(`elements`, `multiLine`?): [`AssertClause`](AssertClause.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3889 + +#### Parameters + +##### elements + +[`NodeArray`](NodeArray.md)\<[`AssertEntry`](AssertEntry.md)\> + +##### multiLine? + +`boolean` + +#### Returns + +[`AssertClause`](AssertClause.md) + +*** + +### createAssertEntry() + +> **createAssertEntry**(`name`, `value`): [`AssertEntry`](AssertEntry.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3891 + +#### Parameters + +##### name + +[`AssertionKey`](../type-aliases/AssertionKey.md) + +##### value + +[`Expression`](Expression.md) + +#### Returns + +[`AssertEntry`](AssertEntry.md) + +*** + +### createAssignment() + +#### Call Signature + +> **createAssignment**(`left`, `right`): [`DestructuringAssignment`](../type-aliases/DestructuringAssignment.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4037 + +##### Parameters + +###### left + +[`ObjectLiteralExpression`](ObjectLiteralExpression.md) | [`ArrayLiteralExpression`](ArrayLiteralExpression.md) + +###### right + +[`Expression`](Expression.md) + +##### Returns + +[`DestructuringAssignment`](../type-aliases/DestructuringAssignment.md) + +#### Call Signature + +> **createAssignment**(`left`, `right`): [`AssignmentExpression`](AssignmentExpression.md)\<[`EqualsToken`](../type-aliases/EqualsToken.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4038 + +##### Parameters + +###### left + +[`Expression`](Expression.md) + +###### right + +[`Expression`](Expression.md) + +##### Returns + +[`AssignmentExpression`](AssignmentExpression.md)\<[`EqualsToken`](../type-aliases/EqualsToken.md)\> + +*** + +### createAwaitExpression() + +> **createAwaitExpression**(`expression`): [`AwaitExpression`](AwaitExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3780 + +#### Parameters + +##### expression + +[`Expression`](Expression.md) + +#### Returns + +[`AwaitExpression`](AwaitExpression.md) + +*** + +### createBigIntLiteral() + +> **createBigIntLiteral**(`value`): [`BigIntLiteral`](BigIntLiteral.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3612 + +#### Parameters + +##### value + +`string` | [`PseudoBigInt`](PseudoBigInt.md) + +#### Returns + +[`BigIntLiteral`](BigIntLiteral.md) + +*** + +### createBinaryExpression() + +> **createBinaryExpression**(`left`, `operator`, `right`): [`BinaryExpression`](BinaryExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3786 + +#### Parameters + +##### left + +[`Expression`](Expression.md) + +##### operator + +[`BinaryOperatorToken`](../type-aliases/BinaryOperatorToken.md) | [`BinaryOperator`](../type-aliases/BinaryOperator.md) + +##### right + +[`Expression`](Expression.md) + +#### Returns + +[`BinaryExpression`](BinaryExpression.md) + +*** + +### createBindingElement() + +> **createBindingElement**(`dotDotDotToken`, `propertyName`, `name`, `initializer`?): [`BindingElement`](BindingElement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3742 + +#### Parameters + +##### dotDotDotToken + +`undefined` | [`DotDotDotToken`](../type-aliases/DotDotDotToken.md) + +##### propertyName + +`undefined` | `string` | [`PropertyName`](../type-aliases/PropertyName.md) + +##### name + +`string` | [`BindingName`](../type-aliases/BindingName.md) + +##### initializer? + +[`Expression`](Expression.md) + +#### Returns + +[`BindingElement`](BindingElement.md) + +*** + +### createBitwiseAnd() + +> **createBitwiseAnd**(`left`, `right`): [`BinaryExpression`](BinaryExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4043 + +#### Parameters + +##### left + +[`Expression`](Expression.md) + +##### right + +[`Expression`](Expression.md) + +#### Returns + +[`BinaryExpression`](BinaryExpression.md) + +*** + +### createBitwiseNot() + +> **createBitwiseNot**(`operand`): [`PrefixUnaryExpression`](PrefixUnaryExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4065 + +#### Parameters + +##### operand + +[`Expression`](Expression.md) + +#### Returns + +[`PrefixUnaryExpression`](PrefixUnaryExpression.md) + +*** + +### createBitwiseOr() + +> **createBitwiseOr**(`left`, `right`): [`BinaryExpression`](BinaryExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4041 + +#### Parameters + +##### left + +[`Expression`](Expression.md) + +##### right + +[`Expression`](Expression.md) + +#### Returns + +[`BinaryExpression`](BinaryExpression.md) + +*** + +### createBitwiseXor() + +> **createBitwiseXor**(`left`, `right`): [`BinaryExpression`](BinaryExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4042 + +#### Parameters + +##### left + +[`Expression`](Expression.md) + +##### right + +[`Expression`](Expression.md) + +#### Returns + +[`BinaryExpression`](BinaryExpression.md) + +*** + +### createBlock() + +> **createBlock**(`statements`, `multiLine`?): [`Block`](Block.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3823 + +#### Parameters + +##### statements + +readonly [`Statement`](Statement.md)[] + +##### multiLine? + +`boolean` + +#### Returns + +[`Block`](Block.md) + +*** + +### createBreakStatement() + +> **createBreakStatement**(`label`?): [`BreakStatement`](BreakStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3844 + +#### Parameters + +##### label? + +`string` | [`Identifier`](Identifier.md) + +#### Returns + +[`BreakStatement`](BreakStatement.md) + +*** + +### createBundle() + +> **createBundle**(`sourceFiles`, `prepends`?): [`Bundle`](Bundle.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4034 + +#### Parameters + +##### sourceFiles + +readonly [`SourceFile`](SourceFile.md)[] + +##### prepends? + +readonly ([`InputFiles`](InputFiles.md) \| [`UnparsedSource`](UnparsedSource.md))[] + +#### Returns + +[`Bundle`](Bundle.md) + +*** + +### createCallChain() + +> **createCallChain**(`expression`, `questionDotToken`, `typeArguments`, `argumentsArray`): [`CallChain`](CallChain.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3758 + +#### Parameters + +##### expression + +[`Expression`](Expression.md) + +##### questionDotToken + +`undefined` | [`QuestionDotToken`](../type-aliases/QuestionDotToken.md) + +##### typeArguments + +`undefined` | readonly [`TypeNode`](TypeNode.md)[] + +##### argumentsArray + +`undefined` | readonly [`Expression`](Expression.md)[] + +#### Returns + +[`CallChain`](CallChain.md) + +*** + +### createCallExpression() + +> **createCallExpression**(`expression`, `typeArguments`, `argumentsArray`): [`CallExpression`](CallExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3756 + +#### Parameters + +##### expression + +[`Expression`](Expression.md) + +##### typeArguments + +`undefined` | readonly [`TypeNode`](TypeNode.md)[] + +##### argumentsArray + +`undefined` | readonly [`Expression`](Expression.md)[] + +#### Returns + +[`CallExpression`](CallExpression.md) + +*** + +### createCallSignature() + +> **createCallSignature**(`typeParameters`, `parameters`, `type`): [`CallSignatureDeclaration`](CallSignatureDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3682 + +#### Parameters + +##### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](TypeParameterDeclaration.md)[] + +##### parameters + +readonly [`ParameterDeclaration`](ParameterDeclaration.md)[] + +##### type + +`undefined` | [`TypeNode`](TypeNode.md) + +#### Returns + +[`CallSignatureDeclaration`](CallSignatureDeclaration.md) + +*** + +### createCaseBlock() + +> **createCaseBlock**(`clauses`): [`CaseBlock`](CaseBlock.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3879 + +#### Parameters + +##### clauses + +readonly [`CaseOrDefaultClause`](../type-aliases/CaseOrDefaultClause.md)[] + +#### Returns + +[`CaseBlock`](CaseBlock.md) + +*** + +### createCaseClause() + +> **createCaseClause**(`expression`, `statements`): [`CaseClause`](CaseClause.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4011 + +#### Parameters + +##### expression + +[`Expression`](Expression.md) + +##### statements + +readonly [`Statement`](Statement.md)[] + +#### Returns + +[`CaseClause`](CaseClause.md) + +*** + +### createCatchClause() + +> **createCatchClause**(`variableDeclaration`, `block`): [`CatchClause`](CatchClause.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4017 + +#### Parameters + +##### variableDeclaration + +`undefined` | `string` | [`VariableDeclaration`](VariableDeclaration.md) | [`BindingName`](../type-aliases/BindingName.md) + +##### block + +[`Block`](Block.md) + +#### Returns + +[`CatchClause`](CatchClause.md) + +*** + +### createClassDeclaration() + +#### Call Signature + +> **createClassDeclaration**(`modifiers`, `name`, `typeParameters`, `heritageClauses`, `members`): [`ClassDeclaration`](ClassDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3865 + +##### Parameters + +###### modifiers + +`undefined` | readonly [`ModifierLike`](../type-aliases/ModifierLike.md)[] + +###### name + +`undefined` | `string` | [`Identifier`](Identifier.md) + +###### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](TypeParameterDeclaration.md)[] + +###### heritageClauses + +`undefined` | readonly [`HeritageClause`](HeritageClause.md)[] + +###### members + +readonly [`ClassElement`](ClassElement.md)[] + +##### Returns + +[`ClassDeclaration`](ClassDeclaration.md) + +#### Call Signature + +> **createClassDeclaration**(`decorators`, `modifiers`, `name`, `typeParameters`, `heritageClauses`, `members`): [`ClassDeclaration`](ClassDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8494 + +##### Parameters + +###### decorators + +`undefined` | readonly [`Decorator`](Decorator.md)[] + +###### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +###### name + +`undefined` | `string` | [`Identifier`](Identifier.md) + +###### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](TypeParameterDeclaration.md)[] + +###### heritageClauses + +`undefined` | readonly [`HeritageClause`](HeritageClause.md)[] + +###### members + +readonly [`ClassElement`](ClassElement.md)[] + +##### Returns + +[`ClassDeclaration`](ClassDeclaration.md) + +##### Deprecated + +Decorators have been combined with modifiers. Callers should use an overload that does not accept a `decorators` parameter. + +*** + +### createClassExpression() + +#### Call Signature + +> **createClassExpression**(`modifiers`, `name`, `typeParameters`, `heritageClauses`, `members`): [`ClassExpression`](ClassExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3805 + +##### Parameters + +###### modifiers + +`undefined` | readonly [`ModifierLike`](../type-aliases/ModifierLike.md)[] + +###### name + +`undefined` | `string` | [`Identifier`](Identifier.md) + +###### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](TypeParameterDeclaration.md)[] + +###### heritageClauses + +`undefined` | readonly [`HeritageClause`](HeritageClause.md)[] + +###### members + +readonly [`ClassElement`](ClassElement.md)[] + +##### Returns + +[`ClassExpression`](ClassExpression.md) + +#### Call Signature + +> **createClassExpression**(`decorators`, `modifiers`, `name`, `typeParameters`, `heritageClauses`, `members`): [`ClassExpression`](ClassExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8478 + +##### Parameters + +###### decorators + +`undefined` | readonly [`Decorator`](Decorator.md)[] + +###### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +###### name + +`undefined` | `string` | [`Identifier`](Identifier.md) + +###### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](TypeParameterDeclaration.md)[] + +###### heritageClauses + +`undefined` | readonly [`HeritageClause`](HeritageClause.md)[] + +###### members + +readonly [`ClassElement`](ClassElement.md)[] + +##### Returns + +[`ClassExpression`](ClassExpression.md) + +##### Deprecated + +Decorators have been combined with modifiers. Callers should use an overload that does not accept a `decorators` parameter. + +*** + +### createClassStaticBlockDeclaration() + +#### Call Signature + +> **createClassStaticBlockDeclaration**(`body`): [`ClassStaticBlockDeclaration`](ClassStaticBlockDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3690 + +##### Parameters + +###### body + +[`Block`](Block.md) + +##### Returns + +[`ClassStaticBlockDeclaration`](ClassStaticBlockDeclaration.md) + +#### Call Signature + +> **createClassStaticBlockDeclaration**(`decorators`, `modifiers`, `body`): [`ClassStaticBlockDeclaration`](ClassStaticBlockDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8470 + +##### Parameters + +###### decorators + +`undefined` | readonly [`Decorator`](Decorator.md)[] + +###### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +###### body + +[`Block`](Block.md) + +##### Returns + +[`ClassStaticBlockDeclaration`](ClassStaticBlockDeclaration.md) + +##### Deprecated + +Decorators and modifiers are no longer supported for this function. Callers should use an overload that does not accept the `decorators` and `modifiers` parameters. + +*** + +### createComma() + +> **createComma**(`left`, `right`): [`BinaryExpression`](BinaryExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4036 + +#### Parameters + +##### left + +[`Expression`](Expression.md) + +##### right + +[`Expression`](Expression.md) + +#### Returns + +[`BinaryExpression`](BinaryExpression.md) + +*** + +### createCommaListExpression() + +> **createCommaListExpression**(`elements`): [`CommaListExpression`](CommaListExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4032 + +#### Parameters + +##### elements + +readonly [`Expression`](Expression.md)[] + +#### Returns + +[`CommaListExpression`](CommaListExpression.md) + +*** + +### createComputedPropertyName() + +> **createComputedPropertyName**(`expression`): [`ComputedPropertyName`](ComputedPropertyName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3660 + +#### Parameters + +##### expression + +[`Expression`](Expression.md) + +#### Returns + +[`ComputedPropertyName`](ComputedPropertyName.md) + +*** + +### createConditionalExpression() + +> **createConditionalExpression**(`condition`, `questionToken`, `whenTrue`, `colonToken`, `whenFalse`): [`ConditionalExpression`](ConditionalExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3788 + +#### Parameters + +##### condition + +[`Expression`](Expression.md) + +##### questionToken + +`undefined` | [`QuestionToken`](../type-aliases/QuestionToken.md) + +##### whenTrue + +[`Expression`](Expression.md) + +##### colonToken + +`undefined` | [`ColonToken`](../type-aliases/ColonToken.md) + +##### whenFalse + +[`Expression`](Expression.md) + +#### Returns + +[`ConditionalExpression`](ConditionalExpression.md) + +*** + +### createConditionalTypeNode() + +> **createConditionalTypeNode**(`checkType`, `extendsType`, `trueType`, `falseType`): [`ConditionalTypeNode`](ConditionalTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3719 + +#### Parameters + +##### checkType + +[`TypeNode`](TypeNode.md) + +##### extendsType + +[`TypeNode`](TypeNode.md) + +##### trueType + +[`TypeNode`](TypeNode.md) + +##### falseType + +[`TypeNode`](TypeNode.md) + +#### Returns + +[`ConditionalTypeNode`](ConditionalTypeNode.md) + +*** + +### createConstructorDeclaration() + +#### Call Signature + +> **createConstructorDeclaration**(`modifiers`, `parameters`, `body`): [`ConstructorDeclaration`](ConstructorDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3676 + +##### Parameters + +###### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +###### parameters + +readonly [`ParameterDeclaration`](ParameterDeclaration.md)[] + +###### body + +`undefined` | [`Block`](Block.md) + +##### Returns + +[`ConstructorDeclaration`](ConstructorDeclaration.md) + +#### Call Signature + +> **createConstructorDeclaration**(`decorators`, `modifiers`, `parameters`, `body`): [`ConstructorDeclaration`](ConstructorDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8438 + +##### Parameters + +###### decorators + +`undefined` | readonly [`Decorator`](Decorator.md)[] + +###### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +###### parameters + +readonly [`ParameterDeclaration`](ParameterDeclaration.md)[] + +###### body + +`undefined` | [`Block`](Block.md) + +##### Returns + +[`ConstructorDeclaration`](ConstructorDeclaration.md) + +##### Deprecated + +This node does not support Decorators. Callers should use an overload that does not accept a `decorators` parameter. + +*** + +### createConstructorTypeNode() + +#### Call Signature + +> **createConstructorTypeNode**(`modifiers`, `typeParameters`, `parameters`, `type`): [`ConstructorTypeNode`](ConstructorTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3699 + +##### Parameters + +###### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +###### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](TypeParameterDeclaration.md)[] + +###### parameters + +readonly [`ParameterDeclaration`](ParameterDeclaration.md)[] + +###### type + +[`TypeNode`](TypeNode.md) + +##### Returns + +[`ConstructorTypeNode`](ConstructorTypeNode.md) + +#### Call Signature + +> **createConstructorTypeNode**(`typeParameters`, `parameters`, `type`): [`ConstructorTypeNode`](ConstructorTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8341 + +##### Parameters + +###### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](TypeParameterDeclaration.md)[] + +###### parameters + +readonly [`ParameterDeclaration`](ParameterDeclaration.md)[] + +###### type + +[`TypeNode`](TypeNode.md) + +##### Returns + +[`ConstructorTypeNode`](ConstructorTypeNode.md) + +##### Deprecated + +Use the overload that accepts 'modifiers' + +*** + +### createConstructSignature() + +> **createConstructSignature**(`typeParameters`, `parameters`, `type`): [`ConstructSignatureDeclaration`](ConstructSignatureDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3684 + +#### Parameters + +##### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](TypeParameterDeclaration.md)[] + +##### parameters + +readonly [`ParameterDeclaration`](ParameterDeclaration.md)[] + +##### type + +`undefined` | [`TypeNode`](TypeNode.md) + +#### Returns + +[`ConstructSignatureDeclaration`](ConstructSignatureDeclaration.md) + +*** + +### createContinueStatement() + +> **createContinueStatement**(`label`?): [`ContinueStatement`](ContinueStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3842 + +#### Parameters + +##### label? + +`string` | [`Identifier`](Identifier.md) + +#### Returns + +[`ContinueStatement`](ContinueStatement.md) + +*** + +### createDebuggerStatement() + +> **createDebuggerStatement**(): [`DebuggerStatement`](DebuggerStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3858 + +#### Returns + +[`DebuggerStatement`](DebuggerStatement.md) + +*** + +### createDecorator() + +> **createDecorator**(`expression`): [`Decorator`](Decorator.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3666 + +#### Parameters + +##### expression + +[`Expression`](Expression.md) + +#### Returns + +[`Decorator`](Decorator.md) + +*** + +### createDefaultClause() + +> **createDefaultClause**(`statements`): [`DefaultClause`](DefaultClause.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4013 + +#### Parameters + +##### statements + +readonly [`Statement`](Statement.md)[] + +#### Returns + +[`DefaultClause`](DefaultClause.md) + +*** + +### createDeleteExpression() + +> **createDeleteExpression**(`expression`): [`DeleteExpression`](DeleteExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3774 + +#### Parameters + +##### expression + +[`Expression`](Expression.md) + +#### Returns + +[`DeleteExpression`](DeleteExpression.md) + +*** + +### createDivide() + +> **createDivide**(`left`, `right`): [`BinaryExpression`](BinaryExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4058 + +#### Parameters + +##### left + +[`Expression`](Expression.md) + +##### right + +[`Expression`](Expression.md) + +#### Returns + +[`BinaryExpression`](BinaryExpression.md) + +*** + +### createDoStatement() + +> **createDoStatement**(`statement`, `expression`): [`DoStatement`](DoStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3832 + +#### Parameters + +##### statement + +[`Statement`](Statement.md) + +##### expression + +[`Expression`](Expression.md) + +#### Returns + +[`DoStatement`](DoStatement.md) + +*** + +### createElementAccessChain() + +> **createElementAccessChain**(`expression`, `questionDotToken`, `index`): [`ElementAccessChain`](ElementAccessChain.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3754 + +#### Parameters + +##### expression + +[`Expression`](Expression.md) + +##### questionDotToken + +`undefined` | [`QuestionDotToken`](../type-aliases/QuestionDotToken.md) + +##### index + +`number` | [`Expression`](Expression.md) + +#### Returns + +[`ElementAccessChain`](ElementAccessChain.md) + +*** + +### createElementAccessExpression() + +> **createElementAccessExpression**(`expression`, `index`): [`ElementAccessExpression`](ElementAccessExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3752 + +#### Parameters + +##### expression + +[`Expression`](Expression.md) + +##### index + +`number` | [`Expression`](Expression.md) + +#### Returns + +[`ElementAccessExpression`](ElementAccessExpression.md) + +*** + +### createEmptyStatement() + +> **createEmptyStatement**(): [`EmptyStatement`](EmptyStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3827 + +#### Returns + +[`EmptyStatement`](EmptyStatement.md) + +*** + +### createEnumDeclaration() + +#### Call Signature + +> **createEnumDeclaration**(`modifiers`, `name`, `members`): [`EnumDeclaration`](EnumDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3873 + +##### Parameters + +###### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +###### name + +`string` | [`Identifier`](Identifier.md) + +###### members + +readonly [`EnumMember`](EnumMember.md)[] + +##### Returns + +[`EnumDeclaration`](EnumDeclaration.md) + +#### Call Signature + +> **createEnumDeclaration**(`decorators`, `modifiers`, `name`, `members`): [`EnumDeclaration`](EnumDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8518 + +##### Parameters + +###### decorators + +`undefined` | readonly [`Decorator`](Decorator.md)[] + +###### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +###### name + +`string` | [`Identifier`](Identifier.md) + +###### members + +readonly [`EnumMember`](EnumMember.md)[] + +##### Returns + +[`EnumDeclaration`](EnumDeclaration.md) + +##### Deprecated + +Decorators are no longer supported for this function. Callers should use an overload that does not accept a `decorators` parameter. + +*** + +### createEnumMember() + +> **createEnumMember**(`name`, `initializer`?): [`EnumMember`](EnumMember.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4025 + +#### Parameters + +##### name + +`string` | [`PropertyName`](../type-aliases/PropertyName.md) + +##### initializer? + +[`Expression`](Expression.md) + +#### Returns + +[`EnumMember`](EnumMember.md) + +*** + +### createEquality() + +> **createEquality**(`left`, `right`): [`BinaryExpression`](BinaryExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4046 + +#### Parameters + +##### left + +[`Expression`](Expression.md) + +##### right + +[`Expression`](Expression.md) + +#### Returns + +[`BinaryExpression`](BinaryExpression.md) + +*** + +### createEtsComponentExpression() + +> **createEtsComponentExpression**(`name`, `argumentExpression`, `body`): [`EtsComponentExpression`](EtsComponentExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3772 + +#### Parameters + +##### name + +[`Expression`](Expression.md) + +##### argumentExpression + +`undefined` | [`NodeArray`](NodeArray.md)\<[`Expression`](Expression.md)\> | [`Expression`](Expression.md)[] + +##### body + +`undefined` | [`Block`](Block.md) + +#### Returns + +[`EtsComponentExpression`](EtsComponentExpression.md) + +*** + +### createExponent() + +> **createExponent**(`left`, `right`): [`BinaryExpression`](BinaryExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4060 + +#### Parameters + +##### left + +[`Expression`](Expression.md) + +##### right + +[`Expression`](Expression.md) + +#### Returns + +[`BinaryExpression`](BinaryExpression.md) + +*** + +### createExportAssignment() + +#### Call Signature + +> **createExportAssignment**(`modifiers`, `isExportEquals`, `expression`): [`ExportAssignment`](ExportAssignment.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3903 + +##### Parameters + +###### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +###### isExportEquals + +`undefined` | `boolean` + +###### expression + +[`Expression`](Expression.md) + +##### Returns + +[`ExportAssignment`](ExportAssignment.md) + +#### Call Signature + +> **createExportAssignment**(`decorators`, `modifiers`, `isExportEquals`, `expression`): [`ExportAssignment`](ExportAssignment.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8550 + +##### Parameters + +###### decorators + +`undefined` | readonly [`Decorator`](Decorator.md)[] + +###### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +###### isExportEquals + +`undefined` | `boolean` + +###### expression + +[`Expression`](Expression.md) + +##### Returns + +[`ExportAssignment`](ExportAssignment.md) + +##### Deprecated + +Decorators are no longer supported for this function. Callers should use an overload that does not accept a `decorators` parameter. + +*** + +### createExportDeclaration() + +#### Call Signature + +> **createExportDeclaration**(`modifiers`, `isTypeOnly`, `exportClause`, `moduleSpecifier`?, `assertClause`?): [`ExportDeclaration`](ExportDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3905 + +##### Parameters + +###### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +###### isTypeOnly + +`boolean` + +###### exportClause + +`undefined` | [`NamedExportBindings`](../type-aliases/NamedExportBindings.md) + +###### moduleSpecifier? + +[`Expression`](Expression.md) + +###### assertClause? + +[`AssertClause`](AssertClause.md) + +##### Returns + +[`ExportDeclaration`](ExportDeclaration.md) + +#### Call Signature + +> **createExportDeclaration**(`decorators`, `modifiers`, `isTypeOnly`, `exportClause`, `moduleSpecifier`?, `assertClause`?): [`ExportDeclaration`](ExportDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8558 + +##### Parameters + +###### decorators + +`undefined` | readonly [`Decorator`](Decorator.md)[] + +###### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +###### isTypeOnly + +`boolean` + +###### exportClause + +`undefined` | [`NamedExportBindings`](../type-aliases/NamedExportBindings.md) + +###### moduleSpecifier? + +[`Expression`](Expression.md) + +###### assertClause? + +[`AssertClause`](AssertClause.md) + +##### Returns + +[`ExportDeclaration`](ExportDeclaration.md) + +##### Deprecated + +Decorators are no longer supported for this function. Callers should use an overload that does not accept a `decorators` parameter. + +*** + +### createExportDefault() + +> **createExportDefault**(`expression`): [`ExportAssignment`](ExportAssignment.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4074 + +#### Parameters + +##### expression + +[`Expression`](Expression.md) + +#### Returns + +[`ExportAssignment`](ExportAssignment.md) + +*** + +### createExportSpecifier() + +> **createExportSpecifier**(`isTypeOnly`, `propertyName`, `name`): [`ExportSpecifier`](ExportSpecifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3909 + +#### Parameters + +##### isTypeOnly + +`boolean` + +##### propertyName + +`undefined` | `string` | [`Identifier`](Identifier.md) + +##### name + +`string` | [`Identifier`](Identifier.md) + +#### Returns + +[`ExportSpecifier`](ExportSpecifier.md) + +*** + +### createExpressionStatement() + +> **createExpressionStatement**(`expression`): [`ExpressionStatement`](ExpressionStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3828 + +#### Parameters + +##### expression + +[`Expression`](Expression.md) + +#### Returns + +[`ExpressionStatement`](ExpressionStatement.md) + +*** + +### createExpressionWithTypeArguments() + +> **createExpressionWithTypeArguments**(`expression`, `typeArguments`): [`ExpressionWithTypeArguments`](ExpressionWithTypeArguments.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3808 + +#### Parameters + +##### expression + +[`Expression`](Expression.md) + +##### typeArguments + +`undefined` | readonly [`TypeNode`](TypeNode.md)[] + +#### Returns + +[`ExpressionWithTypeArguments`](ExpressionWithTypeArguments.md) + +*** + +### createExternalModuleExport() + +> **createExternalModuleExport**(`exportName`): [`ExportDeclaration`](ExportDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4075 + +#### Parameters + +##### exportName + +[`Identifier`](Identifier.md) + +#### Returns + +[`ExportDeclaration`](ExportDeclaration.md) + +*** + +### createExternalModuleReference() + +> **createExternalModuleReference**(`expression`): [`ExternalModuleReference`](ExternalModuleReference.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3911 + +#### Parameters + +##### expression + +[`Expression`](Expression.md) + +#### Returns + +[`ExternalModuleReference`](ExternalModuleReference.md) + +*** + +### createFalse() + +> **createFalse**(): [`FalseLiteral`](FalseLiteral.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3655 + +#### Returns + +[`FalseLiteral`](FalseLiteral.md) + +*** + +### createForInStatement() + +> **createForInStatement**(`initializer`, `expression`, `statement`): [`ForInStatement`](ForInStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3838 + +#### Parameters + +##### initializer + +[`ForInitializer`](../type-aliases/ForInitializer.md) + +##### expression + +[`Expression`](Expression.md) + +##### statement + +[`Statement`](Statement.md) + +#### Returns + +[`ForInStatement`](ForInStatement.md) + +*** + +### createForOfStatement() + +> **createForOfStatement**(`awaitModifier`, `initializer`, `expression`, `statement`): [`ForOfStatement`](ForOfStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3840 + +#### Parameters + +##### awaitModifier + +`undefined` | [`AwaitKeyword`](../type-aliases/AwaitKeyword.md) + +##### initializer + +[`ForInitializer`](../type-aliases/ForInitializer.md) + +##### expression + +[`Expression`](Expression.md) + +##### statement + +[`Statement`](Statement.md) + +#### Returns + +[`ForOfStatement`](ForOfStatement.md) + +*** + +### createForStatement() + +> **createForStatement**(`initializer`, `condition`, `incrementor`, `statement`): [`ForStatement`](ForStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3836 + +#### Parameters + +##### initializer + +`undefined` | [`ForInitializer`](../type-aliases/ForInitializer.md) + +##### condition + +`undefined` | [`Expression`](Expression.md) + +##### incrementor + +`undefined` | [`Expression`](Expression.md) + +##### statement + +[`Statement`](Statement.md) + +#### Returns + +[`ForStatement`](ForStatement.md) + +*** + +### createFunctionDeclaration() + +#### Call Signature + +> **createFunctionDeclaration**(`modifiers`, `asteriskToken`, `name`, `typeParameters`, `parameters`, `type`, `body`): [`FunctionDeclaration`](FunctionDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3863 + +##### Parameters + +###### modifiers + +`undefined` | readonly [`ModifierLike`](../type-aliases/ModifierLike.md)[] + +###### asteriskToken + +`undefined` | [`AsteriskToken`](../type-aliases/AsteriskToken.md) + +###### name + +`undefined` | `string` | [`Identifier`](Identifier.md) + +###### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](TypeParameterDeclaration.md)[] + +###### parameters + +readonly [`ParameterDeclaration`](ParameterDeclaration.md)[] + +###### type + +`undefined` | [`TypeNode`](TypeNode.md) + +###### body + +`undefined` | [`Block`](Block.md) + +##### Returns + +[`FunctionDeclaration`](FunctionDeclaration.md) + +#### Call Signature + +> **createFunctionDeclaration**(`decorators`, `modifiers`, `asteriskToken`, `name`, `typeParameters`, `parameters`, `type`, `body`): [`FunctionDeclaration`](FunctionDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8486 + +##### Parameters + +###### decorators + +`undefined` | readonly [`Decorator`](Decorator.md)[] + +###### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +###### asteriskToken + +`undefined` | [`AsteriskToken`](../type-aliases/AsteriskToken.md) + +###### name + +`undefined` | `string` | [`Identifier`](Identifier.md) + +###### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](TypeParameterDeclaration.md)[] + +###### parameters + +readonly [`ParameterDeclaration`](ParameterDeclaration.md)[] + +###### type + +`undefined` | [`TypeNode`](TypeNode.md) + +###### body + +`undefined` | [`Block`](Block.md) + +##### Returns + +[`FunctionDeclaration`](FunctionDeclaration.md) + +##### Deprecated + +Decorators are no longer supported for this function. Callers should use an overload that does not accept a `decorators` parameter. + +*** + +### createFunctionExpression() + +> **createFunctionExpression**(`modifiers`, `asteriskToken`, `name`, `typeParameters`, `parameters`, `type`, `body`): [`FunctionExpression`](FunctionExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3768 + +#### Parameters + +##### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +##### asteriskToken + +`undefined` | [`AsteriskToken`](../type-aliases/AsteriskToken.md) + +##### name + +`undefined` | `string` | [`Identifier`](Identifier.md) + +##### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](TypeParameterDeclaration.md)[] + +##### parameters + +`undefined` | readonly [`ParameterDeclaration`](ParameterDeclaration.md)[] + +##### type + +`undefined` | [`TypeNode`](TypeNode.md) + +##### body + +[`Block`](Block.md) + +#### Returns + +[`FunctionExpression`](FunctionExpression.md) + +*** + +### createFunctionTypeNode() + +> **createFunctionTypeNode**(`typeParameters`, `parameters`, `type`): [`FunctionTypeNode`](FunctionTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3697 + +#### Parameters + +##### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](TypeParameterDeclaration.md)[] + +##### parameters + +readonly [`ParameterDeclaration`](ParameterDeclaration.md)[] + +##### type + +[`TypeNode`](TypeNode.md) + +#### Returns + +[`FunctionTypeNode`](FunctionTypeNode.md) + +*** + +### createGetAccessorDeclaration() + +#### Call Signature + +> **createGetAccessorDeclaration**(`modifiers`, `name`, `parameters`, `type`, `body`): [`GetAccessorDeclaration`](GetAccessorDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3678 + +##### Parameters + +###### modifiers + +`undefined` | readonly [`ModifierLike`](../type-aliases/ModifierLike.md)[] + +###### name + +`string` | [`PropertyName`](../type-aliases/PropertyName.md) + +###### parameters + +readonly [`ParameterDeclaration`](ParameterDeclaration.md)[] + +###### type + +`undefined` | [`TypeNode`](TypeNode.md) + +###### body + +`undefined` | [`Block`](Block.md) + +##### Returns + +[`GetAccessorDeclaration`](GetAccessorDeclaration.md) + +#### Call Signature + +> **createGetAccessorDeclaration**(`decorators`, `modifiers`, `name`, `parameters`, `type`, `body`): [`GetAccessorDeclaration`](GetAccessorDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8446 + +##### Parameters + +###### decorators + +`undefined` | readonly [`Decorator`](Decorator.md)[] + +###### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +###### name + +`string` | [`PropertyName`](../type-aliases/PropertyName.md) + +###### parameters + +readonly [`ParameterDeclaration`](ParameterDeclaration.md)[] + +###### type + +`undefined` | [`TypeNode`](TypeNode.md) + +###### body + +`undefined` | [`Block`](Block.md) + +##### Returns + +[`GetAccessorDeclaration`](GetAccessorDeclaration.md) + +##### Deprecated + +Decorators have been combined with modifiers. Callers should use an overload that does not accept a `decorators` parameter. + +*** + +### createGreaterThan() + +> **createGreaterThan**(`left`, `right`): [`BinaryExpression`](BinaryExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4050 + +#### Parameters + +##### left + +[`Expression`](Expression.md) + +##### right + +[`Expression`](Expression.md) + +#### Returns + +[`BinaryExpression`](BinaryExpression.md) + +*** + +### createGreaterThanEquals() + +> **createGreaterThanEquals**(`left`, `right`): [`BinaryExpression`](BinaryExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4051 + +#### Parameters + +##### left + +[`Expression`](Expression.md) + +##### right + +[`Expression`](Expression.md) + +#### Returns + +[`BinaryExpression`](BinaryExpression.md) + +*** + +### createHeritageClause() + +> **createHeritageClause**(`token`, `types`): [`HeritageClause`](HeritageClause.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4015 + +#### Parameters + +##### token + +[`ExtendsKeyword`](../enumerations/SyntaxKind.md#extendskeyword) | [`ImplementsKeyword`](../enumerations/SyntaxKind.md#implementskeyword) + +##### types + +readonly [`ExpressionWithTypeArguments`](ExpressionWithTypeArguments.md)[] + +#### Returns + +[`HeritageClause`](HeritageClause.md) + +*** + +### createIdentifier() + +> **createIdentifier**(`text`): [`Identifier`](Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3616 + +#### Parameters + +##### text + +`string` + +#### Returns + +[`Identifier`](Identifier.md) + +*** + +### createIfStatement() + +> **createIfStatement**(`expression`, `thenStatement`, `elseStatement`?): [`IfStatement`](IfStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3830 + +#### Parameters + +##### expression + +[`Expression`](Expression.md) + +##### thenStatement + +[`Statement`](Statement.md) + +##### elseStatement? + +[`Statement`](Statement.md) + +#### Returns + +[`IfStatement`](IfStatement.md) + +*** + +### createImmediatelyInvokedArrowFunction() + +#### Call Signature + +> **createImmediatelyInvokedArrowFunction**(`statements`): [`CallExpression`](CallExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4071 + +##### Parameters + +###### statements + +readonly [`Statement`](Statement.md)[] + +##### Returns + +[`CallExpression`](CallExpression.md) + +#### Call Signature + +> **createImmediatelyInvokedArrowFunction**(`statements`, `param`, `paramValue`): [`CallExpression`](CallExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4072 + +##### Parameters + +###### statements + +readonly [`Statement`](Statement.md)[] + +###### param + +[`ParameterDeclaration`](ParameterDeclaration.md) + +###### paramValue + +[`Expression`](Expression.md) + +##### Returns + +[`CallExpression`](CallExpression.md) + +*** + +### createImmediatelyInvokedFunctionExpression() + +#### Call Signature + +> **createImmediatelyInvokedFunctionExpression**(`statements`): [`CallExpression`](CallExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4069 + +##### Parameters + +###### statements + +readonly [`Statement`](Statement.md)[] + +##### Returns + +[`CallExpression`](CallExpression.md) + +#### Call Signature + +> **createImmediatelyInvokedFunctionExpression**(`statements`, `param`, `paramValue`): [`CallExpression`](CallExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4070 + +##### Parameters + +###### statements + +readonly [`Statement`](Statement.md)[] + +###### param + +[`ParameterDeclaration`](ParameterDeclaration.md) + +###### paramValue + +[`Expression`](Expression.md) + +##### Returns + +[`CallExpression`](CallExpression.md) + +*** + +### createImportClause() + +> **createImportClause**(`isTypeOnly`, `name`, `namedBindings`): [`ImportClause`](ImportClause.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3887 + +#### Parameters + +##### isTypeOnly + +`boolean` + +##### name + +`undefined` | [`Identifier`](Identifier.md) + +##### namedBindings + +`undefined` | [`NamedImportBindings`](../type-aliases/NamedImportBindings.md) + +#### Returns + +[`ImportClause`](ImportClause.md) + +*** + +### createImportDeclaration() + +#### Call Signature + +> **createImportDeclaration**(`modifiers`, `importClause`, `moduleSpecifier`, `assertClause`?): [`ImportDeclaration`](ImportDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3885 + +##### Parameters + +###### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +###### importClause + +`undefined` | [`ImportClause`](ImportClause.md) + +###### moduleSpecifier + +[`Expression`](Expression.md) + +###### assertClause? + +[`AssertClause`](AssertClause.md) + +##### Returns + +[`ImportDeclaration`](ImportDeclaration.md) + +#### Call Signature + +> **createImportDeclaration**(`decorators`, `modifiers`, `importClause`, `moduleSpecifier`, `assertClause`?): [`ImportDeclaration`](ImportDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8542 + +##### Parameters + +###### decorators + +`undefined` | readonly [`Decorator`](Decorator.md)[] + +###### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +###### importClause + +`undefined` | [`ImportClause`](ImportClause.md) + +###### moduleSpecifier + +[`Expression`](Expression.md) + +###### assertClause? + +[`AssertClause`](AssertClause.md) + +##### Returns + +[`ImportDeclaration`](ImportDeclaration.md) + +##### Deprecated + +Decorators are no longer supported for this function. Callers should use an overload that does not accept a `decorators` parameter. + +*** + +### createImportEqualsDeclaration() + +#### Call Signature + +> **createImportEqualsDeclaration**(`modifiers`, `isTypeOnly`, `name`, `moduleReference`): [`ImportEqualsDeclaration`](ImportEqualsDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3883 + +##### Parameters + +###### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +###### isTypeOnly + +`boolean` + +###### name + +`string` | [`Identifier`](Identifier.md) + +###### moduleReference + +[`ModuleReference`](../type-aliases/ModuleReference.md) + +##### Returns + +[`ImportEqualsDeclaration`](ImportEqualsDeclaration.md) + +#### Call Signature + +> **createImportEqualsDeclaration**(`decorators`, `modifiers`, `isTypeOnly`, `name`, `moduleReference`): [`ImportEqualsDeclaration`](ImportEqualsDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8534 + +##### Parameters + +###### decorators + +`undefined` | readonly [`Decorator`](Decorator.md)[] + +###### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +###### isTypeOnly + +`boolean` + +###### name + +`string` | [`Identifier`](Identifier.md) + +###### moduleReference + +[`ModuleReference`](../type-aliases/ModuleReference.md) + +##### Returns + +[`ImportEqualsDeclaration`](ImportEqualsDeclaration.md) + +##### Deprecated + +Decorators are no longer supported for this function. Callers should use an overload that does not accept a `decorators` parameter. + +*** + +### createImportSpecifier() + +> **createImportSpecifier**(`isTypeOnly`, `propertyName`, `name`): [`ImportSpecifier`](ImportSpecifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3901 + +#### Parameters + +##### isTypeOnly + +`boolean` + +##### propertyName + +`undefined` | [`Identifier`](Identifier.md) + +##### name + +[`Identifier`](Identifier.md) + +#### Returns + +[`ImportSpecifier`](ImportSpecifier.md) + +*** + +### createImportTypeAssertionContainer() + +> **createImportTypeAssertionContainer**(`clause`, `multiLine`?): [`ImportTypeAssertionContainer`](ImportTypeAssertionContainer.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3893 + +#### Parameters + +##### clause + +[`AssertClause`](AssertClause.md) + +##### multiLine? + +`boolean` + +#### Returns + +[`ImportTypeAssertionContainer`](ImportTypeAssertionContainer.md) + +*** + +### createImportTypeNode() + +#### Call Signature + +> **createImportTypeNode**(`argument`, `assertions`?, `qualifier`?, `typeArguments`?, `isTypeOf`?): [`ImportTypeNode`](ImportTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3723 + +##### Parameters + +###### argument + +[`TypeNode`](TypeNode.md) + +###### assertions? + +[`ImportTypeAssertionContainer`](ImportTypeAssertionContainer.md) + +###### qualifier? + +[`EntityName`](../type-aliases/EntityName.md) + +###### typeArguments? + +readonly [`TypeNode`](TypeNode.md)[] + +###### isTypeOf? + +`boolean` + +##### Returns + +[`ImportTypeNode`](ImportTypeNode.md) + +#### Call Signature + +> **createImportTypeNode**(`argument`, `assertions`?, `qualifier`?, `typeArguments`?, `isTypeOf`?): [`ImportTypeNode`](ImportTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8348 + +##### Parameters + +###### argument + +[`TypeNode`](TypeNode.md) + +###### assertions? + +[`ImportTypeAssertionContainer`](ImportTypeAssertionContainer.md) + +###### qualifier? + +[`EntityName`](../type-aliases/EntityName.md) + +###### typeArguments? + +readonly [`TypeNode`](TypeNode.md)[] + +###### isTypeOf? + +`boolean` + +##### Returns + +[`ImportTypeNode`](ImportTypeNode.md) + +#### Call Signature + +> **createImportTypeNode**(`argument`, `qualifier`?, `typeArguments`?, `isTypeOf`?): [`ImportTypeNode`](ImportTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8350 + +##### Parameters + +###### argument + +[`TypeNode`](TypeNode.md) + +###### qualifier? + +[`EntityName`](../type-aliases/EntityName.md) + +###### typeArguments? + +readonly [`TypeNode`](TypeNode.md)[] + +###### isTypeOf? + +`boolean` + +##### Returns + +[`ImportTypeNode`](ImportTypeNode.md) + +##### Deprecated + +Use the overload that accepts 'assertions' + +*** + +### createIndexedAccessTypeNode() + +> **createIndexedAccessTypeNode**(`objectType`, `indexType`): [`IndexedAccessTypeNode`](IndexedAccessTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3730 + +#### Parameters + +##### objectType + +[`TypeNode`](TypeNode.md) + +##### indexType + +[`TypeNode`](TypeNode.md) + +#### Returns + +[`IndexedAccessTypeNode`](IndexedAccessTypeNode.md) + +*** + +### createIndexSignature() + +#### Call Signature + +> **createIndexSignature**(`modifiers`, `parameters`, `type`): [`IndexSignatureDeclaration`](IndexSignatureDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3686 + +##### Parameters + +###### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +###### parameters + +readonly [`ParameterDeclaration`](ParameterDeclaration.md)[] + +###### type + +[`TypeNode`](TypeNode.md) + +##### Returns + +[`IndexSignatureDeclaration`](IndexSignatureDeclaration.md) + +#### Call Signature + +> **createIndexSignature**(`decorators`, `modifiers`, `parameters`, `type`): [`IndexSignatureDeclaration`](IndexSignatureDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8462 + +##### Parameters + +###### decorators + +`undefined` | readonly [`Decorator`](Decorator.md)[] + +###### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +###### parameters + +readonly [`ParameterDeclaration`](ParameterDeclaration.md)[] + +###### type + +[`TypeNode`](TypeNode.md) + +##### Returns + +[`IndexSignatureDeclaration`](IndexSignatureDeclaration.md) + +##### Deprecated + +Decorators are no longer supported for this function. Callers should use an overload that does not accept a `decorators` parameter. + +*** + +### createInequality() + +> **createInequality**(`left`, `right`): [`BinaryExpression`](BinaryExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4047 + +#### Parameters + +##### left + +[`Expression`](Expression.md) + +##### right + +[`Expression`](Expression.md) + +#### Returns + +[`BinaryExpression`](BinaryExpression.md) + +*** + +### createInferTypeNode() + +> **createInferTypeNode**(`typeParameter`): [`InferTypeNode`](InferTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3721 + +#### Parameters + +##### typeParameter + +[`TypeParameterDeclaration`](TypeParameterDeclaration.md) + +#### Returns + +[`InferTypeNode`](InferTypeNode.md) + +*** + +### createInterfaceDeclaration() + +#### Call Signature + +> **createInterfaceDeclaration**(`modifiers`, `name`, `typeParameters`, `heritageClauses`, `members`): [`InterfaceDeclaration`](InterfaceDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3869 + +##### Parameters + +###### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +###### name + +`string` | [`Identifier`](Identifier.md) + +###### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](TypeParameterDeclaration.md)[] + +###### heritageClauses + +`undefined` | readonly [`HeritageClause`](HeritageClause.md)[] + +###### members + +readonly [`TypeElement`](TypeElement.md)[] + +##### Returns + +[`InterfaceDeclaration`](InterfaceDeclaration.md) + +#### Call Signature + +> **createInterfaceDeclaration**(`decorators`, `modifiers`, `name`, `typeParameters`, `heritageClauses`, `members`): [`InterfaceDeclaration`](InterfaceDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8502 + +##### Parameters + +###### decorators + +`undefined` | readonly [`Decorator`](Decorator.md)[] + +###### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +###### name + +`string` | [`Identifier`](Identifier.md) + +###### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](TypeParameterDeclaration.md)[] + +###### heritageClauses + +`undefined` | readonly [`HeritageClause`](HeritageClause.md)[] + +###### members + +readonly [`TypeElement`](TypeElement.md)[] + +##### Returns + +[`InterfaceDeclaration`](InterfaceDeclaration.md) + +##### Deprecated + +Decorators are no longer supported for this function. Callers should use an overload that does not accept a `decorators` parameter. + +*** + +### createIntersectionTypeNode() + +> **createIntersectionTypeNode**(`types`): [`IntersectionTypeNode`](IntersectionTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3717 + +#### Parameters + +##### types + +readonly [`TypeNode`](TypeNode.md)[] + +#### Returns + +[`IntersectionTypeNode`](IntersectionTypeNode.md) + +*** + +### createJSDocAllType() + +> **createJSDocAllType**(): [`JSDocAllType`](JSDocAllType.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3913 + +#### Returns + +[`JSDocAllType`](JSDocAllType.md) + +*** + +### createJSDocAugmentsTag() + +> **createJSDocAugmentsTag**(`tagName`, `className`, `comment`?): [`JSDocAugmentsTag`](JSDocAugmentsTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3963 + +#### Parameters + +##### tagName + +`undefined` | [`Identifier`](Identifier.md) + +##### className + +[`ExpressionWithTypeArguments`](ExpressionWithTypeArguments.md) & `object` + +##### comment? + +`string` | [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +#### Returns + +[`JSDocAugmentsTag`](JSDocAugmentsTag.md) + +*** + +### createJSDocAuthorTag() + +> **createJSDocAuthorTag**(`tagName`, `comment`?): [`JSDocAuthorTag`](JSDocAuthorTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3967 + +#### Parameters + +##### tagName + +`undefined` | [`Identifier`](Identifier.md) + +##### comment? + +`string` | [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +#### Returns + +[`JSDocAuthorTag`](JSDocAuthorTag.md) + +*** + +### createJSDocCallbackTag() + +> **createJSDocCallbackTag**(`tagName`, `typeExpression`, `fullName`?, `comment`?): [`JSDocCallbackTag`](JSDocCallbackTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3961 + +#### Parameters + +##### tagName + +`undefined` | [`Identifier`](Identifier.md) + +##### typeExpression + +[`JSDocSignature`](JSDocSignature.md) + +##### fullName? + +[`Identifier`](Identifier.md) | [`JSDocNamespaceDeclaration`](JSDocNamespaceDeclaration.md) + +##### comment? + +`string` | [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +#### Returns + +[`JSDocCallbackTag`](JSDocCallbackTag.md) + +*** + +### createJSDocClassTag() + +> **createJSDocClassTag**(`tagName`, `comment`?): [`JSDocClassTag`](JSDocClassTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3969 + +#### Parameters + +##### tagName + +`undefined` | [`Identifier`](Identifier.md) + +##### comment? + +`string` | [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +#### Returns + +[`JSDocClassTag`](JSDocClassTag.md) + +*** + +### createJSDocComment() + +> **createJSDocComment**(`comment`?, `tags`?): [`JSDoc`](JSDoc.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3987 + +#### Parameters + +##### comment? + +`string` | [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +##### tags? + +readonly [`JSDocTag`](JSDocTag.md)[] + +#### Returns + +[`JSDoc`](JSDoc.md) + +*** + +### createJSDocDeprecatedTag() + +> **createJSDocDeprecatedTag**(`tagName`, `comment`?): [`JSDocDeprecatedTag`](JSDocDeprecatedTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3981 + +#### Parameters + +##### tagName + +[`Identifier`](Identifier.md) + +##### comment? + +`string` | [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +#### Returns + +[`JSDocDeprecatedTag`](JSDocDeprecatedTag.md) + +*** + +### createJSDocEnumTag() + +> **createJSDocEnumTag**(`tagName`, `typeExpression`, `comment`?): [`JSDocEnumTag`](JSDocEnumTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3959 + +#### Parameters + +##### tagName + +`undefined` | [`Identifier`](Identifier.md) + +##### typeExpression + +[`JSDocTypeExpression`](JSDocTypeExpression.md) + +##### comment? + +`string` | [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +#### Returns + +[`JSDocEnumTag`](JSDocEnumTag.md) + +*** + +### createJSDocFunctionType() + +> **createJSDocFunctionType**(`parameters`, `type`): [`JSDocFunctionType`](JSDocFunctionType.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3921 + +#### Parameters + +##### parameters + +readonly [`ParameterDeclaration`](ParameterDeclaration.md)[] + +##### type + +`undefined` | [`TypeNode`](TypeNode.md) + +#### Returns + +[`JSDocFunctionType`](JSDocFunctionType.md) + +*** + +### createJSDocImplementsTag() + +> **createJSDocImplementsTag**(`tagName`, `className`, `comment`?): [`JSDocImplementsTag`](JSDocImplementsTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3965 + +#### Parameters + +##### tagName + +`undefined` | [`Identifier`](Identifier.md) + +##### className + +[`ExpressionWithTypeArguments`](ExpressionWithTypeArguments.md) & `object` + +##### comment? + +`string` | [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +#### Returns + +[`JSDocImplementsTag`](JSDocImplementsTag.md) + +*** + +### createJSDocLink() + +> **createJSDocLink**(`name`, `text`): [`JSDocLink`](JSDocLink.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3933 + +#### Parameters + +##### name + +`undefined` | [`EntityName`](../type-aliases/EntityName.md) | [`JSDocMemberName`](JSDocMemberName.md) + +##### text + +`string` + +#### Returns + +[`JSDocLink`](JSDocLink.md) + +*** + +### createJSDocLinkCode() + +> **createJSDocLinkCode**(`name`, `text`): [`JSDocLinkCode`](JSDocLinkCode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3935 + +#### Parameters + +##### name + +`undefined` | [`EntityName`](../type-aliases/EntityName.md) | [`JSDocMemberName`](JSDocMemberName.md) + +##### text + +`string` + +#### Returns + +[`JSDocLinkCode`](JSDocLinkCode.md) + +*** + +### createJSDocLinkPlain() + +> **createJSDocLinkPlain**(`name`, `text`): [`JSDocLinkPlain`](JSDocLinkPlain.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3937 + +#### Parameters + +##### name + +`undefined` | [`EntityName`](../type-aliases/EntityName.md) | [`JSDocMemberName`](JSDocMemberName.md) + +##### text + +`string` + +#### Returns + +[`JSDocLinkPlain`](JSDocLinkPlain.md) + +*** + +### createJSDocMemberName() + +> **createJSDocMemberName**(`left`, `right`): [`JSDocMemberName`](JSDocMemberName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3931 + +#### Parameters + +##### left + +[`EntityName`](../type-aliases/EntityName.md) | [`JSDocMemberName`](JSDocMemberName.md) + +##### right + +[`Identifier`](Identifier.md) + +#### Returns + +[`JSDocMemberName`](JSDocMemberName.md) + +*** + +### createJSDocNamepathType() + +> **createJSDocNamepathType**(`type`): [`JSDocNamepathType`](JSDocNamepathType.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3925 + +#### Parameters + +##### type + +[`TypeNode`](TypeNode.md) + +#### Returns + +[`JSDocNamepathType`](JSDocNamepathType.md) + +*** + +### createJSDocNameReference() + +> **createJSDocNameReference**(`name`): [`JSDocNameReference`](JSDocNameReference.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3929 + +#### Parameters + +##### name + +[`EntityName`](../type-aliases/EntityName.md) | [`JSDocMemberName`](JSDocMemberName.md) + +#### Returns + +[`JSDocNameReference`](JSDocNameReference.md) + +*** + +### createJSDocNonNullableType() + +> **createJSDocNonNullableType**(`type`, `postfix`?): [`JSDocNonNullableType`](JSDocNonNullableType.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3915 + +#### Parameters + +##### type + +[`TypeNode`](TypeNode.md) + +##### postfix? + +`boolean` + +#### Returns + +[`JSDocNonNullableType`](JSDocNonNullableType.md) + +*** + +### createJSDocNullableType() + +> **createJSDocNullableType**(`type`, `postfix`?): [`JSDocNullableType`](JSDocNullableType.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3917 + +#### Parameters + +##### type + +[`TypeNode`](TypeNode.md) + +##### postfix? + +`boolean` + +#### Returns + +[`JSDocNullableType`](JSDocNullableType.md) + +*** + +### createJSDocOptionalType() + +> **createJSDocOptionalType**(`type`): [`JSDocOptionalType`](JSDocOptionalType.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3919 + +#### Parameters + +##### type + +[`TypeNode`](TypeNode.md) + +#### Returns + +[`JSDocOptionalType`](JSDocOptionalType.md) + +*** + +### createJSDocOverrideTag() + +> **createJSDocOverrideTag**(`tagName`, `comment`?): [`JSDocOverrideTag`](JSDocOverrideTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3983 + +#### Parameters + +##### tagName + +[`Identifier`](Identifier.md) + +##### comment? + +`string` | [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +#### Returns + +[`JSDocOverrideTag`](JSDocOverrideTag.md) + +*** + +### createJSDocParameterTag() + +> **createJSDocParameterTag**(`tagName`, `name`, `isBracketed`, `typeExpression`?, `isNameFirst`?, `comment`?): [`JSDocParameterTag`](JSDocParameterTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3947 + +#### Parameters + +##### tagName + +`undefined` | [`Identifier`](Identifier.md) + +##### name + +[`EntityName`](../type-aliases/EntityName.md) + +##### isBracketed + +`boolean` + +##### typeExpression? + +[`JSDocTypeExpression`](JSDocTypeExpression.md) + +##### isNameFirst? + +`boolean` + +##### comment? + +`string` | [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +#### Returns + +[`JSDocParameterTag`](JSDocParameterTag.md) + +*** + +### createJSDocPrivateTag() + +> **createJSDocPrivateTag**(`tagName`, `comment`?): [`JSDocPrivateTag`](JSDocPrivateTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3973 + +#### Parameters + +##### tagName + +`undefined` | [`Identifier`](Identifier.md) + +##### comment? + +`string` | [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +#### Returns + +[`JSDocPrivateTag`](JSDocPrivateTag.md) + +*** + +### createJSDocPropertyTag() + +> **createJSDocPropertyTag**(`tagName`, `name`, `isBracketed`, `typeExpression`?, `isNameFirst`?, `comment`?): [`JSDocPropertyTag`](JSDocPropertyTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3949 + +#### Parameters + +##### tagName + +`undefined` | [`Identifier`](Identifier.md) + +##### name + +[`EntityName`](../type-aliases/EntityName.md) + +##### isBracketed + +`boolean` + +##### typeExpression? + +[`JSDocTypeExpression`](JSDocTypeExpression.md) + +##### isNameFirst? + +`boolean` + +##### comment? + +`string` | [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +#### Returns + +[`JSDocPropertyTag`](JSDocPropertyTag.md) + +*** + +### createJSDocProtectedTag() + +> **createJSDocProtectedTag**(`tagName`, `comment`?): [`JSDocProtectedTag`](JSDocProtectedTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3975 + +#### Parameters + +##### tagName + +`undefined` | [`Identifier`](Identifier.md) + +##### comment? + +`string` | [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +#### Returns + +[`JSDocProtectedTag`](JSDocProtectedTag.md) + +*** + +### createJSDocPublicTag() + +> **createJSDocPublicTag**(`tagName`, `comment`?): [`JSDocPublicTag`](JSDocPublicTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3971 + +#### Parameters + +##### tagName + +`undefined` | [`Identifier`](Identifier.md) + +##### comment? + +`string` | [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +#### Returns + +[`JSDocPublicTag`](JSDocPublicTag.md) + +*** + +### createJSDocReadonlyTag() + +> **createJSDocReadonlyTag**(`tagName`, `comment`?): [`JSDocReadonlyTag`](JSDocReadonlyTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3977 + +#### Parameters + +##### tagName + +`undefined` | [`Identifier`](Identifier.md) + +##### comment? + +`string` | [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +#### Returns + +[`JSDocReadonlyTag`](JSDocReadonlyTag.md) + +*** + +### createJSDocReturnTag() + +> **createJSDocReturnTag**(`tagName`, `typeExpression`?, `comment`?): [`JSDocReturnTag`](JSDocReturnTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3955 + +#### Parameters + +##### tagName + +`undefined` | [`Identifier`](Identifier.md) + +##### typeExpression? + +[`JSDocTypeExpression`](JSDocTypeExpression.md) + +##### comment? + +`string` | [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +#### Returns + +[`JSDocReturnTag`](JSDocReturnTag.md) + +*** + +### createJSDocSeeTag() + +> **createJSDocSeeTag**(`tagName`, `nameExpression`, `comment`?): [`JSDocSeeTag`](JSDocSeeTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3953 + +#### Parameters + +##### tagName + +`undefined` | [`Identifier`](Identifier.md) + +##### nameExpression + +`undefined` | [`JSDocNameReference`](JSDocNameReference.md) + +##### comment? + +`string` | [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +#### Returns + +[`JSDocSeeTag`](JSDocSeeTag.md) + +*** + +### createJSDocSignature() + +> **createJSDocSignature**(`typeParameters`, `parameters`, `type`?): [`JSDocSignature`](JSDocSignature.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3941 + +#### Parameters + +##### typeParameters + +`undefined` | readonly [`JSDocTemplateTag`](JSDocTemplateTag.md)[] + +##### parameters + +readonly [`JSDocParameterTag`](JSDocParameterTag.md)[] + +##### type? + +[`JSDocReturnTag`](JSDocReturnTag.md) + +#### Returns + +[`JSDocSignature`](JSDocSignature.md) + +*** + +### createJSDocTemplateTag() + +> **createJSDocTemplateTag**(`tagName`, `constraint`, `typeParameters`, `comment`?): [`JSDocTemplateTag`](JSDocTemplateTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3943 + +#### Parameters + +##### tagName + +`undefined` | [`Identifier`](Identifier.md) + +##### constraint + +`undefined` | [`JSDocTypeExpression`](JSDocTypeExpression.md) + +##### typeParameters + +readonly [`TypeParameterDeclaration`](TypeParameterDeclaration.md)[] + +##### comment? + +`string` | [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +#### Returns + +[`JSDocTemplateTag`](JSDocTemplateTag.md) + +*** + +### createJSDocText() + +> **createJSDocText**(`text`): [`JSDocText`](JSDocText.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3985 + +#### Parameters + +##### text + +`string` + +#### Returns + +[`JSDocText`](JSDocText.md) + +*** + +### createJSDocThisTag() + +> **createJSDocThisTag**(`tagName`, `typeExpression`, `comment`?): [`JSDocThisTag`](JSDocThisTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3957 + +#### Parameters + +##### tagName + +`undefined` | [`Identifier`](Identifier.md) + +##### typeExpression + +[`JSDocTypeExpression`](JSDocTypeExpression.md) + +##### comment? + +`string` | [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +#### Returns + +[`JSDocThisTag`](JSDocThisTag.md) + +*** + +### createJSDocTypedefTag() + +> **createJSDocTypedefTag**(`tagName`, `typeExpression`?, `fullName`?, `comment`?): [`JSDocTypedefTag`](JSDocTypedefTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3945 + +#### Parameters + +##### tagName + +`undefined` | [`Identifier`](Identifier.md) + +##### typeExpression? + +[`JSDocTypeLiteral`](JSDocTypeLiteral.md) | [`JSDocTypeExpression`](JSDocTypeExpression.md) + +##### fullName? + +[`Identifier`](Identifier.md) | [`JSDocNamespaceDeclaration`](JSDocNamespaceDeclaration.md) + +##### comment? + +`string` | [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +#### Returns + +[`JSDocTypedefTag`](JSDocTypedefTag.md) + +*** + +### createJSDocTypeExpression() + +> **createJSDocTypeExpression**(`type`): [`JSDocTypeExpression`](JSDocTypeExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3927 + +#### Parameters + +##### type + +[`TypeNode`](TypeNode.md) + +#### Returns + +[`JSDocTypeExpression`](JSDocTypeExpression.md) + +*** + +### createJSDocTypeLiteral() + +> **createJSDocTypeLiteral**(`jsDocPropertyTags`?, `isArrayType`?): [`JSDocTypeLiteral`](JSDocTypeLiteral.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3939 + +#### Parameters + +##### jsDocPropertyTags? + +readonly [`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md)[] + +##### isArrayType? + +`boolean` + +#### Returns + +[`JSDocTypeLiteral`](JSDocTypeLiteral.md) + +*** + +### createJSDocTypeTag() + +> **createJSDocTypeTag**(`tagName`, `typeExpression`, `comment`?): [`JSDocTypeTag`](JSDocTypeTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3951 + +#### Parameters + +##### tagName + +`undefined` | [`Identifier`](Identifier.md) + +##### typeExpression + +[`JSDocTypeExpression`](JSDocTypeExpression.md) + +##### comment? + +`string` | [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +#### Returns + +[`JSDocTypeTag`](JSDocTypeTag.md) + +*** + +### createJSDocUnknownTag() + +> **createJSDocUnknownTag**(`tagName`, `comment`?): [`JSDocUnknownTag`](JSDocUnknownTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3979 + +#### Parameters + +##### tagName + +[`Identifier`](Identifier.md) + +##### comment? + +`string` | [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +#### Returns + +[`JSDocUnknownTag`](JSDocUnknownTag.md) + +*** + +### createJSDocUnknownType() + +> **createJSDocUnknownType**(): [`JSDocUnknownType`](JSDocUnknownType.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3914 + +#### Returns + +[`JSDocUnknownType`](JSDocUnknownType.md) + +*** + +### createJSDocVariadicType() + +> **createJSDocVariadicType**(`type`): [`JSDocVariadicType`](JSDocVariadicType.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3923 + +#### Parameters + +##### type + +[`TypeNode`](TypeNode.md) + +#### Returns + +[`JSDocVariadicType`](JSDocVariadicType.md) + +*** + +### createJsxAttribute() + +> **createJsxAttribute**(`name`, `initializer`): [`JsxAttribute`](JsxAttribute.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4003 + +#### Parameters + +##### name + +[`Identifier`](Identifier.md) + +##### initializer + +`undefined` | [`JsxAttributeValue`](../type-aliases/JsxAttributeValue.md) + +#### Returns + +[`JsxAttribute`](JsxAttribute.md) + +*** + +### createJsxAttributes() + +> **createJsxAttributes**(`properties`): [`JsxAttributes`](JsxAttributes.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4005 + +#### Parameters + +##### properties + +readonly [`JsxAttributeLike`](../type-aliases/JsxAttributeLike.md)[] + +#### Returns + +[`JsxAttributes`](JsxAttributes.md) + +*** + +### createJsxClosingElement() + +> **createJsxClosingElement**(`tagName`): [`JsxClosingElement`](JsxClosingElement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3995 + +#### Parameters + +##### tagName + +[`JsxTagNameExpression`](../type-aliases/JsxTagNameExpression.md) + +#### Returns + +[`JsxClosingElement`](JsxClosingElement.md) + +*** + +### createJsxElement() + +> **createJsxElement**(`openingElement`, `children`, `closingElement`): [`JsxElement`](JsxElement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3989 + +#### Parameters + +##### openingElement + +[`JsxOpeningElement`](JsxOpeningElement.md) + +##### children + +readonly [`JsxChild`](../type-aliases/JsxChild.md)[] + +##### closingElement + +[`JsxClosingElement`](JsxClosingElement.md) + +#### Returns + +[`JsxElement`](JsxElement.md) + +*** + +### createJsxExpression() + +> **createJsxExpression**(`dotDotDotToken`, `expression`): [`JsxExpression`](JsxExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4009 + +#### Parameters + +##### dotDotDotToken + +`undefined` | [`DotDotDotToken`](../type-aliases/DotDotDotToken.md) + +##### expression + +`undefined` | [`Expression`](Expression.md) + +#### Returns + +[`JsxExpression`](JsxExpression.md) + +*** + +### createJsxFragment() + +> **createJsxFragment**(`openingFragment`, `children`, `closingFragment`): [`JsxFragment`](JsxFragment.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3997 + +#### Parameters + +##### openingFragment + +[`JsxOpeningFragment`](JsxOpeningFragment.md) + +##### children + +readonly [`JsxChild`](../type-aliases/JsxChild.md)[] + +##### closingFragment + +[`JsxClosingFragment`](JsxClosingFragment.md) + +#### Returns + +[`JsxFragment`](JsxFragment.md) + +*** + +### createJsxJsxClosingFragment() + +> **createJsxJsxClosingFragment**(): [`JsxClosingFragment`](JsxClosingFragment.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4001 + +#### Returns + +[`JsxClosingFragment`](JsxClosingFragment.md) + +*** + +### createJsxOpeningElement() + +> **createJsxOpeningElement**(`tagName`, `typeArguments`, `attributes`): [`JsxOpeningElement`](JsxOpeningElement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3993 + +#### Parameters + +##### tagName + +[`JsxTagNameExpression`](../type-aliases/JsxTagNameExpression.md) + +##### typeArguments + +`undefined` | readonly [`TypeNode`](TypeNode.md)[] + +##### attributes + +[`JsxAttributes`](JsxAttributes.md) + +#### Returns + +[`JsxOpeningElement`](JsxOpeningElement.md) + +*** + +### createJsxOpeningFragment() + +> **createJsxOpeningFragment**(): [`JsxOpeningFragment`](JsxOpeningFragment.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4000 + +#### Returns + +[`JsxOpeningFragment`](JsxOpeningFragment.md) + +*** + +### createJsxSelfClosingElement() + +> **createJsxSelfClosingElement**(`tagName`, `typeArguments`, `attributes`): [`JsxSelfClosingElement`](JsxSelfClosingElement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3991 + +#### Parameters + +##### tagName + +[`JsxTagNameExpression`](../type-aliases/JsxTagNameExpression.md) + +##### typeArguments + +`undefined` | readonly [`TypeNode`](TypeNode.md)[] + +##### attributes + +[`JsxAttributes`](JsxAttributes.md) + +#### Returns + +[`JsxSelfClosingElement`](JsxSelfClosingElement.md) + +*** + +### createJsxSpreadAttribute() + +> **createJsxSpreadAttribute**(`expression`): [`JsxSpreadAttribute`](JsxSpreadAttribute.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4007 + +#### Parameters + +##### expression + +[`Expression`](Expression.md) + +#### Returns + +[`JsxSpreadAttribute`](JsxSpreadAttribute.md) + +*** + +### createJsxText() + +> **createJsxText**(`text`, `containsOnlyTriviaWhiteSpaces`?): [`JsxText`](JsxText.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3998 + +#### Parameters + +##### text + +`string` + +##### containsOnlyTriviaWhiteSpaces? + +`boolean` + +#### Returns + +[`JsxText`](JsxText.md) + +*** + +### createKeywordTypeNode() + +> **createKeywordTypeNode**\<`TKind`\>(`kind`): [`KeywordTypeNode`](KeywordTypeNode.md)\<`TKind`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3692 + +#### Type Parameters + +• **TKind** *extends* [`KeywordTypeSyntaxKind`](../type-aliases/KeywordTypeSyntaxKind.md) + +#### Parameters + +##### kind + +`TKind` + +#### Returns + +[`KeywordTypeNode`](KeywordTypeNode.md)\<`TKind`\> + +*** + +### createLabeledStatement() + +> **createLabeledStatement**(`label`, `statement`): [`LabeledStatement`](LabeledStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3852 + +#### Parameters + +##### label + +`string` | [`Identifier`](Identifier.md) + +##### statement + +[`Statement`](Statement.md) + +#### Returns + +[`LabeledStatement`](LabeledStatement.md) + +*** + +### createLeftShift() + +> **createLeftShift**(`left`, `right`): [`BinaryExpression`](BinaryExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4052 + +#### Parameters + +##### left + +[`Expression`](Expression.md) + +##### right + +[`Expression`](Expression.md) + +#### Returns + +[`BinaryExpression`](BinaryExpression.md) + +*** + +### createLessThan() + +> **createLessThan**(`left`, `right`): [`BinaryExpression`](BinaryExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4048 + +#### Parameters + +##### left + +[`Expression`](Expression.md) + +##### right + +[`Expression`](Expression.md) + +#### Returns + +[`BinaryExpression`](BinaryExpression.md) + +*** + +### createLessThanEquals() + +> **createLessThanEquals**(`left`, `right`): [`BinaryExpression`](BinaryExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4049 + +#### Parameters + +##### left + +[`Expression`](Expression.md) + +##### right + +[`Expression`](Expression.md) + +#### Returns + +[`BinaryExpression`](BinaryExpression.md) + +*** + +### createLiteralTypeNode() + +> **createLiteralTypeNode**(`literal`): [`LiteralTypeNode`](LiteralTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3734 + +#### Parameters + +##### literal + +[`LiteralExpression`](LiteralExpression.md) | [`PrefixUnaryExpression`](PrefixUnaryExpression.md) | [`NullLiteral`](NullLiteral.md) | [`BooleanLiteral`](../type-aliases/BooleanLiteral.md) + +#### Returns + +[`LiteralTypeNode`](LiteralTypeNode.md) + +*** + +### createLogicalAnd() + +> **createLogicalAnd**(`left`, `right`): [`BinaryExpression`](BinaryExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4040 + +#### Parameters + +##### left + +[`Expression`](Expression.md) + +##### right + +[`Expression`](Expression.md) + +#### Returns + +[`BinaryExpression`](BinaryExpression.md) + +*** + +### createLogicalNot() + +> **createLogicalNot**(`operand`): [`PrefixUnaryExpression`](PrefixUnaryExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4066 + +#### Parameters + +##### operand + +[`Expression`](Expression.md) + +#### Returns + +[`PrefixUnaryExpression`](PrefixUnaryExpression.md) + +*** + +### createLogicalOr() + +> **createLogicalOr**(`left`, `right`): [`BinaryExpression`](BinaryExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4039 + +#### Parameters + +##### left + +[`Expression`](Expression.md) + +##### right + +[`Expression`](Expression.md) + +#### Returns + +[`BinaryExpression`](BinaryExpression.md) + +*** + +### createLoopVariable() + +> **createLoopVariable**(`reservedInNestedScopes`?): [`Identifier`](Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3633 + +Create a unique temporary variable for use in a loop. + +#### Parameters + +##### reservedInNestedScopes? + +`boolean` + +When `true`, reserves the temporary variable name in all nested scopes +during emit so that the variable can be referenced in a nested function body. This is an alternative to +setting `EmitFlags.ReuseTempVariableScope` on the nested function itself. + +#### Returns + +[`Identifier`](Identifier.md) + +*** + +### createMappedTypeNode() + +> **createMappedTypeNode**(`readonlyToken`, `typeParameter`, `nameType`, `questionToken`, `type`, `members`): [`MappedTypeNode`](MappedTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3732 + +#### Parameters + +##### readonlyToken + +`undefined` | [`ReadonlyKeyword`](../type-aliases/ReadonlyKeyword.md) | [`PlusToken`](../type-aliases/PlusToken.md) | [`MinusToken`](../type-aliases/MinusToken.md) + +##### typeParameter + +[`TypeParameterDeclaration`](TypeParameterDeclaration.md) + +##### nameType + +`undefined` | [`TypeNode`](TypeNode.md) + +##### questionToken + +`undefined` | [`QuestionToken`](../type-aliases/QuestionToken.md) | [`PlusToken`](../type-aliases/PlusToken.md) | [`MinusToken`](../type-aliases/MinusToken.md) + +##### type + +`undefined` | [`TypeNode`](TypeNode.md) + +##### members + +`undefined` | [`NodeArray`](NodeArray.md)\<[`TypeElement`](TypeElement.md)\> + +#### Returns + +[`MappedTypeNode`](MappedTypeNode.md) + +*** + +### createMetaProperty() + +> **createMetaProperty**(`keywordToken`, `name`): [`MetaProperty`](MetaProperty.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3816 + +#### Parameters + +##### keywordToken + +[`ImportKeyword`](../enumerations/SyntaxKind.md#importkeyword) | [`NewKeyword`](../enumerations/SyntaxKind.md#newkeyword) + +##### name + +[`Identifier`](Identifier.md) + +#### Returns + +[`MetaProperty`](MetaProperty.md) + +*** + +### createMethodDeclaration() + +#### Call Signature + +> **createMethodDeclaration**(`modifiers`, `asteriskToken`, `name`, `questionToken`, `typeParameters`, `parameters`, `type`, `body`): [`MethodDeclaration`](MethodDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3674 + +##### Parameters + +###### modifiers + +`undefined` | readonly [`ModifierLike`](../type-aliases/ModifierLike.md)[] + +###### asteriskToken + +`undefined` | [`AsteriskToken`](../type-aliases/AsteriskToken.md) + +###### name + +`string` | [`PropertyName`](../type-aliases/PropertyName.md) + +###### questionToken + +`undefined` | [`QuestionToken`](../type-aliases/QuestionToken.md) + +###### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](TypeParameterDeclaration.md)[] + +###### parameters + +readonly [`ParameterDeclaration`](ParameterDeclaration.md)[] + +###### type + +`undefined` | [`TypeNode`](TypeNode.md) + +###### body + +`undefined` | [`Block`](Block.md) + +##### Returns + +[`MethodDeclaration`](MethodDeclaration.md) + +#### Call Signature + +> **createMethodDeclaration**(`decorators`, `modifiers`, `asteriskToken`, `name`, `questionToken`, `typeParameters`, `parameters`, `type`, `body`): [`MethodDeclaration`](MethodDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8430 + +##### Parameters + +###### decorators + +`undefined` | readonly [`Decorator`](Decorator.md)[] + +###### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +###### asteriskToken + +`undefined` | [`AsteriskToken`](../type-aliases/AsteriskToken.md) + +###### name + +`string` | [`PropertyName`](../type-aliases/PropertyName.md) + +###### questionToken + +`undefined` | [`QuestionToken`](../type-aliases/QuestionToken.md) + +###### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](TypeParameterDeclaration.md)[] + +###### parameters + +readonly [`ParameterDeclaration`](ParameterDeclaration.md)[] + +###### type + +`undefined` | [`TypeNode`](TypeNode.md) + +###### body + +`undefined` | [`Block`](Block.md) + +##### Returns + +[`MethodDeclaration`](MethodDeclaration.md) + +##### Deprecated + +Decorators have been combined with modifiers. Callers should use an overload that does not accept a `decorators` parameter. + +*** + +### createMethodSignature() + +> **createMethodSignature**(`modifiers`, `name`, `questionToken`, `typeParameters`, `parameters`, `type`): [`MethodSignature`](MethodSignature.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3672 + +#### Parameters + +##### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +##### name + +`string` | [`PropertyName`](../type-aliases/PropertyName.md) + +##### questionToken + +`undefined` | [`QuestionToken`](../type-aliases/QuestionToken.md) + +##### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](TypeParameterDeclaration.md)[] + +##### parameters + +readonly [`ParameterDeclaration`](ParameterDeclaration.md)[] + +##### type + +`undefined` | [`TypeNode`](TypeNode.md) + +#### Returns + +[`MethodSignature`](MethodSignature.md) + +*** + +### createModifier() + +> **createModifier**\<`T`\>(`kind`): [`ModifierToken`](ModifierToken.md)\<`T`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3656 + +#### Type Parameters + +• **T** *extends* [`ModifierSyntaxKind`](../type-aliases/ModifierSyntaxKind.md) + +#### Parameters + +##### kind + +`T` + +#### Returns + +[`ModifierToken`](ModifierToken.md)\<`T`\> + +*** + +### createModifiersFromModifierFlags() + +> **createModifiersFromModifierFlags**(`flags`): `undefined` \| [`Modifier`](../type-aliases/Modifier.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3657 + +#### Parameters + +##### flags + +[`ModifierFlags`](../enumerations/ModifierFlags.md) + +#### Returns + +`undefined` \| [`Modifier`](../type-aliases/Modifier.md)[] + +*** + +### createModuleBlock() + +> **createModuleBlock**(`statements`): [`ModuleBlock`](ModuleBlock.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3877 + +#### Parameters + +##### statements + +readonly [`Statement`](Statement.md)[] + +#### Returns + +[`ModuleBlock`](ModuleBlock.md) + +*** + +### createModuleDeclaration() + +#### Call Signature + +> **createModuleDeclaration**(`modifiers`, `name`, `body`, `flags`?): [`ModuleDeclaration`](ModuleDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3875 + +##### Parameters + +###### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +###### name + +[`ModuleName`](../type-aliases/ModuleName.md) + +###### body + +`undefined` | [`ModuleBody`](../type-aliases/ModuleBody.md) + +###### flags? + +[`NodeFlags`](../enumerations/NodeFlags.md) + +##### Returns + +[`ModuleDeclaration`](ModuleDeclaration.md) + +#### Call Signature + +> **createModuleDeclaration**(`decorators`, `modifiers`, `name`, `body`, `flags`?): [`ModuleDeclaration`](ModuleDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8526 + +##### Parameters + +###### decorators + +`undefined` | readonly [`Decorator`](Decorator.md)[] + +###### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +###### name + +[`ModuleName`](../type-aliases/ModuleName.md) + +###### body + +`undefined` | [`ModuleBody`](../type-aliases/ModuleBody.md) + +###### flags? + +[`NodeFlags`](../enumerations/NodeFlags.md) + +##### Returns + +[`ModuleDeclaration`](ModuleDeclaration.md) + +##### Deprecated + +Decorators are no longer supported for this function. Callers should use an overload that does not accept a `decorators` parameter. + +*** + +### createModulo() + +> **createModulo**(`left`, `right`): [`BinaryExpression`](BinaryExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4059 + +#### Parameters + +##### left + +[`Expression`](Expression.md) + +##### right + +[`Expression`](Expression.md) + +#### Returns + +[`BinaryExpression`](BinaryExpression.md) + +*** + +### createMultiply() + +> **createMultiply**(`left`, `right`): [`BinaryExpression`](BinaryExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4057 + +#### Parameters + +##### left + +[`Expression`](Expression.md) + +##### right + +[`Expression`](Expression.md) + +#### Returns + +[`BinaryExpression`](BinaryExpression.md) + +*** + +### createNamedExports() + +> **createNamedExports**(`elements`): [`NamedExports`](NamedExports.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3907 + +#### Parameters + +##### elements + +readonly [`ExportSpecifier`](ExportSpecifier.md)[] + +#### Returns + +[`NamedExports`](NamedExports.md) + +*** + +### createNamedImports() + +> **createNamedImports**(`elements`): [`NamedImports`](NamedImports.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3899 + +#### Parameters + +##### elements + +readonly [`ImportSpecifier`](ImportSpecifier.md)[] + +#### Returns + +[`NamedImports`](NamedImports.md) + +*** + +### createNamedTupleMember() + +> **createNamedTupleMember**(`dotDotDotToken`, `name`, `questionToken`, `type`): [`NamedTupleMember`](NamedTupleMember.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3709 + +#### Parameters + +##### dotDotDotToken + +`undefined` | [`DotDotDotToken`](../type-aliases/DotDotDotToken.md) + +##### name + +[`Identifier`](Identifier.md) + +##### questionToken + +`undefined` | [`QuestionToken`](../type-aliases/QuestionToken.md) + +##### type + +[`TypeNode`](TypeNode.md) + +#### Returns + +[`NamedTupleMember`](NamedTupleMember.md) + +*** + +### createNamespaceExport() + +> **createNamespaceExport**(`name`): [`NamespaceExport`](NamespaceExport.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3897 + +#### Parameters + +##### name + +[`Identifier`](Identifier.md) + +#### Returns + +[`NamespaceExport`](NamespaceExport.md) + +*** + +### createNamespaceExportDeclaration() + +> **createNamespaceExportDeclaration**(`name`): [`NamespaceExportDeclaration`](NamespaceExportDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3881 + +#### Parameters + +##### name + +`string` | [`Identifier`](Identifier.md) + +#### Returns + +[`NamespaceExportDeclaration`](NamespaceExportDeclaration.md) + +*** + +### createNamespaceImport() + +> **createNamespaceImport**(`name`): [`NamespaceImport`](NamespaceImport.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3895 + +#### Parameters + +##### name + +[`Identifier`](Identifier.md) + +#### Returns + +[`NamespaceImport`](NamespaceImport.md) + +*** + +### createNewExpression() + +> **createNewExpression**(`expression`, `typeArguments`, `argumentsArray`): [`NewExpression`](NewExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3760 + +#### Parameters + +##### expression + +[`Expression`](Expression.md) + +##### typeArguments + +`undefined` | readonly [`TypeNode`](TypeNode.md)[] + +##### argumentsArray + +`undefined` | readonly [`Expression`](Expression.md)[] + +#### Returns + +[`NewExpression`](NewExpression.md) + +*** + +### createNodeArray() + +> **createNodeArray**\<`T`\>(`elements`?, `hasTrailingComma`?): [`NodeArray`](NodeArray.md)\<`T`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3610 + +#### Type Parameters + +• **T** *extends* [`Node`](Node.md) + +#### Parameters + +##### elements? + +readonly `T`[] + +##### hasTrailingComma? + +`boolean` + +#### Returns + +[`NodeArray`](NodeArray.md)\<`T`\> + +*** + +### createNonNullChain() + +> **createNonNullChain**(`expression`): [`NonNullChain`](NonNullChain.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3814 + +#### Parameters + +##### expression + +[`Expression`](Expression.md) + +#### Returns + +[`NonNullChain`](NonNullChain.md) + +*** + +### createNonNullExpression() + +> **createNonNullExpression**(`expression`): [`NonNullExpression`](NonNullExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3812 + +#### Parameters + +##### expression + +[`Expression`](Expression.md) + +#### Returns + +[`NonNullExpression`](NonNullExpression.md) + +*** + +### createNoSubstitutionTemplateLiteral() + +#### Call Signature + +> **createNoSubstitutionTemplateLiteral**(`text`, `rawText`?): [`NoSubstitutionTemplateLiteral`](NoSubstitutionTemplateLiteral.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3798 + +##### Parameters + +###### text + +`string` + +###### rawText? + +`string` + +##### Returns + +[`NoSubstitutionTemplateLiteral`](NoSubstitutionTemplateLiteral.md) + +#### Call Signature + +> **createNoSubstitutionTemplateLiteral**(`text`, `rawText`): [`NoSubstitutionTemplateLiteral`](NoSubstitutionTemplateLiteral.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3799 + +##### Parameters + +###### text + +`undefined` | `string` + +###### rawText + +`string` + +##### Returns + +[`NoSubstitutionTemplateLiteral`](NoSubstitutionTemplateLiteral.md) + +*** + +### createNotEmittedStatement() + +> **createNotEmittedStatement**(`original`): [`NotEmittedStatement`](NotEmittedStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4029 + +#### Parameters + +##### original + +[`Node`](Node.md) + +#### Returns + +[`NotEmittedStatement`](NotEmittedStatement.md) + +*** + +### createNull() + +> **createNull**(): [`NullLiteral`](NullLiteral.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3653 + +#### Returns + +[`NullLiteral`](NullLiteral.md) + +*** + +### createNumericLiteral() + +> **createNumericLiteral**(`value`, `numericLiteralFlags`?): [`NumericLiteral`](NumericLiteral.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3611 + +#### Parameters + +##### value + +`string` | `number` + +##### numericLiteralFlags? + +[`TokenFlags`](../enumerations/TokenFlags.md) + +#### Returns + +[`NumericLiteral`](NumericLiteral.md) + +*** + +### createObjectBindingPattern() + +> **createObjectBindingPattern**(`elements`): [`ObjectBindingPattern`](ObjectBindingPattern.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3738 + +#### Parameters + +##### elements + +readonly [`BindingElement`](BindingElement.md)[] + +#### Returns + +[`ObjectBindingPattern`](ObjectBindingPattern.md) + +*** + +### createObjectLiteralExpression() + +> **createObjectLiteralExpression**(`properties`?, `multiLine`?): [`ObjectLiteralExpression`](ObjectLiteralExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3746 + +#### Parameters + +##### properties? + +readonly [`ObjectLiteralElementLike`](../type-aliases/ObjectLiteralElementLike.md)[] + +##### multiLine? + +`boolean` + +#### Returns + +[`ObjectLiteralExpression`](ObjectLiteralExpression.md) + +*** + +### createOmittedExpression() + +> **createOmittedExpression**(): [`OmittedExpression`](OmittedExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3807 + +#### Returns + +[`OmittedExpression`](OmittedExpression.md) + +*** + +### createOptionalTypeNode() + +> **createOptionalTypeNode**(`type`): [`OptionalTypeNode`](OptionalTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3711 + +#### Parameters + +##### type + +[`TypeNode`](TypeNode.md) + +#### Returns + +[`OptionalTypeNode`](OptionalTypeNode.md) + +*** + +### createParameterDeclaration() + +#### Call Signature + +> **createParameterDeclaration**(`modifiers`, `dotDotDotToken`, `name`, `questionToken`?, `type`?, `initializer`?): [`ParameterDeclaration`](ParameterDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3664 + +##### Parameters + +###### modifiers + +`undefined` | readonly [`ModifierLike`](../type-aliases/ModifierLike.md)[] + +###### dotDotDotToken + +`undefined` | [`DotDotDotToken`](../type-aliases/DotDotDotToken.md) + +###### name + +`string` | [`BindingName`](../type-aliases/BindingName.md) + +###### questionToken? + +[`QuestionToken`](../type-aliases/QuestionToken.md) + +###### type? + +[`TypeNode`](TypeNode.md) + +###### initializer? + +[`Expression`](Expression.md) + +##### Returns + +[`ParameterDeclaration`](ParameterDeclaration.md) + +#### Call Signature + +> **createParameterDeclaration**(`decorators`, `modifiers`, `dotDotDotToken`, `name`, `questionToken`?, `type`?, `initializer`?): [`ParameterDeclaration`](ParameterDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8414 + +##### Parameters + +###### decorators + +`undefined` | readonly [`Decorator`](Decorator.md)[] + +###### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +###### dotDotDotToken + +`undefined` | [`DotDotDotToken`](../type-aliases/DotDotDotToken.md) + +###### name + +`string` | [`BindingName`](../type-aliases/BindingName.md) + +###### questionToken? + +[`QuestionToken`](../type-aliases/QuestionToken.md) + +###### type? + +[`TypeNode`](TypeNode.md) + +###### initializer? + +[`Expression`](Expression.md) + +##### Returns + +[`ParameterDeclaration`](ParameterDeclaration.md) + +##### Deprecated + +Decorators have been combined with modifiers. Callers should use an overload that does not accept a `decorators` parameter. + +*** + +### createParenthesizedExpression() + +> **createParenthesizedExpression**(`expression`): [`ParenthesizedExpression`](ParenthesizedExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3766 + +#### Parameters + +##### expression + +[`Expression`](Expression.md) + +#### Returns + +[`ParenthesizedExpression`](ParenthesizedExpression.md) + +*** + +### createParenthesizedType() + +> **createParenthesizedType**(`type`): [`ParenthesizedTypeNode`](ParenthesizedTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3725 + +#### Parameters + +##### type + +[`TypeNode`](TypeNode.md) + +#### Returns + +[`ParenthesizedTypeNode`](ParenthesizedTypeNode.md) + +*** + +### createPartiallyEmittedExpression() + +> **createPartiallyEmittedExpression**(`expression`, `original`?): [`PartiallyEmittedExpression`](PartiallyEmittedExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4030 + +#### Parameters + +##### expression + +[`Expression`](Expression.md) + +##### original? + +[`Node`](Node.md) + +#### Returns + +[`PartiallyEmittedExpression`](PartiallyEmittedExpression.md) + +*** + +### createPostfixDecrement() + +> **createPostfixDecrement**(`operand`): [`PostfixUnaryExpression`](PostfixUnaryExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4068 + +#### Parameters + +##### operand + +[`Expression`](Expression.md) + +#### Returns + +[`PostfixUnaryExpression`](PostfixUnaryExpression.md) + +*** + +### createPostfixIncrement() + +> **createPostfixIncrement**(`operand`): [`PostfixUnaryExpression`](PostfixUnaryExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4067 + +#### Parameters + +##### operand + +[`Expression`](Expression.md) + +#### Returns + +[`PostfixUnaryExpression`](PostfixUnaryExpression.md) + +*** + +### createPostfixUnaryExpression() + +> **createPostfixUnaryExpression**(`operand`, `operator`): [`PostfixUnaryExpression`](PostfixUnaryExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3784 + +#### Parameters + +##### operand + +[`Expression`](Expression.md) + +##### operator + +[`PostfixUnaryOperator`](../type-aliases/PostfixUnaryOperator.md) + +#### Returns + +[`PostfixUnaryExpression`](PostfixUnaryExpression.md) + +*** + +### createPrefixDecrement() + +> **createPrefixDecrement**(`operand`): [`PrefixUnaryExpression`](PrefixUnaryExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4064 + +#### Parameters + +##### operand + +[`Expression`](Expression.md) + +#### Returns + +[`PrefixUnaryExpression`](PrefixUnaryExpression.md) + +*** + +### createPrefixIncrement() + +> **createPrefixIncrement**(`operand`): [`PrefixUnaryExpression`](PrefixUnaryExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4063 + +#### Parameters + +##### operand + +[`Expression`](Expression.md) + +#### Returns + +[`PrefixUnaryExpression`](PrefixUnaryExpression.md) + +*** + +### createPrefixMinus() + +> **createPrefixMinus**(`operand`): [`PrefixUnaryExpression`](PrefixUnaryExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4062 + +#### Parameters + +##### operand + +[`Expression`](Expression.md) + +#### Returns + +[`PrefixUnaryExpression`](PrefixUnaryExpression.md) + +*** + +### createPrefixPlus() + +> **createPrefixPlus**(`operand`): [`PrefixUnaryExpression`](PrefixUnaryExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4061 + +#### Parameters + +##### operand + +[`Expression`](Expression.md) + +#### Returns + +[`PrefixUnaryExpression`](PrefixUnaryExpression.md) + +*** + +### createPrefixUnaryExpression() + +> **createPrefixUnaryExpression**(`operator`, `operand`): [`PrefixUnaryExpression`](PrefixUnaryExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3782 + +#### Parameters + +##### operator + +[`PrefixUnaryOperator`](../type-aliases/PrefixUnaryOperator.md) + +##### operand + +[`Expression`](Expression.md) + +#### Returns + +[`PrefixUnaryExpression`](PrefixUnaryExpression.md) + +*** + +### createPrivateIdentifier() + +> **createPrivateIdentifier**(`text`): [`PrivateIdentifier`](PrivateIdentifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3638 + +#### Parameters + +##### text + +`string` + +#### Returns + +[`PrivateIdentifier`](PrivateIdentifier.md) + +*** + +### createPropertyAccessChain() + +> **createPropertyAccessChain**(`expression`, `questionDotToken`, `name`): [`PropertyAccessChain`](PropertyAccessChain.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3750 + +#### Parameters + +##### expression + +[`Expression`](Expression.md) + +##### questionDotToken + +`undefined` | [`QuestionDotToken`](../type-aliases/QuestionDotToken.md) + +##### name + +`string` | [`MemberName`](../type-aliases/MemberName.md) + +#### Returns + +[`PropertyAccessChain`](PropertyAccessChain.md) + +*** + +### createPropertyAccessExpression() + +> **createPropertyAccessExpression**(`expression`, `name`): [`PropertyAccessExpression`](PropertyAccessExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3748 + +#### Parameters + +##### expression + +[`Expression`](Expression.md) + +##### name + +`string` | [`MemberName`](../type-aliases/MemberName.md) + +#### Returns + +[`PropertyAccessExpression`](PropertyAccessExpression.md) + +*** + +### createPropertyAssignment() + +> **createPropertyAssignment**(`name`, `initializer`): [`PropertyAssignment`](PropertyAssignment.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4019 + +#### Parameters + +##### name + +`string` | [`PropertyName`](../type-aliases/PropertyName.md) + +##### initializer + +[`Expression`](Expression.md) + +#### Returns + +[`PropertyAssignment`](PropertyAssignment.md) + +*** + +### createPropertyDeclaration() + +#### Call Signature + +> **createPropertyDeclaration**(`modifiers`, `name`, `questionOrExclamationToken`, `type`, `initializer`): [`PropertyDeclaration`](PropertyDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3670 + +##### Parameters + +###### modifiers + +`undefined` | readonly [`ModifierLike`](../type-aliases/ModifierLike.md)[] + +###### name + +`string` | [`PropertyName`](../type-aliases/PropertyName.md) + +###### questionOrExclamationToken + +`undefined` | [`QuestionToken`](../type-aliases/QuestionToken.md) | [`ExclamationToken`](../type-aliases/ExclamationToken.md) + +###### type + +`undefined` | [`TypeNode`](TypeNode.md) + +###### initializer + +`undefined` | [`Expression`](Expression.md) + +##### Returns + +[`PropertyDeclaration`](PropertyDeclaration.md) + +#### Call Signature + +> **createPropertyDeclaration**(`decorators`, `modifiers`, `name`, `questionOrExclamationToken`, `type`, `initializer`): [`PropertyDeclaration`](PropertyDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8422 + +##### Parameters + +###### decorators + +`undefined` | readonly [`Decorator`](Decorator.md)[] + +###### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +###### name + +`string` | [`PropertyName`](../type-aliases/PropertyName.md) + +###### questionOrExclamationToken + +`undefined` | [`QuestionToken`](../type-aliases/QuestionToken.md) | [`ExclamationToken`](../type-aliases/ExclamationToken.md) + +###### type + +`undefined` | [`TypeNode`](TypeNode.md) + +###### initializer + +`undefined` | [`Expression`](Expression.md) + +##### Returns + +[`PropertyDeclaration`](PropertyDeclaration.md) + +##### Deprecated + +Decorators have been combined with modifiers. Callers should use an overload that does not accept a `decorators` parameter. + +*** + +### createPropertySignature() + +> **createPropertySignature**(`modifiers`, `name`, `questionToken`, `type`): [`PropertySignature`](PropertySignature.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3668 + +#### Parameters + +##### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +##### name + +`string` | [`PropertyName`](../type-aliases/PropertyName.md) + +##### questionToken + +`undefined` | [`QuestionToken`](../type-aliases/QuestionToken.md) + +##### type + +`undefined` | [`TypeNode`](TypeNode.md) + +#### Returns + +[`PropertySignature`](PropertySignature.md) + +*** + +### createQualifiedName() + +> **createQualifiedName**(`left`, `right`): [`QualifiedName`](QualifiedName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3658 + +#### Parameters + +##### left + +[`EntityName`](../type-aliases/EntityName.md) + +##### right + +`string` | [`Identifier`](Identifier.md) + +#### Returns + +[`QualifiedName`](QualifiedName.md) + +*** + +### createRegularExpressionLiteral() + +> **createRegularExpressionLiteral**(`text`): [`RegularExpressionLiteral`](RegularExpressionLiteral.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3615 + +#### Parameters + +##### text + +`string` + +#### Returns + +[`RegularExpressionLiteral`](RegularExpressionLiteral.md) + +*** + +### createRestTypeNode() + +> **createRestTypeNode**(`type`): [`RestTypeNode`](RestTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3713 + +#### Parameters + +##### type + +[`TypeNode`](TypeNode.md) + +#### Returns + +[`RestTypeNode`](RestTypeNode.md) + +*** + +### createReturnStatement() + +> **createReturnStatement**(`expression`?): [`ReturnStatement`](ReturnStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3846 + +#### Parameters + +##### expression? + +[`Expression`](Expression.md) + +#### Returns + +[`ReturnStatement`](ReturnStatement.md) + +*** + +### createRightShift() + +> **createRightShift**(`left`, `right`): [`BinaryExpression`](BinaryExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4053 + +#### Parameters + +##### left + +[`Expression`](Expression.md) + +##### right + +[`Expression`](Expression.md) + +#### Returns + +[`BinaryExpression`](BinaryExpression.md) + +*** + +### createSatisfiesExpression() + +> **createSatisfiesExpression**(`expression`, `type`): [`SatisfiesExpression`](SatisfiesExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3818 + +#### Parameters + +##### expression + +[`Expression`](Expression.md) + +##### type + +[`TypeNode`](TypeNode.md) + +#### Returns + +[`SatisfiesExpression`](SatisfiesExpression.md) + +*** + +### createSemicolonClassElement() + +> **createSemicolonClassElement**(): [`SemicolonClassElement`](SemicolonClassElement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3822 + +#### Returns + +[`SemicolonClassElement`](SemicolonClassElement.md) + +*** + +### createSetAccessorDeclaration() + +#### Call Signature + +> **createSetAccessorDeclaration**(`modifiers`, `name`, `parameters`, `body`): [`SetAccessorDeclaration`](SetAccessorDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3680 + +##### Parameters + +###### modifiers + +`undefined` | readonly [`ModifierLike`](../type-aliases/ModifierLike.md)[] + +###### name + +`string` | [`PropertyName`](../type-aliases/PropertyName.md) + +###### parameters + +readonly [`ParameterDeclaration`](ParameterDeclaration.md)[] + +###### body + +`undefined` | [`Block`](Block.md) + +##### Returns + +[`SetAccessorDeclaration`](SetAccessorDeclaration.md) + +#### Call Signature + +> **createSetAccessorDeclaration**(`decorators`, `modifiers`, `name`, `parameters`, `body`): [`SetAccessorDeclaration`](SetAccessorDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8454 + +##### Parameters + +###### decorators + +`undefined` | readonly [`Decorator`](Decorator.md)[] + +###### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +###### name + +`string` | [`PropertyName`](../type-aliases/PropertyName.md) + +###### parameters + +readonly [`ParameterDeclaration`](ParameterDeclaration.md)[] + +###### body + +`undefined` | [`Block`](Block.md) + +##### Returns + +[`SetAccessorDeclaration`](SetAccessorDeclaration.md) + +##### Deprecated + +Decorators have been combined with modifiers. Callers should use an overload that does not accept a `decorators` parameter. + +*** + +### createShorthandPropertyAssignment() + +> **createShorthandPropertyAssignment**(`name`, `objectAssignmentInitializer`?): [`ShorthandPropertyAssignment`](ShorthandPropertyAssignment.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4021 + +#### Parameters + +##### name + +`string` | [`Identifier`](Identifier.md) + +##### objectAssignmentInitializer? + +[`Expression`](Expression.md) + +#### Returns + +[`ShorthandPropertyAssignment`](ShorthandPropertyAssignment.md) + +*** + +### createSourceFile() + +> **createSourceFile**(`statements`, `endOfFileToken`, `flags`): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4027 + +#### Parameters + +##### statements + +readonly [`Statement`](Statement.md)[] + +##### endOfFileToken + +[`EndOfFileToken`](../type-aliases/EndOfFileToken.md) + +##### flags + +[`NodeFlags`](../enumerations/NodeFlags.md) + +#### Returns + +[`SourceFile`](SourceFile.md) + +*** + +### createSpreadAssignment() + +> **createSpreadAssignment**(`expression`): [`SpreadAssignment`](SpreadAssignment.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4023 + +#### Parameters + +##### expression + +[`Expression`](Expression.md) + +#### Returns + +[`SpreadAssignment`](SpreadAssignment.md) + +*** + +### createSpreadElement() + +> **createSpreadElement**(`expression`): [`SpreadElement`](SpreadElement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3803 + +#### Parameters + +##### expression + +[`Expression`](Expression.md) + +#### Returns + +[`SpreadElement`](SpreadElement.md) + +*** + +### createStrictEquality() + +> **createStrictEquality**(`left`, `right`): [`BinaryExpression`](BinaryExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4044 + +#### Parameters + +##### left + +[`Expression`](Expression.md) + +##### right + +[`Expression`](Expression.md) + +#### Returns + +[`BinaryExpression`](BinaryExpression.md) + +*** + +### createStrictInequality() + +> **createStrictInequality**(`left`, `right`): [`BinaryExpression`](BinaryExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4045 + +#### Parameters + +##### left + +[`Expression`](Expression.md) + +##### right + +[`Expression`](Expression.md) + +#### Returns + +[`BinaryExpression`](BinaryExpression.md) + +*** + +### createStringLiteral() + +> **createStringLiteral**(`text`, `isSingleQuote`?): [`StringLiteral`](StringLiteral.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3613 + +#### Parameters + +##### text + +`string` + +##### isSingleQuote? + +`boolean` + +#### Returns + +[`StringLiteral`](StringLiteral.md) + +*** + +### createStringLiteralFromNode() + +> **createStringLiteralFromNode**(`sourceNode`, `isSingleQuote`?): [`StringLiteral`](StringLiteral.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3614 + +#### Parameters + +##### sourceNode + +[`PrivateIdentifier`](PrivateIdentifier.md) | [`PropertyNameLiteral`](../type-aliases/PropertyNameLiteral.md) + +##### isSingleQuote? + +`boolean` + +#### Returns + +[`StringLiteral`](StringLiteral.md) + +*** + +### createStructDeclaration() + +> **createStructDeclaration**(`modifiers`, `name`, `typeParameters`, `heritageClauses`, `members`): [`StructDeclaration`](StructDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3867 + +#### Parameters + +##### modifiers + +`undefined` | readonly [`ModifierLike`](../type-aliases/ModifierLike.md)[] + +##### name + +`undefined` | `string` | [`Identifier`](Identifier.md) + +##### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](TypeParameterDeclaration.md)[] + +##### heritageClauses + +`undefined` | readonly [`HeritageClause`](HeritageClause.md)[] + +##### members + +readonly [`ClassElement`](ClassElement.md)[] + +#### Returns + +[`StructDeclaration`](StructDeclaration.md) + +*** + +### createSubtract() + +> **createSubtract**(`left`, `right`): [`BinaryExpression`](BinaryExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4056 + +#### Parameters + +##### left + +[`Expression`](Expression.md) + +##### right + +[`Expression`](Expression.md) + +#### Returns + +[`BinaryExpression`](BinaryExpression.md) + +*** + +### createSuper() + +> **createSuper**(): [`SuperExpression`](SuperExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3651 + +#### Returns + +[`SuperExpression`](SuperExpression.md) + +*** + +### createSwitchStatement() + +> **createSwitchStatement**(`expression`, `caseBlock`): [`SwitchStatement`](SwitchStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3850 + +#### Parameters + +##### expression + +[`Expression`](Expression.md) + +##### caseBlock + +[`CaseBlock`](CaseBlock.md) + +#### Returns + +[`SwitchStatement`](SwitchStatement.md) + +*** + +### createTaggedTemplateExpression() + +> **createTaggedTemplateExpression**(`tag`, `typeArguments`, `template`): [`TaggedTemplateExpression`](TaggedTemplateExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3762 + +#### Parameters + +##### tag + +[`Expression`](Expression.md) + +##### typeArguments + +`undefined` | readonly [`TypeNode`](TypeNode.md)[] + +##### template + +[`TemplateLiteral`](../type-aliases/TemplateLiteral.md) + +#### Returns + +[`TaggedTemplateExpression`](TaggedTemplateExpression.md) + +*** + +### createTemplateExpression() + +> **createTemplateExpression**(`head`, `templateSpans`): [`TemplateExpression`](TemplateExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3790 + +#### Parameters + +##### head + +[`TemplateHead`](TemplateHead.md) + +##### templateSpans + +readonly [`TemplateSpan`](TemplateSpan.md)[] + +#### Returns + +[`TemplateExpression`](TemplateExpression.md) + +*** + +### createTemplateHead() + +#### Call Signature + +> **createTemplateHead**(`text`, `rawText`?, `templateFlags`?): [`TemplateHead`](TemplateHead.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3792 + +##### Parameters + +###### text + +`string` + +###### rawText? + +`string` + +###### templateFlags? + +[`TokenFlags`](../enumerations/TokenFlags.md) + +##### Returns + +[`TemplateHead`](TemplateHead.md) + +#### Call Signature + +> **createTemplateHead**(`text`, `rawText`, `templateFlags`?): [`TemplateHead`](TemplateHead.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3793 + +##### Parameters + +###### text + +`undefined` | `string` + +###### rawText + +`string` + +###### templateFlags? + +[`TokenFlags`](../enumerations/TokenFlags.md) + +##### Returns + +[`TemplateHead`](TemplateHead.md) + +*** + +### createTemplateLiteralType() + +> **createTemplateLiteralType**(`head`, `templateSpans`): [`TemplateLiteralTypeNode`](TemplateLiteralTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3736 + +#### Parameters + +##### head + +[`TemplateHead`](TemplateHead.md) + +##### templateSpans + +readonly [`TemplateLiteralTypeSpan`](TemplateLiteralTypeSpan.md)[] + +#### Returns + +[`TemplateLiteralTypeNode`](TemplateLiteralTypeNode.md) + +*** + +### createTemplateLiteralTypeSpan() + +> **createTemplateLiteralTypeSpan**(`type`, `literal`): [`TemplateLiteralTypeSpan`](TemplateLiteralTypeSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3688 + +#### Parameters + +##### type + +[`TypeNode`](TypeNode.md) + +##### literal + +[`TemplateMiddle`](TemplateMiddle.md) | [`TemplateTail`](TemplateTail.md) + +#### Returns + +[`TemplateLiteralTypeSpan`](TemplateLiteralTypeSpan.md) + +*** + +### createTemplateMiddle() + +#### Call Signature + +> **createTemplateMiddle**(`text`, `rawText`?, `templateFlags`?): [`TemplateMiddle`](TemplateMiddle.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3794 + +##### Parameters + +###### text + +`string` + +###### rawText? + +`string` + +###### templateFlags? + +[`TokenFlags`](../enumerations/TokenFlags.md) + +##### Returns + +[`TemplateMiddle`](TemplateMiddle.md) + +#### Call Signature + +> **createTemplateMiddle**(`text`, `rawText`, `templateFlags`?): [`TemplateMiddle`](TemplateMiddle.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3795 + +##### Parameters + +###### text + +`undefined` | `string` + +###### rawText + +`string` + +###### templateFlags? + +[`TokenFlags`](../enumerations/TokenFlags.md) + +##### Returns + +[`TemplateMiddle`](TemplateMiddle.md) + +*** + +### createTemplateSpan() + +> **createTemplateSpan**(`expression`, `literal`): [`TemplateSpan`](TemplateSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3820 + +#### Parameters + +##### expression + +[`Expression`](Expression.md) + +##### literal + +[`TemplateMiddle`](TemplateMiddle.md) | [`TemplateTail`](TemplateTail.md) + +#### Returns + +[`TemplateSpan`](TemplateSpan.md) + +*** + +### createTemplateTail() + +#### Call Signature + +> **createTemplateTail**(`text`, `rawText`?, `templateFlags`?): [`TemplateTail`](TemplateTail.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3796 + +##### Parameters + +###### text + +`string` + +###### rawText? + +`string` + +###### templateFlags? + +[`TokenFlags`](../enumerations/TokenFlags.md) + +##### Returns + +[`TemplateTail`](TemplateTail.md) + +#### Call Signature + +> **createTemplateTail**(`text`, `rawText`, `templateFlags`?): [`TemplateTail`](TemplateTail.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3797 + +##### Parameters + +###### text + +`undefined` | `string` + +###### rawText + +`string` + +###### templateFlags? + +[`TokenFlags`](../enumerations/TokenFlags.md) + +##### Returns + +[`TemplateTail`](TemplateTail.md) + +*** + +### createTempVariable() + +> **createTempVariable**(`recordTempVariable`, `reservedInNestedScopes`?): [`Identifier`](Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3626 + +Create a unique temporary variable. + +#### Parameters + +##### recordTempVariable + +An optional callback used to record the temporary variable name. This +should usually be a reference to `hoistVariableDeclaration` from a `TransformationContext`, but +can be `undefined` if you plan to record the temporary variable manually. + +`undefined` | (`node`) => `void` + +##### reservedInNestedScopes? + +`boolean` + +When `true`, reserves the temporary variable name in all nested scopes +during emit so that the variable can be referenced in a nested function body. This is an alternative to +setting `EmitFlags.ReuseTempVariableScope` on the nested function itself. + +#### Returns + +[`Identifier`](Identifier.md) + +*** + +### createThis() + +> **createThis**(): [`ThisExpression`](ThisExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3652 + +#### Returns + +[`ThisExpression`](ThisExpression.md) + +*** + +### createThisTypeNode() + +> **createThisTypeNode**(): [`ThisTypeNode`](ThisTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3727 + +#### Returns + +[`ThisTypeNode`](ThisTypeNode.md) + +*** + +### createThrowStatement() + +> **createThrowStatement**(`expression`): [`ThrowStatement`](ThrowStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3854 + +#### Parameters + +##### expression + +[`Expression`](Expression.md) + +#### Returns + +[`ThrowStatement`](ThrowStatement.md) + +*** + +### createToken() + +#### Call Signature + +> **createToken**(`token`): [`SuperExpression`](SuperExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3641 + +##### Parameters + +###### token + +[`SuperKeyword`](../enumerations/SyntaxKind.md#superkeyword) + +##### Returns + +[`SuperExpression`](SuperExpression.md) + +#### Call Signature + +> **createToken**(`token`): [`ThisExpression`](ThisExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3642 + +##### Parameters + +###### token + +[`ThisKeyword`](../enumerations/SyntaxKind.md#thiskeyword) + +##### Returns + +[`ThisExpression`](ThisExpression.md) + +#### Call Signature + +> **createToken**(`token`): [`NullLiteral`](NullLiteral.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3643 + +##### Parameters + +###### token + +[`NullKeyword`](../enumerations/SyntaxKind.md#nullkeyword) + +##### Returns + +[`NullLiteral`](NullLiteral.md) + +#### Call Signature + +> **createToken**(`token`): [`TrueLiteral`](TrueLiteral.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3644 + +##### Parameters + +###### token + +[`TrueKeyword`](../enumerations/SyntaxKind.md#truekeyword) + +##### Returns + +[`TrueLiteral`](TrueLiteral.md) + +#### Call Signature + +> **createToken**(`token`): [`FalseLiteral`](FalseLiteral.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3645 + +##### Parameters + +###### token + +[`FalseKeyword`](../enumerations/SyntaxKind.md#falsekeyword) + +##### Returns + +[`FalseLiteral`](FalseLiteral.md) + +#### Call Signature + +> **createToken**\<`TKind`\>(`token`): [`PunctuationToken`](PunctuationToken.md)\<`TKind`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3646 + +##### Type Parameters + +• **TKind** *extends* [`PunctuationSyntaxKind`](../type-aliases/PunctuationSyntaxKind.md) + +##### Parameters + +###### token + +`TKind` + +##### Returns + +[`PunctuationToken`](PunctuationToken.md)\<`TKind`\> + +#### Call Signature + +> **createToken**\<`TKind`\>(`token`): [`KeywordTypeNode`](KeywordTypeNode.md)\<`TKind`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3647 + +##### Type Parameters + +• **TKind** *extends* [`KeywordTypeSyntaxKind`](../type-aliases/KeywordTypeSyntaxKind.md) + +##### Parameters + +###### token + +`TKind` + +##### Returns + +[`KeywordTypeNode`](KeywordTypeNode.md)\<`TKind`\> + +#### Call Signature + +> **createToken**\<`TKind`\>(`token`): [`ModifierToken`](ModifierToken.md)\<`TKind`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3648 + +##### Type Parameters + +• **TKind** *extends* [`ModifierSyntaxKind`](../type-aliases/ModifierSyntaxKind.md) + +##### Parameters + +###### token + +`TKind` + +##### Returns + +[`ModifierToken`](ModifierToken.md)\<`TKind`\> + +#### Call Signature + +> **createToken**\<`TKind`\>(`token`): [`KeywordToken`](KeywordToken.md)\<`TKind`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3649 + +##### Type Parameters + +• **TKind** *extends* [`KeywordSyntaxKind`](../type-aliases/KeywordSyntaxKind.md) + +##### Parameters + +###### token + +`TKind` + +##### Returns + +[`KeywordToken`](KeywordToken.md)\<`TKind`\> + +#### Call Signature + +> **createToken**\<`TKind`\>(`token`): [`Token`](Token.md)\<`TKind`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3650 + +##### Type Parameters + +• **TKind** *extends* [`Unknown`](../enumerations/SyntaxKind.md#unknown) \| [`EndOfFileToken`](../enumerations/SyntaxKind.md#endoffiletoken) + +##### Parameters + +###### token + +`TKind` + +##### Returns + +[`Token`](Token.md)\<`TKind`\> + +*** + +### createTrue() + +> **createTrue**(): [`TrueLiteral`](TrueLiteral.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3654 + +#### Returns + +[`TrueLiteral`](TrueLiteral.md) + +*** + +### createTryStatement() + +> **createTryStatement**(`tryBlock`, `catchClause`, `finallyBlock`): [`TryStatement`](TryStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3856 + +#### Parameters + +##### tryBlock + +[`Block`](Block.md) + +##### catchClause + +`undefined` | [`CatchClause`](CatchClause.md) + +##### finallyBlock + +`undefined` | [`Block`](Block.md) + +#### Returns + +[`TryStatement`](TryStatement.md) + +*** + +### createTupleTypeNode() + +> **createTupleTypeNode**(`elements`): [`TupleTypeNode`](TupleTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3707 + +#### Parameters + +##### elements + +readonly ([`TypeNode`](TypeNode.md) \| [`NamedTupleMember`](NamedTupleMember.md))[] + +#### Returns + +[`TupleTypeNode`](TupleTypeNode.md) + +*** + +### createTypeAliasDeclaration() + +#### Call Signature + +> **createTypeAliasDeclaration**(`modifiers`, `name`, `typeParameters`, `type`): [`TypeAliasDeclaration`](TypeAliasDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3871 + +##### Parameters + +###### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +###### name + +`string` | [`Identifier`](Identifier.md) + +###### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](TypeParameterDeclaration.md)[] + +###### type + +[`TypeNode`](TypeNode.md) + +##### Returns + +[`TypeAliasDeclaration`](TypeAliasDeclaration.md) + +#### Call Signature + +> **createTypeAliasDeclaration**(`decorators`, `modifiers`, `name`, `typeParameters`, `type`): [`TypeAliasDeclaration`](TypeAliasDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8510 + +##### Parameters + +###### decorators + +`undefined` | readonly [`Decorator`](Decorator.md)[] + +###### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +###### name + +`string` | [`Identifier`](Identifier.md) + +###### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](TypeParameterDeclaration.md)[] + +###### type + +[`TypeNode`](TypeNode.md) + +##### Returns + +[`TypeAliasDeclaration`](TypeAliasDeclaration.md) + +##### Deprecated + +Decorators are no longer supported for this function. Callers should use an overload that does not accept a `decorators` parameter. + +*** + +### createTypeAssertion() + +> **createTypeAssertion**(`type`, `expression`): [`TypeAssertion`](TypeAssertion.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3764 + +#### Parameters + +##### type + +[`TypeNode`](TypeNode.md) + +##### expression + +[`Expression`](Expression.md) + +#### Returns + +[`TypeAssertion`](TypeAssertion.md) + +*** + +### createTypeLiteralNode() + +> **createTypeLiteralNode**(`members`): [`TypeLiteralNode`](TypeLiteralNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3703 + +#### Parameters + +##### members + +`undefined` | readonly [`TypeElement`](TypeElement.md)[] + +#### Returns + +[`TypeLiteralNode`](TypeLiteralNode.md) + +*** + +### createTypeOfExpression() + +> **createTypeOfExpression**(`expression`): [`TypeOfExpression`](TypeOfExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3776 + +#### Parameters + +##### expression + +[`Expression`](Expression.md) + +#### Returns + +[`TypeOfExpression`](TypeOfExpression.md) + +*** + +### createTypeOperatorNode() + +> **createTypeOperatorNode**(`operator`, `type`): [`TypeOperatorNode`](TypeOperatorNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3728 + +#### Parameters + +##### operator + +[`KeyOfKeyword`](../enumerations/SyntaxKind.md#keyofkeyword) | [`ReadonlyKeyword`](../enumerations/SyntaxKind.md#readonlykeyword) | [`UniqueKeyword`](../enumerations/SyntaxKind.md#uniquekeyword) + +##### type + +[`TypeNode`](TypeNode.md) + +#### Returns + +[`TypeOperatorNode`](TypeOperatorNode.md) + +*** + +### createTypeParameterDeclaration() + +#### Call Signature + +> **createTypeParameterDeclaration**(`modifiers`, `name`, `constraint`?, `defaultType`?): [`TypeParameterDeclaration`](TypeParameterDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3662 + +##### Parameters + +###### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +###### name + +`string` | [`Identifier`](Identifier.md) + +###### constraint? + +[`TypeNode`](TypeNode.md) + +###### defaultType? + +[`TypeNode`](TypeNode.md) + +##### Returns + +[`TypeParameterDeclaration`](TypeParameterDeclaration.md) + +#### Call Signature + +> **createTypeParameterDeclaration**(`name`, `constraint`?, `defaultType`?): [`TypeParameterDeclaration`](TypeParameterDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8358 + +##### Parameters + +###### name + +`string` | [`Identifier`](Identifier.md) + +###### constraint? + +[`TypeNode`](TypeNode.md) + +###### defaultType? + +[`TypeNode`](TypeNode.md) + +##### Returns + +[`TypeParameterDeclaration`](TypeParameterDeclaration.md) + +##### Deprecated + +Use the overload that accepts 'modifiers' + +*** + +### createTypePredicateNode() + +> **createTypePredicateNode**(`assertsModifier`, `parameterName`, `type`): [`TypePredicateNode`](TypePredicateNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3693 + +#### Parameters + +##### assertsModifier + +`undefined` | [`AssertsKeyword`](../type-aliases/AssertsKeyword.md) + +##### parameterName + +`string` | [`Identifier`](Identifier.md) | [`ThisTypeNode`](ThisTypeNode.md) + +##### type + +`undefined` | [`TypeNode`](TypeNode.md) + +#### Returns + +[`TypePredicateNode`](TypePredicateNode.md) + +*** + +### createTypeQueryNode() + +> **createTypeQueryNode**(`exprName`, `typeArguments`?): [`TypeQueryNode`](TypeQueryNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3701 + +#### Parameters + +##### exprName + +[`EntityName`](../type-aliases/EntityName.md) + +##### typeArguments? + +readonly [`TypeNode`](TypeNode.md)[] + +#### Returns + +[`TypeQueryNode`](TypeQueryNode.md) + +*** + +### createTypeReferenceNode() + +> **createTypeReferenceNode**(`typeName`, `typeArguments`?): [`TypeReferenceNode`](TypeReferenceNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3695 + +#### Parameters + +##### typeName + +`string` | [`EntityName`](../type-aliases/EntityName.md) + +##### typeArguments? + +readonly [`TypeNode`](TypeNode.md)[] + +#### Returns + +[`TypeReferenceNode`](TypeReferenceNode.md) + +*** + +### createUnionTypeNode() + +> **createUnionTypeNode**(`types`): [`UnionTypeNode`](UnionTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3715 + +#### Parameters + +##### types + +readonly [`TypeNode`](TypeNode.md)[] + +#### Returns + +[`UnionTypeNode`](UnionTypeNode.md) + +*** + +### createUniqueName() + +> **createUniqueName**(`text`, `flags`?): [`Identifier`](Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3635 + +Create a unique name based on the supplied text. + +#### Parameters + +##### text + +`string` + +##### flags? + +[`GeneratedIdentifierFlags`](../enumerations/GeneratedIdentifierFlags.md) + +#### Returns + +[`Identifier`](Identifier.md) + +*** + +### createUniquePrivateName() + +> **createUniquePrivateName**(`text`?): [`PrivateIdentifier`](PrivateIdentifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3639 + +#### Parameters + +##### text? + +`string` + +#### Returns + +[`PrivateIdentifier`](PrivateIdentifier.md) + +*** + +### createUnsignedRightShift() + +> **createUnsignedRightShift**(`left`, `right`): [`BinaryExpression`](BinaryExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4054 + +#### Parameters + +##### left + +[`Expression`](Expression.md) + +##### right + +[`Expression`](Expression.md) + +#### Returns + +[`BinaryExpression`](BinaryExpression.md) + +*** + +### createVariableDeclaration() + +> **createVariableDeclaration**(`name`, `exclamationToken`?, `type`?, `initializer`?): [`VariableDeclaration`](VariableDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3859 + +#### Parameters + +##### name + +`string` | [`BindingName`](../type-aliases/BindingName.md) + +##### exclamationToken? + +[`ExclamationToken`](../type-aliases/ExclamationToken.md) + +##### type? + +[`TypeNode`](TypeNode.md) + +##### initializer? + +[`Expression`](Expression.md) + +#### Returns + +[`VariableDeclaration`](VariableDeclaration.md) + +*** + +### createVariableDeclarationList() + +> **createVariableDeclarationList**(`declarations`, `flags`?): [`VariableDeclarationList`](VariableDeclarationList.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3861 + +#### Parameters + +##### declarations + +readonly [`VariableDeclaration`](VariableDeclaration.md)[] + +##### flags? + +[`NodeFlags`](../enumerations/NodeFlags.md) + +#### Returns + +[`VariableDeclarationList`](VariableDeclarationList.md) + +*** + +### createVariableStatement() + +> **createVariableStatement**(`modifiers`, `declarationList`): [`VariableStatement`](VariableStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3825 + +#### Parameters + +##### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +##### declarationList + +[`VariableDeclarationList`](VariableDeclarationList.md) | readonly [`VariableDeclaration`](VariableDeclaration.md)[] + +#### Returns + +[`VariableStatement`](VariableStatement.md) + +*** + +### createVoidExpression() + +> **createVoidExpression**(`expression`): [`VoidExpression`](VoidExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3778 + +#### Parameters + +##### expression + +[`Expression`](Expression.md) + +#### Returns + +[`VoidExpression`](VoidExpression.md) + +*** + +### createVoidZero() + +> **createVoidZero**(): [`VoidExpression`](VoidExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4073 + +#### Returns + +[`VoidExpression`](VoidExpression.md) + +*** + +### createWhileStatement() + +> **createWhileStatement**(`expression`, `statement`): [`WhileStatement`](WhileStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3834 + +#### Parameters + +##### expression + +[`Expression`](Expression.md) + +##### statement + +[`Statement`](Statement.md) + +#### Returns + +[`WhileStatement`](WhileStatement.md) + +*** + +### createWithStatement() + +> **createWithStatement**(`expression`, `statement`): [`WithStatement`](WithStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3848 + +#### Parameters + +##### expression + +[`Expression`](Expression.md) + +##### statement + +[`Statement`](Statement.md) + +#### Returns + +[`WithStatement`](WithStatement.md) + +*** + +### createYieldExpression() + +#### Call Signature + +> **createYieldExpression**(`asteriskToken`, `expression`): [`YieldExpression`](YieldExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3800 + +##### Parameters + +###### asteriskToken + +[`AsteriskToken`](../type-aliases/AsteriskToken.md) + +###### expression + +[`Expression`](Expression.md) + +##### Returns + +[`YieldExpression`](YieldExpression.md) + +#### Call Signature + +> **createYieldExpression**(`asteriskToken`, `expression`): [`YieldExpression`](YieldExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3801 + +##### Parameters + +###### asteriskToken + +`undefined` + +###### expression + +`undefined` | [`Expression`](Expression.md) + +##### Returns + +[`YieldExpression`](YieldExpression.md) + +*** + +### getGeneratedNameForNode() + +> **getGeneratedNameForNode**(`node`, `flags`?): [`Identifier`](Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3637 + +Create a unique name generated for a node. + +#### Parameters + +##### node + +`undefined` | [`Node`](Node.md) + +##### flags? + +[`GeneratedIdentifierFlags`](../enumerations/GeneratedIdentifierFlags.md) + +#### Returns + +[`Identifier`](Identifier.md) + +*** + +### getGeneratedPrivateNameForNode() + +> **getGeneratedPrivateNameForNode**(`node`): [`PrivateIdentifier`](PrivateIdentifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3640 + +#### Parameters + +##### node + +[`Node`](Node.md) + +#### Returns + +[`PrivateIdentifier`](PrivateIdentifier.md) + +*** + +### restoreOuterExpressions() + +> **restoreOuterExpressions**(`outerExpression`, `innerExpression`, `kinds`?): [`Expression`](Expression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4076 + +#### Parameters + +##### outerExpression + +`undefined` | [`Expression`](Expression.md) + +##### innerExpression + +[`Expression`](Expression.md) + +##### kinds? + +[`OuterExpressionKinds`](../enumerations/OuterExpressionKinds.md) + +#### Returns + +[`Expression`](Expression.md) + +*** + +### updateArrayBindingPattern() + +> **updateArrayBindingPattern**(`node`, `elements`): [`ArrayBindingPattern`](ArrayBindingPattern.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3741 + +#### Parameters + +##### node + +[`ArrayBindingPattern`](ArrayBindingPattern.md) + +##### elements + +readonly [`ArrayBindingElement`](../type-aliases/ArrayBindingElement.md)[] + +#### Returns + +[`ArrayBindingPattern`](ArrayBindingPattern.md) + +*** + +### updateArrayLiteralExpression() + +> **updateArrayLiteralExpression**(`node`, `elements`): [`ArrayLiteralExpression`](ArrayLiteralExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3745 + +#### Parameters + +##### node + +[`ArrayLiteralExpression`](ArrayLiteralExpression.md) + +##### elements + +readonly [`Expression`](Expression.md)[] + +#### Returns + +[`ArrayLiteralExpression`](ArrayLiteralExpression.md) + +*** + +### updateArrayTypeNode() + +> **updateArrayTypeNode**(`node`, `elementType`): [`ArrayTypeNode`](ArrayTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3706 + +#### Parameters + +##### node + +[`ArrayTypeNode`](ArrayTypeNode.md) + +##### elementType + +[`TypeNode`](TypeNode.md) + +#### Returns + +[`ArrayTypeNode`](ArrayTypeNode.md) + +*** + +### updateArrowFunction() + +> **updateArrowFunction**(`node`, `modifiers`, `typeParameters`, `parameters`, `type`, `equalsGreaterThanToken`, `body`): [`ArrowFunction`](ArrowFunction.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3771 + +#### Parameters + +##### node + +[`ArrowFunction`](ArrowFunction.md) + +##### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +##### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](TypeParameterDeclaration.md)[] + +##### parameters + +readonly [`ParameterDeclaration`](ParameterDeclaration.md)[] + +##### type + +`undefined` | [`TypeNode`](TypeNode.md) + +##### equalsGreaterThanToken + +[`EqualsGreaterThanToken`](../type-aliases/EqualsGreaterThanToken.md) + +##### body + +[`ConciseBody`](../type-aliases/ConciseBody.md) + +#### Returns + +[`ArrowFunction`](ArrowFunction.md) + +*** + +### updateAsExpression() + +> **updateAsExpression**(`node`, `expression`, `type`): [`AsExpression`](AsExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3811 + +#### Parameters + +##### node + +[`AsExpression`](AsExpression.md) + +##### expression + +[`Expression`](Expression.md) + +##### type + +[`TypeNode`](TypeNode.md) + +#### Returns + +[`AsExpression`](AsExpression.md) + +*** + +### updateAssertClause() + +> **updateAssertClause**(`node`, `elements`, `multiLine`?): [`AssertClause`](AssertClause.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3890 + +#### Parameters + +##### node + +[`AssertClause`](AssertClause.md) + +##### elements + +[`NodeArray`](NodeArray.md)\<[`AssertEntry`](AssertEntry.md)\> + +##### multiLine? + +`boolean` + +#### Returns + +[`AssertClause`](AssertClause.md) + +*** + +### updateAssertEntry() + +> **updateAssertEntry**(`node`, `name`, `value`): [`AssertEntry`](AssertEntry.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3892 + +#### Parameters + +##### node + +[`AssertEntry`](AssertEntry.md) + +##### name + +[`AssertionKey`](../type-aliases/AssertionKey.md) + +##### value + +[`Expression`](Expression.md) + +#### Returns + +[`AssertEntry`](AssertEntry.md) + +*** + +### updateAwaitExpression() + +> **updateAwaitExpression**(`node`, `expression`): [`AwaitExpression`](AwaitExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3781 + +#### Parameters + +##### node + +[`AwaitExpression`](AwaitExpression.md) + +##### expression + +[`Expression`](Expression.md) + +#### Returns + +[`AwaitExpression`](AwaitExpression.md) + +*** + +### updateBinaryExpression() + +> **updateBinaryExpression**(`node`, `left`, `operator`, `right`): [`BinaryExpression`](BinaryExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3787 + +#### Parameters + +##### node + +[`BinaryExpression`](BinaryExpression.md) + +##### left + +[`Expression`](Expression.md) + +##### operator + +[`BinaryOperatorToken`](../type-aliases/BinaryOperatorToken.md) | [`BinaryOperator`](../type-aliases/BinaryOperator.md) + +##### right + +[`Expression`](Expression.md) + +#### Returns + +[`BinaryExpression`](BinaryExpression.md) + +*** + +### updateBindingElement() + +> **updateBindingElement**(`node`, `dotDotDotToken`, `propertyName`, `name`, `initializer`): [`BindingElement`](BindingElement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3743 + +#### Parameters + +##### node + +[`BindingElement`](BindingElement.md) + +##### dotDotDotToken + +`undefined` | [`DotDotDotToken`](../type-aliases/DotDotDotToken.md) + +##### propertyName + +`undefined` | [`PropertyName`](../type-aliases/PropertyName.md) + +##### name + +[`BindingName`](../type-aliases/BindingName.md) + +##### initializer + +`undefined` | [`Expression`](Expression.md) + +#### Returns + +[`BindingElement`](BindingElement.md) + +*** + +### updateBlock() + +> **updateBlock**(`node`, `statements`): [`Block`](Block.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3824 + +#### Parameters + +##### node + +[`Block`](Block.md) + +##### statements + +readonly [`Statement`](Statement.md)[] + +#### Returns + +[`Block`](Block.md) + +*** + +### updateBreakStatement() + +> **updateBreakStatement**(`node`, `label`): [`BreakStatement`](BreakStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3845 + +#### Parameters + +##### node + +[`BreakStatement`](BreakStatement.md) + +##### label + +`undefined` | [`Identifier`](Identifier.md) + +#### Returns + +[`BreakStatement`](BreakStatement.md) + +*** + +### updateBundle() + +> **updateBundle**(`node`, `sourceFiles`, `prepends`?): [`Bundle`](Bundle.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4035 + +#### Parameters + +##### node + +[`Bundle`](Bundle.md) + +##### sourceFiles + +readonly [`SourceFile`](SourceFile.md)[] + +##### prepends? + +readonly ([`InputFiles`](InputFiles.md) \| [`UnparsedSource`](UnparsedSource.md))[] + +#### Returns + +[`Bundle`](Bundle.md) + +*** + +### updateCallChain() + +> **updateCallChain**(`node`, `expression`, `questionDotToken`, `typeArguments`, `argumentsArray`): [`CallChain`](CallChain.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3759 + +#### Parameters + +##### node + +[`CallChain`](CallChain.md) + +##### expression + +[`Expression`](Expression.md) + +##### questionDotToken + +`undefined` | [`QuestionDotToken`](../type-aliases/QuestionDotToken.md) + +##### typeArguments + +`undefined` | readonly [`TypeNode`](TypeNode.md)[] + +##### argumentsArray + +readonly [`Expression`](Expression.md)[] + +#### Returns + +[`CallChain`](CallChain.md) + +*** + +### updateCallExpression() + +> **updateCallExpression**(`node`, `expression`, `typeArguments`, `argumentsArray`): [`CallExpression`](CallExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3757 + +#### Parameters + +##### node + +[`CallExpression`](CallExpression.md) + +##### expression + +[`Expression`](Expression.md) + +##### typeArguments + +`undefined` | readonly [`TypeNode`](TypeNode.md)[] + +##### argumentsArray + +readonly [`Expression`](Expression.md)[] + +#### Returns + +[`CallExpression`](CallExpression.md) + +*** + +### updateCallSignature() + +> **updateCallSignature**(`node`, `typeParameters`, `parameters`, `type`): [`CallSignatureDeclaration`](CallSignatureDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3683 + +#### Parameters + +##### node + +[`CallSignatureDeclaration`](CallSignatureDeclaration.md) + +##### typeParameters + +`undefined` | [`NodeArray`](NodeArray.md)\<[`TypeParameterDeclaration`](TypeParameterDeclaration.md)\> + +##### parameters + +[`NodeArray`](NodeArray.md)\<[`ParameterDeclaration`](ParameterDeclaration.md)\> + +##### type + +`undefined` | [`TypeNode`](TypeNode.md) + +#### Returns + +[`CallSignatureDeclaration`](CallSignatureDeclaration.md) + +*** + +### updateCaseBlock() + +> **updateCaseBlock**(`node`, `clauses`): [`CaseBlock`](CaseBlock.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3880 + +#### Parameters + +##### node + +[`CaseBlock`](CaseBlock.md) + +##### clauses + +readonly [`CaseOrDefaultClause`](../type-aliases/CaseOrDefaultClause.md)[] + +#### Returns + +[`CaseBlock`](CaseBlock.md) + +*** + +### updateCaseClause() + +> **updateCaseClause**(`node`, `expression`, `statements`): [`CaseClause`](CaseClause.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4012 + +#### Parameters + +##### node + +[`CaseClause`](CaseClause.md) + +##### expression + +[`Expression`](Expression.md) + +##### statements + +readonly [`Statement`](Statement.md)[] + +#### Returns + +[`CaseClause`](CaseClause.md) + +*** + +### updateCatchClause() + +> **updateCatchClause**(`node`, `variableDeclaration`, `block`): [`CatchClause`](CatchClause.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4018 + +#### Parameters + +##### node + +[`CatchClause`](CatchClause.md) + +##### variableDeclaration + +`undefined` | [`VariableDeclaration`](VariableDeclaration.md) + +##### block + +[`Block`](Block.md) + +#### Returns + +[`CatchClause`](CatchClause.md) + +*** + +### updateClassDeclaration() + +#### Call Signature + +> **updateClassDeclaration**(`node`, `modifiers`, `name`, `typeParameters`, `heritageClauses`, `members`): [`ClassDeclaration`](ClassDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3866 + +##### Parameters + +###### node + +[`ClassDeclaration`](ClassDeclaration.md) + +###### modifiers + +`undefined` | readonly [`ModifierLike`](../type-aliases/ModifierLike.md)[] + +###### name + +`undefined` | [`Identifier`](Identifier.md) + +###### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](TypeParameterDeclaration.md)[] + +###### heritageClauses + +`undefined` | readonly [`HeritageClause`](HeritageClause.md)[] + +###### members + +readonly [`ClassElement`](ClassElement.md)[] + +##### Returns + +[`ClassDeclaration`](ClassDeclaration.md) + +#### Call Signature + +> **updateClassDeclaration**(`node`, `decorators`, `modifiers`, `name`, `typeParameters`, `heritageClauses`, `members`): [`ClassDeclaration`](ClassDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8498 + +##### Parameters + +###### node + +[`ClassDeclaration`](ClassDeclaration.md) + +###### decorators + +`undefined` | readonly [`Decorator`](Decorator.md)[] + +###### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +###### name + +`undefined` | [`Identifier`](Identifier.md) + +###### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](TypeParameterDeclaration.md)[] + +###### heritageClauses + +`undefined` | readonly [`HeritageClause`](HeritageClause.md)[] + +###### members + +readonly [`ClassElement`](ClassElement.md)[] + +##### Returns + +[`ClassDeclaration`](ClassDeclaration.md) + +##### Deprecated + +Decorators have been combined with modifiers. Callers should use an overload that does not accept a `decorators` parameter. + +*** + +### updateClassExpression() + +#### Call Signature + +> **updateClassExpression**(`node`, `modifiers`, `name`, `typeParameters`, `heritageClauses`, `members`): [`ClassExpression`](ClassExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3806 + +##### Parameters + +###### node + +[`ClassExpression`](ClassExpression.md) + +###### modifiers + +`undefined` | readonly [`ModifierLike`](../type-aliases/ModifierLike.md)[] + +###### name + +`undefined` | [`Identifier`](Identifier.md) + +###### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](TypeParameterDeclaration.md)[] + +###### heritageClauses + +`undefined` | readonly [`HeritageClause`](HeritageClause.md)[] + +###### members + +readonly [`ClassElement`](ClassElement.md)[] + +##### Returns + +[`ClassExpression`](ClassExpression.md) + +#### Call Signature + +> **updateClassExpression**(`node`, `decorators`, `modifiers`, `name`, `typeParameters`, `heritageClauses`, `members`): [`ClassExpression`](ClassExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8482 + +##### Parameters + +###### node + +[`ClassExpression`](ClassExpression.md) + +###### decorators + +`undefined` | readonly [`Decorator`](Decorator.md)[] + +###### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +###### name + +`undefined` | [`Identifier`](Identifier.md) + +###### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](TypeParameterDeclaration.md)[] + +###### heritageClauses + +`undefined` | readonly [`HeritageClause`](HeritageClause.md)[] + +###### members + +readonly [`ClassElement`](ClassElement.md)[] + +##### Returns + +[`ClassExpression`](ClassExpression.md) + +##### Deprecated + +Decorators have been combined with modifiers. Callers should use an overload that does not accept a `decorators` parameter. + +*** + +### updateClassStaticBlockDeclaration() + +#### Call Signature + +> **updateClassStaticBlockDeclaration**(`node`, `body`): [`ClassStaticBlockDeclaration`](ClassStaticBlockDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3691 + +##### Parameters + +###### node + +[`ClassStaticBlockDeclaration`](ClassStaticBlockDeclaration.md) + +###### body + +[`Block`](Block.md) + +##### Returns + +[`ClassStaticBlockDeclaration`](ClassStaticBlockDeclaration.md) + +#### Call Signature + +> **updateClassStaticBlockDeclaration**(`node`, `decorators`, `modifiers`, `body`): [`ClassStaticBlockDeclaration`](ClassStaticBlockDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8474 + +##### Parameters + +###### node + +[`ClassStaticBlockDeclaration`](ClassStaticBlockDeclaration.md) + +###### decorators + +`undefined` | readonly [`Decorator`](Decorator.md)[] + +###### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +###### body + +[`Block`](Block.md) + +##### Returns + +[`ClassStaticBlockDeclaration`](ClassStaticBlockDeclaration.md) + +##### Deprecated + +Decorators are no longer supported for this function. Callers should use an overload that does not accept a `decorators` parameter. + +*** + +### updateCommaListExpression() + +> **updateCommaListExpression**(`node`, `elements`): [`CommaListExpression`](CommaListExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4033 + +#### Parameters + +##### node + +[`CommaListExpression`](CommaListExpression.md) + +##### elements + +readonly [`Expression`](Expression.md)[] + +#### Returns + +[`CommaListExpression`](CommaListExpression.md) + +*** + +### updateComputedPropertyName() + +> **updateComputedPropertyName**(`node`, `expression`): [`ComputedPropertyName`](ComputedPropertyName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3661 + +#### Parameters + +##### node + +[`ComputedPropertyName`](ComputedPropertyName.md) + +##### expression + +[`Expression`](Expression.md) + +#### Returns + +[`ComputedPropertyName`](ComputedPropertyName.md) + +*** + +### updateConditionalExpression() + +> **updateConditionalExpression**(`node`, `condition`, `questionToken`, `whenTrue`, `colonToken`, `whenFalse`): [`ConditionalExpression`](ConditionalExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3789 + +#### Parameters + +##### node + +[`ConditionalExpression`](ConditionalExpression.md) + +##### condition + +[`Expression`](Expression.md) + +##### questionToken + +[`QuestionToken`](../type-aliases/QuestionToken.md) + +##### whenTrue + +[`Expression`](Expression.md) + +##### colonToken + +[`ColonToken`](../type-aliases/ColonToken.md) + +##### whenFalse + +[`Expression`](Expression.md) + +#### Returns + +[`ConditionalExpression`](ConditionalExpression.md) + +*** + +### updateConditionalTypeNode() + +> **updateConditionalTypeNode**(`node`, `checkType`, `extendsType`, `trueType`, `falseType`): [`ConditionalTypeNode`](ConditionalTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3720 + +#### Parameters + +##### node + +[`ConditionalTypeNode`](ConditionalTypeNode.md) + +##### checkType + +[`TypeNode`](TypeNode.md) + +##### extendsType + +[`TypeNode`](TypeNode.md) + +##### trueType + +[`TypeNode`](TypeNode.md) + +##### falseType + +[`TypeNode`](TypeNode.md) + +#### Returns + +[`ConditionalTypeNode`](ConditionalTypeNode.md) + +*** + +### updateConstructorDeclaration() + +#### Call Signature + +> **updateConstructorDeclaration**(`node`, `modifiers`, `parameters`, `body`): [`ConstructorDeclaration`](ConstructorDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3677 + +##### Parameters + +###### node + +[`ConstructorDeclaration`](ConstructorDeclaration.md) + +###### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +###### parameters + +readonly [`ParameterDeclaration`](ParameterDeclaration.md)[] + +###### body + +`undefined` | [`Block`](Block.md) + +##### Returns + +[`ConstructorDeclaration`](ConstructorDeclaration.md) + +#### Call Signature + +> **updateConstructorDeclaration**(`node`, `decorators`, `modifiers`, `parameters`, `body`): [`ConstructorDeclaration`](ConstructorDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8442 + +##### Parameters + +###### node + +[`ConstructorDeclaration`](ConstructorDeclaration.md) + +###### decorators + +`undefined` | readonly [`Decorator`](Decorator.md)[] + +###### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +###### parameters + +readonly [`ParameterDeclaration`](ParameterDeclaration.md)[] + +###### body + +`undefined` | [`Block`](Block.md) + +##### Returns + +[`ConstructorDeclaration`](ConstructorDeclaration.md) + +##### Deprecated + +This node does not support Decorators. Callers should use an overload that does not accept a `decorators` parameter. + +*** + +### updateConstructorTypeNode() + +#### Call Signature + +> **updateConstructorTypeNode**(`node`, `modifiers`, `typeParameters`, `parameters`, `type`): [`ConstructorTypeNode`](ConstructorTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3700 + +##### Parameters + +###### node + +[`ConstructorTypeNode`](ConstructorTypeNode.md) + +###### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +###### typeParameters + +`undefined` | [`NodeArray`](NodeArray.md)\<[`TypeParameterDeclaration`](TypeParameterDeclaration.md)\> + +###### parameters + +[`NodeArray`](NodeArray.md)\<[`ParameterDeclaration`](ParameterDeclaration.md)\> + +###### type + +[`TypeNode`](TypeNode.md) + +##### Returns + +[`ConstructorTypeNode`](ConstructorTypeNode.md) + +#### Call Signature + +> **updateConstructorTypeNode**(`node`, `typeParameters`, `parameters`, `type`): [`ConstructorTypeNode`](ConstructorTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8343 + +##### Parameters + +###### node + +[`ConstructorTypeNode`](ConstructorTypeNode.md) + +###### typeParameters + +`undefined` | [`NodeArray`](NodeArray.md)\<[`TypeParameterDeclaration`](TypeParameterDeclaration.md)\> + +###### parameters + +[`NodeArray`](NodeArray.md)\<[`ParameterDeclaration`](ParameterDeclaration.md)\> + +###### type + +[`TypeNode`](TypeNode.md) + +##### Returns + +[`ConstructorTypeNode`](ConstructorTypeNode.md) + +##### Deprecated + +Use the overload that accepts 'modifiers' + +*** + +### updateConstructSignature() + +> **updateConstructSignature**(`node`, `typeParameters`, `parameters`, `type`): [`ConstructSignatureDeclaration`](ConstructSignatureDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3685 + +#### Parameters + +##### node + +[`ConstructSignatureDeclaration`](ConstructSignatureDeclaration.md) + +##### typeParameters + +`undefined` | [`NodeArray`](NodeArray.md)\<[`TypeParameterDeclaration`](TypeParameterDeclaration.md)\> + +##### parameters + +[`NodeArray`](NodeArray.md)\<[`ParameterDeclaration`](ParameterDeclaration.md)\> + +##### type + +`undefined` | [`TypeNode`](TypeNode.md) + +#### Returns + +[`ConstructSignatureDeclaration`](ConstructSignatureDeclaration.md) + +*** + +### updateContinueStatement() + +> **updateContinueStatement**(`node`, `label`): [`ContinueStatement`](ContinueStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3843 + +#### Parameters + +##### node + +[`ContinueStatement`](ContinueStatement.md) + +##### label + +`undefined` | [`Identifier`](Identifier.md) + +#### Returns + +[`ContinueStatement`](ContinueStatement.md) + +*** + +### updateDecorator() + +> **updateDecorator**(`node`, `expression`): [`Decorator`](Decorator.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3667 + +#### Parameters + +##### node + +[`Decorator`](Decorator.md) + +##### expression + +[`Expression`](Expression.md) + +#### Returns + +[`Decorator`](Decorator.md) + +*** + +### updateDefaultClause() + +> **updateDefaultClause**(`node`, `statements`): [`DefaultClause`](DefaultClause.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4014 + +#### Parameters + +##### node + +[`DefaultClause`](DefaultClause.md) + +##### statements + +readonly [`Statement`](Statement.md)[] + +#### Returns + +[`DefaultClause`](DefaultClause.md) + +*** + +### updateDeleteExpression() + +> **updateDeleteExpression**(`node`, `expression`): [`DeleteExpression`](DeleteExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3775 + +#### Parameters + +##### node + +[`DeleteExpression`](DeleteExpression.md) + +##### expression + +[`Expression`](Expression.md) + +#### Returns + +[`DeleteExpression`](DeleteExpression.md) + +*** + +### updateDoStatement() + +> **updateDoStatement**(`node`, `statement`, `expression`): [`DoStatement`](DoStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3833 + +#### Parameters + +##### node + +[`DoStatement`](DoStatement.md) + +##### statement + +[`Statement`](Statement.md) + +##### expression + +[`Expression`](Expression.md) + +#### Returns + +[`DoStatement`](DoStatement.md) + +*** + +### updateElementAccessChain() + +> **updateElementAccessChain**(`node`, `expression`, `questionDotToken`, `argumentExpression`): [`ElementAccessChain`](ElementAccessChain.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3755 + +#### Parameters + +##### node + +[`ElementAccessChain`](ElementAccessChain.md) + +##### expression + +[`Expression`](Expression.md) + +##### questionDotToken + +`undefined` | [`QuestionDotToken`](../type-aliases/QuestionDotToken.md) + +##### argumentExpression + +[`Expression`](Expression.md) + +#### Returns + +[`ElementAccessChain`](ElementAccessChain.md) + +*** + +### updateElementAccessExpression() + +> **updateElementAccessExpression**(`node`, `expression`, `argumentExpression`): [`ElementAccessExpression`](ElementAccessExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3753 + +#### Parameters + +##### node + +[`ElementAccessExpression`](ElementAccessExpression.md) + +##### expression + +[`Expression`](Expression.md) + +##### argumentExpression + +[`Expression`](Expression.md) + +#### Returns + +[`ElementAccessExpression`](ElementAccessExpression.md) + +*** + +### updateEnumDeclaration() + +#### Call Signature + +> **updateEnumDeclaration**(`node`, `modifiers`, `name`, `members`): [`EnumDeclaration`](EnumDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3874 + +##### Parameters + +###### node + +[`EnumDeclaration`](EnumDeclaration.md) + +###### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +###### name + +[`Identifier`](Identifier.md) + +###### members + +readonly [`EnumMember`](EnumMember.md)[] + +##### Returns + +[`EnumDeclaration`](EnumDeclaration.md) + +#### Call Signature + +> **updateEnumDeclaration**(`node`, `decorators`, `modifiers`, `name`, `members`): [`EnumDeclaration`](EnumDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8522 + +##### Parameters + +###### node + +[`EnumDeclaration`](EnumDeclaration.md) + +###### decorators + +`undefined` | readonly [`Decorator`](Decorator.md)[] + +###### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +###### name + +[`Identifier`](Identifier.md) + +###### members + +readonly [`EnumMember`](EnumMember.md)[] + +##### Returns + +[`EnumDeclaration`](EnumDeclaration.md) + +##### Deprecated + +Decorators are no longer supported for this function. Callers should use an overload that does not accept a `decorators` parameter. + +*** + +### updateEnumMember() + +> **updateEnumMember**(`node`, `name`, `initializer`): [`EnumMember`](EnumMember.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4026 + +#### Parameters + +##### node + +[`EnumMember`](EnumMember.md) + +##### name + +[`PropertyName`](../type-aliases/PropertyName.md) + +##### initializer + +`undefined` | [`Expression`](Expression.md) + +#### Returns + +[`EnumMember`](EnumMember.md) + +*** + +### updateEtsComponentExpression() + +> **updateEtsComponentExpression**(`node`, `name`, `argumentExpression`, `body`): [`EtsComponentExpression`](EtsComponentExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3773 + +#### Parameters + +##### node + +[`EtsComponentExpression`](EtsComponentExpression.md) + +##### name + +`undefined` | [`Expression`](Expression.md) + +##### argumentExpression + +`undefined` | [`NodeArray`](NodeArray.md)\<[`Expression`](Expression.md)\> | [`Expression`](Expression.md)[] + +##### body + +`undefined` | [`Block`](Block.md) + +#### Returns + +[`EtsComponentExpression`](EtsComponentExpression.md) + +*** + +### updateExportAssignment() + +#### Call Signature + +> **updateExportAssignment**(`node`, `modifiers`, `expression`): [`ExportAssignment`](ExportAssignment.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3904 + +##### Parameters + +###### node + +[`ExportAssignment`](ExportAssignment.md) + +###### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +###### expression + +[`Expression`](Expression.md) + +##### Returns + +[`ExportAssignment`](ExportAssignment.md) + +#### Call Signature + +> **updateExportAssignment**(`node`, `decorators`, `modifiers`, `expression`): [`ExportAssignment`](ExportAssignment.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8554 + +##### Parameters + +###### node + +[`ExportAssignment`](ExportAssignment.md) + +###### decorators + +`undefined` | readonly [`Decorator`](Decorator.md)[] + +###### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +###### expression + +[`Expression`](Expression.md) + +##### Returns + +[`ExportAssignment`](ExportAssignment.md) + +##### Deprecated + +Decorators are no longer supported for this function. Callers should use an overload that does not accept a `decorators` parameter. + +*** + +### updateExportDeclaration() + +#### Call Signature + +> **updateExportDeclaration**(`node`, `modifiers`, `isTypeOnly`, `exportClause`, `moduleSpecifier`, `assertClause`): [`ExportDeclaration`](ExportDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3906 + +##### Parameters + +###### node + +[`ExportDeclaration`](ExportDeclaration.md) + +###### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +###### isTypeOnly + +`boolean` + +###### exportClause + +`undefined` | [`NamedExportBindings`](../type-aliases/NamedExportBindings.md) + +###### moduleSpecifier + +`undefined` | [`Expression`](Expression.md) + +###### assertClause + +`undefined` | [`AssertClause`](AssertClause.md) + +##### Returns + +[`ExportDeclaration`](ExportDeclaration.md) + +#### Call Signature + +> **updateExportDeclaration**(`node`, `decorators`, `modifiers`, `isTypeOnly`, `exportClause`, `moduleSpecifier`, `assertClause`): [`ExportDeclaration`](ExportDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8562 + +##### Parameters + +###### node + +[`ExportDeclaration`](ExportDeclaration.md) + +###### decorators + +`undefined` | readonly [`Decorator`](Decorator.md)[] + +###### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +###### isTypeOnly + +`boolean` + +###### exportClause + +`undefined` | [`NamedExportBindings`](../type-aliases/NamedExportBindings.md) + +###### moduleSpecifier + +`undefined` | [`Expression`](Expression.md) + +###### assertClause + +`undefined` | [`AssertClause`](AssertClause.md) + +##### Returns + +[`ExportDeclaration`](ExportDeclaration.md) + +##### Deprecated + +Decorators are no longer supported for this function. Callers should use an overload that does not accept a `decorators` parameter. + +*** + +### updateExportSpecifier() + +> **updateExportSpecifier**(`node`, `isTypeOnly`, `propertyName`, `name`): [`ExportSpecifier`](ExportSpecifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3910 + +#### Parameters + +##### node + +[`ExportSpecifier`](ExportSpecifier.md) + +##### isTypeOnly + +`boolean` + +##### propertyName + +`undefined` | [`Identifier`](Identifier.md) + +##### name + +[`Identifier`](Identifier.md) + +#### Returns + +[`ExportSpecifier`](ExportSpecifier.md) + +*** + +### updateExpressionStatement() + +> **updateExpressionStatement**(`node`, `expression`): [`ExpressionStatement`](ExpressionStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3829 + +#### Parameters + +##### node + +[`ExpressionStatement`](ExpressionStatement.md) + +##### expression + +[`Expression`](Expression.md) + +#### Returns + +[`ExpressionStatement`](ExpressionStatement.md) + +*** + +### updateExpressionWithTypeArguments() + +> **updateExpressionWithTypeArguments**(`node`, `expression`, `typeArguments`): [`ExpressionWithTypeArguments`](ExpressionWithTypeArguments.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3809 + +#### Parameters + +##### node + +[`ExpressionWithTypeArguments`](ExpressionWithTypeArguments.md) + +##### expression + +[`Expression`](Expression.md) + +##### typeArguments + +`undefined` | readonly [`TypeNode`](TypeNode.md)[] + +#### Returns + +[`ExpressionWithTypeArguments`](ExpressionWithTypeArguments.md) + +*** + +### updateExternalModuleReference() + +> **updateExternalModuleReference**(`node`, `expression`): [`ExternalModuleReference`](ExternalModuleReference.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3912 + +#### Parameters + +##### node + +[`ExternalModuleReference`](ExternalModuleReference.md) + +##### expression + +[`Expression`](Expression.md) + +#### Returns + +[`ExternalModuleReference`](ExternalModuleReference.md) + +*** + +### updateForInStatement() + +> **updateForInStatement**(`node`, `initializer`, `expression`, `statement`): [`ForInStatement`](ForInStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3839 + +#### Parameters + +##### node + +[`ForInStatement`](ForInStatement.md) + +##### initializer + +[`ForInitializer`](../type-aliases/ForInitializer.md) + +##### expression + +[`Expression`](Expression.md) + +##### statement + +[`Statement`](Statement.md) + +#### Returns + +[`ForInStatement`](ForInStatement.md) + +*** + +### updateForOfStatement() + +> **updateForOfStatement**(`node`, `awaitModifier`, `initializer`, `expression`, `statement`): [`ForOfStatement`](ForOfStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3841 + +#### Parameters + +##### node + +[`ForOfStatement`](ForOfStatement.md) + +##### awaitModifier + +`undefined` | [`AwaitKeyword`](../type-aliases/AwaitKeyword.md) + +##### initializer + +[`ForInitializer`](../type-aliases/ForInitializer.md) + +##### expression + +[`Expression`](Expression.md) + +##### statement + +[`Statement`](Statement.md) + +#### Returns + +[`ForOfStatement`](ForOfStatement.md) + +*** + +### updateForStatement() + +> **updateForStatement**(`node`, `initializer`, `condition`, `incrementor`, `statement`): [`ForStatement`](ForStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3837 + +#### Parameters + +##### node + +[`ForStatement`](ForStatement.md) + +##### initializer + +`undefined` | [`ForInitializer`](../type-aliases/ForInitializer.md) + +##### condition + +`undefined` | [`Expression`](Expression.md) + +##### incrementor + +`undefined` | [`Expression`](Expression.md) + +##### statement + +[`Statement`](Statement.md) + +#### Returns + +[`ForStatement`](ForStatement.md) + +*** + +### updateFunctionDeclaration() + +#### Call Signature + +> **updateFunctionDeclaration**(`node`, `modifiers`, `asteriskToken`, `name`, `typeParameters`, `parameters`, `type`, `body`): [`FunctionDeclaration`](FunctionDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3864 + +##### Parameters + +###### node + +[`FunctionDeclaration`](FunctionDeclaration.md) + +###### modifiers + +`undefined` | readonly [`ModifierLike`](../type-aliases/ModifierLike.md)[] + +###### asteriskToken + +`undefined` | [`AsteriskToken`](../type-aliases/AsteriskToken.md) + +###### name + +`undefined` | [`Identifier`](Identifier.md) + +###### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](TypeParameterDeclaration.md)[] + +###### parameters + +readonly [`ParameterDeclaration`](ParameterDeclaration.md)[] + +###### type + +`undefined` | [`TypeNode`](TypeNode.md) + +###### body + +`undefined` | [`Block`](Block.md) + +##### Returns + +[`FunctionDeclaration`](FunctionDeclaration.md) + +#### Call Signature + +> **updateFunctionDeclaration**(`node`, `decorators`, `modifiers`, `asteriskToken`, `name`, `typeParameters`, `parameters`, `type`, `body`): [`FunctionDeclaration`](FunctionDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8490 + +##### Parameters + +###### node + +[`FunctionDeclaration`](FunctionDeclaration.md) + +###### decorators + +`undefined` | readonly [`Decorator`](Decorator.md)[] + +###### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +###### asteriskToken + +`undefined` | [`AsteriskToken`](../type-aliases/AsteriskToken.md) + +###### name + +`undefined` | [`Identifier`](Identifier.md) + +###### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](TypeParameterDeclaration.md)[] + +###### parameters + +readonly [`ParameterDeclaration`](ParameterDeclaration.md)[] + +###### type + +`undefined` | [`TypeNode`](TypeNode.md) + +###### body + +`undefined` | [`Block`](Block.md) + +##### Returns + +[`FunctionDeclaration`](FunctionDeclaration.md) + +##### Deprecated + +Decorators are no longer supported for this function. Callers should use an overload that does not accept a `decorators` parameter. + +*** + +### updateFunctionExpression() + +> **updateFunctionExpression**(`node`, `modifiers`, `asteriskToken`, `name`, `typeParameters`, `parameters`, `type`, `body`): [`FunctionExpression`](FunctionExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3769 + +#### Parameters + +##### node + +[`FunctionExpression`](FunctionExpression.md) + +##### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +##### asteriskToken + +`undefined` | [`AsteriskToken`](../type-aliases/AsteriskToken.md) + +##### name + +`undefined` | [`Identifier`](Identifier.md) + +##### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](TypeParameterDeclaration.md)[] + +##### parameters + +readonly [`ParameterDeclaration`](ParameterDeclaration.md)[] + +##### type + +`undefined` | [`TypeNode`](TypeNode.md) + +##### body + +[`Block`](Block.md) + +#### Returns + +[`FunctionExpression`](FunctionExpression.md) + +*** + +### updateFunctionTypeNode() + +> **updateFunctionTypeNode**(`node`, `typeParameters`, `parameters`, `type`): [`FunctionTypeNode`](FunctionTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3698 + +#### Parameters + +##### node + +[`FunctionTypeNode`](FunctionTypeNode.md) + +##### typeParameters + +`undefined` | [`NodeArray`](NodeArray.md)\<[`TypeParameterDeclaration`](TypeParameterDeclaration.md)\> + +##### parameters + +[`NodeArray`](NodeArray.md)\<[`ParameterDeclaration`](ParameterDeclaration.md)\> + +##### type + +[`TypeNode`](TypeNode.md) + +#### Returns + +[`FunctionTypeNode`](FunctionTypeNode.md) + +*** + +### updateGetAccessorDeclaration() + +#### Call Signature + +> **updateGetAccessorDeclaration**(`node`, `modifiers`, `name`, `parameters`, `type`, `body`): [`GetAccessorDeclaration`](GetAccessorDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3679 + +##### Parameters + +###### node + +[`GetAccessorDeclaration`](GetAccessorDeclaration.md) + +###### modifiers + +`undefined` | readonly [`ModifierLike`](../type-aliases/ModifierLike.md)[] + +###### name + +[`PropertyName`](../type-aliases/PropertyName.md) + +###### parameters + +readonly [`ParameterDeclaration`](ParameterDeclaration.md)[] + +###### type + +`undefined` | [`TypeNode`](TypeNode.md) + +###### body + +`undefined` | [`Block`](Block.md) + +##### Returns + +[`GetAccessorDeclaration`](GetAccessorDeclaration.md) + +#### Call Signature + +> **updateGetAccessorDeclaration**(`node`, `decorators`, `modifiers`, `name`, `parameters`, `type`, `body`): [`GetAccessorDeclaration`](GetAccessorDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8450 + +##### Parameters + +###### node + +[`GetAccessorDeclaration`](GetAccessorDeclaration.md) + +###### decorators + +`undefined` | readonly [`Decorator`](Decorator.md)[] + +###### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +###### name + +[`PropertyName`](../type-aliases/PropertyName.md) + +###### parameters + +readonly [`ParameterDeclaration`](ParameterDeclaration.md)[] + +###### type + +`undefined` | [`TypeNode`](TypeNode.md) + +###### body + +`undefined` | [`Block`](Block.md) + +##### Returns + +[`GetAccessorDeclaration`](GetAccessorDeclaration.md) + +##### Deprecated + +Decorators have been combined with modifiers. Callers should use an overload that does not accept a `decorators` parameter. + +*** + +### updateHeritageClause() + +> **updateHeritageClause**(`node`, `types`): [`HeritageClause`](HeritageClause.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4016 + +#### Parameters + +##### node + +[`HeritageClause`](HeritageClause.md) + +##### types + +readonly [`ExpressionWithTypeArguments`](ExpressionWithTypeArguments.md)[] + +#### Returns + +[`HeritageClause`](HeritageClause.md) + +*** + +### updateIfStatement() + +> **updateIfStatement**(`node`, `expression`, `thenStatement`, `elseStatement`): [`IfStatement`](IfStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3831 + +#### Parameters + +##### node + +[`IfStatement`](IfStatement.md) + +##### expression + +[`Expression`](Expression.md) + +##### thenStatement + +[`Statement`](Statement.md) + +##### elseStatement + +`undefined` | [`Statement`](Statement.md) + +#### Returns + +[`IfStatement`](IfStatement.md) + +*** + +### updateImportClause() + +> **updateImportClause**(`node`, `isTypeOnly`, `name`, `namedBindings`): [`ImportClause`](ImportClause.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3888 + +#### Parameters + +##### node + +[`ImportClause`](ImportClause.md) + +##### isTypeOnly + +`boolean` + +##### name + +`undefined` | [`Identifier`](Identifier.md) + +##### namedBindings + +`undefined` | [`NamedImportBindings`](../type-aliases/NamedImportBindings.md) + +#### Returns + +[`ImportClause`](ImportClause.md) + +*** + +### updateImportDeclaration() + +#### Call Signature + +> **updateImportDeclaration**(`node`, `modifiers`, `importClause`, `moduleSpecifier`, `assertClause`): [`ImportDeclaration`](ImportDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3886 + +##### Parameters + +###### node + +[`ImportDeclaration`](ImportDeclaration.md) + +###### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +###### importClause + +`undefined` | [`ImportClause`](ImportClause.md) + +###### moduleSpecifier + +[`Expression`](Expression.md) + +###### assertClause + +`undefined` | [`AssertClause`](AssertClause.md) + +##### Returns + +[`ImportDeclaration`](ImportDeclaration.md) + +#### Call Signature + +> **updateImportDeclaration**(`node`, `decorators`, `modifiers`, `importClause`, `moduleSpecifier`, `assertClause`): [`ImportDeclaration`](ImportDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8546 + +##### Parameters + +###### node + +[`ImportDeclaration`](ImportDeclaration.md) + +###### decorators + +`undefined` | readonly [`Decorator`](Decorator.md)[] + +###### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +###### importClause + +`undefined` | [`ImportClause`](ImportClause.md) + +###### moduleSpecifier + +[`Expression`](Expression.md) + +###### assertClause + +`undefined` | [`AssertClause`](AssertClause.md) + +##### Returns + +[`ImportDeclaration`](ImportDeclaration.md) + +##### Deprecated + +Decorators are no longer supported for this function. Callers should use an overload that does not accept a `decorators` parameter. + +*** + +### updateImportEqualsDeclaration() + +#### Call Signature + +> **updateImportEqualsDeclaration**(`node`, `modifiers`, `isTypeOnly`, `name`, `moduleReference`): [`ImportEqualsDeclaration`](ImportEqualsDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3884 + +##### Parameters + +###### node + +[`ImportEqualsDeclaration`](ImportEqualsDeclaration.md) + +###### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +###### isTypeOnly + +`boolean` + +###### name + +[`Identifier`](Identifier.md) + +###### moduleReference + +[`ModuleReference`](../type-aliases/ModuleReference.md) + +##### Returns + +[`ImportEqualsDeclaration`](ImportEqualsDeclaration.md) + +#### Call Signature + +> **updateImportEqualsDeclaration**(`node`, `decorators`, `modifiers`, `isTypeOnly`, `name`, `moduleReference`): [`ImportEqualsDeclaration`](ImportEqualsDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8538 + +##### Parameters + +###### node + +[`ImportEqualsDeclaration`](ImportEqualsDeclaration.md) + +###### decorators + +`undefined` | readonly [`Decorator`](Decorator.md)[] + +###### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +###### isTypeOnly + +`boolean` + +###### name + +[`Identifier`](Identifier.md) + +###### moduleReference + +[`ModuleReference`](../type-aliases/ModuleReference.md) + +##### Returns + +[`ImportEqualsDeclaration`](ImportEqualsDeclaration.md) + +##### Deprecated + +Decorators are no longer supported for this function. Callers should use an overload that does not accept a `decorators` parameter. + +*** + +### updateImportSpecifier() + +> **updateImportSpecifier**(`node`, `isTypeOnly`, `propertyName`, `name`): [`ImportSpecifier`](ImportSpecifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3902 + +#### Parameters + +##### node + +[`ImportSpecifier`](ImportSpecifier.md) + +##### isTypeOnly + +`boolean` + +##### propertyName + +`undefined` | [`Identifier`](Identifier.md) + +##### name + +[`Identifier`](Identifier.md) + +#### Returns + +[`ImportSpecifier`](ImportSpecifier.md) + +*** + +### updateImportTypeAssertionContainer() + +> **updateImportTypeAssertionContainer**(`node`, `clause`, `multiLine`?): [`ImportTypeAssertionContainer`](ImportTypeAssertionContainer.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3894 + +#### Parameters + +##### node + +[`ImportTypeAssertionContainer`](ImportTypeAssertionContainer.md) + +##### clause + +[`AssertClause`](AssertClause.md) + +##### multiLine? + +`boolean` + +#### Returns + +[`ImportTypeAssertionContainer`](ImportTypeAssertionContainer.md) + +*** + +### updateImportTypeNode() + +#### Call Signature + +> **updateImportTypeNode**(`node`, `argument`, `assertions`, `qualifier`, `typeArguments`, `isTypeOf`?): [`ImportTypeNode`](ImportTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3724 + +##### Parameters + +###### node + +[`ImportTypeNode`](ImportTypeNode.md) + +###### argument + +[`TypeNode`](TypeNode.md) + +###### assertions + +`undefined` | [`ImportTypeAssertionContainer`](ImportTypeAssertionContainer.md) + +###### qualifier + +`undefined` | [`EntityName`](../type-aliases/EntityName.md) + +###### typeArguments + +`undefined` | readonly [`TypeNode`](TypeNode.md)[] + +###### isTypeOf? + +`boolean` + +##### Returns + +[`ImportTypeNode`](ImportTypeNode.md) + +#### Call Signature + +> **updateImportTypeNode**(`node`, `argument`, `qualifier`, `typeArguments`, `isTypeOf`?): [`ImportTypeNode`](ImportTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8352 + +##### Parameters + +###### node + +[`ImportTypeNode`](ImportTypeNode.md) + +###### argument + +[`TypeNode`](TypeNode.md) + +###### qualifier + +`undefined` | [`EntityName`](../type-aliases/EntityName.md) + +###### typeArguments + +`undefined` | readonly [`TypeNode`](TypeNode.md)[] + +###### isTypeOf? + +`boolean` + +##### Returns + +[`ImportTypeNode`](ImportTypeNode.md) + +##### Deprecated + +Use the overload that accepts 'assertions' + +*** + +### updateIndexedAccessTypeNode() + +> **updateIndexedAccessTypeNode**(`node`, `objectType`, `indexType`): [`IndexedAccessTypeNode`](IndexedAccessTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3731 + +#### Parameters + +##### node + +[`IndexedAccessTypeNode`](IndexedAccessTypeNode.md) + +##### objectType + +[`TypeNode`](TypeNode.md) + +##### indexType + +[`TypeNode`](TypeNode.md) + +#### Returns + +[`IndexedAccessTypeNode`](IndexedAccessTypeNode.md) + +*** + +### updateIndexSignature() + +#### Call Signature + +> **updateIndexSignature**(`node`, `modifiers`, `parameters`, `type`): [`IndexSignatureDeclaration`](IndexSignatureDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3687 + +##### Parameters + +###### node + +[`IndexSignatureDeclaration`](IndexSignatureDeclaration.md) + +###### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +###### parameters + +readonly [`ParameterDeclaration`](ParameterDeclaration.md)[] + +###### type + +[`TypeNode`](TypeNode.md) + +##### Returns + +[`IndexSignatureDeclaration`](IndexSignatureDeclaration.md) + +#### Call Signature + +> **updateIndexSignature**(`node`, `decorators`, `modifiers`, `parameters`, `type`): [`IndexSignatureDeclaration`](IndexSignatureDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8466 + +##### Parameters + +###### node + +[`IndexSignatureDeclaration`](IndexSignatureDeclaration.md) + +###### decorators + +`undefined` | readonly [`Decorator`](Decorator.md)[] + +###### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +###### parameters + +readonly [`ParameterDeclaration`](ParameterDeclaration.md)[] + +###### type + +[`TypeNode`](TypeNode.md) + +##### Returns + +[`IndexSignatureDeclaration`](IndexSignatureDeclaration.md) + +##### Deprecated + +Decorators and modifiers are no longer supported for this function. Callers should use an overload that does not accept the `decorators` and `modifiers` parameters. + +*** + +### updateInferTypeNode() + +> **updateInferTypeNode**(`node`, `typeParameter`): [`InferTypeNode`](InferTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3722 + +#### Parameters + +##### node + +[`InferTypeNode`](InferTypeNode.md) + +##### typeParameter + +[`TypeParameterDeclaration`](TypeParameterDeclaration.md) + +#### Returns + +[`InferTypeNode`](InferTypeNode.md) + +*** + +### updateInterfaceDeclaration() + +#### Call Signature + +> **updateInterfaceDeclaration**(`node`, `modifiers`, `name`, `typeParameters`, `heritageClauses`, `members`): [`InterfaceDeclaration`](InterfaceDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3870 + +##### Parameters + +###### node + +[`InterfaceDeclaration`](InterfaceDeclaration.md) + +###### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +###### name + +[`Identifier`](Identifier.md) + +###### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](TypeParameterDeclaration.md)[] + +###### heritageClauses + +`undefined` | readonly [`HeritageClause`](HeritageClause.md)[] + +###### members + +readonly [`TypeElement`](TypeElement.md)[] + +##### Returns + +[`InterfaceDeclaration`](InterfaceDeclaration.md) + +#### Call Signature + +> **updateInterfaceDeclaration**(`node`, `decorators`, `modifiers`, `name`, `typeParameters`, `heritageClauses`, `members`): [`InterfaceDeclaration`](InterfaceDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8506 + +##### Parameters + +###### node + +[`InterfaceDeclaration`](InterfaceDeclaration.md) + +###### decorators + +`undefined` | readonly [`Decorator`](Decorator.md)[] + +###### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +###### name + +[`Identifier`](Identifier.md) + +###### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](TypeParameterDeclaration.md)[] + +###### heritageClauses + +`undefined` | readonly [`HeritageClause`](HeritageClause.md)[] + +###### members + +readonly [`TypeElement`](TypeElement.md)[] + +##### Returns + +[`InterfaceDeclaration`](InterfaceDeclaration.md) + +##### Deprecated + +Decorators are no longer supported for this function. Callers should use an overload that does not accept a `decorators` parameter. + +*** + +### updateIntersectionTypeNode() + +> **updateIntersectionTypeNode**(`node`, `types`): [`IntersectionTypeNode`](IntersectionTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3718 + +#### Parameters + +##### node + +[`IntersectionTypeNode`](IntersectionTypeNode.md) + +##### types + +[`NodeArray`](NodeArray.md)\<[`TypeNode`](TypeNode.md)\> + +#### Returns + +[`IntersectionTypeNode`](IntersectionTypeNode.md) + +*** + +### updateJSDocAugmentsTag() + +> **updateJSDocAugmentsTag**(`node`, `tagName`, `className`, `comment`): [`JSDocAugmentsTag`](JSDocAugmentsTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3964 + +#### Parameters + +##### node + +[`JSDocAugmentsTag`](JSDocAugmentsTag.md) + +##### tagName + +`undefined` | [`Identifier`](Identifier.md) + +##### className + +[`ExpressionWithTypeArguments`](ExpressionWithTypeArguments.md) & `object` + +##### comment + +`undefined` | `string` | [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +#### Returns + +[`JSDocAugmentsTag`](JSDocAugmentsTag.md) + +*** + +### updateJSDocAuthorTag() + +> **updateJSDocAuthorTag**(`node`, `tagName`, `comment`): [`JSDocAuthorTag`](JSDocAuthorTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3968 + +#### Parameters + +##### node + +[`JSDocAuthorTag`](JSDocAuthorTag.md) + +##### tagName + +`undefined` | [`Identifier`](Identifier.md) + +##### comment + +`undefined` | `string` | [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +#### Returns + +[`JSDocAuthorTag`](JSDocAuthorTag.md) + +*** + +### updateJSDocCallbackTag() + +> **updateJSDocCallbackTag**(`node`, `tagName`, `typeExpression`, `fullName`, `comment`): [`JSDocCallbackTag`](JSDocCallbackTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3962 + +#### Parameters + +##### node + +[`JSDocCallbackTag`](JSDocCallbackTag.md) + +##### tagName + +`undefined` | [`Identifier`](Identifier.md) + +##### typeExpression + +[`JSDocSignature`](JSDocSignature.md) + +##### fullName + +`undefined` | [`Identifier`](Identifier.md) | [`JSDocNamespaceDeclaration`](JSDocNamespaceDeclaration.md) + +##### comment + +`undefined` | `string` | [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +#### Returns + +[`JSDocCallbackTag`](JSDocCallbackTag.md) + +*** + +### updateJSDocClassTag() + +> **updateJSDocClassTag**(`node`, `tagName`, `comment`): [`JSDocClassTag`](JSDocClassTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3970 + +#### Parameters + +##### node + +[`JSDocClassTag`](JSDocClassTag.md) + +##### tagName + +`undefined` | [`Identifier`](Identifier.md) + +##### comment + +`undefined` | `string` | [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +#### Returns + +[`JSDocClassTag`](JSDocClassTag.md) + +*** + +### updateJSDocComment() + +> **updateJSDocComment**(`node`, `comment`, `tags`): [`JSDoc`](JSDoc.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3988 + +#### Parameters + +##### node + +[`JSDoc`](JSDoc.md) + +##### comment + +`undefined` | `string` | [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +##### tags + +`undefined` | readonly [`JSDocTag`](JSDocTag.md)[] + +#### Returns + +[`JSDoc`](JSDoc.md) + +*** + +### updateJSDocDeprecatedTag() + +> **updateJSDocDeprecatedTag**(`node`, `tagName`, `comment`?): [`JSDocDeprecatedTag`](JSDocDeprecatedTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3982 + +#### Parameters + +##### node + +[`JSDocDeprecatedTag`](JSDocDeprecatedTag.md) + +##### tagName + +[`Identifier`](Identifier.md) + +##### comment? + +`string` | [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +#### Returns + +[`JSDocDeprecatedTag`](JSDocDeprecatedTag.md) + +*** + +### updateJSDocEnumTag() + +> **updateJSDocEnumTag**(`node`, `tagName`, `typeExpression`, `comment`): [`JSDocEnumTag`](JSDocEnumTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3960 + +#### Parameters + +##### node + +[`JSDocEnumTag`](JSDocEnumTag.md) + +##### tagName + +`undefined` | [`Identifier`](Identifier.md) + +##### typeExpression + +[`JSDocTypeExpression`](JSDocTypeExpression.md) + +##### comment + +`undefined` | `string` | [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +#### Returns + +[`JSDocEnumTag`](JSDocEnumTag.md) + +*** + +### updateJSDocFunctionType() + +> **updateJSDocFunctionType**(`node`, `parameters`, `type`): [`JSDocFunctionType`](JSDocFunctionType.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3922 + +#### Parameters + +##### node + +[`JSDocFunctionType`](JSDocFunctionType.md) + +##### parameters + +readonly [`ParameterDeclaration`](ParameterDeclaration.md)[] + +##### type + +`undefined` | [`TypeNode`](TypeNode.md) + +#### Returns + +[`JSDocFunctionType`](JSDocFunctionType.md) + +*** + +### updateJSDocImplementsTag() + +> **updateJSDocImplementsTag**(`node`, `tagName`, `className`, `comment`): [`JSDocImplementsTag`](JSDocImplementsTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3966 + +#### Parameters + +##### node + +[`JSDocImplementsTag`](JSDocImplementsTag.md) + +##### tagName + +`undefined` | [`Identifier`](Identifier.md) + +##### className + +[`ExpressionWithTypeArguments`](ExpressionWithTypeArguments.md) & `object` + +##### comment + +`undefined` | `string` | [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +#### Returns + +[`JSDocImplementsTag`](JSDocImplementsTag.md) + +*** + +### updateJSDocLink() + +> **updateJSDocLink**(`node`, `name`, `text`): [`JSDocLink`](JSDocLink.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3934 + +#### Parameters + +##### node + +[`JSDocLink`](JSDocLink.md) + +##### name + +`undefined` | [`EntityName`](../type-aliases/EntityName.md) | [`JSDocMemberName`](JSDocMemberName.md) + +##### text + +`string` + +#### Returns + +[`JSDocLink`](JSDocLink.md) + +*** + +### updateJSDocLinkCode() + +> **updateJSDocLinkCode**(`node`, `name`, `text`): [`JSDocLinkCode`](JSDocLinkCode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3936 + +#### Parameters + +##### node + +[`JSDocLinkCode`](JSDocLinkCode.md) + +##### name + +`undefined` | [`EntityName`](../type-aliases/EntityName.md) | [`JSDocMemberName`](JSDocMemberName.md) + +##### text + +`string` + +#### Returns + +[`JSDocLinkCode`](JSDocLinkCode.md) + +*** + +### updateJSDocLinkPlain() + +> **updateJSDocLinkPlain**(`node`, `name`, `text`): [`JSDocLinkPlain`](JSDocLinkPlain.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3938 + +#### Parameters + +##### node + +[`JSDocLinkPlain`](JSDocLinkPlain.md) + +##### name + +`undefined` | [`EntityName`](../type-aliases/EntityName.md) | [`JSDocMemberName`](JSDocMemberName.md) + +##### text + +`string` + +#### Returns + +[`JSDocLinkPlain`](JSDocLinkPlain.md) + +*** + +### updateJSDocMemberName() + +> **updateJSDocMemberName**(`node`, `left`, `right`): [`JSDocMemberName`](JSDocMemberName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3932 + +#### Parameters + +##### node + +[`JSDocMemberName`](JSDocMemberName.md) + +##### left + +[`EntityName`](../type-aliases/EntityName.md) | [`JSDocMemberName`](JSDocMemberName.md) + +##### right + +[`Identifier`](Identifier.md) + +#### Returns + +[`JSDocMemberName`](JSDocMemberName.md) + +*** + +### updateJSDocNamepathType() + +> **updateJSDocNamepathType**(`node`, `type`): [`JSDocNamepathType`](JSDocNamepathType.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3926 + +#### Parameters + +##### node + +[`JSDocNamepathType`](JSDocNamepathType.md) + +##### type + +[`TypeNode`](TypeNode.md) + +#### Returns + +[`JSDocNamepathType`](JSDocNamepathType.md) + +*** + +### updateJSDocNameReference() + +> **updateJSDocNameReference**(`node`, `name`): [`JSDocNameReference`](JSDocNameReference.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3930 + +#### Parameters + +##### node + +[`JSDocNameReference`](JSDocNameReference.md) + +##### name + +[`EntityName`](../type-aliases/EntityName.md) | [`JSDocMemberName`](JSDocMemberName.md) + +#### Returns + +[`JSDocNameReference`](JSDocNameReference.md) + +*** + +### updateJSDocNonNullableType() + +> **updateJSDocNonNullableType**(`node`, `type`): [`JSDocNonNullableType`](JSDocNonNullableType.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3916 + +#### Parameters + +##### node + +[`JSDocNonNullableType`](JSDocNonNullableType.md) + +##### type + +[`TypeNode`](TypeNode.md) + +#### Returns + +[`JSDocNonNullableType`](JSDocNonNullableType.md) + +*** + +### updateJSDocNullableType() + +> **updateJSDocNullableType**(`node`, `type`): [`JSDocNullableType`](JSDocNullableType.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3918 + +#### Parameters + +##### node + +[`JSDocNullableType`](JSDocNullableType.md) + +##### type + +[`TypeNode`](TypeNode.md) + +#### Returns + +[`JSDocNullableType`](JSDocNullableType.md) + +*** + +### updateJSDocOptionalType() + +> **updateJSDocOptionalType**(`node`, `type`): [`JSDocOptionalType`](JSDocOptionalType.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3920 + +#### Parameters + +##### node + +[`JSDocOptionalType`](JSDocOptionalType.md) + +##### type + +[`TypeNode`](TypeNode.md) + +#### Returns + +[`JSDocOptionalType`](JSDocOptionalType.md) + +*** + +### updateJSDocOverrideTag() + +> **updateJSDocOverrideTag**(`node`, `tagName`, `comment`?): [`JSDocOverrideTag`](JSDocOverrideTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3984 + +#### Parameters + +##### node + +[`JSDocOverrideTag`](JSDocOverrideTag.md) + +##### tagName + +[`Identifier`](Identifier.md) + +##### comment? + +`string` | [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +#### Returns + +[`JSDocOverrideTag`](JSDocOverrideTag.md) + +*** + +### updateJSDocParameterTag() + +> **updateJSDocParameterTag**(`node`, `tagName`, `name`, `isBracketed`, `typeExpression`, `isNameFirst`, `comment`): [`JSDocParameterTag`](JSDocParameterTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3948 + +#### Parameters + +##### node + +[`JSDocParameterTag`](JSDocParameterTag.md) + +##### tagName + +`undefined` | [`Identifier`](Identifier.md) + +##### name + +[`EntityName`](../type-aliases/EntityName.md) + +##### isBracketed + +`boolean` + +##### typeExpression + +`undefined` | [`JSDocTypeExpression`](JSDocTypeExpression.md) + +##### isNameFirst + +`boolean` + +##### comment + +`undefined` | `string` | [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +#### Returns + +[`JSDocParameterTag`](JSDocParameterTag.md) + +*** + +### updateJSDocPrivateTag() + +> **updateJSDocPrivateTag**(`node`, `tagName`, `comment`): [`JSDocPrivateTag`](JSDocPrivateTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3974 + +#### Parameters + +##### node + +[`JSDocPrivateTag`](JSDocPrivateTag.md) + +##### tagName + +`undefined` | [`Identifier`](Identifier.md) + +##### comment + +`undefined` | `string` | [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +#### Returns + +[`JSDocPrivateTag`](JSDocPrivateTag.md) + +*** + +### updateJSDocPropertyTag() + +> **updateJSDocPropertyTag**(`node`, `tagName`, `name`, `isBracketed`, `typeExpression`, `isNameFirst`, `comment`): [`JSDocPropertyTag`](JSDocPropertyTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3950 + +#### Parameters + +##### node + +[`JSDocPropertyTag`](JSDocPropertyTag.md) + +##### tagName + +`undefined` | [`Identifier`](Identifier.md) + +##### name + +[`EntityName`](../type-aliases/EntityName.md) + +##### isBracketed + +`boolean` + +##### typeExpression + +`undefined` | [`JSDocTypeExpression`](JSDocTypeExpression.md) + +##### isNameFirst + +`boolean` + +##### comment + +`undefined` | `string` | [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +#### Returns + +[`JSDocPropertyTag`](JSDocPropertyTag.md) + +*** + +### updateJSDocProtectedTag() + +> **updateJSDocProtectedTag**(`node`, `tagName`, `comment`): [`JSDocProtectedTag`](JSDocProtectedTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3976 + +#### Parameters + +##### node + +[`JSDocProtectedTag`](JSDocProtectedTag.md) + +##### tagName + +`undefined` | [`Identifier`](Identifier.md) + +##### comment + +`undefined` | `string` | [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +#### Returns + +[`JSDocProtectedTag`](JSDocProtectedTag.md) + +*** + +### updateJSDocPublicTag() + +> **updateJSDocPublicTag**(`node`, `tagName`, `comment`): [`JSDocPublicTag`](JSDocPublicTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3972 + +#### Parameters + +##### node + +[`JSDocPublicTag`](JSDocPublicTag.md) + +##### tagName + +`undefined` | [`Identifier`](Identifier.md) + +##### comment + +`undefined` | `string` | [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +#### Returns + +[`JSDocPublicTag`](JSDocPublicTag.md) + +*** + +### updateJSDocReadonlyTag() + +> **updateJSDocReadonlyTag**(`node`, `tagName`, `comment`): [`JSDocReadonlyTag`](JSDocReadonlyTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3978 + +#### Parameters + +##### node + +[`JSDocReadonlyTag`](JSDocReadonlyTag.md) + +##### tagName + +`undefined` | [`Identifier`](Identifier.md) + +##### comment + +`undefined` | `string` | [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +#### Returns + +[`JSDocReadonlyTag`](JSDocReadonlyTag.md) + +*** + +### updateJSDocReturnTag() + +> **updateJSDocReturnTag**(`node`, `tagName`, `typeExpression`, `comment`): [`JSDocReturnTag`](JSDocReturnTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3956 + +#### Parameters + +##### node + +[`JSDocReturnTag`](JSDocReturnTag.md) + +##### tagName + +`undefined` | [`Identifier`](Identifier.md) + +##### typeExpression + +`undefined` | [`JSDocTypeExpression`](JSDocTypeExpression.md) + +##### comment + +`undefined` | `string` | [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +#### Returns + +[`JSDocReturnTag`](JSDocReturnTag.md) + +*** + +### updateJSDocSeeTag() + +> **updateJSDocSeeTag**(`node`, `tagName`, `nameExpression`, `comment`?): [`JSDocSeeTag`](JSDocSeeTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3954 + +#### Parameters + +##### node + +[`JSDocSeeTag`](JSDocSeeTag.md) + +##### tagName + +`undefined` | [`Identifier`](Identifier.md) + +##### nameExpression + +`undefined` | [`JSDocNameReference`](JSDocNameReference.md) + +##### comment? + +`string` | [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +#### Returns + +[`JSDocSeeTag`](JSDocSeeTag.md) + +*** + +### updateJSDocSignature() + +> **updateJSDocSignature**(`node`, `typeParameters`, `parameters`, `type`): [`JSDocSignature`](JSDocSignature.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3942 + +#### Parameters + +##### node + +[`JSDocSignature`](JSDocSignature.md) + +##### typeParameters + +`undefined` | readonly [`JSDocTemplateTag`](JSDocTemplateTag.md)[] + +##### parameters + +readonly [`JSDocParameterTag`](JSDocParameterTag.md)[] + +##### type + +`undefined` | [`JSDocReturnTag`](JSDocReturnTag.md) + +#### Returns + +[`JSDocSignature`](JSDocSignature.md) + +*** + +### updateJSDocTemplateTag() + +> **updateJSDocTemplateTag**(`node`, `tagName`, `constraint`, `typeParameters`, `comment`): [`JSDocTemplateTag`](JSDocTemplateTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3944 + +#### Parameters + +##### node + +[`JSDocTemplateTag`](JSDocTemplateTag.md) + +##### tagName + +`undefined` | [`Identifier`](Identifier.md) + +##### constraint + +`undefined` | [`JSDocTypeExpression`](JSDocTypeExpression.md) + +##### typeParameters + +readonly [`TypeParameterDeclaration`](TypeParameterDeclaration.md)[] + +##### comment + +`undefined` | `string` | [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +#### Returns + +[`JSDocTemplateTag`](JSDocTemplateTag.md) + +*** + +### updateJSDocText() + +> **updateJSDocText**(`node`, `text`): [`JSDocText`](JSDocText.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3986 + +#### Parameters + +##### node + +[`JSDocText`](JSDocText.md) + +##### text + +`string` + +#### Returns + +[`JSDocText`](JSDocText.md) + +*** + +### updateJSDocThisTag() + +> **updateJSDocThisTag**(`node`, `tagName`, `typeExpression`, `comment`): [`JSDocThisTag`](JSDocThisTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3958 + +#### Parameters + +##### node + +[`JSDocThisTag`](JSDocThisTag.md) + +##### tagName + +`undefined` | [`Identifier`](Identifier.md) + +##### typeExpression + +`undefined` | [`JSDocTypeExpression`](JSDocTypeExpression.md) + +##### comment + +`undefined` | `string` | [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +#### Returns + +[`JSDocThisTag`](JSDocThisTag.md) + +*** + +### updateJSDocTypedefTag() + +> **updateJSDocTypedefTag**(`node`, `tagName`, `typeExpression`, `fullName`, `comment`): [`JSDocTypedefTag`](JSDocTypedefTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3946 + +#### Parameters + +##### node + +[`JSDocTypedefTag`](JSDocTypedefTag.md) + +##### tagName + +`undefined` | [`Identifier`](Identifier.md) + +##### typeExpression + +`undefined` | [`JSDocTypeLiteral`](JSDocTypeLiteral.md) | [`JSDocTypeExpression`](JSDocTypeExpression.md) + +##### fullName + +`undefined` | [`Identifier`](Identifier.md) | [`JSDocNamespaceDeclaration`](JSDocNamespaceDeclaration.md) + +##### comment + +`undefined` | `string` | [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +#### Returns + +[`JSDocTypedefTag`](JSDocTypedefTag.md) + +*** + +### updateJSDocTypeExpression() + +> **updateJSDocTypeExpression**(`node`, `type`): [`JSDocTypeExpression`](JSDocTypeExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3928 + +#### Parameters + +##### node + +[`JSDocTypeExpression`](JSDocTypeExpression.md) + +##### type + +[`TypeNode`](TypeNode.md) + +#### Returns + +[`JSDocTypeExpression`](JSDocTypeExpression.md) + +*** + +### updateJSDocTypeLiteral() + +> **updateJSDocTypeLiteral**(`node`, `jsDocPropertyTags`, `isArrayType`): [`JSDocTypeLiteral`](JSDocTypeLiteral.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3940 + +#### Parameters + +##### node + +[`JSDocTypeLiteral`](JSDocTypeLiteral.md) + +##### jsDocPropertyTags + +`undefined` | readonly [`JSDocPropertyLikeTag`](JSDocPropertyLikeTag.md)[] + +##### isArrayType + +`undefined` | `boolean` + +#### Returns + +[`JSDocTypeLiteral`](JSDocTypeLiteral.md) + +*** + +### updateJSDocTypeTag() + +> **updateJSDocTypeTag**(`node`, `tagName`, `typeExpression`, `comment`): [`JSDocTypeTag`](JSDocTypeTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3952 + +#### Parameters + +##### node + +[`JSDocTypeTag`](JSDocTypeTag.md) + +##### tagName + +`undefined` | [`Identifier`](Identifier.md) + +##### typeExpression + +[`JSDocTypeExpression`](JSDocTypeExpression.md) + +##### comment + +`undefined` | `string` | [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +#### Returns + +[`JSDocTypeTag`](JSDocTypeTag.md) + +*** + +### updateJSDocUnknownTag() + +> **updateJSDocUnknownTag**(`node`, `tagName`, `comment`): [`JSDocUnknownTag`](JSDocUnknownTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3980 + +#### Parameters + +##### node + +[`JSDocUnknownTag`](JSDocUnknownTag.md) + +##### tagName + +[`Identifier`](Identifier.md) + +##### comment + +`undefined` | `string` | [`NodeArray`](NodeArray.md)\<[`JSDocComment`](../type-aliases/JSDocComment.md)\> + +#### Returns + +[`JSDocUnknownTag`](JSDocUnknownTag.md) + +*** + +### updateJSDocVariadicType() + +> **updateJSDocVariadicType**(`node`, `type`): [`JSDocVariadicType`](JSDocVariadicType.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3924 + +#### Parameters + +##### node + +[`JSDocVariadicType`](JSDocVariadicType.md) + +##### type + +[`TypeNode`](TypeNode.md) + +#### Returns + +[`JSDocVariadicType`](JSDocVariadicType.md) + +*** + +### updateJsxAttribute() + +> **updateJsxAttribute**(`node`, `name`, `initializer`): [`JsxAttribute`](JsxAttribute.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4004 + +#### Parameters + +##### node + +[`JsxAttribute`](JsxAttribute.md) + +##### name + +[`Identifier`](Identifier.md) + +##### initializer + +`undefined` | [`JsxAttributeValue`](../type-aliases/JsxAttributeValue.md) + +#### Returns + +[`JsxAttribute`](JsxAttribute.md) + +*** + +### updateJsxAttributes() + +> **updateJsxAttributes**(`node`, `properties`): [`JsxAttributes`](JsxAttributes.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4006 + +#### Parameters + +##### node + +[`JsxAttributes`](JsxAttributes.md) + +##### properties + +readonly [`JsxAttributeLike`](../type-aliases/JsxAttributeLike.md)[] + +#### Returns + +[`JsxAttributes`](JsxAttributes.md) + +*** + +### updateJsxClosingElement() + +> **updateJsxClosingElement**(`node`, `tagName`): [`JsxClosingElement`](JsxClosingElement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3996 + +#### Parameters + +##### node + +[`JsxClosingElement`](JsxClosingElement.md) + +##### tagName + +[`JsxTagNameExpression`](../type-aliases/JsxTagNameExpression.md) + +#### Returns + +[`JsxClosingElement`](JsxClosingElement.md) + +*** + +### updateJsxElement() + +> **updateJsxElement**(`node`, `openingElement`, `children`, `closingElement`): [`JsxElement`](JsxElement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3990 + +#### Parameters + +##### node + +[`JsxElement`](JsxElement.md) + +##### openingElement + +[`JsxOpeningElement`](JsxOpeningElement.md) + +##### children + +readonly [`JsxChild`](../type-aliases/JsxChild.md)[] + +##### closingElement + +[`JsxClosingElement`](JsxClosingElement.md) + +#### Returns + +[`JsxElement`](JsxElement.md) + +*** + +### updateJsxExpression() + +> **updateJsxExpression**(`node`, `expression`): [`JsxExpression`](JsxExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4010 + +#### Parameters + +##### node + +[`JsxExpression`](JsxExpression.md) + +##### expression + +`undefined` | [`Expression`](Expression.md) + +#### Returns + +[`JsxExpression`](JsxExpression.md) + +*** + +### updateJsxFragment() + +> **updateJsxFragment**(`node`, `openingFragment`, `children`, `closingFragment`): [`JsxFragment`](JsxFragment.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4002 + +#### Parameters + +##### node + +[`JsxFragment`](JsxFragment.md) + +##### openingFragment + +[`JsxOpeningFragment`](JsxOpeningFragment.md) + +##### children + +readonly [`JsxChild`](../type-aliases/JsxChild.md)[] + +##### closingFragment + +[`JsxClosingFragment`](JsxClosingFragment.md) + +#### Returns + +[`JsxFragment`](JsxFragment.md) + +*** + +### updateJsxOpeningElement() + +> **updateJsxOpeningElement**(`node`, `tagName`, `typeArguments`, `attributes`): [`JsxOpeningElement`](JsxOpeningElement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3994 + +#### Parameters + +##### node + +[`JsxOpeningElement`](JsxOpeningElement.md) + +##### tagName + +[`JsxTagNameExpression`](../type-aliases/JsxTagNameExpression.md) + +##### typeArguments + +`undefined` | readonly [`TypeNode`](TypeNode.md)[] + +##### attributes + +[`JsxAttributes`](JsxAttributes.md) + +#### Returns + +[`JsxOpeningElement`](JsxOpeningElement.md) + +*** + +### updateJsxSelfClosingElement() + +> **updateJsxSelfClosingElement**(`node`, `tagName`, `typeArguments`, `attributes`): [`JsxSelfClosingElement`](JsxSelfClosingElement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3992 + +#### Parameters + +##### node + +[`JsxSelfClosingElement`](JsxSelfClosingElement.md) + +##### tagName + +[`JsxTagNameExpression`](../type-aliases/JsxTagNameExpression.md) + +##### typeArguments + +`undefined` | readonly [`TypeNode`](TypeNode.md)[] + +##### attributes + +[`JsxAttributes`](JsxAttributes.md) + +#### Returns + +[`JsxSelfClosingElement`](JsxSelfClosingElement.md) + +*** + +### updateJsxSpreadAttribute() + +> **updateJsxSpreadAttribute**(`node`, `expression`): [`JsxSpreadAttribute`](JsxSpreadAttribute.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4008 + +#### Parameters + +##### node + +[`JsxSpreadAttribute`](JsxSpreadAttribute.md) + +##### expression + +[`Expression`](Expression.md) + +#### Returns + +[`JsxSpreadAttribute`](JsxSpreadAttribute.md) + +*** + +### updateJsxText() + +> **updateJsxText**(`node`, `text`, `containsOnlyTriviaWhiteSpaces`?): [`JsxText`](JsxText.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3999 + +#### Parameters + +##### node + +[`JsxText`](JsxText.md) + +##### text + +`string` + +##### containsOnlyTriviaWhiteSpaces? + +`boolean` + +#### Returns + +[`JsxText`](JsxText.md) + +*** + +### updateLabeledStatement() + +> **updateLabeledStatement**(`node`, `label`, `statement`): [`LabeledStatement`](LabeledStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3853 + +#### Parameters + +##### node + +[`LabeledStatement`](LabeledStatement.md) + +##### label + +[`Identifier`](Identifier.md) + +##### statement + +[`Statement`](Statement.md) + +#### Returns + +[`LabeledStatement`](LabeledStatement.md) + +*** + +### updateLiteralTypeNode() + +> **updateLiteralTypeNode**(`node`, `literal`): [`LiteralTypeNode`](LiteralTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3735 + +#### Parameters + +##### node + +[`LiteralTypeNode`](LiteralTypeNode.md) + +##### literal + +[`LiteralExpression`](LiteralExpression.md) | [`PrefixUnaryExpression`](PrefixUnaryExpression.md) | [`NullLiteral`](NullLiteral.md) | [`BooleanLiteral`](../type-aliases/BooleanLiteral.md) + +#### Returns + +[`LiteralTypeNode`](LiteralTypeNode.md) + +*** + +### updateMappedTypeNode() + +> **updateMappedTypeNode**(`node`, `readonlyToken`, `typeParameter`, `nameType`, `questionToken`, `type`, `members`): [`MappedTypeNode`](MappedTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3733 + +#### Parameters + +##### node + +[`MappedTypeNode`](MappedTypeNode.md) + +##### readonlyToken + +`undefined` | [`ReadonlyKeyword`](../type-aliases/ReadonlyKeyword.md) | [`PlusToken`](../type-aliases/PlusToken.md) | [`MinusToken`](../type-aliases/MinusToken.md) + +##### typeParameter + +[`TypeParameterDeclaration`](TypeParameterDeclaration.md) + +##### nameType + +`undefined` | [`TypeNode`](TypeNode.md) + +##### questionToken + +`undefined` | [`QuestionToken`](../type-aliases/QuestionToken.md) | [`PlusToken`](../type-aliases/PlusToken.md) | [`MinusToken`](../type-aliases/MinusToken.md) + +##### type + +`undefined` | [`TypeNode`](TypeNode.md) + +##### members + +`undefined` | [`NodeArray`](NodeArray.md)\<[`TypeElement`](TypeElement.md)\> + +#### Returns + +[`MappedTypeNode`](MappedTypeNode.md) + +*** + +### updateMetaProperty() + +> **updateMetaProperty**(`node`, `name`): [`MetaProperty`](MetaProperty.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3817 + +#### Parameters + +##### node + +[`MetaProperty`](MetaProperty.md) + +##### name + +[`Identifier`](Identifier.md) + +#### Returns + +[`MetaProperty`](MetaProperty.md) + +*** + +### updateMethodDeclaration() + +#### Call Signature + +> **updateMethodDeclaration**(`node`, `modifiers`, `asteriskToken`, `name`, `questionToken`, `typeParameters`, `parameters`, `type`, `body`): [`MethodDeclaration`](MethodDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3675 + +##### Parameters + +###### node + +[`MethodDeclaration`](MethodDeclaration.md) + +###### modifiers + +`undefined` | readonly [`ModifierLike`](../type-aliases/ModifierLike.md)[] + +###### asteriskToken + +`undefined` | [`AsteriskToken`](../type-aliases/AsteriskToken.md) + +###### name + +[`PropertyName`](../type-aliases/PropertyName.md) + +###### questionToken + +`undefined` | [`QuestionToken`](../type-aliases/QuestionToken.md) + +###### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](TypeParameterDeclaration.md)[] + +###### parameters + +readonly [`ParameterDeclaration`](ParameterDeclaration.md)[] + +###### type + +`undefined` | [`TypeNode`](TypeNode.md) + +###### body + +`undefined` | [`Block`](Block.md) + +##### Returns + +[`MethodDeclaration`](MethodDeclaration.md) + +#### Call Signature + +> **updateMethodDeclaration**(`node`, `decorators`, `modifiers`, `asteriskToken`, `name`, `questionToken`, `typeParameters`, `parameters`, `type`, `body`): [`MethodDeclaration`](MethodDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8434 + +##### Parameters + +###### node + +[`MethodDeclaration`](MethodDeclaration.md) + +###### decorators + +`undefined` | readonly [`Decorator`](Decorator.md)[] + +###### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +###### asteriskToken + +`undefined` | [`AsteriskToken`](../type-aliases/AsteriskToken.md) + +###### name + +[`PropertyName`](../type-aliases/PropertyName.md) + +###### questionToken + +`undefined` | [`QuestionToken`](../type-aliases/QuestionToken.md) + +###### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](TypeParameterDeclaration.md)[] + +###### parameters + +readonly [`ParameterDeclaration`](ParameterDeclaration.md)[] + +###### type + +`undefined` | [`TypeNode`](TypeNode.md) + +###### body + +`undefined` | [`Block`](Block.md) + +##### Returns + +[`MethodDeclaration`](MethodDeclaration.md) + +##### Deprecated + +Decorators have been combined with modifiers. Callers should use an overload that does not accept a `decorators` parameter. + +*** + +### updateMethodSignature() + +> **updateMethodSignature**(`node`, `modifiers`, `name`, `questionToken`, `typeParameters`, `parameters`, `type`): [`MethodSignature`](MethodSignature.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3673 + +#### Parameters + +##### node + +[`MethodSignature`](MethodSignature.md) + +##### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +##### name + +[`PropertyName`](../type-aliases/PropertyName.md) + +##### questionToken + +`undefined` | [`QuestionToken`](../type-aliases/QuestionToken.md) + +##### typeParameters + +`undefined` | [`NodeArray`](NodeArray.md)\<[`TypeParameterDeclaration`](TypeParameterDeclaration.md)\> + +##### parameters + +[`NodeArray`](NodeArray.md)\<[`ParameterDeclaration`](ParameterDeclaration.md)\> + +##### type + +`undefined` | [`TypeNode`](TypeNode.md) + +#### Returns + +[`MethodSignature`](MethodSignature.md) + +*** + +### updateModuleBlock() + +> **updateModuleBlock**(`node`, `statements`): [`ModuleBlock`](ModuleBlock.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3878 + +#### Parameters + +##### node + +[`ModuleBlock`](ModuleBlock.md) + +##### statements + +readonly [`Statement`](Statement.md)[] + +#### Returns + +[`ModuleBlock`](ModuleBlock.md) + +*** + +### updateModuleDeclaration() + +#### Call Signature + +> **updateModuleDeclaration**(`node`, `modifiers`, `name`, `body`): [`ModuleDeclaration`](ModuleDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3876 + +##### Parameters + +###### node + +[`ModuleDeclaration`](ModuleDeclaration.md) + +###### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +###### name + +[`ModuleName`](../type-aliases/ModuleName.md) + +###### body + +`undefined` | [`ModuleBody`](../type-aliases/ModuleBody.md) + +##### Returns + +[`ModuleDeclaration`](ModuleDeclaration.md) + +#### Call Signature + +> **updateModuleDeclaration**(`node`, `decorators`, `modifiers`, `name`, `body`): [`ModuleDeclaration`](ModuleDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8530 + +##### Parameters + +###### node + +[`ModuleDeclaration`](ModuleDeclaration.md) + +###### decorators + +`undefined` | readonly [`Decorator`](Decorator.md)[] + +###### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +###### name + +[`ModuleName`](../type-aliases/ModuleName.md) + +###### body + +`undefined` | [`ModuleBody`](../type-aliases/ModuleBody.md) + +##### Returns + +[`ModuleDeclaration`](ModuleDeclaration.md) + +##### Deprecated + +Decorators are no longer supported for this function. Callers should use an overload that does not accept a `decorators` parameter. + +*** + +### updateNamedExports() + +> **updateNamedExports**(`node`, `elements`): [`NamedExports`](NamedExports.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3908 + +#### Parameters + +##### node + +[`NamedExports`](NamedExports.md) + +##### elements + +readonly [`ExportSpecifier`](ExportSpecifier.md)[] + +#### Returns + +[`NamedExports`](NamedExports.md) + +*** + +### updateNamedImports() + +> **updateNamedImports**(`node`, `elements`): [`NamedImports`](NamedImports.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3900 + +#### Parameters + +##### node + +[`NamedImports`](NamedImports.md) + +##### elements + +readonly [`ImportSpecifier`](ImportSpecifier.md)[] + +#### Returns + +[`NamedImports`](NamedImports.md) + +*** + +### updateNamedTupleMember() + +> **updateNamedTupleMember**(`node`, `dotDotDotToken`, `name`, `questionToken`, `type`): [`NamedTupleMember`](NamedTupleMember.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3710 + +#### Parameters + +##### node + +[`NamedTupleMember`](NamedTupleMember.md) + +##### dotDotDotToken + +`undefined` | [`DotDotDotToken`](../type-aliases/DotDotDotToken.md) + +##### name + +[`Identifier`](Identifier.md) + +##### questionToken + +`undefined` | [`QuestionToken`](../type-aliases/QuestionToken.md) + +##### type + +[`TypeNode`](TypeNode.md) + +#### Returns + +[`NamedTupleMember`](NamedTupleMember.md) + +*** + +### updateNamespaceExport() + +> **updateNamespaceExport**(`node`, `name`): [`NamespaceExport`](NamespaceExport.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3898 + +#### Parameters + +##### node + +[`NamespaceExport`](NamespaceExport.md) + +##### name + +[`Identifier`](Identifier.md) + +#### Returns + +[`NamespaceExport`](NamespaceExport.md) + +*** + +### updateNamespaceExportDeclaration() + +> **updateNamespaceExportDeclaration**(`node`, `name`): [`NamespaceExportDeclaration`](NamespaceExportDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3882 + +#### Parameters + +##### node + +[`NamespaceExportDeclaration`](NamespaceExportDeclaration.md) + +##### name + +[`Identifier`](Identifier.md) + +#### Returns + +[`NamespaceExportDeclaration`](NamespaceExportDeclaration.md) + +*** + +### updateNamespaceImport() + +> **updateNamespaceImport**(`node`, `name`): [`NamespaceImport`](NamespaceImport.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3896 + +#### Parameters + +##### node + +[`NamespaceImport`](NamespaceImport.md) + +##### name + +[`Identifier`](Identifier.md) + +#### Returns + +[`NamespaceImport`](NamespaceImport.md) + +*** + +### updateNewExpression() + +> **updateNewExpression**(`node`, `expression`, `typeArguments`, `argumentsArray`): [`NewExpression`](NewExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3761 + +#### Parameters + +##### node + +[`NewExpression`](NewExpression.md) + +##### expression + +[`Expression`](Expression.md) + +##### typeArguments + +`undefined` | readonly [`TypeNode`](TypeNode.md)[] + +##### argumentsArray + +`undefined` | readonly [`Expression`](Expression.md)[] + +#### Returns + +[`NewExpression`](NewExpression.md) + +*** + +### updateNonNullChain() + +> **updateNonNullChain**(`node`, `expression`): [`NonNullChain`](NonNullChain.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3815 + +#### Parameters + +##### node + +[`NonNullChain`](NonNullChain.md) + +##### expression + +[`Expression`](Expression.md) + +#### Returns + +[`NonNullChain`](NonNullChain.md) + +*** + +### updateNonNullExpression() + +> **updateNonNullExpression**(`node`, `expression`): [`NonNullExpression`](NonNullExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3813 + +#### Parameters + +##### node + +[`NonNullExpression`](NonNullExpression.md) + +##### expression + +[`Expression`](Expression.md) + +#### Returns + +[`NonNullExpression`](NonNullExpression.md) + +*** + +### updateObjectBindingPattern() + +> **updateObjectBindingPattern**(`node`, `elements`): [`ObjectBindingPattern`](ObjectBindingPattern.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3739 + +#### Parameters + +##### node + +[`ObjectBindingPattern`](ObjectBindingPattern.md) + +##### elements + +readonly [`BindingElement`](BindingElement.md)[] + +#### Returns + +[`ObjectBindingPattern`](ObjectBindingPattern.md) + +*** + +### updateObjectLiteralExpression() + +> **updateObjectLiteralExpression**(`node`, `properties`): [`ObjectLiteralExpression`](ObjectLiteralExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3747 + +#### Parameters + +##### node + +[`ObjectLiteralExpression`](ObjectLiteralExpression.md) + +##### properties + +readonly [`ObjectLiteralElementLike`](../type-aliases/ObjectLiteralElementLike.md)[] + +#### Returns + +[`ObjectLiteralExpression`](ObjectLiteralExpression.md) + +*** + +### updateOptionalTypeNode() + +> **updateOptionalTypeNode**(`node`, `type`): [`OptionalTypeNode`](OptionalTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3712 + +#### Parameters + +##### node + +[`OptionalTypeNode`](OptionalTypeNode.md) + +##### type + +[`TypeNode`](TypeNode.md) + +#### Returns + +[`OptionalTypeNode`](OptionalTypeNode.md) + +*** + +### updateParameterDeclaration() + +#### Call Signature + +> **updateParameterDeclaration**(`node`, `modifiers`, `dotDotDotToken`, `name`, `questionToken`, `type`, `initializer`): [`ParameterDeclaration`](ParameterDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3665 + +##### Parameters + +###### node + +[`ParameterDeclaration`](ParameterDeclaration.md) + +###### modifiers + +`undefined` | readonly [`ModifierLike`](../type-aliases/ModifierLike.md)[] + +###### dotDotDotToken + +`undefined` | [`DotDotDotToken`](../type-aliases/DotDotDotToken.md) + +###### name + +`string` | [`BindingName`](../type-aliases/BindingName.md) + +###### questionToken + +`undefined` | [`QuestionToken`](../type-aliases/QuestionToken.md) + +###### type + +`undefined` | [`TypeNode`](TypeNode.md) + +###### initializer + +`undefined` | [`Expression`](Expression.md) + +##### Returns + +[`ParameterDeclaration`](ParameterDeclaration.md) + +#### Call Signature + +> **updateParameterDeclaration**(`node`, `decorators`, `modifiers`, `dotDotDotToken`, `name`, `questionToken`, `type`, `initializer`): [`ParameterDeclaration`](ParameterDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8418 + +##### Parameters + +###### node + +[`ParameterDeclaration`](ParameterDeclaration.md) + +###### decorators + +`undefined` | readonly [`Decorator`](Decorator.md)[] + +###### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +###### dotDotDotToken + +`undefined` | [`DotDotDotToken`](../type-aliases/DotDotDotToken.md) + +###### name + +`string` | [`BindingName`](../type-aliases/BindingName.md) + +###### questionToken + +`undefined` | [`QuestionToken`](../type-aliases/QuestionToken.md) + +###### type + +`undefined` | [`TypeNode`](TypeNode.md) + +###### initializer + +`undefined` | [`Expression`](Expression.md) + +##### Returns + +[`ParameterDeclaration`](ParameterDeclaration.md) + +##### Deprecated + +Decorators have been combined with modifiers. Callers should use an overload that does not accept a `decorators` parameter. + +*** + +### updateParenthesizedExpression() + +> **updateParenthesizedExpression**(`node`, `expression`): [`ParenthesizedExpression`](ParenthesizedExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3767 + +#### Parameters + +##### node + +[`ParenthesizedExpression`](ParenthesizedExpression.md) + +##### expression + +[`Expression`](Expression.md) + +#### Returns + +[`ParenthesizedExpression`](ParenthesizedExpression.md) + +*** + +### updateParenthesizedType() + +> **updateParenthesizedType**(`node`, `type`): [`ParenthesizedTypeNode`](ParenthesizedTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3726 + +#### Parameters + +##### node + +[`ParenthesizedTypeNode`](ParenthesizedTypeNode.md) + +##### type + +[`TypeNode`](TypeNode.md) + +#### Returns + +[`ParenthesizedTypeNode`](ParenthesizedTypeNode.md) + +*** + +### updatePartiallyEmittedExpression() + +> **updatePartiallyEmittedExpression**(`node`, `expression`): [`PartiallyEmittedExpression`](PartiallyEmittedExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4031 + +#### Parameters + +##### node + +[`PartiallyEmittedExpression`](PartiallyEmittedExpression.md) + +##### expression + +[`Expression`](Expression.md) + +#### Returns + +[`PartiallyEmittedExpression`](PartiallyEmittedExpression.md) + +*** + +### updatePostfixUnaryExpression() + +> **updatePostfixUnaryExpression**(`node`, `operand`): [`PostfixUnaryExpression`](PostfixUnaryExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3785 + +#### Parameters + +##### node + +[`PostfixUnaryExpression`](PostfixUnaryExpression.md) + +##### operand + +[`Expression`](Expression.md) + +#### Returns + +[`PostfixUnaryExpression`](PostfixUnaryExpression.md) + +*** + +### updatePrefixUnaryExpression() + +> **updatePrefixUnaryExpression**(`node`, `operand`): [`PrefixUnaryExpression`](PrefixUnaryExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3783 + +#### Parameters + +##### node + +[`PrefixUnaryExpression`](PrefixUnaryExpression.md) + +##### operand + +[`Expression`](Expression.md) + +#### Returns + +[`PrefixUnaryExpression`](PrefixUnaryExpression.md) + +*** + +### updatePropertyAccessChain() + +> **updatePropertyAccessChain**(`node`, `expression`, `questionDotToken`, `name`): [`PropertyAccessChain`](PropertyAccessChain.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3751 + +#### Parameters + +##### node + +[`PropertyAccessChain`](PropertyAccessChain.md) + +##### expression + +[`Expression`](Expression.md) + +##### questionDotToken + +`undefined` | [`QuestionDotToken`](../type-aliases/QuestionDotToken.md) + +##### name + +[`MemberName`](../type-aliases/MemberName.md) + +#### Returns + +[`PropertyAccessChain`](PropertyAccessChain.md) + +*** + +### updatePropertyAccessExpression() + +> **updatePropertyAccessExpression**(`node`, `expression`, `name`): [`PropertyAccessExpression`](PropertyAccessExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3749 + +#### Parameters + +##### node + +[`PropertyAccessExpression`](PropertyAccessExpression.md) + +##### expression + +[`Expression`](Expression.md) + +##### name + +[`MemberName`](../type-aliases/MemberName.md) + +#### Returns + +[`PropertyAccessExpression`](PropertyAccessExpression.md) + +*** + +### updatePropertyAssignment() + +> **updatePropertyAssignment**(`node`, `name`, `initializer`): [`PropertyAssignment`](PropertyAssignment.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4020 + +#### Parameters + +##### node + +[`PropertyAssignment`](PropertyAssignment.md) + +##### name + +[`PropertyName`](../type-aliases/PropertyName.md) + +##### initializer + +[`Expression`](Expression.md) + +#### Returns + +[`PropertyAssignment`](PropertyAssignment.md) + +*** + +### updatePropertyDeclaration() + +#### Call Signature + +> **updatePropertyDeclaration**(`node`, `modifiers`, `name`, `questionOrExclamationToken`, `type`, `initializer`): [`PropertyDeclaration`](PropertyDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3671 + +##### Parameters + +###### node + +[`PropertyDeclaration`](PropertyDeclaration.md) + +###### modifiers + +`undefined` | readonly [`ModifierLike`](../type-aliases/ModifierLike.md)[] + +###### name + +`string` | [`PropertyName`](../type-aliases/PropertyName.md) + +###### questionOrExclamationToken + +`undefined` | [`QuestionToken`](../type-aliases/QuestionToken.md) | [`ExclamationToken`](../type-aliases/ExclamationToken.md) + +###### type + +`undefined` | [`TypeNode`](TypeNode.md) + +###### initializer + +`undefined` | [`Expression`](Expression.md) + +##### Returns + +[`PropertyDeclaration`](PropertyDeclaration.md) + +#### Call Signature + +> **updatePropertyDeclaration**(`node`, `decorators`, `modifiers`, `name`, `questionOrExclamationToken`, `type`, `initializer`): [`PropertyDeclaration`](PropertyDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8426 + +##### Parameters + +###### node + +[`PropertyDeclaration`](PropertyDeclaration.md) + +###### decorators + +`undefined` | readonly [`Decorator`](Decorator.md)[] + +###### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +###### name + +`string` | [`PropertyName`](../type-aliases/PropertyName.md) + +###### questionOrExclamationToken + +`undefined` | [`QuestionToken`](../type-aliases/QuestionToken.md) | [`ExclamationToken`](../type-aliases/ExclamationToken.md) + +###### type + +`undefined` | [`TypeNode`](TypeNode.md) + +###### initializer + +`undefined` | [`Expression`](Expression.md) + +##### Returns + +[`PropertyDeclaration`](PropertyDeclaration.md) + +##### Deprecated + +Decorators have been combined with modifiers. Callers should use an overload that does not accept a `decorators` parameter. + +*** + +### updatePropertySignature() + +> **updatePropertySignature**(`node`, `modifiers`, `name`, `questionToken`, `type`): [`PropertySignature`](PropertySignature.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3669 + +#### Parameters + +##### node + +[`PropertySignature`](PropertySignature.md) + +##### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +##### name + +[`PropertyName`](../type-aliases/PropertyName.md) + +##### questionToken + +`undefined` | [`QuestionToken`](../type-aliases/QuestionToken.md) + +##### type + +`undefined` | [`TypeNode`](TypeNode.md) + +#### Returns + +[`PropertySignature`](PropertySignature.md) + +*** + +### updateQualifiedName() + +> **updateQualifiedName**(`node`, `left`, `right`): [`QualifiedName`](QualifiedName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3659 + +#### Parameters + +##### node + +[`QualifiedName`](QualifiedName.md) + +##### left + +[`EntityName`](../type-aliases/EntityName.md) + +##### right + +[`Identifier`](Identifier.md) + +#### Returns + +[`QualifiedName`](QualifiedName.md) + +*** + +### updateRestTypeNode() + +> **updateRestTypeNode**(`node`, `type`): [`RestTypeNode`](RestTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3714 + +#### Parameters + +##### node + +[`RestTypeNode`](RestTypeNode.md) + +##### type + +[`TypeNode`](TypeNode.md) + +#### Returns + +[`RestTypeNode`](RestTypeNode.md) + +*** + +### updateReturnStatement() + +> **updateReturnStatement**(`node`, `expression`): [`ReturnStatement`](ReturnStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3847 + +#### Parameters + +##### node + +[`ReturnStatement`](ReturnStatement.md) + +##### expression + +`undefined` | [`Expression`](Expression.md) + +#### Returns + +[`ReturnStatement`](ReturnStatement.md) + +*** + +### updateSatisfiesExpression() + +> **updateSatisfiesExpression**(`node`, `expression`, `type`): [`SatisfiesExpression`](SatisfiesExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3819 + +#### Parameters + +##### node + +[`SatisfiesExpression`](SatisfiesExpression.md) + +##### expression + +[`Expression`](Expression.md) + +##### type + +[`TypeNode`](TypeNode.md) + +#### Returns + +[`SatisfiesExpression`](SatisfiesExpression.md) + +*** + +### updateSetAccessorDeclaration() + +#### Call Signature + +> **updateSetAccessorDeclaration**(`node`, `modifiers`, `name`, `parameters`, `body`): [`SetAccessorDeclaration`](SetAccessorDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3681 + +##### Parameters + +###### node + +[`SetAccessorDeclaration`](SetAccessorDeclaration.md) + +###### modifiers + +`undefined` | readonly [`ModifierLike`](../type-aliases/ModifierLike.md)[] + +###### name + +[`PropertyName`](../type-aliases/PropertyName.md) + +###### parameters + +readonly [`ParameterDeclaration`](ParameterDeclaration.md)[] + +###### body + +`undefined` | [`Block`](Block.md) + +##### Returns + +[`SetAccessorDeclaration`](SetAccessorDeclaration.md) + +#### Call Signature + +> **updateSetAccessorDeclaration**(`node`, `decorators`, `modifiers`, `name`, `parameters`, `body`): [`SetAccessorDeclaration`](SetAccessorDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8458 + +##### Parameters + +###### node + +[`SetAccessorDeclaration`](SetAccessorDeclaration.md) + +###### decorators + +`undefined` | readonly [`Decorator`](Decorator.md)[] + +###### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +###### name + +[`PropertyName`](../type-aliases/PropertyName.md) + +###### parameters + +readonly [`ParameterDeclaration`](ParameterDeclaration.md)[] + +###### body + +`undefined` | [`Block`](Block.md) + +##### Returns + +[`SetAccessorDeclaration`](SetAccessorDeclaration.md) + +##### Deprecated + +Decorators have been combined with modifiers. Callers should use an overload that does not accept a `decorators` parameter. + +*** + +### updateShorthandPropertyAssignment() + +> **updateShorthandPropertyAssignment**(`node`, `name`, `objectAssignmentInitializer`): [`ShorthandPropertyAssignment`](ShorthandPropertyAssignment.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4022 + +#### Parameters + +##### node + +[`ShorthandPropertyAssignment`](ShorthandPropertyAssignment.md) + +##### name + +[`Identifier`](Identifier.md) + +##### objectAssignmentInitializer + +`undefined` | [`Expression`](Expression.md) + +#### Returns + +[`ShorthandPropertyAssignment`](ShorthandPropertyAssignment.md) + +*** + +### updateSourceFile() + +> **updateSourceFile**(`node`, `statements`, `isDeclarationFile`?, `referencedFiles`?, `typeReferences`?, `hasNoDefaultLib`?, `libReferences`?): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4028 + +#### Parameters + +##### node + +[`SourceFile`](SourceFile.md) + +##### statements + +readonly [`Statement`](Statement.md)[] + +##### isDeclarationFile? + +`boolean` + +##### referencedFiles? + +readonly [`FileReference`](FileReference.md)[] + +##### typeReferences? + +readonly [`FileReference`](FileReference.md)[] + +##### hasNoDefaultLib? + +`boolean` + +##### libReferences? + +readonly [`FileReference`](FileReference.md)[] + +#### Returns + +[`SourceFile`](SourceFile.md) + +*** + +### updateSpreadAssignment() + +> **updateSpreadAssignment**(`node`, `expression`): [`SpreadAssignment`](SpreadAssignment.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4024 + +#### Parameters + +##### node + +[`SpreadAssignment`](SpreadAssignment.md) + +##### expression + +[`Expression`](Expression.md) + +#### Returns + +[`SpreadAssignment`](SpreadAssignment.md) + +*** + +### updateSpreadElement() + +> **updateSpreadElement**(`node`, `expression`): [`SpreadElement`](SpreadElement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3804 + +#### Parameters + +##### node + +[`SpreadElement`](SpreadElement.md) + +##### expression + +[`Expression`](Expression.md) + +#### Returns + +[`SpreadElement`](SpreadElement.md) + +*** + +### updateStructDeclaration() + +> **updateStructDeclaration**(`node`, `modifiers`, `name`, `typeParameters`, `heritageClauses`, `members`): [`StructDeclaration`](StructDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3868 + +#### Parameters + +##### node + +[`StructDeclaration`](StructDeclaration.md) + +##### modifiers + +`undefined` | readonly [`ModifierLike`](../type-aliases/ModifierLike.md)[] + +##### name + +`undefined` | [`Identifier`](Identifier.md) + +##### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](TypeParameterDeclaration.md)[] + +##### heritageClauses + +`undefined` | readonly [`HeritageClause`](HeritageClause.md)[] + +##### members + +readonly [`ClassElement`](ClassElement.md)[] + +#### Returns + +[`StructDeclaration`](StructDeclaration.md) + +*** + +### updateSwitchStatement() + +> **updateSwitchStatement**(`node`, `expression`, `caseBlock`): [`SwitchStatement`](SwitchStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3851 + +#### Parameters + +##### node + +[`SwitchStatement`](SwitchStatement.md) + +##### expression + +[`Expression`](Expression.md) + +##### caseBlock + +[`CaseBlock`](CaseBlock.md) + +#### Returns + +[`SwitchStatement`](SwitchStatement.md) + +*** + +### updateTaggedTemplateExpression() + +> **updateTaggedTemplateExpression**(`node`, `tag`, `typeArguments`, `template`): [`TaggedTemplateExpression`](TaggedTemplateExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3763 + +#### Parameters + +##### node + +[`TaggedTemplateExpression`](TaggedTemplateExpression.md) + +##### tag + +[`Expression`](Expression.md) + +##### typeArguments + +`undefined` | readonly [`TypeNode`](TypeNode.md)[] + +##### template + +[`TemplateLiteral`](../type-aliases/TemplateLiteral.md) + +#### Returns + +[`TaggedTemplateExpression`](TaggedTemplateExpression.md) + +*** + +### updateTemplateExpression() + +> **updateTemplateExpression**(`node`, `head`, `templateSpans`): [`TemplateExpression`](TemplateExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3791 + +#### Parameters + +##### node + +[`TemplateExpression`](TemplateExpression.md) + +##### head + +[`TemplateHead`](TemplateHead.md) + +##### templateSpans + +readonly [`TemplateSpan`](TemplateSpan.md)[] + +#### Returns + +[`TemplateExpression`](TemplateExpression.md) + +*** + +### updateTemplateLiteralType() + +> **updateTemplateLiteralType**(`node`, `head`, `templateSpans`): [`TemplateLiteralTypeNode`](TemplateLiteralTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3737 + +#### Parameters + +##### node + +[`TemplateLiteralTypeNode`](TemplateLiteralTypeNode.md) + +##### head + +[`TemplateHead`](TemplateHead.md) + +##### templateSpans + +readonly [`TemplateLiteralTypeSpan`](TemplateLiteralTypeSpan.md)[] + +#### Returns + +[`TemplateLiteralTypeNode`](TemplateLiteralTypeNode.md) + +*** + +### updateTemplateLiteralTypeSpan() + +> **updateTemplateLiteralTypeSpan**(`node`, `type`, `literal`): [`TemplateLiteralTypeSpan`](TemplateLiteralTypeSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3689 + +#### Parameters + +##### node + +[`TemplateLiteralTypeSpan`](TemplateLiteralTypeSpan.md) + +##### type + +[`TypeNode`](TypeNode.md) + +##### literal + +[`TemplateMiddle`](TemplateMiddle.md) | [`TemplateTail`](TemplateTail.md) + +#### Returns + +[`TemplateLiteralTypeSpan`](TemplateLiteralTypeSpan.md) + +*** + +### updateTemplateSpan() + +> **updateTemplateSpan**(`node`, `expression`, `literal`): [`TemplateSpan`](TemplateSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3821 + +#### Parameters + +##### node + +[`TemplateSpan`](TemplateSpan.md) + +##### expression + +[`Expression`](Expression.md) + +##### literal + +[`TemplateMiddle`](TemplateMiddle.md) | [`TemplateTail`](TemplateTail.md) + +#### Returns + +[`TemplateSpan`](TemplateSpan.md) + +*** + +### updateThrowStatement() + +> **updateThrowStatement**(`node`, `expression`): [`ThrowStatement`](ThrowStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3855 + +#### Parameters + +##### node + +[`ThrowStatement`](ThrowStatement.md) + +##### expression + +[`Expression`](Expression.md) + +#### Returns + +[`ThrowStatement`](ThrowStatement.md) + +*** + +### updateTryStatement() + +> **updateTryStatement**(`node`, `tryBlock`, `catchClause`, `finallyBlock`): [`TryStatement`](TryStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3857 + +#### Parameters + +##### node + +[`TryStatement`](TryStatement.md) + +##### tryBlock + +[`Block`](Block.md) + +##### catchClause + +`undefined` | [`CatchClause`](CatchClause.md) + +##### finallyBlock + +`undefined` | [`Block`](Block.md) + +#### Returns + +[`TryStatement`](TryStatement.md) + +*** + +### updateTupleTypeNode() + +> **updateTupleTypeNode**(`node`, `elements`): [`TupleTypeNode`](TupleTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3708 + +#### Parameters + +##### node + +[`TupleTypeNode`](TupleTypeNode.md) + +##### elements + +readonly ([`TypeNode`](TypeNode.md) \| [`NamedTupleMember`](NamedTupleMember.md))[] + +#### Returns + +[`TupleTypeNode`](TupleTypeNode.md) + +*** + +### updateTypeAliasDeclaration() + +#### Call Signature + +> **updateTypeAliasDeclaration**(`node`, `modifiers`, `name`, `typeParameters`, `type`): [`TypeAliasDeclaration`](TypeAliasDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3872 + +##### Parameters + +###### node + +[`TypeAliasDeclaration`](TypeAliasDeclaration.md) + +###### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +###### name + +[`Identifier`](Identifier.md) + +###### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](TypeParameterDeclaration.md)[] + +###### type + +[`TypeNode`](TypeNode.md) + +##### Returns + +[`TypeAliasDeclaration`](TypeAliasDeclaration.md) + +#### Call Signature + +> **updateTypeAliasDeclaration**(`node`, `decorators`, `modifiers`, `name`, `typeParameters`, `type`): [`TypeAliasDeclaration`](TypeAliasDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8514 + +##### Parameters + +###### node + +[`TypeAliasDeclaration`](TypeAliasDeclaration.md) + +###### decorators + +`undefined` | readonly [`Decorator`](Decorator.md)[] + +###### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +###### name + +[`Identifier`](Identifier.md) + +###### typeParameters + +`undefined` | readonly [`TypeParameterDeclaration`](TypeParameterDeclaration.md)[] + +###### type + +[`TypeNode`](TypeNode.md) + +##### Returns + +[`TypeAliasDeclaration`](TypeAliasDeclaration.md) + +##### Deprecated + +Decorators are no longer supported for this function. Callers should use an overload that does not accept a `decorators` parameter. + +*** + +### updateTypeAssertion() + +> **updateTypeAssertion**(`node`, `type`, `expression`): [`TypeAssertion`](TypeAssertion.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3765 + +#### Parameters + +##### node + +[`TypeAssertion`](TypeAssertion.md) + +##### type + +[`TypeNode`](TypeNode.md) + +##### expression + +[`Expression`](Expression.md) + +#### Returns + +[`TypeAssertion`](TypeAssertion.md) + +*** + +### updateTypeLiteralNode() + +> **updateTypeLiteralNode**(`node`, `members`): [`TypeLiteralNode`](TypeLiteralNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3704 + +#### Parameters + +##### node + +[`TypeLiteralNode`](TypeLiteralNode.md) + +##### members + +[`NodeArray`](NodeArray.md)\<[`TypeElement`](TypeElement.md)\> + +#### Returns + +[`TypeLiteralNode`](TypeLiteralNode.md) + +*** + +### updateTypeOfExpression() + +> **updateTypeOfExpression**(`node`, `expression`): [`TypeOfExpression`](TypeOfExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3777 + +#### Parameters + +##### node + +[`TypeOfExpression`](TypeOfExpression.md) + +##### expression + +[`Expression`](Expression.md) + +#### Returns + +[`TypeOfExpression`](TypeOfExpression.md) + +*** + +### updateTypeOperatorNode() + +> **updateTypeOperatorNode**(`node`, `type`): [`TypeOperatorNode`](TypeOperatorNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3729 + +#### Parameters + +##### node + +[`TypeOperatorNode`](TypeOperatorNode.md) + +##### type + +[`TypeNode`](TypeNode.md) + +#### Returns + +[`TypeOperatorNode`](TypeOperatorNode.md) + +*** + +### updateTypeParameterDeclaration() + +#### Call Signature + +> **updateTypeParameterDeclaration**(`node`, `modifiers`, `name`, `constraint`, `defaultType`): [`TypeParameterDeclaration`](TypeParameterDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3663 + +##### Parameters + +###### node + +[`TypeParameterDeclaration`](TypeParameterDeclaration.md) + +###### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +###### name + +[`Identifier`](Identifier.md) + +###### constraint + +`undefined` | [`TypeNode`](TypeNode.md) + +###### defaultType + +`undefined` | [`TypeNode`](TypeNode.md) + +##### Returns + +[`TypeParameterDeclaration`](TypeParameterDeclaration.md) + +#### Call Signature + +> **updateTypeParameterDeclaration**(`node`, `name`, `constraint`, `defaultType`): [`TypeParameterDeclaration`](TypeParameterDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8360 + +##### Parameters + +###### node + +[`TypeParameterDeclaration`](TypeParameterDeclaration.md) + +###### name + +[`Identifier`](Identifier.md) + +###### constraint + +`undefined` | [`TypeNode`](TypeNode.md) + +###### defaultType + +`undefined` | [`TypeNode`](TypeNode.md) + +##### Returns + +[`TypeParameterDeclaration`](TypeParameterDeclaration.md) + +##### Deprecated + +Use the overload that accepts 'modifiers' + +*** + +### updateTypePredicateNode() + +> **updateTypePredicateNode**(`node`, `assertsModifier`, `parameterName`, `type`): [`TypePredicateNode`](TypePredicateNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3694 + +#### Parameters + +##### node + +[`TypePredicateNode`](TypePredicateNode.md) + +##### assertsModifier + +`undefined` | [`AssertsKeyword`](../type-aliases/AssertsKeyword.md) + +##### parameterName + +[`Identifier`](Identifier.md) | [`ThisTypeNode`](ThisTypeNode.md) + +##### type + +`undefined` | [`TypeNode`](TypeNode.md) + +#### Returns + +[`TypePredicateNode`](TypePredicateNode.md) + +*** + +### updateTypeQueryNode() + +> **updateTypeQueryNode**(`node`, `exprName`, `typeArguments`?): [`TypeQueryNode`](TypeQueryNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3702 + +#### Parameters + +##### node + +[`TypeQueryNode`](TypeQueryNode.md) + +##### exprName + +[`EntityName`](../type-aliases/EntityName.md) + +##### typeArguments? + +readonly [`TypeNode`](TypeNode.md)[] + +#### Returns + +[`TypeQueryNode`](TypeQueryNode.md) + +*** + +### updateTypeReferenceNode() + +> **updateTypeReferenceNode**(`node`, `typeName`, `typeArguments`): [`TypeReferenceNode`](TypeReferenceNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3696 + +#### Parameters + +##### node + +[`TypeReferenceNode`](TypeReferenceNode.md) + +##### typeName + +[`EntityName`](../type-aliases/EntityName.md) + +##### typeArguments + +`undefined` | [`NodeArray`](NodeArray.md)\<[`TypeNode`](TypeNode.md)\> + +#### Returns + +[`TypeReferenceNode`](TypeReferenceNode.md) + +*** + +### updateUnionTypeNode() + +> **updateUnionTypeNode**(`node`, `types`): [`UnionTypeNode`](UnionTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3716 + +#### Parameters + +##### node + +[`UnionTypeNode`](UnionTypeNode.md) + +##### types + +[`NodeArray`](NodeArray.md)\<[`TypeNode`](TypeNode.md)\> + +#### Returns + +[`UnionTypeNode`](UnionTypeNode.md) + +*** + +### updateVariableDeclaration() + +> **updateVariableDeclaration**(`node`, `name`, `exclamationToken`, `type`, `initializer`): [`VariableDeclaration`](VariableDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3860 + +#### Parameters + +##### node + +[`VariableDeclaration`](VariableDeclaration.md) + +##### name + +[`BindingName`](../type-aliases/BindingName.md) + +##### exclamationToken + +`undefined` | [`ExclamationToken`](../type-aliases/ExclamationToken.md) + +##### type + +`undefined` | [`TypeNode`](TypeNode.md) + +##### initializer + +`undefined` | [`Expression`](Expression.md) + +#### Returns + +[`VariableDeclaration`](VariableDeclaration.md) + +*** + +### updateVariableDeclarationList() + +> **updateVariableDeclarationList**(`node`, `declarations`): [`VariableDeclarationList`](VariableDeclarationList.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3862 + +#### Parameters + +##### node + +[`VariableDeclarationList`](VariableDeclarationList.md) + +##### declarations + +readonly [`VariableDeclaration`](VariableDeclaration.md)[] + +#### Returns + +[`VariableDeclarationList`](VariableDeclarationList.md) + +*** + +### updateVariableStatement() + +> **updateVariableStatement**(`node`, `modifiers`, `declarationList`): [`VariableStatement`](VariableStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3826 + +#### Parameters + +##### node + +[`VariableStatement`](VariableStatement.md) + +##### modifiers + +`undefined` | readonly [`Modifier`](../type-aliases/Modifier.md)[] + +##### declarationList + +[`VariableDeclarationList`](VariableDeclarationList.md) + +#### Returns + +[`VariableStatement`](VariableStatement.md) + +*** + +### updateVoidExpression() + +> **updateVoidExpression**(`node`, `expression`): [`VoidExpression`](VoidExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3779 + +#### Parameters + +##### node + +[`VoidExpression`](VoidExpression.md) + +##### expression + +[`Expression`](Expression.md) + +#### Returns + +[`VoidExpression`](VoidExpression.md) + +*** + +### updateWhileStatement() + +> **updateWhileStatement**(`node`, `expression`, `statement`): [`WhileStatement`](WhileStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3835 + +#### Parameters + +##### node + +[`WhileStatement`](WhileStatement.md) + +##### expression + +[`Expression`](Expression.md) + +##### statement + +[`Statement`](Statement.md) + +#### Returns + +[`WhileStatement`](WhileStatement.md) + +*** + +### updateWithStatement() + +> **updateWithStatement**(`node`, `expression`, `statement`): [`WithStatement`](WithStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3849 + +#### Parameters + +##### node + +[`WithStatement`](WithStatement.md) + +##### expression + +[`Expression`](Expression.md) + +##### statement + +[`Statement`](Statement.md) + +#### Returns + +[`WithStatement`](WithStatement.md) + +*** + +### updateYieldExpression() + +> **updateYieldExpression**(`node`, `asteriskToken`, `expression`): [`YieldExpression`](YieldExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3802 + +#### Parameters + +##### node + +[`YieldExpression`](YieldExpression.md) + +##### asteriskToken + +`undefined` | [`AsteriskToken`](../type-aliases/AsteriskToken.md) + +##### expression + +`undefined` | [`Expression`](Expression.md) + +#### Returns + +[`YieldExpression`](YieldExpression.md) diff --git a/docs/api_docs/namespaces/ts/interfaces/NodeVisitor.md b/docs/api_docs/namespaces/ts/interfaces/NodeVisitor.md new file mode 100644 index 0000000000000000000000000000000000000000..4d72b2f82e4a943a86b8a4d06540277d8ec64317 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/NodeVisitor.md @@ -0,0 +1,69 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / NodeVisitor + +# Interface: NodeVisitor() + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4177 + +> **NodeVisitor**\<`T`\>(`nodes`, `visitor`, `test`?, `lift`?): `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4178 + +## Type Parameters + +• **T** *extends* [`Node`](Node.md) + +## Parameters + +### nodes + +`T` + +### visitor + +`undefined` | [`Visitor`](../type-aliases/Visitor.md) + +### test? + +(`node`) => `boolean` + +### lift? + +(`node`) => `T` + +## Returns + +`T` + +> **NodeVisitor**\<`T`\>(`nodes`, `visitor`, `test`?, `lift`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4179 + +## Type Parameters + +• **T** *extends* [`Node`](Node.md) + +## Parameters + +### nodes + +`undefined` | `T` + +### visitor + +`undefined` | [`Visitor`](../type-aliases/Visitor.md) + +### test? + +(`node`) => `boolean` + +### lift? + +(`node`) => `T` + +## Returns + +`undefined` \| `T` diff --git a/docs/api_docs/namespaces/ts/interfaces/NodeWithTypeArguments.md b/docs/api_docs/namespaces/ts/interfaces/NodeWithTypeArguments.md new file mode 100644 index 0000000000000000000000000000000000000000..6de6fbc401f1154f8d787df7a6cb273824ce4d81 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/NodeWithTypeArguments.md @@ -0,0 +1,504 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / NodeWithTypeArguments + +# Interface: NodeWithTypeArguments + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:945 + +## Extends + +- [`TypeNode`](TypeNode.md) + +## Extended by + +- [`ImportTypeNode`](ImportTypeNode.md) +- [`TypeReferenceNode`](TypeReferenceNode.md) +- [`TypeQueryNode`](TypeQueryNode.md) +- [`ExpressionWithTypeArguments`](ExpressionWithTypeArguments.md) + +## Properties + +### \_typeNodeBrand + +> **\_typeNodeBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:912 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`_typeNodeBrand`](TypeNode.md#_typenodebrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`decorators`](TypeNode.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`end`](TypeNode.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`flags`](TypeNode.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`SyntaxKind`](../enumerations/SyntaxKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:598 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`kind`](TypeNode.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`locals`](TypeNode.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`modifiers`](TypeNode.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`parent`](TypeNode.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`pos`](TypeNode.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`skipCheck`](TypeNode.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`symbol`](TypeNode.md#symbol) + +*** + +### typeArguments? + +> `readonly` `optional` **typeArguments**: [`NodeArray`](NodeArray.md)\<[`TypeNode`](TypeNode.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:946 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`forEachChild`](TypeNode.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getChildAt`](TypeNode.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getChildCount`](TypeNode.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getChildren`](TypeNode.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getEnd`](TypeNode.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFirstToken`](TypeNode.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFullStart`](TypeNode.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFullText`](TypeNode.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFullWidth`](TypeNode.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getLastToken`](TypeNode.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getLeadingTriviaWidth`](TypeNode.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getSourceFile`](TypeNode.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getStart`](TypeNode.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getText`](TypeNode.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getWidth`](TypeNode.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/NodesVisitor.md b/docs/api_docs/namespaces/ts/interfaces/NodesVisitor.md new file mode 100644 index 0000000000000000000000000000000000000000..d2eebdc8d2680b1cbf92d57df7261bd089bee31a --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/NodesVisitor.md @@ -0,0 +1,77 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / NodesVisitor + +# Interface: NodesVisitor() + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4181 + +> **NodesVisitor**\<`T`\>(`nodes`, `visitor`, `test`?, `start`?, `count`?): [`NodeArray`](NodeArray.md)\<`T`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4182 + +## Type Parameters + +• **T** *extends* [`Node`](Node.md) + +## Parameters + +### nodes + +[`NodeArray`](NodeArray.md)\<`T`\> + +### visitor + +`undefined` | [`Visitor`](../type-aliases/Visitor.md) + +### test? + +(`node`) => `boolean` + +### start? + +`number` + +### count? + +`number` + +## Returns + +[`NodeArray`](NodeArray.md)\<`T`\> + +> **NodesVisitor**\<`T`\>(`nodes`, `visitor`, `test`?, `start`?, `count`?): `undefined` \| [`NodeArray`](NodeArray.md)\<`T`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4183 + +## Type Parameters + +• **T** *extends* [`Node`](Node.md) + +## Parameters + +### nodes + +`undefined` | [`NodeArray`](NodeArray.md)\<`T`\> + +### visitor + +`undefined` | [`Visitor`](../type-aliases/Visitor.md) + +### test? + +(`node`) => `boolean` + +### start? + +`number` + +### count? + +`number` + +## Returns + +`undefined` \| [`NodeArray`](NodeArray.md)\<`T`\> diff --git a/docs/api_docs/namespaces/ts/interfaces/NonNullChain.md b/docs/api_docs/namespaces/ts/interfaces/NonNullChain.md new file mode 100644 index 0000000000000000000000000000000000000000..479b51e930577284f76d33eaa6669d00f7e048cb --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/NonNullChain.md @@ -0,0 +1,545 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / NonNullChain + +# Interface: NonNullChain + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1390 + +## Extends + +- [`NonNullExpression`](NonNullExpression.md) + +## Properties + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`NonNullExpression`](NonNullExpression.md).[`_expressionBrand`](NonNullExpression.md#_expressionbrand) + +*** + +### \_leftHandSideExpressionBrand + +> **\_leftHandSideExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1086 + +#### Inherited from + +[`NonNullExpression`](NonNullExpression.md).[`_leftHandSideExpressionBrand`](NonNullExpression.md#_lefthandsideexpressionbrand) + +*** + +### \_optionalChainBrand + +> **\_optionalChainBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1391 + +*** + +### \_unaryExpressionBrand + +> **\_unaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1066 + +#### Inherited from + +[`NonNullExpression`](NonNullExpression.md).[`_unaryExpressionBrand`](NonNullExpression.md#_unaryexpressionbrand) + +*** + +### \_updateExpressionBrand + +> **\_updateExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1071 + +#### Inherited from + +[`NonNullExpression`](NonNullExpression.md).[`_updateExpressionBrand`](NonNullExpression.md#_updateexpressionbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`NonNullExpression`](NonNullExpression.md).[`decorators`](NonNullExpression.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`NonNullExpression`](NonNullExpression.md).[`end`](NonNullExpression.md#end) + +*** + +### expression + +> `readonly` **expression**: [`Expression`](Expression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1388 + +#### Inherited from + +[`NonNullExpression`](NonNullExpression.md).[`expression`](NonNullExpression.md#expression) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`NonNullExpression`](NonNullExpression.md).[`flags`](NonNullExpression.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`NonNullExpression`](../enumerations/SyntaxKind.md#nonnullexpression) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1387 + +#### Inherited from + +[`NonNullExpression`](NonNullExpression.md).[`kind`](NonNullExpression.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`NonNullExpression`](NonNullExpression.md).[`locals`](NonNullExpression.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`NonNullExpression`](NonNullExpression.md).[`modifiers`](NonNullExpression.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`NonNullExpression`](NonNullExpression.md).[`parent`](NonNullExpression.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`NonNullExpression`](NonNullExpression.md).[`pos`](NonNullExpression.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`NonNullExpression`](NonNullExpression.md).[`skipCheck`](NonNullExpression.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`NonNullExpression`](NonNullExpression.md).[`symbol`](NonNullExpression.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`NonNullExpression`](NonNullExpression.md).[`forEachChild`](NonNullExpression.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`NonNullExpression`](NonNullExpression.md).[`getChildAt`](NonNullExpression.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`NonNullExpression`](NonNullExpression.md).[`getChildCount`](NonNullExpression.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`NonNullExpression`](NonNullExpression.md).[`getChildren`](NonNullExpression.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`NonNullExpression`](NonNullExpression.md).[`getEnd`](NonNullExpression.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`NonNullExpression`](NonNullExpression.md).[`getFirstToken`](NonNullExpression.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`NonNullExpression`](NonNullExpression.md).[`getFullStart`](NonNullExpression.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`NonNullExpression`](NonNullExpression.md).[`getFullText`](NonNullExpression.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`NonNullExpression`](NonNullExpression.md).[`getFullWidth`](NonNullExpression.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`NonNullExpression`](NonNullExpression.md).[`getLastToken`](NonNullExpression.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`NonNullExpression`](NonNullExpression.md).[`getLeadingTriviaWidth`](NonNullExpression.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`NonNullExpression`](NonNullExpression.md).[`getSourceFile`](NonNullExpression.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`NonNullExpression`](NonNullExpression.md).[`getStart`](NonNullExpression.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`NonNullExpression`](NonNullExpression.md).[`getText`](NonNullExpression.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`NonNullExpression`](NonNullExpression.md).[`getWidth`](NonNullExpression.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/NonNullExpression.md b/docs/api_docs/namespaces/ts/interfaces/NonNullExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..a0e73099f7b5cc910fe0f945532ba1aa46bea8db --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/NonNullExpression.md @@ -0,0 +1,537 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / NonNullExpression + +# Interface: NonNullExpression + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1386 + +## Extends + +- [`LeftHandSideExpression`](LeftHandSideExpression.md) + +## Extended by + +- [`NonNullChain`](NonNullChain.md) + +## Properties + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`_expressionBrand`](LeftHandSideExpression.md#_expressionbrand) + +*** + +### \_leftHandSideExpressionBrand + +> **\_leftHandSideExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1086 + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`_leftHandSideExpressionBrand`](LeftHandSideExpression.md#_lefthandsideexpressionbrand) + +*** + +### \_unaryExpressionBrand + +> **\_unaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1066 + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`_unaryExpressionBrand`](LeftHandSideExpression.md#_unaryexpressionbrand) + +*** + +### \_updateExpressionBrand + +> **\_updateExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1071 + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`_updateExpressionBrand`](LeftHandSideExpression.md#_updateexpressionbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`decorators`](LeftHandSideExpression.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`end`](LeftHandSideExpression.md#end) + +*** + +### expression + +> `readonly` **expression**: [`Expression`](Expression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1388 + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`flags`](LeftHandSideExpression.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`NonNullExpression`](../enumerations/SyntaxKind.md#nonnullexpression) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1387 + +#### Overrides + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`kind`](LeftHandSideExpression.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`locals`](LeftHandSideExpression.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`modifiers`](LeftHandSideExpression.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`parent`](LeftHandSideExpression.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`pos`](LeftHandSideExpression.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`skipCheck`](LeftHandSideExpression.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`symbol`](LeftHandSideExpression.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`forEachChild`](LeftHandSideExpression.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`getChildAt`](LeftHandSideExpression.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`getChildCount`](LeftHandSideExpression.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`getChildren`](LeftHandSideExpression.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`getEnd`](LeftHandSideExpression.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`getFirstToken`](LeftHandSideExpression.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`getFullStart`](LeftHandSideExpression.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`getFullText`](LeftHandSideExpression.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`getFullWidth`](LeftHandSideExpression.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`getLastToken`](LeftHandSideExpression.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`getLeadingTriviaWidth`](LeftHandSideExpression.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`getSourceFile`](LeftHandSideExpression.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`getStart`](LeftHandSideExpression.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`getText`](LeftHandSideExpression.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`getWidth`](LeftHandSideExpression.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/NonRelativeModuleNameResolutionCache.md b/docs/api_docs/namespaces/ts/interfaces/NonRelativeModuleNameResolutionCache.md new file mode 100644 index 0000000000000000000000000000000000000000..7d6eb3dbd947a6a0d89824d0a02d70a8788ef4e5 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/NonRelativeModuleNameResolutionCache.md @@ -0,0 +1,62 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / NonRelativeModuleNameResolutionCache + +# Interface: NonRelativeModuleNameResolutionCache + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5392 + +Stored map from non-relative module name to a table: directory -> result of module lookup in this directory +We support only non-relative module names because resolution of relative module names is usually more deterministic and thus less expensive. + +## Extends + +- [`PackageJsonInfoCache`](PackageJsonInfoCache.md) + +## Extended by + +- [`ModuleResolutionCache`](ModuleResolutionCache.md) + +## Methods + +### clear() + +> **clear**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5396 + +#### Returns + +`void` + +#### Inherited from + +[`PackageJsonInfoCache`](PackageJsonInfoCache.md).[`clear`](PackageJsonInfoCache.md#clear) + +*** + +### getOrCreateCacheForModuleName() + +> **getOrCreateCacheForModuleName**(`nonRelativeModuleName`, `mode`, `redirectedReference`?): [`PerModuleNameCache`](PerModuleNameCache.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5393 + +#### Parameters + +##### nonRelativeModuleName + +`string` + +##### mode + +`undefined` | [`CommonJS`](../enumerations/ModuleKind.md#commonjs) | [`ESNext`](../enumerations/ModuleKind.md#esnext) + +##### redirectedReference? + +[`ResolvedProjectReference`](ResolvedProjectReference.md) + +#### Returns + +[`PerModuleNameCache`](PerModuleNameCache.md) diff --git a/docs/api_docs/namespaces/ts/interfaces/NotEmittedStatement.md b/docs/api_docs/namespaces/ts/interfaces/NotEmittedStatement.md new file mode 100644 index 0000000000000000000000000000000000000000..3f26e0fd2bbf15a108a8c2184e8c8763da25a963 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/NotEmittedStatement.md @@ -0,0 +1,489 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / NotEmittedStatement + +# Interface: NotEmittedStatement + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1473 + +## Extends + +- [`Statement`](Statement.md) + +## Properties + +### \_statementBrand + +> **\_statementBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1471 + +#### Inherited from + +[`Statement`](Statement.md).[`_statementBrand`](Statement.md#_statementbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Statement`](Statement.md).[`decorators`](Statement.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Statement`](Statement.md).[`end`](Statement.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Statement`](Statement.md).[`flags`](Statement.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`NotEmittedStatement`](../enumerations/SyntaxKind.md#notemittedstatement) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1474 + +#### Overrides + +[`Statement`](Statement.md).[`kind`](Statement.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Statement`](Statement.md).[`locals`](Statement.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Statement`](Statement.md).[`modifiers`](Statement.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`Statement`](Statement.md).[`parent`](Statement.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Statement`](Statement.md).[`pos`](Statement.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Statement`](Statement.md).[`skipCheck`](Statement.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Statement`](Statement.md).[`symbol`](Statement.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Statement`](Statement.md).[`forEachChild`](Statement.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getChildAt`](Statement.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getChildCount`](Statement.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Statement`](Statement.md).[`getChildren`](Statement.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getEnd`](Statement.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getFirstToken`](Statement.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getFullStart`](Statement.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Statement`](Statement.md).[`getFullText`](Statement.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getFullWidth`](Statement.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getLastToken`](Statement.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getLeadingTriviaWidth`](Statement.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getSourceFile`](Statement.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getStart`](Statement.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Statement`](Statement.md).[`getText`](Statement.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getWidth`](Statement.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/NullLiteral.md b/docs/api_docs/namespaces/ts/interfaces/NullLiteral.md new file mode 100644 index 0000000000000000000000000000000000000000..6bce0e0816efcf53fad93fcd68238f707cfe82b4 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/NullLiteral.md @@ -0,0 +1,549 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / NullLiteral + +# Interface: NullLiteral + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1094 + +## Extends + +- [`PrimaryExpression`](PrimaryExpression.md) + +## Properties + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_expressionBrand`](PrimaryExpression.md#_expressionbrand) + +*** + +### \_leftHandSideExpressionBrand + +> **\_leftHandSideExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1086 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_leftHandSideExpressionBrand`](PrimaryExpression.md#_lefthandsideexpressionbrand) + +*** + +### \_memberExpressionBrand + +> **\_memberExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1089 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_memberExpressionBrand`](PrimaryExpression.md#_memberexpressionbrand) + +*** + +### \_primaryExpressionBrand + +> **\_primaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1092 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_primaryExpressionBrand`](PrimaryExpression.md#_primaryexpressionbrand) + +*** + +### \_unaryExpressionBrand + +> **\_unaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1066 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_unaryExpressionBrand`](PrimaryExpression.md#_unaryexpressionbrand) + +*** + +### \_updateExpressionBrand + +> **\_updateExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1071 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_updateExpressionBrand`](PrimaryExpression.md#_updateexpressionbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`decorators`](PrimaryExpression.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`end`](PrimaryExpression.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`flags`](PrimaryExpression.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`NullKeyword`](../enumerations/SyntaxKind.md#nullkeyword) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1095 + +#### Overrides + +[`PrimaryExpression`](PrimaryExpression.md).[`kind`](PrimaryExpression.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`locals`](PrimaryExpression.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`modifiers`](PrimaryExpression.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`parent`](PrimaryExpression.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`pos`](PrimaryExpression.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`skipCheck`](PrimaryExpression.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`symbol`](PrimaryExpression.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`forEachChild`](PrimaryExpression.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getChildAt`](PrimaryExpression.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getChildCount`](PrimaryExpression.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getChildren`](PrimaryExpression.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getEnd`](PrimaryExpression.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFirstToken`](PrimaryExpression.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFullStart`](PrimaryExpression.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFullText`](PrimaryExpression.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFullWidth`](PrimaryExpression.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getLastToken`](PrimaryExpression.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getLeadingTriviaWidth`](PrimaryExpression.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getSourceFile`](PrimaryExpression.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getStart`](PrimaryExpression.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getText`](PrimaryExpression.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getWidth`](PrimaryExpression.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/NumberLiteralType.md b/docs/api_docs/namespaces/ts/interfaces/NumberLiteralType.md new file mode 100644 index 0000000000000000000000000000000000000000..9a29843b319a700ad0c5f07bf8b67a03f01f24fd --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/NumberLiteralType.md @@ -0,0 +1,483 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / NumberLiteralType + +# Interface: NumberLiteralType + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2788 + +## Extends + +- [`LiteralType`](LiteralType.md) + +## Properties + +### aliasSymbol? + +> `optional` **aliasSymbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2773 + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`aliasSymbol`](LiteralType.md#aliassymbol) + +*** + +### aliasTypeArguments? + +> `optional` **aliasTypeArguments**: readonly [`Type`](Type.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2774 + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`aliasTypeArguments`](LiteralType.md#aliastypearguments) + +*** + +### flags + +> **flags**: [`TypeFlags`](../enumerations/TypeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2770 + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`flags`](LiteralType.md#flags) + +*** + +### freshType + +> **freshType**: [`LiteralType`](LiteralType.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2778 + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`freshType`](LiteralType.md#freshtype) + +*** + +### pattern? + +> `optional` **pattern**: [`DestructuringPattern`](../type-aliases/DestructuringPattern.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2772 + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`pattern`](LiteralType.md#pattern) + +*** + +### regularType + +> **regularType**: [`LiteralType`](LiteralType.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2779 + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`regularType`](LiteralType.md#regulartype) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2771 + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`symbol`](LiteralType.md#symbol) + +*** + +### value + +> **value**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2789 + +#### Overrides + +[`LiteralType`](LiteralType.md).[`value`](LiteralType.md#value) + +## Methods + +### getApparentProperties() + +> **getApparentProperties**(): [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6124 + +#### Returns + +[`Symbol`](Symbol.md)[] + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`getApparentProperties`](LiteralType.md#getapparentproperties) + +*** + +### getBaseTypes() + +> **getBaseTypes**(): `undefined` \| [`BaseType`](../type-aliases/BaseType.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6129 + +#### Returns + +`undefined` \| [`BaseType`](../type-aliases/BaseType.md)[] + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`getBaseTypes`](LiteralType.md#getbasetypes) + +*** + +### getCallSignatures() + +> **getCallSignatures**(): readonly [`Signature`](Signature.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6125 + +#### Returns + +readonly [`Signature`](Signature.md)[] + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`getCallSignatures`](LiteralType.md#getcallsignatures) + +*** + +### getConstraint() + +> **getConstraint**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6131 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`getConstraint`](LiteralType.md#getconstraint) + +*** + +### getConstructSignatures() + +> **getConstructSignatures**(): readonly [`Signature`](Signature.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6126 + +#### Returns + +readonly [`Signature`](Signature.md)[] + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`getConstructSignatures`](LiteralType.md#getconstructsignatures) + +*** + +### getDefault() + +> **getDefault**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6132 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`getDefault`](LiteralType.md#getdefault) + +*** + +### getFlags() + +> **getFlags**(): [`TypeFlags`](../enumerations/TypeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6120 + +#### Returns + +[`TypeFlags`](../enumerations/TypeFlags.md) + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`getFlags`](LiteralType.md#getflags) + +*** + +### getNonNullableType() + +> **getNonNullableType**(): [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6130 + +#### Returns + +[`Type`](Type.md) + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`getNonNullableType`](LiteralType.md#getnonnullabletype) + +*** + +### getNumberIndexType() + +> **getNumberIndexType**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6128 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`getNumberIndexType`](LiteralType.md#getnumberindextype) + +*** + +### getProperties() + +> **getProperties**(): [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6122 + +#### Returns + +[`Symbol`](Symbol.md)[] + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`getProperties`](LiteralType.md#getproperties) + +*** + +### getProperty() + +> **getProperty**(`propertyName`): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6123 + +#### Parameters + +##### propertyName + +`string` + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`getProperty`](LiteralType.md#getproperty) + +*** + +### getStringIndexType() + +> **getStringIndexType**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6127 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`getStringIndexType`](LiteralType.md#getstringindextype) + +*** + +### getSymbol() + +> **getSymbol**(): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6121 + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`getSymbol`](LiteralType.md#getsymbol) + +*** + +### isClass() + +> **isClass**(): `this is InterfaceType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6141 + +#### Returns + +`this is InterfaceType` + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`isClass`](LiteralType.md#isclass) + +*** + +### isClassOrInterface() + +> **isClassOrInterface**(): `this is InterfaceType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6140 + +#### Returns + +`this is InterfaceType` + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`isClassOrInterface`](LiteralType.md#isclassorinterface) + +*** + +### isIndexType() + +> **isIndexType**(): `this is IndexType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6142 + +#### Returns + +`this is IndexType` + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`isIndexType`](LiteralType.md#isindextype) + +*** + +### isIntersection() + +> **isIntersection**(): `this is IntersectionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6134 + +#### Returns + +`this is IntersectionType` + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`isIntersection`](LiteralType.md#isintersection) + +*** + +### isLiteral() + +> **isLiteral**(): `this is LiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6136 + +#### Returns + +`this is LiteralType` + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`isLiteral`](LiteralType.md#isliteral) + +*** + +### isNumberLiteral() + +> **isNumberLiteral**(): `this is NumberLiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6138 + +#### Returns + +`this is NumberLiteralType` + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`isNumberLiteral`](LiteralType.md#isnumberliteral) + +*** + +### isStringLiteral() + +> **isStringLiteral**(): `this is StringLiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6137 + +#### Returns + +`this is StringLiteralType` + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`isStringLiteral`](LiteralType.md#isstringliteral) + +*** + +### isTypeParameter() + +> **isTypeParameter**(): `this is TypeParameter` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6139 + +#### Returns + +`this is TypeParameter` + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`isTypeParameter`](LiteralType.md#istypeparameter) + +*** + +### isUnion() + +> **isUnion**(): `this is UnionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6133 + +#### Returns + +`this is UnionType` + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`isUnion`](LiteralType.md#isunion) + +*** + +### isUnionOrIntersection() + +> **isUnionOrIntersection**(): `this is UnionOrIntersectionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6135 + +#### Returns + +`this is UnionOrIntersectionType` + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`isUnionOrIntersection`](LiteralType.md#isunionorintersection) diff --git a/docs/api_docs/namespaces/ts/interfaces/NumericLiteral.md b/docs/api_docs/namespaces/ts/interfaces/NumericLiteral.md new file mode 100644 index 0000000000000000000000000000000000000000..97cad68cf3315927cf98dcd147096740f899ae1a --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/NumericLiteral.md @@ -0,0 +1,609 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / NumericLiteral + +# Interface: NumericLiteral + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1243 + +## Extends + +- [`LiteralExpression`](LiteralExpression.md).[`Declaration`](Declaration.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`Declaration`](Declaration.md).[`_declarationBrand`](Declaration.md#_declarationbrand) + +*** + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`_expressionBrand`](LiteralExpression.md#_expressionbrand) + +*** + +### \_leftHandSideExpressionBrand + +> **\_leftHandSideExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1086 + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`_leftHandSideExpressionBrand`](LiteralExpression.md#_lefthandsideexpressionbrand) + +*** + +### \_literalExpressionBrand + +> **\_literalExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1227 + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`_literalExpressionBrand`](LiteralExpression.md#_literalexpressionbrand) + +*** + +### \_memberExpressionBrand + +> **\_memberExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1089 + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`_memberExpressionBrand`](LiteralExpression.md#_memberexpressionbrand) + +*** + +### \_primaryExpressionBrand + +> **\_primaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1092 + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`_primaryExpressionBrand`](LiteralExpression.md#_primaryexpressionbrand) + +*** + +### \_unaryExpressionBrand + +> **\_unaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1066 + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`_unaryExpressionBrand`](LiteralExpression.md#_unaryexpressionbrand) + +*** + +### \_updateExpressionBrand + +> **\_updateExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1071 + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`_updateExpressionBrand`](LiteralExpression.md#_updateexpressionbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Declaration`](Declaration.md).[`decorators`](Declaration.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Declaration`](Declaration.md).[`end`](Declaration.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Declaration`](Declaration.md).[`flags`](Declaration.md#flags) + +*** + +### hasExtendedUnicodeEscape? + +> `optional` **hasExtendedUnicodeEscape**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1221 + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`hasExtendedUnicodeEscape`](LiteralExpression.md#hasextendedunicodeescape) + +*** + +### isUnterminated? + +> `optional` **isUnterminated**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1220 + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`isUnterminated`](LiteralExpression.md#isunterminated) + +*** + +### kind + +> `readonly` **kind**: [`NumericLiteral`](../enumerations/SyntaxKind.md#numericliteral) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1244 + +#### Overrides + +[`Declaration`](Declaration.md).[`kind`](Declaration.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Declaration`](Declaration.md).[`locals`](Declaration.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Declaration`](Declaration.md).[`modifiers`](Declaration.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`Declaration`](Declaration.md).[`parent`](Declaration.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Declaration`](Declaration.md).[`pos`](Declaration.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Declaration`](Declaration.md).[`skipCheck`](Declaration.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Declaration`](Declaration.md).[`symbol`](Declaration.md#symbol) + +*** + +### text + +> **text**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1219 + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`text`](LiteralExpression.md#text) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Declaration`](Declaration.md).[`forEachChild`](Declaration.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getChildAt`](Declaration.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getChildCount`](Declaration.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Declaration`](Declaration.md).[`getChildren`](Declaration.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getEnd`](Declaration.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFirstToken`](Declaration.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFullStart`](Declaration.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFullText`](Declaration.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFullWidth`](Declaration.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getLastToken`](Declaration.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getLeadingTriviaWidth`](Declaration.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getSourceFile`](Declaration.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getStart`](Declaration.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getText`](Declaration.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getWidth`](Declaration.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/ObjectBindingPattern.md b/docs/api_docs/namespaces/ts/interfaces/ObjectBindingPattern.md new file mode 100644 index 0000000000000000000000000000000000000000..5ed9d05f04040d3630672741d3fc0d4d676bb156 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ObjectBindingPattern.md @@ -0,0 +1,485 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ObjectBindingPattern + +# Interface: ObjectBindingPattern + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:825 + +## Extends + +- [`Node`](Node.md) + +## Properties + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`decorators`](Node.md#decorators) + +*** + +### elements + +> `readonly` **elements**: [`NodeArray`](NodeArray.md)\<[`BindingElement`](BindingElement.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:828 + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Node`](Node.md).[`end`](Node.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Node`](Node.md).[`flags`](Node.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`ObjectBindingPattern`](../enumerations/SyntaxKind.md#objectbindingpattern) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:826 + +#### Overrides + +[`Node`](Node.md).[`kind`](Node.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Node`](Node.md).[`locals`](Node.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`modifiers`](Node.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`ParameterDeclaration`](ParameterDeclaration.md) \| [`VariableDeclaration`](VariableDeclaration.md) \| [`BindingElement`](BindingElement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:827 + +#### Overrides + +[`Node`](Node.md).[`parent`](Node.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Node`](Node.md).[`pos`](Node.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Node`](Node.md).[`skipCheck`](Node.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Node`](Node.md).[`symbol`](Node.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Node`](Node.md).[`forEachChild`](Node.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getChildAt`](Node.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getChildCount`](Node.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Node`](Node.md).[`getChildren`](Node.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getEnd`](Node.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getFirstToken`](Node.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullStart`](Node.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getFullText`](Node.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullWidth`](Node.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getLastToken`](Node.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getLeadingTriviaWidth`](Node.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Node`](Node.md).[`getSourceFile`](Node.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getStart`](Node.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getText`](Node.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getWidth`](Node.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/ObjectDestructuringAssignment.md b/docs/api_docs/namespaces/ts/interfaces/ObjectDestructuringAssignment.md new file mode 100644 index 0000000000000000000000000000000000000000..72858b9047506b35037816363756c47d5836eb6d --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ObjectDestructuringAssignment.md @@ -0,0 +1,537 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ObjectDestructuringAssignment + +# Interface: ObjectDestructuringAssignment + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1172 + +## Extends + +- [`AssignmentExpression`](AssignmentExpression.md)\<[`EqualsToken`](../type-aliases/EqualsToken.md)\> + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`AssignmentExpression`](AssignmentExpression.md).[`_declarationBrand`](AssignmentExpression.md#_declarationbrand) + +*** + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`AssignmentExpression`](AssignmentExpression.md).[`_expressionBrand`](AssignmentExpression.md#_expressionbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`AssignmentExpression`](AssignmentExpression.md).[`decorators`](AssignmentExpression.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`AssignmentExpression`](AssignmentExpression.md).[`end`](AssignmentExpression.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`AssignmentExpression`](AssignmentExpression.md).[`flags`](AssignmentExpression.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`BinaryExpression`](../enumerations/SyntaxKind.md#binaryexpression) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1162 + +#### Inherited from + +[`AssignmentExpression`](AssignmentExpression.md).[`kind`](AssignmentExpression.md#kind) + +*** + +### left + +> `readonly` **left**: [`ObjectLiteralExpression`](ObjectLiteralExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1173 + +#### Overrides + +[`AssignmentExpression`](AssignmentExpression.md).[`left`](AssignmentExpression.md#left) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`AssignmentExpression`](AssignmentExpression.md).[`locals`](AssignmentExpression.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`AssignmentExpression`](AssignmentExpression.md).[`modifiers`](AssignmentExpression.md#modifiers) + +*** + +### operatorToken + +> `readonly` **operatorToken**: [`EqualsToken`](../type-aliases/EqualsToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1170 + +#### Inherited from + +[`AssignmentExpression`](AssignmentExpression.md).[`operatorToken`](AssignmentExpression.md#operatortoken) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`AssignmentExpression`](AssignmentExpression.md).[`parent`](AssignmentExpression.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`AssignmentExpression`](AssignmentExpression.md).[`pos`](AssignmentExpression.md#pos) + +*** + +### right + +> `readonly` **right**: [`Expression`](Expression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1165 + +#### Inherited from + +[`AssignmentExpression`](AssignmentExpression.md).[`right`](AssignmentExpression.md#right) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`AssignmentExpression`](AssignmentExpression.md).[`skipCheck`](AssignmentExpression.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`AssignmentExpression`](AssignmentExpression.md).[`symbol`](AssignmentExpression.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`AssignmentExpression`](AssignmentExpression.md).[`forEachChild`](AssignmentExpression.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`AssignmentExpression`](AssignmentExpression.md).[`getChildAt`](AssignmentExpression.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`AssignmentExpression`](AssignmentExpression.md).[`getChildCount`](AssignmentExpression.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`AssignmentExpression`](AssignmentExpression.md).[`getChildren`](AssignmentExpression.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`AssignmentExpression`](AssignmentExpression.md).[`getEnd`](AssignmentExpression.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`AssignmentExpression`](AssignmentExpression.md).[`getFirstToken`](AssignmentExpression.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`AssignmentExpression`](AssignmentExpression.md).[`getFullStart`](AssignmentExpression.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`AssignmentExpression`](AssignmentExpression.md).[`getFullText`](AssignmentExpression.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`AssignmentExpression`](AssignmentExpression.md).[`getFullWidth`](AssignmentExpression.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`AssignmentExpression`](AssignmentExpression.md).[`getLastToken`](AssignmentExpression.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`AssignmentExpression`](AssignmentExpression.md).[`getLeadingTriviaWidth`](AssignmentExpression.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`AssignmentExpression`](AssignmentExpression.md).[`getSourceFile`](AssignmentExpression.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`AssignmentExpression`](AssignmentExpression.md).[`getStart`](AssignmentExpression.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`AssignmentExpression`](AssignmentExpression.md).[`getText`](AssignmentExpression.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`AssignmentExpression`](AssignmentExpression.md).[`getWidth`](AssignmentExpression.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/ObjectLiteralElement.md b/docs/api_docs/namespaces/ts/interfaces/ObjectLiteralElement.md new file mode 100644 index 0000000000000000000000000000000000000000..f5dd470ee544143bde34b44b42a54521ef129100 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ObjectLiteralElement.md @@ -0,0 +1,520 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ObjectLiteralElement + +# Interface: ObjectLiteralElement + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:797 + +## Extends + +- [`NamedDeclaration`](NamedDeclaration.md) + +## Extended by + +- [`PropertyAssignment`](PropertyAssignment.md) +- [`ShorthandPropertyAssignment`](ShorthandPropertyAssignment.md) +- [`SpreadAssignment`](SpreadAssignment.md) +- [`MethodDeclaration`](MethodDeclaration.md) +- [`GetAccessorDeclaration`](GetAccessorDeclaration.md) +- [`SetAccessorDeclaration`](SetAccessorDeclaration.md) +- [`JsxAttribute`](JsxAttribute.md) +- [`JsxSpreadAttribute`](JsxSpreadAttribute.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`_declarationBrand`](NamedDeclaration.md#_declarationbrand) + +*** + +### \_objectLiteralBrand + +> **\_objectLiteralBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:798 + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`decorators`](NamedDeclaration.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`end`](NamedDeclaration.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`flags`](NamedDeclaration.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`SyntaxKind`](../enumerations/SyntaxKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:598 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`kind`](NamedDeclaration.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`locals`](NamedDeclaration.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`modifiers`](NamedDeclaration.md#modifiers) + +*** + +### name? + +> `readonly` `optional` **name**: [`PropertyName`](../type-aliases/PropertyName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:799 + +#### Overrides + +[`NamedDeclaration`](NamedDeclaration.md).[`name`](NamedDeclaration.md#name) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`parent`](NamedDeclaration.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`pos`](NamedDeclaration.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`skipCheck`](NamedDeclaration.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`symbol`](NamedDeclaration.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`forEachChild`](NamedDeclaration.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getChildAt`](NamedDeclaration.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getChildCount`](NamedDeclaration.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getChildren`](NamedDeclaration.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getEnd`](NamedDeclaration.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFirstToken`](NamedDeclaration.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFullStart`](NamedDeclaration.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFullText`](NamedDeclaration.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFullWidth`](NamedDeclaration.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getLastToken`](NamedDeclaration.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getLeadingTriviaWidth`](NamedDeclaration.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getSourceFile`](NamedDeclaration.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getStart`](NamedDeclaration.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getText`](NamedDeclaration.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getWidth`](NamedDeclaration.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/ObjectLiteralExpression.md b/docs/api_docs/namespaces/ts/interfaces/ObjectLiteralExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..b1d6de266f0b1e699712a509eaadec71526cb86c --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ObjectLiteralExpression.md @@ -0,0 +1,578 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ObjectLiteralExpression + +# Interface: ObjectLiteralExpression + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1298 + +This interface is a base interface for ObjectLiteralExpression and JSXAttributes to extend from. JSXAttributes is similar to +ObjectLiteralExpression in that it contains array of properties; however, JSXAttributes' properties can only be +JSXAttribute or JSXSpreadAttribute. ObjectLiteralExpression, on the other hand, can only have properties of type +ObjectLiteralElement (e.g. PropertyAssignment, ShorthandPropertyAssignment etc.) + +## Extends + +- [`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md)\<[`ObjectLiteralElementLike`](../type-aliases/ObjectLiteralElementLike.md)\> + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`_declarationBrand`](ObjectLiteralExpressionBase.md#_declarationbrand) + +*** + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`_expressionBrand`](ObjectLiteralExpressionBase.md#_expressionbrand) + +*** + +### \_leftHandSideExpressionBrand + +> **\_leftHandSideExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1086 + +#### Inherited from + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`_leftHandSideExpressionBrand`](ObjectLiteralExpressionBase.md#_lefthandsideexpressionbrand) + +*** + +### \_memberExpressionBrand + +> **\_memberExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1089 + +#### Inherited from + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`_memberExpressionBrand`](ObjectLiteralExpressionBase.md#_memberexpressionbrand) + +*** + +### \_primaryExpressionBrand + +> **\_primaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1092 + +#### Inherited from + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`_primaryExpressionBrand`](ObjectLiteralExpressionBase.md#_primaryexpressionbrand) + +*** + +### \_unaryExpressionBrand + +> **\_unaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1066 + +#### Inherited from + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`_unaryExpressionBrand`](ObjectLiteralExpressionBase.md#_unaryexpressionbrand) + +*** + +### \_updateExpressionBrand + +> **\_updateExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1071 + +#### Inherited from + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`_updateExpressionBrand`](ObjectLiteralExpressionBase.md#_updateexpressionbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`decorators`](ObjectLiteralExpressionBase.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`end`](ObjectLiteralExpressionBase.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`flags`](ObjectLiteralExpressionBase.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`ObjectLiteralExpression`](../enumerations/SyntaxKind.md#objectliteralexpression) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1299 + +#### Overrides + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`kind`](ObjectLiteralExpressionBase.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`locals`](ObjectLiteralExpressionBase.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`modifiers`](ObjectLiteralExpressionBase.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`parent`](ObjectLiteralExpressionBase.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`pos`](ObjectLiteralExpressionBase.md#pos) + +*** + +### properties + +> `readonly` **properties**: [`NodeArray`](NodeArray.md)\<[`ObjectLiteralElementLike`](../type-aliases/ObjectLiteralElementLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1296 + +#### Inherited from + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`properties`](ObjectLiteralExpressionBase.md#properties) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`skipCheck`](ObjectLiteralExpressionBase.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`symbol`](ObjectLiteralExpressionBase.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`forEachChild`](ObjectLiteralExpressionBase.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`getChildAt`](ObjectLiteralExpressionBase.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`getChildCount`](ObjectLiteralExpressionBase.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`getChildren`](ObjectLiteralExpressionBase.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`getEnd`](ObjectLiteralExpressionBase.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`getFirstToken`](ObjectLiteralExpressionBase.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`getFullStart`](ObjectLiteralExpressionBase.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`getFullText`](ObjectLiteralExpressionBase.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`getFullWidth`](ObjectLiteralExpressionBase.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`getLastToken`](ObjectLiteralExpressionBase.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`getLeadingTriviaWidth`](ObjectLiteralExpressionBase.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`getSourceFile`](ObjectLiteralExpressionBase.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`getStart`](ObjectLiteralExpressionBase.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`getText`](ObjectLiteralExpressionBase.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md).[`getWidth`](ObjectLiteralExpressionBase.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/ObjectLiteralExpressionBase.md b/docs/api_docs/namespaces/ts/interfaces/ObjectLiteralExpressionBase.md new file mode 100644 index 0000000000000000000000000000000000000000..4153e39095e0be34eff98480c2ab0ef707e1aed7 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ObjectLiteralExpressionBase.md @@ -0,0 +1,583 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ObjectLiteralExpressionBase + +# Interface: ObjectLiteralExpressionBase\ + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1295 + +This interface is a base interface for ObjectLiteralExpression and JSXAttributes to extend from. JSXAttributes is similar to +ObjectLiteralExpression in that it contains array of properties; however, JSXAttributes' properties can only be +JSXAttribute or JSXSpreadAttribute. ObjectLiteralExpression, on the other hand, can only have properties of type +ObjectLiteralElement (e.g. PropertyAssignment, ShorthandPropertyAssignment etc.) + +## Extends + +- [`PrimaryExpression`](PrimaryExpression.md).[`Declaration`](Declaration.md) + +## Extended by + +- [`ObjectLiteralExpression`](ObjectLiteralExpression.md) +- [`JsxAttributes`](JsxAttributes.md) + +## Type Parameters + +• **T** *extends* [`ObjectLiteralElement`](ObjectLiteralElement.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`Declaration`](Declaration.md).[`_declarationBrand`](Declaration.md#_declarationbrand) + +*** + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_expressionBrand`](PrimaryExpression.md#_expressionbrand) + +*** + +### \_leftHandSideExpressionBrand + +> **\_leftHandSideExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1086 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_leftHandSideExpressionBrand`](PrimaryExpression.md#_lefthandsideexpressionbrand) + +*** + +### \_memberExpressionBrand + +> **\_memberExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1089 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_memberExpressionBrand`](PrimaryExpression.md#_memberexpressionbrand) + +*** + +### \_primaryExpressionBrand + +> **\_primaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1092 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_primaryExpressionBrand`](PrimaryExpression.md#_primaryexpressionbrand) + +*** + +### \_unaryExpressionBrand + +> **\_unaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1066 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_unaryExpressionBrand`](PrimaryExpression.md#_unaryexpressionbrand) + +*** + +### \_updateExpressionBrand + +> **\_updateExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1071 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_updateExpressionBrand`](PrimaryExpression.md#_updateexpressionbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Declaration`](Declaration.md).[`decorators`](Declaration.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Declaration`](Declaration.md).[`end`](Declaration.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Declaration`](Declaration.md).[`flags`](Declaration.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`SyntaxKind`](../enumerations/SyntaxKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:598 + +#### Inherited from + +[`Declaration`](Declaration.md).[`kind`](Declaration.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Declaration`](Declaration.md).[`locals`](Declaration.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Declaration`](Declaration.md).[`modifiers`](Declaration.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`Declaration`](Declaration.md).[`parent`](Declaration.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Declaration`](Declaration.md).[`pos`](Declaration.md#pos) + +*** + +### properties + +> `readonly` **properties**: [`NodeArray`](NodeArray.md)\<`T`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1296 + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Declaration`](Declaration.md).[`skipCheck`](Declaration.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Declaration`](Declaration.md).[`symbol`](Declaration.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Declaration`](Declaration.md).[`forEachChild`](Declaration.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getChildAt`](Declaration.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getChildCount`](Declaration.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Declaration`](Declaration.md).[`getChildren`](Declaration.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getEnd`](Declaration.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFirstToken`](Declaration.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFullStart`](Declaration.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFullText`](Declaration.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFullWidth`](Declaration.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getLastToken`](Declaration.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getLeadingTriviaWidth`](Declaration.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getSourceFile`](Declaration.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getStart`](Declaration.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getText`](Declaration.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getWidth`](Declaration.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/ObjectType.md b/docs/api_docs/namespaces/ts/interfaces/ObjectType.md new file mode 100644 index 0000000000000000000000000000000000000000..db8f3d14a3be0fb351468f1b16f64ba524b82e3b --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ObjectType.md @@ -0,0 +1,461 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ObjectType + +# Interface: ObjectType + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2817 + +## Extends + +- [`Type`](Type.md) + +## Extended by + +- [`InterfaceType`](InterfaceType.md) +- [`TypeReference`](TypeReference.md) +- [`EvolvingArrayType`](EvolvingArrayType.md) + +## Properties + +### aliasSymbol? + +> `optional` **aliasSymbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2773 + +#### Inherited from + +[`Type`](Type.md).[`aliasSymbol`](Type.md#aliassymbol) + +*** + +### aliasTypeArguments? + +> `optional` **aliasTypeArguments**: readonly [`Type`](Type.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2774 + +#### Inherited from + +[`Type`](Type.md).[`aliasTypeArguments`](Type.md#aliastypearguments) + +*** + +### flags + +> **flags**: [`TypeFlags`](../enumerations/TypeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2770 + +#### Inherited from + +[`Type`](Type.md).[`flags`](Type.md#flags) + +*** + +### objectFlags + +> **objectFlags**: [`ObjectFlags`](../enumerations/ObjectFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2818 + +*** + +### pattern? + +> `optional` **pattern**: [`DestructuringPattern`](../type-aliases/DestructuringPattern.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2772 + +#### Inherited from + +[`Type`](Type.md).[`pattern`](Type.md#pattern) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2771 + +#### Inherited from + +[`Type`](Type.md).[`symbol`](Type.md#symbol) + +## Methods + +### getApparentProperties() + +> **getApparentProperties**(): [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6124 + +#### Returns + +[`Symbol`](Symbol.md)[] + +#### Inherited from + +[`Type`](Type.md).[`getApparentProperties`](Type.md#getapparentproperties) + +*** + +### getBaseTypes() + +> **getBaseTypes**(): `undefined` \| [`BaseType`](../type-aliases/BaseType.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6129 + +#### Returns + +`undefined` \| [`BaseType`](../type-aliases/BaseType.md)[] + +#### Inherited from + +[`Type`](Type.md).[`getBaseTypes`](Type.md#getbasetypes) + +*** + +### getCallSignatures() + +> **getCallSignatures**(): readonly [`Signature`](Signature.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6125 + +#### Returns + +readonly [`Signature`](Signature.md)[] + +#### Inherited from + +[`Type`](Type.md).[`getCallSignatures`](Type.md#getcallsignatures) + +*** + +### getConstraint() + +> **getConstraint**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6131 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`Type`](Type.md).[`getConstraint`](Type.md#getconstraint) + +*** + +### getConstructSignatures() + +> **getConstructSignatures**(): readonly [`Signature`](Signature.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6126 + +#### Returns + +readonly [`Signature`](Signature.md)[] + +#### Inherited from + +[`Type`](Type.md).[`getConstructSignatures`](Type.md#getconstructsignatures) + +*** + +### getDefault() + +> **getDefault**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6132 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`Type`](Type.md).[`getDefault`](Type.md#getdefault) + +*** + +### getFlags() + +> **getFlags**(): [`TypeFlags`](../enumerations/TypeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6120 + +#### Returns + +[`TypeFlags`](../enumerations/TypeFlags.md) + +#### Inherited from + +[`Type`](Type.md).[`getFlags`](Type.md#getflags) + +*** + +### getNonNullableType() + +> **getNonNullableType**(): [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6130 + +#### Returns + +[`Type`](Type.md) + +#### Inherited from + +[`Type`](Type.md).[`getNonNullableType`](Type.md#getnonnullabletype) + +*** + +### getNumberIndexType() + +> **getNumberIndexType**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6128 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`Type`](Type.md).[`getNumberIndexType`](Type.md#getnumberindextype) + +*** + +### getProperties() + +> **getProperties**(): [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6122 + +#### Returns + +[`Symbol`](Symbol.md)[] + +#### Inherited from + +[`Type`](Type.md).[`getProperties`](Type.md#getproperties) + +*** + +### getProperty() + +> **getProperty**(`propertyName`): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6123 + +#### Parameters + +##### propertyName + +`string` + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +#### Inherited from + +[`Type`](Type.md).[`getProperty`](Type.md#getproperty) + +*** + +### getStringIndexType() + +> **getStringIndexType**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6127 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`Type`](Type.md).[`getStringIndexType`](Type.md#getstringindextype) + +*** + +### getSymbol() + +> **getSymbol**(): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6121 + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +#### Inherited from + +[`Type`](Type.md).[`getSymbol`](Type.md#getsymbol) + +*** + +### isClass() + +> **isClass**(): `this is InterfaceType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6141 + +#### Returns + +`this is InterfaceType` + +#### Inherited from + +[`Type`](Type.md).[`isClass`](Type.md#isclass) + +*** + +### isClassOrInterface() + +> **isClassOrInterface**(): `this is InterfaceType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6140 + +#### Returns + +`this is InterfaceType` + +#### Inherited from + +[`Type`](Type.md).[`isClassOrInterface`](Type.md#isclassorinterface) + +*** + +### isIndexType() + +> **isIndexType**(): `this is IndexType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6142 + +#### Returns + +`this is IndexType` + +#### Inherited from + +[`Type`](Type.md).[`isIndexType`](Type.md#isindextype) + +*** + +### isIntersection() + +> **isIntersection**(): `this is IntersectionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6134 + +#### Returns + +`this is IntersectionType` + +#### Inherited from + +[`Type`](Type.md).[`isIntersection`](Type.md#isintersection) + +*** + +### isLiteral() + +> **isLiteral**(): `this is LiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6136 + +#### Returns + +`this is LiteralType` + +#### Inherited from + +[`Type`](Type.md).[`isLiteral`](Type.md#isliteral) + +*** + +### isNumberLiteral() + +> **isNumberLiteral**(): `this is NumberLiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6138 + +#### Returns + +`this is NumberLiteralType` + +#### Inherited from + +[`Type`](Type.md).[`isNumberLiteral`](Type.md#isnumberliteral) + +*** + +### isStringLiteral() + +> **isStringLiteral**(): `this is StringLiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6137 + +#### Returns + +`this is StringLiteralType` + +#### Inherited from + +[`Type`](Type.md).[`isStringLiteral`](Type.md#isstringliteral) + +*** + +### isTypeParameter() + +> **isTypeParameter**(): `this is TypeParameter` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6139 + +#### Returns + +`this is TypeParameter` + +#### Inherited from + +[`Type`](Type.md).[`isTypeParameter`](Type.md#istypeparameter) + +*** + +### isUnion() + +> **isUnion**(): `this is UnionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6133 + +#### Returns + +`this is UnionType` + +#### Inherited from + +[`Type`](Type.md).[`isUnion`](Type.md#isunion) + +*** + +### isUnionOrIntersection() + +> **isUnionOrIntersection**(): `this is UnionOrIntersectionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6135 + +#### Returns + +`this is UnionOrIntersectionType` + +#### Inherited from + +[`Type`](Type.md).[`isUnionOrIntersection`](Type.md#isunionorintersection) diff --git a/docs/api_docs/namespaces/ts/interfaces/OmittedExpression.md b/docs/api_docs/namespaces/ts/interfaces/OmittedExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..3bd109d77813646e54c3034c6f05d3422de40f35 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/OmittedExpression.md @@ -0,0 +1,489 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / OmittedExpression + +# Interface: OmittedExpression + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1058 + +## Extends + +- [`Expression`](Expression.md) + +## Properties + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`Expression`](Expression.md).[`_expressionBrand`](Expression.md#_expressionbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Expression`](Expression.md).[`decorators`](Expression.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Expression`](Expression.md).[`end`](Expression.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Expression`](Expression.md).[`flags`](Expression.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`OmittedExpression`](../enumerations/SyntaxKind.md#omittedexpression) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1059 + +#### Overrides + +[`Expression`](Expression.md).[`kind`](Expression.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Expression`](Expression.md).[`locals`](Expression.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Expression`](Expression.md).[`modifiers`](Expression.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`Expression`](Expression.md).[`parent`](Expression.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Expression`](Expression.md).[`pos`](Expression.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Expression`](Expression.md).[`skipCheck`](Expression.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Expression`](Expression.md).[`symbol`](Expression.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Expression`](Expression.md).[`forEachChild`](Expression.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Expression`](Expression.md).[`getChildAt`](Expression.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getChildCount`](Expression.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Expression`](Expression.md).[`getChildren`](Expression.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getEnd`](Expression.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Expression`](Expression.md).[`getFirstToken`](Expression.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getFullStart`](Expression.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Expression`](Expression.md).[`getFullText`](Expression.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getFullWidth`](Expression.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Expression`](Expression.md).[`getLastToken`](Expression.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getLeadingTriviaWidth`](Expression.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Expression`](Expression.md).[`getSourceFile`](Expression.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getStart`](Expression.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Expression`](Expression.md).[`getText`](Expression.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getWidth`](Expression.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/OptionalTypeNode.md b/docs/api_docs/namespaces/ts/interfaces/OptionalTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..a40b2afcff82053c94b2570dd499ba20fae58ef5 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/OptionalTypeNode.md @@ -0,0 +1,497 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / OptionalTypeNode + +# Interface: OptionalTypeNode + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:983 + +## Extends + +- [`TypeNode`](TypeNode.md) + +## Properties + +### \_typeNodeBrand + +> **\_typeNodeBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:912 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`_typeNodeBrand`](TypeNode.md#_typenodebrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`decorators`](TypeNode.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`end`](TypeNode.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`flags`](TypeNode.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`OptionalType`](../enumerations/SyntaxKind.md#optionaltype) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:984 + +#### Overrides + +[`TypeNode`](TypeNode.md).[`kind`](TypeNode.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`locals`](TypeNode.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`modifiers`](TypeNode.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`parent`](TypeNode.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`pos`](TypeNode.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`skipCheck`](TypeNode.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`symbol`](TypeNode.md#symbol) + +*** + +### type + +> `readonly` **type**: [`TypeNode`](TypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:985 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`forEachChild`](TypeNode.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getChildAt`](TypeNode.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getChildCount`](TypeNode.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getChildren`](TypeNode.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getEnd`](TypeNode.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFirstToken`](TypeNode.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFullStart`](TypeNode.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFullText`](TypeNode.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFullWidth`](TypeNode.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getLastToken`](TypeNode.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getLeadingTriviaWidth`](TypeNode.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getSourceFile`](TypeNode.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getStart`](TypeNode.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getText`](TypeNode.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getWidth`](TypeNode.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/OrganizeImportsArgs.md b/docs/api_docs/namespaces/ts/interfaces/OrganizeImportsArgs.md new file mode 100644 index 0000000000000000000000000000000000000000..e92efd62b1dfff4382cab1345a4ff1973b11e735 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/OrganizeImportsArgs.md @@ -0,0 +1,57 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / OrganizeImportsArgs + +# Interface: OrganizeImportsArgs + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6447 + +## Extends + +- [`CombinedCodeFixScope`](CombinedCodeFixScope.md) + +## Properties + +### fileName + +> **fileName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6440 + +#### Inherited from + +[`CombinedCodeFixScope`](CombinedCodeFixScope.md).[`fileName`](CombinedCodeFixScope.md#filename) + +*** + +### mode? + +> `optional` **mode**: [`OrganizeImportsMode`](../enumerations/OrganizeImportsMode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6450 + +*** + +### ~~skipDestructiveCodeActions?~~ + +> `optional` **skipDestructiveCodeActions**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6449 + +#### Deprecated + +Use `mode` instead + +*** + +### type + +> **type**: `"file"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6439 + +#### Inherited from + +[`CombinedCodeFixScope`](CombinedCodeFixScope.md).[`type`](CombinedCodeFixScope.md#type) diff --git a/docs/api_docs/namespaces/ts/interfaces/OutliningSpan.md b/docs/api_docs/namespaces/ts/interfaces/OutliningSpan.md new file mode 100644 index 0000000000000000000000000000000000000000..5bdbe5625275290a6b5be6b84d28add200efe5fb --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/OutliningSpan.md @@ -0,0 +1,60 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / OutliningSpan + +# Interface: OutliningSpan + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7055 + +## Properties + +### autoCollapse + +> **autoCollapse**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7066 + +Whether or not this region should be automatically collapsed when +the 'Collapse to Definitions' command is invoked. + +*** + +### bannerText + +> **bannerText**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7061 + +The text to display in the editor for the collapsed region. + +*** + +### hintSpan + +> **hintSpan**: [`TextSpan`](TextSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7059 + +The span of the document to display when the user hovers over the collapsed span. + +*** + +### kind + +> **kind**: [`OutliningSpanKind`](../enumerations/OutliningSpanKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7070 + +Classification of the contents of the span + +*** + +### textSpan + +> **textSpan**: [`TextSpan`](TextSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7057 + +The span of the document to actually collapse. diff --git a/docs/api_docs/namespaces/ts/interfaces/OutputFile.md b/docs/api_docs/namespaces/ts/interfaces/OutputFile.md new file mode 100644 index 0000000000000000000000000000000000000000..f39b6f26427f0adbf28bda654d70c53f6ccc2de7 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/OutputFile.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / OutputFile + +# Interface: OutputFile + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5635 + +## Properties + +### name + +> **name**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5636 + +*** + +### text + +> **text**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5638 + +*** + +### writeByteOrderMark + +> **writeByteOrderMark**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5637 diff --git a/docs/api_docs/namespaces/ts/interfaces/PackageId.md b/docs/api_docs/namespaces/ts/interfaces/PackageId.md new file mode 100644 index 0000000000000000000000000000000000000000..8e880eeae874455c9d50f5f6f92c60c7ffdc8550 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/PackageId.md @@ -0,0 +1,45 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / PackageId + +# Interface: PackageId + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3393 + +Unique identifier with a package name and version. +If changing this, remember to change `packageIdIsEqual`. + +## Properties + +### name + +> **name**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3399 + +Name of the package. +Should not include `@types`. +If accessing a non-index file, this should include its name e.g. "foo/bar". + +*** + +### subModuleName + +> **subModuleName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3404 + +Name of a submodule within this package. +May be "". + +*** + +### version + +> **version**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3406 + +Version of the package, e.g. "1.2.3" diff --git a/docs/api_docs/namespaces/ts/interfaces/PackageJsonInfoCache.md b/docs/api_docs/namespaces/ts/interfaces/PackageJsonInfoCache.md new file mode 100644 index 0000000000000000000000000000000000000000..813cf51a76b2a00d14d5da10063a10fa1fdb3bb9 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/PackageJsonInfoCache.md @@ -0,0 +1,27 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / PackageJsonInfoCache + +# Interface: PackageJsonInfoCache + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5395 + +## Extended by + +- [`TypeReferenceDirectiveResolutionCache`](TypeReferenceDirectiveResolutionCache.md) +- [`ModuleResolutionCache`](ModuleResolutionCache.md) +- [`NonRelativeModuleNameResolutionCache`](NonRelativeModuleNameResolutionCache.md) + +## Methods + +### clear() + +> **clear**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5396 + +#### Returns + +`void` diff --git a/docs/api_docs/namespaces/ts/interfaces/ParameterDeclaration.md b/docs/api_docs/namespaces/ts/interfaces/ParameterDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..058a845097063b7f64d18a074b2068949d475c25 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ParameterDeclaration.md @@ -0,0 +1,533 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ParameterDeclaration + +# Interface: ParameterDeclaration + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:759 + +## Extends + +- [`NamedDeclaration`](NamedDeclaration.md).[`JSDocContainer`](JSDocContainer.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`_declarationBrand`](NamedDeclaration.md#_declarationbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`decorators`](NamedDeclaration.md#decorators) + +*** + +### dotDotDotToken? + +> `readonly` `optional` **dotDotDotToken**: [`DotDotDotToken`](../type-aliases/DotDotDotToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:763 + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`end`](NamedDeclaration.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`flags`](NamedDeclaration.md#flags) + +*** + +### initializer? + +> `readonly` `optional` **initializer**: [`Expression`](Expression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:767 + +*** + +### kind + +> `readonly` **kind**: [`Parameter`](../enumerations/SyntaxKind.md#parameter) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:760 + +#### Overrides + +[`NamedDeclaration`](NamedDeclaration.md).[`kind`](NamedDeclaration.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`locals`](NamedDeclaration.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:762 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Overrides + +[`NamedDeclaration`](NamedDeclaration.md).[`modifiers`](NamedDeclaration.md#modifiers) + +*** + +### name + +> `readonly` **name**: [`BindingName`](../type-aliases/BindingName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:764 + +#### Overrides + +[`NamedDeclaration`](NamedDeclaration.md).[`name`](NamedDeclaration.md#name) + +*** + +### parent + +> `readonly` **parent**: [`SignatureDeclaration`](../type-aliases/SignatureDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:761 + +#### Overrides + +[`NamedDeclaration`](NamedDeclaration.md).[`parent`](NamedDeclaration.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`pos`](NamedDeclaration.md#pos) + +*** + +### questionToken? + +> `readonly` `optional` **questionToken**: [`QuestionToken`](../type-aliases/QuestionToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:765 + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`skipCheck`](NamedDeclaration.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`symbol`](NamedDeclaration.md#symbol) + +*** + +### type? + +> `readonly` `optional` **type**: [`TypeNode`](TypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:766 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`forEachChild`](NamedDeclaration.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getChildAt`](NamedDeclaration.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getChildCount`](NamedDeclaration.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getChildren`](NamedDeclaration.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getEnd`](NamedDeclaration.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFirstToken`](NamedDeclaration.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFullStart`](NamedDeclaration.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFullText`](NamedDeclaration.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFullWidth`](NamedDeclaration.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getLastToken`](NamedDeclaration.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getLeadingTriviaWidth`](NamedDeclaration.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getSourceFile`](NamedDeclaration.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getStart`](NamedDeclaration.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getText`](NamedDeclaration.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getWidth`](NamedDeclaration.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/ParenthesizedExpression.md b/docs/api_docs/namespaces/ts/interfaces/ParenthesizedExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..fbbe373c8221d0dee5ccadf299707db46c74bb26 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ParenthesizedExpression.md @@ -0,0 +1,557 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ParenthesizedExpression + +# Interface: ParenthesizedExpression + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1276 + +## Extends + +- [`PrimaryExpression`](PrimaryExpression.md).[`JSDocContainer`](JSDocContainer.md) + +## Properties + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_expressionBrand`](PrimaryExpression.md#_expressionbrand) + +*** + +### \_leftHandSideExpressionBrand + +> **\_leftHandSideExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1086 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_leftHandSideExpressionBrand`](PrimaryExpression.md#_lefthandsideexpressionbrand) + +*** + +### \_memberExpressionBrand + +> **\_memberExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1089 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_memberExpressionBrand`](PrimaryExpression.md#_memberexpressionbrand) + +*** + +### \_primaryExpressionBrand + +> **\_primaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1092 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_primaryExpressionBrand`](PrimaryExpression.md#_primaryexpressionbrand) + +*** + +### \_unaryExpressionBrand + +> **\_unaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1066 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_unaryExpressionBrand`](PrimaryExpression.md#_unaryexpressionbrand) + +*** + +### \_updateExpressionBrand + +> **\_updateExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1071 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_updateExpressionBrand`](PrimaryExpression.md#_updateexpressionbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`decorators`](PrimaryExpression.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`end`](PrimaryExpression.md#end) + +*** + +### expression + +> `readonly` **expression**: [`Expression`](Expression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1278 + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`flags`](PrimaryExpression.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`ParenthesizedExpression`](../enumerations/SyntaxKind.md#parenthesizedexpression) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1277 + +#### Overrides + +[`PrimaryExpression`](PrimaryExpression.md).[`kind`](PrimaryExpression.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`locals`](PrimaryExpression.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`modifiers`](PrimaryExpression.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`parent`](PrimaryExpression.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`pos`](PrimaryExpression.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`skipCheck`](PrimaryExpression.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`symbol`](PrimaryExpression.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`forEachChild`](PrimaryExpression.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getChildAt`](PrimaryExpression.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getChildCount`](PrimaryExpression.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getChildren`](PrimaryExpression.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getEnd`](PrimaryExpression.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFirstToken`](PrimaryExpression.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFullStart`](PrimaryExpression.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFullText`](PrimaryExpression.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFullWidth`](PrimaryExpression.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getLastToken`](PrimaryExpression.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getLeadingTriviaWidth`](PrimaryExpression.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getSourceFile`](PrimaryExpression.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getStart`](PrimaryExpression.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getText`](PrimaryExpression.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getWidth`](PrimaryExpression.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/ParenthesizedTypeNode.md b/docs/api_docs/namespaces/ts/interfaces/ParenthesizedTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..761a9525197b7aa1999e09e64d864aff096bcd79 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ParenthesizedTypeNode.md @@ -0,0 +1,497 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ParenthesizedTypeNode + +# Interface: ParenthesizedTypeNode + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1011 + +## Extends + +- [`TypeNode`](TypeNode.md) + +## Properties + +### \_typeNodeBrand + +> **\_typeNodeBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:912 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`_typeNodeBrand`](TypeNode.md#_typenodebrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`decorators`](TypeNode.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`end`](TypeNode.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`flags`](TypeNode.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`ParenthesizedType`](../enumerations/SyntaxKind.md#parenthesizedtype) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1012 + +#### Overrides + +[`TypeNode`](TypeNode.md).[`kind`](TypeNode.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`locals`](TypeNode.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`modifiers`](TypeNode.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`parent`](TypeNode.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`pos`](TypeNode.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`skipCheck`](TypeNode.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`symbol`](TypeNode.md#symbol) + +*** + +### type + +> `readonly` **type**: [`TypeNode`](TypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1013 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`forEachChild`](TypeNode.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getChildAt`](TypeNode.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getChildCount`](TypeNode.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getChildren`](TypeNode.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getEnd`](TypeNode.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFirstToken`](TypeNode.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFullStart`](TypeNode.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFullText`](TypeNode.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFullWidth`](TypeNode.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getLastToken`](TypeNode.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getLeadingTriviaWidth`](TypeNode.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getSourceFile`](TypeNode.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getStart`](TypeNode.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getText`](TypeNode.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getWidth`](TypeNode.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/ParseConfigFileHost.md b/docs/api_docs/namespaces/ts/interfaces/ParseConfigFileHost.md new file mode 100644 index 0000000000000000000000000000000000000000..95a2bf979253db7e37628300060716dd1f6860b7 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ParseConfigFileHost.md @@ -0,0 +1,161 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ParseConfigFileHost + +# Interface: ParseConfigFileHost + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5272 + +Interface extending ParseConfigHost to support ParseConfigFile that reads config file and reports errors + +## Extends + +- [`ParseConfigHost`](ParseConfigHost.md).[`ConfigFileDiagnosticsReporter`](ConfigFileDiagnosticsReporter.md) + +## Properties + +### onUnRecoverableConfigFileDiagnostic + +> **onUnRecoverableConfigFileDiagnostic**: [`DiagnosticReporter`](../type-aliases/DiagnosticReporter.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5267 + +Reports unrecoverable error when parsing config file + +#### Inherited from + +[`ConfigFileDiagnosticsReporter`](ConfigFileDiagnosticsReporter.md).[`onUnRecoverableConfigFileDiagnostic`](ConfigFileDiagnosticsReporter.md#onunrecoverableconfigfilediagnostic) + +*** + +### useCaseSensitiveFileNames + +> **useCaseSensitiveFileNames**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2237 + +#### Inherited from + +[`ParseConfigHost`](ParseConfigHost.md).[`useCaseSensitiveFileNames`](ParseConfigHost.md#usecasesensitivefilenames) + +## Methods + +### fileExists() + +> **fileExists**(`path`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2243 + +Gets a value indicating whether the specified path exists and is a file. + +#### Parameters + +##### path + +`string` + +The path to test. + +#### Returns + +`boolean` + +#### Inherited from + +[`ParseConfigHost`](ParseConfigHost.md).[`fileExists`](ParseConfigHost.md#fileexists) + +*** + +### getCurrentDirectory() + +> **getCurrentDirectory**(): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5273 + +#### Returns + +`string` + +*** + +### readDirectory() + +> **readDirectory**(`rootDir`, `extensions`, `excludes`, `includes`, `depth`?): readonly `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2238 + +#### Parameters + +##### rootDir + +`string` + +##### extensions + +readonly `string`[] + +##### excludes + +`undefined` | readonly `string`[] + +##### includes + +readonly `string`[] + +##### depth? + +`number` + +#### Returns + +readonly `string`[] + +#### Inherited from + +[`ParseConfigHost`](ParseConfigHost.md).[`readDirectory`](ParseConfigHost.md#readdirectory) + +*** + +### readFile() + +> **readFile**(`path`): `undefined` \| `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2244 + +#### Parameters + +##### path + +`string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[`ParseConfigHost`](ParseConfigHost.md).[`readFile`](ParseConfigHost.md#readfile) + +*** + +### trace()? + +> `optional` **trace**(`s`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2245 + +#### Parameters + +##### s + +`string` + +#### Returns + +`void` + +#### Inherited from + +[`ParseConfigHost`](ParseConfigHost.md).[`trace`](ParseConfigHost.md#trace) diff --git a/docs/api_docs/namespaces/ts/interfaces/ParseConfigHost.md b/docs/api_docs/namespaces/ts/interfaces/ParseConfigHost.md new file mode 100644 index 0000000000000000000000000000000000000000..035d9ef28ac5a7c043c825c8dce1b7cba3a7734f --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ParseConfigHost.md @@ -0,0 +1,113 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ParseConfigHost + +# Interface: ParseConfigHost + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2236 + +## Extended by + +- [`ParseConfigFileHost`](ParseConfigFileHost.md) + +## Properties + +### useCaseSensitiveFileNames + +> **useCaseSensitiveFileNames**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2237 + +## Methods + +### fileExists() + +> **fileExists**(`path`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2243 + +Gets a value indicating whether the specified path exists and is a file. + +#### Parameters + +##### path + +`string` + +The path to test. + +#### Returns + +`boolean` + +*** + +### readDirectory() + +> **readDirectory**(`rootDir`, `extensions`, `excludes`, `includes`, `depth`?): readonly `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2238 + +#### Parameters + +##### rootDir + +`string` + +##### extensions + +readonly `string`[] + +##### excludes + +`undefined` | readonly `string`[] + +##### includes + +readonly `string`[] + +##### depth? + +`number` + +#### Returns + +readonly `string`[] + +*** + +### readFile() + +> **readFile**(`path`): `undefined` \| `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2244 + +#### Parameters + +##### path + +`string` + +#### Returns + +`undefined` \| `string` + +*** + +### trace()? + +> `optional` **trace**(`s`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2245 + +#### Parameters + +##### s + +`string` + +#### Returns + +`void` diff --git a/docs/api_docs/namespaces/ts/interfaces/ParsedCommandLine.md b/docs/api_docs/namespaces/ts/interfaces/ParsedCommandLine.md new file mode 100644 index 0000000000000000000000000000000000000000..b8f3557b7cbb20f6eef5154765dea8216a2f49ce --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ParsedCommandLine.md @@ -0,0 +1,83 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ParsedCommandLine + +# Interface: ParsedCommandLine + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3316 + +Either a parsed command line or a parsed tsconfig.json + +## Properties + +### compileOnSave? + +> `optional` **compileOnSave**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3325 + +*** + +### errors + +> **errors**: [`Diagnostic`](Diagnostic.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3323 + +*** + +### fileNames + +> **fileNames**: `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3319 + +*** + +### options + +> **options**: [`CompilerOptions`](CompilerOptions.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3317 + +*** + +### projectReferences? + +> `optional` **projectReferences**: readonly [`ProjectReference`](ProjectReference.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3320 + +*** + +### raw? + +> `optional` **raw**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3322 + +*** + +### typeAcquisition? + +> `optional` **typeAcquisition**: [`TypeAcquisition`](TypeAcquisition.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3318 + +*** + +### watchOptions? + +> `optional` **watchOptions**: [`WatchOptions`](WatchOptions.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3321 + +*** + +### wildcardDirectories? + +> `optional` **wildcardDirectories**: [`MapLike`](MapLike.md)\<[`WatchDirectoryFlags`](../enumerations/WatchDirectoryFlags.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3324 diff --git a/docs/api_docs/namespaces/ts/interfaces/ParsedTsconfig.md b/docs/api_docs/namespaces/ts/interfaces/ParsedTsconfig.md new file mode 100644 index 0000000000000000000000000000000000000000..94bf1fc88a4d6ec0e7934a39ff6cf993af2e820f --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ParsedTsconfig.md @@ -0,0 +1,51 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ParsedTsconfig + +# Interface: ParsedTsconfig + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5321 + +## Properties + +### extendedConfigPath? + +> `optional` **extendedConfigPath**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5329 + +Note that the case of the config path has not yet been normalized, as no files have been imported into the project yet + +*** + +### options? + +> `optional` **options**: [`CompilerOptions`](CompilerOptions.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5323 + +*** + +### raw + +> **raw**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5322 + +*** + +### typeAcquisition? + +> `optional` **typeAcquisition**: [`TypeAcquisition`](TypeAcquisition.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5325 + +*** + +### watchOptions? + +> `optional` **watchOptions**: [`WatchOptions`](WatchOptions.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5324 diff --git a/docs/api_docs/namespaces/ts/interfaces/PartiallyEmittedExpression.md b/docs/api_docs/namespaces/ts/interfaces/PartiallyEmittedExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..6210fadbd4bfcec7f8518df4e62bb3f8c2a4ccf4 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/PartiallyEmittedExpression.md @@ -0,0 +1,533 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / PartiallyEmittedExpression + +# Interface: PartiallyEmittedExpression + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1061 + +## Extends + +- [`LeftHandSideExpression`](LeftHandSideExpression.md) + +## Properties + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`_expressionBrand`](LeftHandSideExpression.md#_expressionbrand) + +*** + +### \_leftHandSideExpressionBrand + +> **\_leftHandSideExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1086 + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`_leftHandSideExpressionBrand`](LeftHandSideExpression.md#_lefthandsideexpressionbrand) + +*** + +### \_unaryExpressionBrand + +> **\_unaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1066 + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`_unaryExpressionBrand`](LeftHandSideExpression.md#_unaryexpressionbrand) + +*** + +### \_updateExpressionBrand + +> **\_updateExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1071 + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`_updateExpressionBrand`](LeftHandSideExpression.md#_updateexpressionbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`decorators`](LeftHandSideExpression.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`end`](LeftHandSideExpression.md#end) + +*** + +### expression + +> `readonly` **expression**: [`Expression`](Expression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1063 + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`flags`](LeftHandSideExpression.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`PartiallyEmittedExpression`](../enumerations/SyntaxKind.md#partiallyemittedexpression) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1062 + +#### Overrides + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`kind`](LeftHandSideExpression.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`locals`](LeftHandSideExpression.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`modifiers`](LeftHandSideExpression.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`parent`](LeftHandSideExpression.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`pos`](LeftHandSideExpression.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`skipCheck`](LeftHandSideExpression.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`symbol`](LeftHandSideExpression.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`forEachChild`](LeftHandSideExpression.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`getChildAt`](LeftHandSideExpression.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`getChildCount`](LeftHandSideExpression.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`getChildren`](LeftHandSideExpression.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`getEnd`](LeftHandSideExpression.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`getFirstToken`](LeftHandSideExpression.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`getFullStart`](LeftHandSideExpression.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`getFullText`](LeftHandSideExpression.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`getFullWidth`](LeftHandSideExpression.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`getLastToken`](LeftHandSideExpression.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`getLeadingTriviaWidth`](LeftHandSideExpression.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`getSourceFile`](LeftHandSideExpression.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`getStart`](LeftHandSideExpression.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`getText`](LeftHandSideExpression.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`LeftHandSideExpression`](LeftHandSideExpression.md).[`getWidth`](LeftHandSideExpression.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/PerDirectoryResolutionCache.md b/docs/api_docs/namespaces/ts/interfaces/PerDirectoryResolutionCache.md new file mode 100644 index 0000000000000000000000000000000000000000..b72cf5bde2dc95994a0c409d5dc1c01c8b6ee2ec --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/PerDirectoryResolutionCache.md @@ -0,0 +1,76 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / PerDirectoryResolutionCache + +# Interface: PerDirectoryResolutionCache\ + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5376 + +Cached resolutions per containing directory. +This assumes that any module id will have the same resolution for sibling files located in the same folder. + +## Extended by + +- [`TypeReferenceDirectiveResolutionCache`](TypeReferenceDirectiveResolutionCache.md) +- [`ModuleResolutionCache`](ModuleResolutionCache.md) + +## Type Parameters + +• **T** + +## Methods + +### clear() + +> **clear**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5378 + +#### Returns + +`void` + +*** + +### getOrCreateCacheForDirectory() + +> **getOrCreateCacheForDirectory**(`directoryName`, `redirectedReference`?): [`ModeAwareCache`](ModeAwareCache.md)\<`T`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5377 + +#### Parameters + +##### directoryName + +`string` + +##### redirectedReference? + +[`ResolvedProjectReference`](ResolvedProjectReference.md) + +#### Returns + +[`ModeAwareCache`](ModeAwareCache.md)\<`T`\> + +*** + +### update() + +> **update**(`options`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5383 + +Updates with the current compilerOptions the cache will operate with. + This updates the redirects map as well if needed so module resolutions are cached if they can across the projects + +#### Parameters + +##### options + +[`CompilerOptions`](CompilerOptions.md) + +#### Returns + +`void` diff --git a/docs/api_docs/namespaces/ts/interfaces/PerModuleNameCache.md b/docs/api_docs/namespaces/ts/interfaces/PerModuleNameCache.md new file mode 100644 index 0000000000000000000000000000000000000000..29b2be03471d3fe5729335a7d0a0935018e3bdf4 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/PerModuleNameCache.md @@ -0,0 +1,49 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / PerModuleNameCache + +# Interface: PerModuleNameCache + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5398 + +## Methods + +### get() + +> **get**(`directory`): `undefined` \| [`ResolvedModuleWithFailedLookupLocations`](ResolvedModuleWithFailedLookupLocations.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5399 + +#### Parameters + +##### directory + +`string` + +#### Returns + +`undefined` \| [`ResolvedModuleWithFailedLookupLocations`](ResolvedModuleWithFailedLookupLocations.md) + +*** + +### set() + +> **set**(`directory`, `result`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5400 + +#### Parameters + +##### directory + +`string` + +##### result + +[`ResolvedModuleWithFailedLookupLocations`](ResolvedModuleWithFailedLookupLocations.md) + +#### Returns + +`void` diff --git a/docs/api_docs/namespaces/ts/interfaces/PerformanceEvent.md b/docs/api_docs/namespaces/ts/interfaces/PerformanceEvent.md new file mode 100644 index 0000000000000000000000000000000000000000..16f5fc8173dc6fb21ce43da32ca6f932cdff4035 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/PerformanceEvent.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / PerformanceEvent + +# Interface: PerformanceEvent + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6208 + +## Properties + +### durationMs + +> **durationMs**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6210 + +*** + +### kind + +> **kind**: `"UpdateGraph"` \| `"CreatePackageJsonAutoImportProvider"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6209 diff --git a/docs/api_docs/namespaces/ts/interfaces/PluginImport.md b/docs/api_docs/namespaces/ts/interfaces/PluginImport.md new file mode 100644 index 0000000000000000000000000000000000000000..5b8ae02ccc81707e87ba2ab1dfbce8ae5ccb9459 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/PluginImport.md @@ -0,0 +1,17 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / PluginImport + +# Interface: PluginImport + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3040 + +## Properties + +### name + +> **name**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3041 diff --git a/docs/api_docs/namespaces/ts/interfaces/PostfixUnaryExpression.md b/docs/api_docs/namespaces/ts/interfaces/PostfixUnaryExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..bc6e835862a4c6393fe03c038e028b1ad70e5ced --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/PostfixUnaryExpression.md @@ -0,0 +1,529 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / PostfixUnaryExpression + +# Interface: PostfixUnaryExpression + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1080 + +## Extends + +- [`UpdateExpression`](UpdateExpression.md) + +## Properties + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`_expressionBrand`](UpdateExpression.md#_expressionbrand) + +*** + +### \_unaryExpressionBrand + +> **\_unaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1066 + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`_unaryExpressionBrand`](UpdateExpression.md#_unaryexpressionbrand) + +*** + +### \_updateExpressionBrand + +> **\_updateExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1071 + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`_updateExpressionBrand`](UpdateExpression.md#_updateexpressionbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`decorators`](UpdateExpression.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`end`](UpdateExpression.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`flags`](UpdateExpression.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`PostfixUnaryExpression`](../enumerations/SyntaxKind.md#postfixunaryexpression) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1081 + +#### Overrides + +[`UpdateExpression`](UpdateExpression.md).[`kind`](UpdateExpression.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`locals`](UpdateExpression.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`modifiers`](UpdateExpression.md#modifiers) + +*** + +### operand + +> `readonly` **operand**: [`LeftHandSideExpression`](LeftHandSideExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1082 + +*** + +### operator + +> `readonly` **operator**: [`PostfixUnaryOperator`](../type-aliases/PostfixUnaryOperator.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1083 + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`parent`](UpdateExpression.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`pos`](UpdateExpression.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`skipCheck`](UpdateExpression.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`symbol`](UpdateExpression.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`forEachChild`](UpdateExpression.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`getChildAt`](UpdateExpression.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`getChildCount`](UpdateExpression.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`getChildren`](UpdateExpression.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`getEnd`](UpdateExpression.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`getFirstToken`](UpdateExpression.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`getFullStart`](UpdateExpression.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`getFullText`](UpdateExpression.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`getFullWidth`](UpdateExpression.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`getLastToken`](UpdateExpression.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`getLeadingTriviaWidth`](UpdateExpression.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`getSourceFile`](UpdateExpression.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`getStart`](UpdateExpression.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`getText`](UpdateExpression.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`getWidth`](UpdateExpression.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/PreProcessedFileInfo.md b/docs/api_docs/namespaces/ts/interfaces/PreProcessedFileInfo.md new file mode 100644 index 0000000000000000000000000000000000000000..b0380cee93eaa013e6f6ee55ac581de4c91fa6cb --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/PreProcessedFileInfo.md @@ -0,0 +1,57 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / PreProcessedFileInfo + +# Interface: PreProcessedFileInfo + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6193 + +## Properties + +### ambientExternalModules? + +> `optional` **ambientExternalModules**: `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6198 + +*** + +### importedFiles + +> **importedFiles**: [`FileReference`](FileReference.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6197 + +*** + +### isLibFile + +> **isLibFile**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6199 + +*** + +### libReferenceDirectives + +> **libReferenceDirectives**: [`FileReference`](FileReference.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6196 + +*** + +### referencedFiles + +> **referencedFiles**: [`FileReference`](FileReference.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6194 + +*** + +### typeReferenceDirectives + +> **typeReferenceDirectives**: [`FileReference`](FileReference.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6195 diff --git a/docs/api_docs/namespaces/ts/interfaces/PrefixUnaryExpression.md b/docs/api_docs/namespaces/ts/interfaces/PrefixUnaryExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..c9ae2fd297a86662222d7b8d891e1f9c3fc6a2e4 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/PrefixUnaryExpression.md @@ -0,0 +1,533 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / PrefixUnaryExpression + +# Interface: PrefixUnaryExpression + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1074 + +## Extends + +- [`UpdateExpression`](UpdateExpression.md) + +## Extended by + +- [`JsonMinusNumericLiteral`](JsonMinusNumericLiteral.md) + +## Properties + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`_expressionBrand`](UpdateExpression.md#_expressionbrand) + +*** + +### \_unaryExpressionBrand + +> **\_unaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1066 + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`_unaryExpressionBrand`](UpdateExpression.md#_unaryexpressionbrand) + +*** + +### \_updateExpressionBrand + +> **\_updateExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1071 + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`_updateExpressionBrand`](UpdateExpression.md#_updateexpressionbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`decorators`](UpdateExpression.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`end`](UpdateExpression.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`flags`](UpdateExpression.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`PrefixUnaryExpression`](../enumerations/SyntaxKind.md#prefixunaryexpression) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1075 + +#### Overrides + +[`UpdateExpression`](UpdateExpression.md).[`kind`](UpdateExpression.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`locals`](UpdateExpression.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`modifiers`](UpdateExpression.md#modifiers) + +*** + +### operand + +> `readonly` **operand**: [`UnaryExpression`](UnaryExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1077 + +*** + +### operator + +> `readonly` **operator**: [`PrefixUnaryOperator`](../type-aliases/PrefixUnaryOperator.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1076 + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`parent`](UpdateExpression.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`pos`](UpdateExpression.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`skipCheck`](UpdateExpression.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`symbol`](UpdateExpression.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`forEachChild`](UpdateExpression.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`getChildAt`](UpdateExpression.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`getChildCount`](UpdateExpression.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`getChildren`](UpdateExpression.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`getEnd`](UpdateExpression.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`getFirstToken`](UpdateExpression.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`getFullStart`](UpdateExpression.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`getFullText`](UpdateExpression.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`getFullWidth`](UpdateExpression.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`getLastToken`](UpdateExpression.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`getLeadingTriviaWidth`](UpdateExpression.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`getSourceFile`](UpdateExpression.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`getStart`](UpdateExpression.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`getText`](UpdateExpression.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`UpdateExpression`](UpdateExpression.md).[`getWidth`](UpdateExpression.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/PrimaryExpression.md b/docs/api_docs/namespaces/ts/interfaces/PrimaryExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..89772df42e560c8eaa24f9c5033b0ee6958a5060 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/PrimaryExpression.md @@ -0,0 +1,569 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / PrimaryExpression + +# Interface: PrimaryExpression + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1091 + +## Extends + +- [`MemberExpression`](MemberExpression.md) + +## Extended by + +- [`Identifier`](Identifier.md) +- [`PrivateIdentifier`](PrivateIdentifier.md) +- [`NullLiteral`](NullLiteral.md) +- [`TrueLiteral`](TrueLiteral.md) +- [`FalseLiteral`](FalseLiteral.md) +- [`ThisExpression`](ThisExpression.md) +- [`SuperExpression`](SuperExpression.md) +- [`ImportExpression`](ImportExpression.md) +- [`FunctionExpression`](FunctionExpression.md) +- [`EtsComponentExpression`](EtsComponentExpression.md) +- [`LiteralExpression`](LiteralExpression.md) +- [`TemplateExpression`](TemplateExpression.md) +- [`ParenthesizedExpression`](ParenthesizedExpression.md) +- [`ArrayLiteralExpression`](ArrayLiteralExpression.md) +- [`ObjectLiteralExpressionBase`](ObjectLiteralExpressionBase.md) +- [`NewExpression`](NewExpression.md) +- [`MetaProperty`](MetaProperty.md) +- [`JsxElement`](JsxElement.md) +- [`JsxSelfClosingElement`](JsxSelfClosingElement.md) +- [`JsxFragment`](JsxFragment.md) +- [`ClassExpression`](ClassExpression.md) + +## Properties + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`_expressionBrand`](MemberExpression.md#_expressionbrand) + +*** + +### \_leftHandSideExpressionBrand + +> **\_leftHandSideExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1086 + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`_leftHandSideExpressionBrand`](MemberExpression.md#_lefthandsideexpressionbrand) + +*** + +### \_memberExpressionBrand + +> **\_memberExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1089 + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`_memberExpressionBrand`](MemberExpression.md#_memberexpressionbrand) + +*** + +### \_primaryExpressionBrand + +> **\_primaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1092 + +*** + +### \_unaryExpressionBrand + +> **\_unaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1066 + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`_unaryExpressionBrand`](MemberExpression.md#_unaryexpressionbrand) + +*** + +### \_updateExpressionBrand + +> **\_updateExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1071 + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`_updateExpressionBrand`](MemberExpression.md#_updateexpressionbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`decorators`](MemberExpression.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`end`](MemberExpression.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`flags`](MemberExpression.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`SyntaxKind`](../enumerations/SyntaxKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:598 + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`kind`](MemberExpression.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`locals`](MemberExpression.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`modifiers`](MemberExpression.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`parent`](MemberExpression.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`pos`](MemberExpression.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`skipCheck`](MemberExpression.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`symbol`](MemberExpression.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`forEachChild`](MemberExpression.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`getChildAt`](MemberExpression.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`getChildCount`](MemberExpression.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`getChildren`](MemberExpression.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`getEnd`](MemberExpression.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`getFirstToken`](MemberExpression.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`getFullStart`](MemberExpression.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`getFullText`](MemberExpression.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`getFullWidth`](MemberExpression.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`getLastToken`](MemberExpression.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`getLeadingTriviaWidth`](MemberExpression.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`getSourceFile`](MemberExpression.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`getStart`](MemberExpression.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`getText`](MemberExpression.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`getWidth`](MemberExpression.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/PrintHandlers.md b/docs/api_docs/namespaces/ts/interfaces/PrintHandlers.md new file mode 100644 index 0000000000000000000000000000000000000000..efaa05819086e6f2a7f1363ff0dd2adeefd5ab21 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/PrintHandlers.md @@ -0,0 +1,141 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / PrintHandlers + +# Interface: PrintHandlers + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4215 + +## Methods + +### hasGlobalName()? + +> `optional` **hasGlobalName**(`name`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4220 + +A hook used by the Printer when generating unique names to avoid collisions with +globally defined names that exist outside of the current source file. + +#### Parameters + +##### name + +`string` + +#### Returns + +`boolean` + +*** + +### isEmitNotificationEnabled()? + +> `optional` **isEmitNotificationEnabled**(`node`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4244 + +A hook used to check if an emit notification is required for a node. + +#### Parameters + +##### node + +[`Node`](Node.md) + +The node to emit. + +#### Returns + +`boolean` + +*** + +### onEmitNode()? + +> `optional` **onEmitNode**(`hint`, `node`, `emitCallback`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4239 + +A hook used by the Printer to provide notifications prior to emitting a node. A +compatible implementation **must** invoke `emitCallback` with the provided `hint` and +`node` values. + +#### Parameters + +##### hint + +[`EmitHint`](../enumerations/EmitHint.md) + +A hint indicating the intended purpose of the node. + +##### node + +[`Node`](Node.md) + +The node to emit. + +##### emitCallback + +(`hint`, `node`) => `void` + +A callback that, when invoked, will emit the node. + +#### Returns + +`void` + +#### Example + +```ts +var printer = createPrinter(printerOptions, { + onEmitNode(hint, node, emitCallback) { + // set up or track state prior to emitting the node... + emitCallback(hint, node); + // restore state after emitting the node... + } +}); +``` + +*** + +### substituteNode()? + +> `optional` **substituteNode**(`hint`, `node`): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4261 + +A hook used by the Printer to perform just-in-time substitution of a node. This is +primarily used by node transformations that need to substitute one node for another, +such as replacing `myExportedVar` with `exports.myExportedVar`. + +#### Parameters + +##### hint + +[`EmitHint`](../enumerations/EmitHint.md) + +A hint indicating the intended purpose of the node. + +##### node + +[`Node`](Node.md) + +The node to emit. + +#### Returns + +[`Node`](Node.md) + +#### Example + +```ts +var printer = createPrinter(printerOptions, { + substituteNode(hint, node) { + // perform substitution if necessary... + return node; + } +}); +``` diff --git a/docs/api_docs/namespaces/ts/interfaces/Printer.md b/docs/api_docs/namespaces/ts/interfaces/Printer.md new file mode 100644 index 0000000000000000000000000000000000000000..1bd14feebc9cfb799c108ed6b2a9a3047aced127 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/Printer.md @@ -0,0 +1,148 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / Printer + +# Interface: Printer + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4186 + +## Methods + +### printBundle() + +> **printBundle**(`bundle`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4212 + +Prints a bundle of source files as-is, without any emit transformations. + +#### Parameters + +##### bundle + +[`Bundle`](Bundle.md) + +#### Returns + +`string` + +*** + +### printFile() + +> **printFile**(`sourceFile`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4208 + +Prints a source file as-is, without any emit transformations. + +#### Parameters + +##### sourceFile + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +*** + +### printList() + +> **printList**\<`T`\>(`format`, `list`, `sourceFile`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4204 + +Prints a list of nodes using the given format flags + +#### Type Parameters + +• **T** *extends* [`Node`](Node.md) + +#### Parameters + +##### format + +[`ListFormat`](../enumerations/ListFormat.md) + +##### list + +[`NodeArray`](NodeArray.md)\<`T`\> + +##### sourceFile + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +*** + +### printNode() + +> **printNode**(`hint`, `node`, `sourceFile`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4200 + +Print a node and its subtree as-is, without any emit transformations. + +#### Parameters + +##### hint + +[`EmitHint`](../enumerations/EmitHint.md) + +A value indicating the purpose of a node. This is primarily used to +distinguish between an `Identifier` used in an expression position, versus an +`Identifier` used as an `IdentifierName` as part of a declaration. For most nodes you +should just pass `Unspecified`. + +##### node + +[`Node`](Node.md) + +The node to print. The node and its subtree are printed as-is, without any +emit transformations. + +##### sourceFile + +[`SourceFile`](SourceFile.md) + +A source file that provides context for the node. The source text of +the file is used to emit the original source content for literals and identifiers, while +the identifiers of the source file are used when generating unique names to avoid +collisions. + +#### Returns + +`string` + +*** + +### writeFile() + +> **writeFile**(`sourceFile`, `writer`, `sourceMapGenerator`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4213 + +#### Parameters + +##### sourceFile + +[`SourceFile`](SourceFile.md) + +##### writer + +[`EmitTextWriter`](EmitTextWriter.md) + +##### sourceMapGenerator + +`undefined` | [`SourceMapGenerator`](SourceMapGenerator.md) + +#### Returns + +`void` diff --git a/docs/api_docs/namespaces/ts/interfaces/PrinterOptions.md b/docs/api_docs/namespaces/ts/interfaces/PrinterOptions.md new file mode 100644 index 0000000000000000000000000000000000000000..5b7990e8d51666a4cb241c2a5f17cc6e26d9e91d --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/PrinterOptions.md @@ -0,0 +1,65 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / PrinterOptions + +# Interface: PrinterOptions + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4263 + +## Properties + +### inlineSourceMap? + +> `optional` **inlineSourceMap**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4269 + +*** + +### inlineSources? + +> `optional` **inlineSources**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4270 + +*** + +### newLine? + +> `optional` **newLine**: [`NewLineKind`](../enumerations/NewLineKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4265 + +*** + +### noEmitHelpers? + +> `optional` **noEmitHelpers**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4267 + +*** + +### omitTrailingSemicolon? + +> `optional` **omitTrailingSemicolon**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4266 + +*** + +### removeComments? + +> `optional` **removeComments**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4264 + +*** + +### sourceMap? + +> `optional` **sourceMap**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4268 diff --git a/docs/api_docs/namespaces/ts/interfaces/PrivateIdentifier.md b/docs/api_docs/namespaces/ts/interfaces/PrivateIdentifier.md new file mode 100644 index 0000000000000000000000000000000000000000..925b1526d47b246c65298f09c987990a0e0cb401 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/PrivateIdentifier.md @@ -0,0 +1,565 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / PrivateIdentifier + +# Interface: PrivateIdentifier + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:712 + +## Extends + +- [`PrimaryExpression`](PrimaryExpression.md) + +## Properties + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_expressionBrand`](PrimaryExpression.md#_expressionbrand) + +*** + +### \_leftHandSideExpressionBrand + +> **\_leftHandSideExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1086 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_leftHandSideExpressionBrand`](PrimaryExpression.md#_lefthandsideexpressionbrand) + +*** + +### \_memberExpressionBrand + +> **\_memberExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1089 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_memberExpressionBrand`](PrimaryExpression.md#_memberexpressionbrand) + +*** + +### \_primaryExpressionBrand + +> **\_primaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1092 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_primaryExpressionBrand`](PrimaryExpression.md#_primaryexpressionbrand) + +*** + +### \_unaryExpressionBrand + +> **\_unaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1066 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_unaryExpressionBrand`](PrimaryExpression.md#_unaryexpressionbrand) + +*** + +### \_updateExpressionBrand + +> **\_updateExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1071 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_updateExpressionBrand`](PrimaryExpression.md#_updateexpressionbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`decorators`](PrimaryExpression.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`end`](PrimaryExpression.md#end) + +*** + +### escapedText + +> `readonly` **escapedText**: [`__String`](../type-aliases/String.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:714 + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`flags`](PrimaryExpression.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`PrivateIdentifier`](../enumerations/SyntaxKind.md#privateidentifier) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:713 + +#### Overrides + +[`PrimaryExpression`](PrimaryExpression.md).[`kind`](PrimaryExpression.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`locals`](PrimaryExpression.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`modifiers`](PrimaryExpression.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`parent`](PrimaryExpression.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`pos`](PrimaryExpression.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`skipCheck`](PrimaryExpression.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`symbol`](PrimaryExpression.md#symbol) + +*** + +### text + +> `readonly` **text**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6108 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`forEachChild`](PrimaryExpression.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getChildAt`](PrimaryExpression.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getChildCount`](PrimaryExpression.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getChildren`](PrimaryExpression.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getEnd`](PrimaryExpression.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFirstToken`](PrimaryExpression.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFullStart`](PrimaryExpression.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFullText`](PrimaryExpression.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFullWidth`](PrimaryExpression.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getLastToken`](PrimaryExpression.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getLeadingTriviaWidth`](PrimaryExpression.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getSourceFile`](PrimaryExpression.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getStart`](PrimaryExpression.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getText`](PrimaryExpression.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getWidth`](PrimaryExpression.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/Program.md b/docs/api_docs/namespaces/ts/interfaces/Program.md new file mode 100644 index 0000000000000000000000000000000000000000..afaacf4637a5a19d349239529d1222498c70880c --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/Program.md @@ -0,0 +1,584 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / Program + +# Interface: Program + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2273 + +## Extends + +- [`ScriptReferenceHost`](ScriptReferenceHost.md) + +## Methods + +### emit() + +> **emit**(`targetSourceFile`?, `writeFile`?, `cancellationToken`?, `emitOnlyDtsFiles`?, `customTransformers`?): [`EmitResult`](EmitResult.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2293 + +Emits the JavaScript and declaration files. If targetSourceFile is not specified, then +the JavaScript and declaration files will be produced for all the files in this program. +If targetSourceFile is specified, then only the JavaScript and declaration for that +specific file will be generated. + +If writeFile is not specified then the writeFile callback from the compiler host will be +used for writing the JavaScript and declaration files. Otherwise, the writeFile parameter +will be invoked when writing the JavaScript and declaration files. + +#### Parameters + +##### targetSourceFile? + +[`SourceFile`](SourceFile.md) + +##### writeFile? + +[`WriteFileCallback`](../type-aliases/WriteFileCallback.md) + +##### cancellationToken? + +[`CancellationToken`](CancellationToken.md) + +##### emitOnlyDtsFiles? + +`boolean` + +##### customTransformers? + +[`CustomTransformers`](CustomTransformers.md) + +#### Returns + +[`EmitResult`](EmitResult.md) + +*** + +### getCompilerOptions() + +> **getCompilerOptions**(): [`CompilerOptions`](CompilerOptions.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2231 + +#### Returns + +[`CompilerOptions`](CompilerOptions.md) + +#### Inherited from + +[`ScriptReferenceHost`](ScriptReferenceHost.md).[`getCompilerOptions`](ScriptReferenceHost.md#getcompileroptions) + +*** + +### getConfigFileParsingDiagnostics() + +> **getConfigFileParsingDiagnostics**(): readonly [`Diagnostic`](Diagnostic.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2301 + +#### Returns + +readonly [`Diagnostic`](Diagnostic.md)[] + +*** + +### getCurrentDirectory() + +> **getCurrentDirectory**(): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2274 + +#### Returns + +`string` + +#### Overrides + +[`ScriptReferenceHost`](ScriptReferenceHost.md).[`getCurrentDirectory`](ScriptReferenceHost.md#getcurrentdirectory) + +*** + +### getDeclarationDiagnostics() + +> **getDeclarationDiagnostics**(`sourceFile`?, `cancellationToken`?): readonly [`DiagnosticWithLocation`](DiagnosticWithLocation.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2300 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### cancellationToken? + +[`CancellationToken`](CancellationToken.md) + +#### Returns + +readonly [`DiagnosticWithLocation`](DiagnosticWithLocation.md)[] + +*** + +### getEtsLibSFromProgram() + +> **getEtsLibSFromProgram**(): `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2302 + +#### Returns + +`string`[] + +*** + +### getFileCheckedModuleInfo()? + +> `optional` **getFileCheckedModuleInfo**(`containFilePath`): [`FileCheckModuleInfo`](FileCheckModuleInfo.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2329 + +#### Parameters + +##### containFilePath + +`string` + +#### Returns + +[`FileCheckModuleInfo`](FileCheckModuleInfo.md) + +*** + +### getGlobalDiagnostics() + +> **getGlobalDiagnostics**(`cancellationToken`?): readonly [`Diagnostic`](Diagnostic.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2295 + +#### Parameters + +##### cancellationToken? + +[`CancellationToken`](CancellationToken.md) + +#### Returns + +readonly [`Diagnostic`](Diagnostic.md)[] + +*** + +### getIdentifierCount() + +> **getIdentifierCount**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2312 + +#### Returns + +`number` + +*** + +### getInstantiationCount() + +> **getInstantiationCount**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2315 + +#### Returns + +`number` + +*** + +### getJsDocNodeCheckedConfig()? + +> `optional` **getJsDocNodeCheckedConfig**(`jsDocFileCheckInfo`, `symbolSourceFilePath`): [`JsDocNodeCheckConfig`](JsDocNodeCheckConfig.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2327 + +#### Parameters + +##### jsDocFileCheckInfo + +[`FileCheckModuleInfo`](FileCheckModuleInfo.md) + +##### symbolSourceFilePath + +`string` + +#### Returns + +[`JsDocNodeCheckConfig`](JsDocNodeCheckConfig.md) + +*** + +### getJsDocNodeConditionCheckedResult()? + +> `optional` **getJsDocNodeConditionCheckedResult**(`jsDocFileCheckedInfo`, `jsDocs`): [`ConditionCheckResult`](ConditionCheckResult.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2328 + +#### Parameters + +##### jsDocFileCheckedInfo + +[`FileCheckModuleInfo`](FileCheckModuleInfo.md) + +##### jsDocs + +[`JsDocTagInfo`](JsDocTagInfo.md)[] + +#### Returns + +[`ConditionCheckResult`](ConditionCheckResult.md) + +*** + +### getLinterTypeChecker() + +> **getLinterTypeChecker**(): [`TypeChecker`](TypeChecker.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2310 + +Gets a type checker that can be used to semantically analyze source files in the program for arkts linter. + +#### Returns + +[`TypeChecker`](TypeChecker.md) + +*** + +### getNodeCount() + +> **getNodeCount**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2311 + +#### Returns + +`number` + +*** + +### getOptionsDiagnostics() + +> **getOptionsDiagnostics**(`cancellationToken`?): readonly [`Diagnostic`](Diagnostic.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2294 + +#### Parameters + +##### cancellationToken? + +[`CancellationToken`](CancellationToken.md) + +#### Returns + +readonly [`Diagnostic`](Diagnostic.md)[] + +*** + +### getProjectReferences() + +> **getProjectReferences**(): `undefined` \| readonly [`ProjectReference`](ProjectReference.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2325 + +#### Returns + +`undefined` \| readonly [`ProjectReference`](ProjectReference.md)[] + +*** + +### getRelationCacheSizes() + +> **getRelationCacheSizes**(): `object` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2316 + +#### Returns + +`object` + +##### assignable + +> **assignable**: `number` + +##### identity + +> **identity**: `number` + +##### strictSubtype + +> **strictSubtype**: `number` + +##### subtype + +> **subtype**: `number` + +*** + +### getResolvedProjectReferences() + +> **getResolvedProjectReferences**(): `undefined` \| readonly (`undefined` \| [`ResolvedProjectReference`](ResolvedProjectReference.md))[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2326 + +#### Returns + +`undefined` \| readonly (`undefined` \| [`ResolvedProjectReference`](ResolvedProjectReference.md))[] + +*** + +### getRootFileNames() + +> **getRootFileNames**(): readonly `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2278 + +Get a list of root file names that were passed to a 'createProgram' + +#### Returns + +readonly `string`[] + +*** + +### getSemanticDiagnostics() + +> **getSemanticDiagnostics**(`sourceFile`?, `cancellationToken`?): readonly [`Diagnostic`](Diagnostic.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2298 + +The first time this is called, it will return global diagnostics (no location). + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### cancellationToken? + +[`CancellationToken`](CancellationToken.md) + +#### Returns + +readonly [`Diagnostic`](Diagnostic.md)[] + +*** + +### getSemanticDiagnosticsForLinter() + +> **getSemanticDiagnosticsForLinter**(`sourceFile`?, `cancellationToken`?): readonly [`Diagnostic`](Diagnostic.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2299 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### cancellationToken? + +[`CancellationToken`](CancellationToken.md) + +#### Returns + +readonly [`Diagnostic`](Diagnostic.md)[] + +*** + +### getSourceFile() + +> **getSourceFile**(`fileName`): `undefined` \| [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2232 + +#### Parameters + +##### fileName + +`string` + +#### Returns + +`undefined` \| [`SourceFile`](SourceFile.md) + +#### Inherited from + +[`ScriptReferenceHost`](ScriptReferenceHost.md).[`getSourceFile`](ScriptReferenceHost.md#getsourcefile) + +*** + +### getSourceFileByPath() + +> **getSourceFileByPath**(`path`): `undefined` \| [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2233 + +#### Parameters + +##### path + +[`Path`](../type-aliases/Path.md) + +#### Returns + +`undefined` \| [`SourceFile`](SourceFile.md) + +#### Inherited from + +[`ScriptReferenceHost`](ScriptReferenceHost.md).[`getSourceFileByPath`](ScriptReferenceHost.md#getsourcefilebypath) + +*** + +### getSourceFileFromReference() + +> **getSourceFileFromReference**(`referencingFile`, `ref`): `undefined` \| [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2324 + +#### Parameters + +##### referencingFile + +[`SourceFile`](SourceFile.md) | [`UnparsedSource`](UnparsedSource.md) + +##### ref + +[`FileReference`](FileReference.md) + +#### Returns + +`undefined` \| [`SourceFile`](SourceFile.md) + +*** + +### getSourceFiles() + +> **getSourceFiles**(): readonly [`SourceFile`](SourceFile.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2282 + +Get a list of files in the program + +#### Returns + +readonly [`SourceFile`](SourceFile.md)[] + +*** + +### getSymbolCount() + +> **getSymbolCount**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2313 + +#### Returns + +`number` + +*** + +### getSyntacticDiagnostics() + +> **getSyntacticDiagnostics**(`sourceFile`?, `cancellationToken`?): readonly [`DiagnosticWithLocation`](DiagnosticWithLocation.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2296 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### cancellationToken? + +[`CancellationToken`](CancellationToken.md) + +#### Returns + +readonly [`DiagnosticWithLocation`](DiagnosticWithLocation.md)[] + +*** + +### getTypeChecker() + +> **getTypeChecker**(): [`TypeChecker`](TypeChecker.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2306 + +Gets a type checker that can be used to semantically analyze source files in the program. + +#### Returns + +[`TypeChecker`](TypeChecker.md) + +*** + +### getTypeCount() + +> **getTypeCount**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2314 + +#### Returns + +`number` + +*** + +### isSourceFileDefaultLibrary() + +> **isSourceFileDefaultLibrary**(`file`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2323 + +#### Parameters + +##### file + +[`SourceFile`](SourceFile.md) + +#### Returns + +`boolean` + +*** + +### isSourceFileFromExternalLibrary() + +> **isSourceFileFromExternalLibrary**(`file`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2322 + +#### Parameters + +##### file + +[`SourceFile`](SourceFile.md) + +#### Returns + +`boolean` + +*** + +### releaseTypeChecker() + +> **releaseTypeChecker**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2333 + +Release typeChecker & linterTypeChecker + +#### Returns + +`void` diff --git a/docs/api_docs/namespaces/ts/interfaces/ProgramHost.md b/docs/api_docs/namespaces/ts/interfaces/ProgramHost.md new file mode 100644 index 0000000000000000000000000000000000000000..abb6073628f9142089571b8400d9700bc688bcdd --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ProgramHost.md @@ -0,0 +1,404 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ProgramHost + +# Interface: ProgramHost\ + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5808 + +## Extended by + +- [`WatchCompilerHost`](WatchCompilerHost.md) +- [`SolutionBuilderHostBase`](SolutionBuilderHostBase.md) + +## Type Parameters + +• **T** *extends* [`BuilderProgram`](BuilderProgram.md) + +## Properties + +### createProgram + +> **createProgram**: [`CreateProgram`](../type-aliases/CreateProgram.md)\<`T`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5812 + +Used to create the program when need for program creation or recreation detected + +## Methods + +### createHash()? + +> `optional` **createHash**(`data`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5818 + +#### Parameters + +##### data + +`string` + +#### Returns + +`string` + +*** + +### directoryExists()? + +> `optional` **directoryExists**(`path`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5830 + +If provided, used for module resolution as well as to handle directory structure + +#### Parameters + +##### path + +`string` + +#### Returns + +`boolean` + +*** + +### fileExists() + +> **fileExists**(`path`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5823 + +Use to check file presence for source files and +if resolveModuleNames is not provided (complier is in charge of module resolution) then module files as well + +#### Parameters + +##### path + +`string` + +#### Returns + +`boolean` + +*** + +### getCurrentDirectory() + +> **getCurrentDirectory**(): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5815 + +#### Returns + +`string` + +*** + +### getDefaultLibFileName() + +> **getDefaultLibFileName**(`options`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5816 + +#### Parameters + +##### options + +[`CompilerOptions`](CompilerOptions.md) + +#### Returns + +`string` + +*** + +### getDefaultLibLocation()? + +> `optional` **getDefaultLibLocation**(): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5817 + +#### Returns + +`string` + +*** + +### getDirectories()? + +> `optional` **getDirectories**(`path`): `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5832 + +If provided, used in resolutions as well as handling directory structure + +#### Parameters + +##### path + +`string` + +#### Returns + +`string`[] + +*** + +### getEnvironmentVariable()? + +> `optional` **getEnvironmentVariable**(`name`): `undefined` \| `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5840 + +If provided is used to get the environment variable + +#### Parameters + +##### name + +`string` + +#### Returns + +`undefined` \| `string` + +*** + +### getModuleResolutionCache()? + +> `optional` **getModuleResolutionCache**(): `undefined` \| [`ModuleResolutionCache`](ModuleResolutionCache.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5850 + +Returns the module resolution cache used by a provided `resolveModuleNames` implementation so that any non-name module resolution operations (eg, package.json lookup) can reuse it + +#### Returns + +`undefined` \| [`ModuleResolutionCache`](ModuleResolutionCache.md) + +*** + +### getNewLine() + +> **getNewLine**(): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5814 + +#### Returns + +`string` + +*** + +### hasInvalidatedResolutions()? + +> `optional` **hasInvalidatedResolutions**(`filePath`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5846 + +If provided along with custom resolveModuleNames or resolveTypeReferenceDirectives, used to determine if unchanged file path needs to re-resolve modules/type reference directives + +#### Parameters + +##### filePath + +[`Path`](../type-aliases/Path.md) + +#### Returns + +`boolean` + +*** + +### readDirectory()? + +> `optional` **readDirectory**(`path`, `extensions`?, `exclude`?, `include`?, `depth`?): `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5834 + +If provided, used to cache and handle directory structure modifications + +#### Parameters + +##### path + +`string` + +##### extensions? + +readonly `string`[] + +##### exclude? + +readonly `string`[] + +##### include? + +readonly `string`[] + +##### depth? + +`number` + +#### Returns + +`string`[] + +*** + +### readFile() + +> **readFile**(`path`, `encoding`?): `undefined` \| `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5828 + +Use to read file text for source files and +if resolveModuleNames is not provided (complier is in charge of module resolution) then module files as well + +#### Parameters + +##### path + +`string` + +##### encoding? + +`string` + +#### Returns + +`undefined` \| `string` + +*** + +### realpath()? + +> `optional` **realpath**(`path`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5836 + +Symbol links resolution + +#### Parameters + +##### path + +`string` + +#### Returns + +`string` + +*** + +### resolveModuleNames()? + +> `optional` **resolveModuleNames**(`moduleNames`, `containingFile`, `reusedNames`, `redirectedReference`, `options`, `containingSourceFile`?): (`undefined` \| [`ResolvedModule`](ResolvedModule.md))[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5842 + +If provided, used to resolve the module names, otherwise typescript's default module resolution + +#### Parameters + +##### moduleNames + +`string`[] + +##### containingFile + +`string` + +##### reusedNames + +`undefined` | `string`[] + +##### redirectedReference + +`undefined` | [`ResolvedProjectReference`](ResolvedProjectReference.md) + +##### options + +[`CompilerOptions`](CompilerOptions.md) + +##### containingSourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +(`undefined` \| [`ResolvedModule`](ResolvedModule.md))[] + +*** + +### resolveTypeReferenceDirectives()? + +> `optional` **resolveTypeReferenceDirectives**(`typeReferenceDirectiveNames`, `containingFile`, `redirectedReference`, `options`, `containingFileMode`?): (`undefined` \| [`ResolvedTypeReferenceDirective`](ResolvedTypeReferenceDirective.md))[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5844 + +If provided, used to resolve type reference directives, otherwise typescript's default resolution + +#### Parameters + +##### typeReferenceDirectiveNames + +`string`[] | readonly [`FileReference`](FileReference.md)[] + +##### containingFile + +`string` + +##### redirectedReference + +`undefined` | [`ResolvedProjectReference`](ResolvedProjectReference.md) + +##### options + +[`CompilerOptions`](CompilerOptions.md) + +##### containingFileMode? + +[`CommonJS`](../enumerations/ModuleKind.md#commonjs) | [`ESNext`](../enumerations/ModuleKind.md#esnext) + +#### Returns + +(`undefined` \| [`ResolvedTypeReferenceDirective`](ResolvedTypeReferenceDirective.md))[] + +*** + +### trace()? + +> `optional` **trace**(`s`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5838 + +If provided would be used to write log about compilation + +#### Parameters + +##### s + +`string` + +#### Returns + +`void` + +*** + +### useCaseSensitiveFileNames() + +> **useCaseSensitiveFileNames**(): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5813 + +#### Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/interfaces/ProjectReference.md b/docs/api_docs/namespaces/ts/interfaces/ProjectReference.md new file mode 100644 index 0000000000000000000000000000000000000000..393ffd4d74f293fdb546e75b16ac78d35e6e765a --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ProjectReference.md @@ -0,0 +1,49 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ProjectReference + +# Interface: ProjectReference + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3043 + +## Properties + +### circular? + +> `optional` **circular**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3051 + +True if it is intended that this reference form a circularity + +*** + +### originalPath? + +> `optional` **originalPath**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3047 + +The path as the user originally wrote it + +*** + +### path + +> **path**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3045 + +A normalized path on disk + +*** + +### prepend? + +> `optional` **prepend**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3049 + +True if the output of this reference should be prepended to the output of this project. Only valid for --outFile compilations diff --git a/docs/api_docs/namespaces/ts/interfaces/PropertyAccessChain.md b/docs/api_docs/namespaces/ts/interfaces/PropertyAccessChain.md new file mode 100644 index 0000000000000000000000000000000000000000..4a209e57d482bdddb86b430fa0960729933fade2 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/PropertyAccessChain.md @@ -0,0 +1,593 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / PropertyAccessChain + +# Interface: PropertyAccessChain + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1310 + +## Extends + +- [`PropertyAccessExpression`](PropertyAccessExpression.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`_declarationBrand`](PropertyAccessExpression.md#_declarationbrand) + +*** + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`_expressionBrand`](PropertyAccessExpression.md#_expressionbrand) + +*** + +### \_leftHandSideExpressionBrand + +> **\_leftHandSideExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1086 + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`_leftHandSideExpressionBrand`](PropertyAccessExpression.md#_lefthandsideexpressionbrand) + +*** + +### \_memberExpressionBrand + +> **\_memberExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1089 + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`_memberExpressionBrand`](PropertyAccessExpression.md#_memberexpressionbrand) + +*** + +### \_optionalChainBrand + +> **\_optionalChainBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1311 + +*** + +### \_unaryExpressionBrand + +> **\_unaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1066 + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`_unaryExpressionBrand`](PropertyAccessExpression.md#_unaryexpressionbrand) + +*** + +### \_updateExpressionBrand + +> **\_updateExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1071 + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`_updateExpressionBrand`](PropertyAccessExpression.md#_updateexpressionbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`decorators`](PropertyAccessExpression.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`end`](PropertyAccessExpression.md#end) + +*** + +### expression + +> `readonly` **expression**: [`LeftHandSideExpression`](LeftHandSideExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1306 + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`expression`](PropertyAccessExpression.md#expression) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`flags`](PropertyAccessExpression.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`PropertyAccessExpression`](../enumerations/SyntaxKind.md#propertyaccessexpression) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1305 + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`kind`](PropertyAccessExpression.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`locals`](PropertyAccessExpression.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`modifiers`](PropertyAccessExpression.md#modifiers) + +*** + +### name + +> `readonly` **name**: [`MemberName`](../type-aliases/MemberName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1312 + +#### Overrides + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`name`](PropertyAccessExpression.md#name) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`parent`](PropertyAccessExpression.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`pos`](PropertyAccessExpression.md#pos) + +*** + +### questionDotToken? + +> `readonly` `optional` **questionDotToken**: [`QuestionDotToken`](../type-aliases/QuestionDotToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1307 + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`questionDotToken`](PropertyAccessExpression.md#questiondottoken) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`skipCheck`](PropertyAccessExpression.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`symbol`](PropertyAccessExpression.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`forEachChild`](PropertyAccessExpression.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`getChildAt`](PropertyAccessExpression.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`getChildCount`](PropertyAccessExpression.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`getChildren`](PropertyAccessExpression.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`getEnd`](PropertyAccessExpression.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`getFirstToken`](PropertyAccessExpression.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`getFullStart`](PropertyAccessExpression.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`getFullText`](PropertyAccessExpression.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`getFullWidth`](PropertyAccessExpression.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`getLastToken`](PropertyAccessExpression.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`getLeadingTriviaWidth`](PropertyAccessExpression.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`getSourceFile`](PropertyAccessExpression.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`getStart`](PropertyAccessExpression.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`getText`](PropertyAccessExpression.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`getWidth`](PropertyAccessExpression.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/PropertyAccessEntityNameExpression.md b/docs/api_docs/namespaces/ts/interfaces/PropertyAccessEntityNameExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..e458cca2069f6e3f6ea86e45ff63f330ed9b8da3 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/PropertyAccessEntityNameExpression.md @@ -0,0 +1,595 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / PropertyAccessEntityNameExpression + +# Interface: PropertyAccessEntityNameExpression + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1318 + +Brand for a PropertyAccessExpression which, like a QualifiedName, consists of a sequence of identifiers separated by dots. + +## Extends + +- [`PropertyAccessExpression`](PropertyAccessExpression.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`_declarationBrand`](PropertyAccessExpression.md#_declarationbrand) + +*** + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`_expressionBrand`](PropertyAccessExpression.md#_expressionbrand) + +*** + +### \_leftHandSideExpressionBrand + +> **\_leftHandSideExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1086 + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`_leftHandSideExpressionBrand`](PropertyAccessExpression.md#_lefthandsideexpressionbrand) + +*** + +### \_memberExpressionBrand + +> **\_memberExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1089 + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`_memberExpressionBrand`](PropertyAccessExpression.md#_memberexpressionbrand) + +*** + +### \_propertyAccessExpressionLikeQualifiedNameBrand? + +> `optional` **\_propertyAccessExpressionLikeQualifiedNameBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1319 + +*** + +### \_unaryExpressionBrand + +> **\_unaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1066 + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`_unaryExpressionBrand`](PropertyAccessExpression.md#_unaryexpressionbrand) + +*** + +### \_updateExpressionBrand + +> **\_updateExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1071 + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`_updateExpressionBrand`](PropertyAccessExpression.md#_updateexpressionbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`decorators`](PropertyAccessExpression.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`end`](PropertyAccessExpression.md#end) + +*** + +### expression + +> `readonly` **expression**: [`EntityNameExpression`](../type-aliases/EntityNameExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1320 + +#### Overrides + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`expression`](PropertyAccessExpression.md#expression) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`flags`](PropertyAccessExpression.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`PropertyAccessExpression`](../enumerations/SyntaxKind.md#propertyaccessexpression) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1305 + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`kind`](PropertyAccessExpression.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`locals`](PropertyAccessExpression.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`modifiers`](PropertyAccessExpression.md#modifiers) + +*** + +### name + +> `readonly` **name**: [`Identifier`](Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1321 + +#### Overrides + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`name`](PropertyAccessExpression.md#name) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`parent`](PropertyAccessExpression.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`pos`](PropertyAccessExpression.md#pos) + +*** + +### questionDotToken? + +> `readonly` `optional` **questionDotToken**: [`QuestionDotToken`](../type-aliases/QuestionDotToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1307 + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`questionDotToken`](PropertyAccessExpression.md#questiondottoken) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`skipCheck`](PropertyAccessExpression.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`symbol`](PropertyAccessExpression.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`forEachChild`](PropertyAccessExpression.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`getChildAt`](PropertyAccessExpression.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`getChildCount`](PropertyAccessExpression.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`getChildren`](PropertyAccessExpression.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`getEnd`](PropertyAccessExpression.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`getFirstToken`](PropertyAccessExpression.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`getFullStart`](PropertyAccessExpression.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`getFullText`](PropertyAccessExpression.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`getFullWidth`](PropertyAccessExpression.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`getLastToken`](PropertyAccessExpression.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`getLeadingTriviaWidth`](PropertyAccessExpression.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`getSourceFile`](PropertyAccessExpression.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`getStart`](PropertyAccessExpression.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`getText`](PropertyAccessExpression.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`getWidth`](PropertyAccessExpression.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/PropertyAccessExpression.md b/docs/api_docs/namespaces/ts/interfaces/PropertyAccessExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..30cd96d6f3df7255b2870fc671535bd774dc1766 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/PropertyAccessExpression.md @@ -0,0 +1,584 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / PropertyAccessExpression + +# Interface: PropertyAccessExpression + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1304 + +## Extends + +- [`MemberExpression`](MemberExpression.md).[`NamedDeclaration`](NamedDeclaration.md) + +## Extended by + +- [`PropertyAccessChain`](PropertyAccessChain.md) +- [`SuperPropertyAccessExpression`](SuperPropertyAccessExpression.md) +- [`PropertyAccessEntityNameExpression`](PropertyAccessEntityNameExpression.md) +- [`JsxTagNamePropertyAccess`](JsxTagNamePropertyAccess.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`_declarationBrand`](NamedDeclaration.md#_declarationbrand) + +*** + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`_expressionBrand`](MemberExpression.md#_expressionbrand) + +*** + +### \_leftHandSideExpressionBrand + +> **\_leftHandSideExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1086 + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`_leftHandSideExpressionBrand`](MemberExpression.md#_lefthandsideexpressionbrand) + +*** + +### \_memberExpressionBrand + +> **\_memberExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1089 + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`_memberExpressionBrand`](MemberExpression.md#_memberexpressionbrand) + +*** + +### \_unaryExpressionBrand + +> **\_unaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1066 + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`_unaryExpressionBrand`](MemberExpression.md#_unaryexpressionbrand) + +*** + +### \_updateExpressionBrand + +> **\_updateExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1071 + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`_updateExpressionBrand`](MemberExpression.md#_updateexpressionbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`decorators`](NamedDeclaration.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`end`](NamedDeclaration.md#end) + +*** + +### expression + +> `readonly` **expression**: [`LeftHandSideExpression`](LeftHandSideExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1306 + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`flags`](NamedDeclaration.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`PropertyAccessExpression`](../enumerations/SyntaxKind.md#propertyaccessexpression) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1305 + +#### Overrides + +[`NamedDeclaration`](NamedDeclaration.md).[`kind`](NamedDeclaration.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`locals`](NamedDeclaration.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`modifiers`](NamedDeclaration.md#modifiers) + +*** + +### name + +> `readonly` **name**: [`MemberName`](../type-aliases/MemberName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1308 + +#### Overrides + +[`NamedDeclaration`](NamedDeclaration.md).[`name`](NamedDeclaration.md#name) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`parent`](NamedDeclaration.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`pos`](NamedDeclaration.md#pos) + +*** + +### questionDotToken? + +> `readonly` `optional` **questionDotToken**: [`QuestionDotToken`](../type-aliases/QuestionDotToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1307 + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`skipCheck`](NamedDeclaration.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`symbol`](NamedDeclaration.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`forEachChild`](NamedDeclaration.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getChildAt`](NamedDeclaration.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getChildCount`](NamedDeclaration.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getChildren`](NamedDeclaration.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getEnd`](NamedDeclaration.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFirstToken`](NamedDeclaration.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFullStart`](NamedDeclaration.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFullText`](NamedDeclaration.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFullWidth`](NamedDeclaration.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getLastToken`](NamedDeclaration.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getLeadingTriviaWidth`](NamedDeclaration.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getSourceFile`](NamedDeclaration.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getStart`](NamedDeclaration.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getText`](NamedDeclaration.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getWidth`](NamedDeclaration.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/PropertyAssignment.md b/docs/api_docs/namespaces/ts/interfaces/PropertyAssignment.md new file mode 100644 index 0000000000000000000000000000000000000000..12cddffdaa22bf9e7906e8231f128266dd4d6bd7 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/PropertyAssignment.md @@ -0,0 +1,545 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / PropertyAssignment + +# Interface: PropertyAssignment + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:803 + +## Extends + +- [`ObjectLiteralElement`](ObjectLiteralElement.md).[`JSDocContainer`](JSDocContainer.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`_declarationBrand`](ObjectLiteralElement.md#_declarationbrand) + +*** + +### \_objectLiteralBrand + +> **\_objectLiteralBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:798 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`_objectLiteralBrand`](ObjectLiteralElement.md#_objectliteralbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`decorators`](ObjectLiteralElement.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`end`](ObjectLiteralElement.md#end) + +*** + +### ~~exclamationToken?~~ + +> `readonly` `optional` **exclamationToken**: [`ExclamationToken`](../type-aliases/ExclamationToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8396 + +#### Deprecated + +A property assignment cannot have an exclamation token + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`flags`](ObjectLiteralElement.md#flags) + +*** + +### initializer + +> `readonly` **initializer**: [`Expression`](Expression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:807 + +*** + +### kind + +> `readonly` **kind**: [`PropertyAssignment`](../enumerations/SyntaxKind.md#propertyassignment) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:804 + +#### Overrides + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`kind`](ObjectLiteralElement.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`locals`](ObjectLiteralElement.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`modifiers`](ObjectLiteralElement.md#modifiers) + +*** + +### name + +> `readonly` **name**: [`PropertyName`](../type-aliases/PropertyName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:806 + +#### Overrides + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`name`](ObjectLiteralElement.md#name) + +*** + +### parent + +> `readonly` **parent**: [`ObjectLiteralExpression`](ObjectLiteralExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:805 + +#### Overrides + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`parent`](ObjectLiteralElement.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`pos`](ObjectLiteralElement.md#pos) + +*** + +### ~~questionToken?~~ + +> `readonly` `optional` **questionToken**: [`QuestionToken`](../type-aliases/QuestionToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8394 + +#### Deprecated + +A property assignment cannot have a question token + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`skipCheck`](ObjectLiteralElement.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`symbol`](ObjectLiteralElement.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`forEachChild`](ObjectLiteralElement.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getChildAt`](ObjectLiteralElement.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getChildCount`](ObjectLiteralElement.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getChildren`](ObjectLiteralElement.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getEnd`](ObjectLiteralElement.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getFirstToken`](ObjectLiteralElement.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getFullStart`](ObjectLiteralElement.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getFullText`](ObjectLiteralElement.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getFullWidth`](ObjectLiteralElement.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getLastToken`](ObjectLiteralElement.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getLeadingTriviaWidth`](ObjectLiteralElement.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getSourceFile`](ObjectLiteralElement.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getStart`](ObjectLiteralElement.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getText`](ObjectLiteralElement.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getWidth`](ObjectLiteralElement.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/PropertyDeclaration.md b/docs/api_docs/namespaces/ts/interfaces/PropertyDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..809b428217b3ca9c75d19081e6ac6f7170a0c792 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/PropertyDeclaration.md @@ -0,0 +1,549 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / PropertyDeclaration + +# Interface: PropertyDeclaration + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:784 + +## Extends + +- [`ClassElement`](ClassElement.md).[`JSDocContainer`](JSDocContainer.md) + +## Extended by + +- [`AutoAccessorPropertyDeclaration`](AutoAccessorPropertyDeclaration.md) + +## Properties + +### \_classElementBrand + +> **\_classElementBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1633 + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`_classElementBrand`](ClassElement.md#_classelementbrand) + +*** + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`_declarationBrand`](ClassElement.md#_declarationbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`decorators`](ClassElement.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`end`](ClassElement.md#end) + +*** + +### exclamationToken? + +> `readonly` `optional` **exclamationToken**: [`ExclamationToken`](../type-aliases/ExclamationToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:790 + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`flags`](ClassElement.md#flags) + +*** + +### initializer? + +> `readonly` `optional` **initializer**: [`Expression`](Expression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:792 + +*** + +### kind + +> `readonly` **kind**: [`PropertyDeclaration`](../enumerations/SyntaxKind.md#propertydeclaration) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:785 + +#### Overrides + +[`ClassElement`](ClassElement.md).[`kind`](ClassElement.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`locals`](ClassElement.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:787 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Overrides + +[`ClassElement`](ClassElement.md).[`modifiers`](ClassElement.md#modifiers) + +*** + +### name + +> `readonly` **name**: [`PropertyName`](../type-aliases/PropertyName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:788 + +#### Overrides + +[`ClassElement`](ClassElement.md).[`name`](ClassElement.md#name) + +*** + +### parent + +> `readonly` **parent**: [`ClassLikeDeclaration`](../type-aliases/ClassLikeDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:786 + +#### Overrides + +[`ClassElement`](ClassElement.md).[`parent`](ClassElement.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`pos`](ClassElement.md#pos) + +*** + +### questionToken? + +> `readonly` `optional` **questionToken**: [`QuestionToken`](../type-aliases/QuestionToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:789 + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`skipCheck`](ClassElement.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`symbol`](ClassElement.md#symbol) + +*** + +### type? + +> `readonly` `optional` **type**: [`TypeNode`](TypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:791 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`forEachChild`](ClassElement.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`getChildAt`](ClassElement.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`getChildCount`](ClassElement.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`getChildren`](ClassElement.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`getEnd`](ClassElement.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`getFirstToken`](ClassElement.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`getFullStart`](ClassElement.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`getFullText`](ClassElement.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`getFullWidth`](ClassElement.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`getLastToken`](ClassElement.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`getLeadingTriviaWidth`](ClassElement.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`getSourceFile`](ClassElement.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`getStart`](ClassElement.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`getText`](ClassElement.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`getWidth`](ClassElement.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/PropertyLikeDeclaration.md b/docs/api_docs/namespaces/ts/interfaces/PropertyLikeDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..ac3830891f64a3bd4b5f2787959583863553aff4 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/PropertyLikeDeclaration.md @@ -0,0 +1,501 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / PropertyLikeDeclaration + +# Interface: PropertyLikeDeclaration + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:822 + +## Extends + +- [`NamedDeclaration`](NamedDeclaration.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`_declarationBrand`](NamedDeclaration.md#_declarationbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`decorators`](NamedDeclaration.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`end`](NamedDeclaration.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`flags`](NamedDeclaration.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`SyntaxKind`](../enumerations/SyntaxKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:598 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`kind`](NamedDeclaration.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`locals`](NamedDeclaration.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`modifiers`](NamedDeclaration.md#modifiers) + +*** + +### name + +> `readonly` **name**: [`PropertyName`](../type-aliases/PropertyName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:823 + +#### Overrides + +[`NamedDeclaration`](NamedDeclaration.md).[`name`](NamedDeclaration.md#name) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`parent`](NamedDeclaration.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`pos`](NamedDeclaration.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`skipCheck`](NamedDeclaration.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`symbol`](NamedDeclaration.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`forEachChild`](NamedDeclaration.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getChildAt`](NamedDeclaration.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getChildCount`](NamedDeclaration.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getChildren`](NamedDeclaration.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getEnd`](NamedDeclaration.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFirstToken`](NamedDeclaration.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFullStart`](NamedDeclaration.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFullText`](NamedDeclaration.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFullWidth`](NamedDeclaration.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getLastToken`](NamedDeclaration.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getLeadingTriviaWidth`](NamedDeclaration.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getSourceFile`](NamedDeclaration.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getStart`](NamedDeclaration.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getText`](NamedDeclaration.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getWidth`](NamedDeclaration.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/PropertySignature.md b/docs/api_docs/namespaces/ts/interfaces/PropertySignature.md new file mode 100644 index 0000000000000000000000000000000000000000..8b74d62e88e3445317de060fbadc451ddb7b4921 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/PropertySignature.md @@ -0,0 +1,545 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / PropertySignature + +# Interface: PropertySignature + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:777 + +## Extends + +- [`TypeElement`](TypeElement.md).[`JSDocContainer`](JSDocContainer.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`_declarationBrand`](TypeElement.md#_declarationbrand) + +*** + +### \_typeElementBrand + +> **\_typeElementBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1637 + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`_typeElementBrand`](TypeElement.md#_typeelementbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`decorators`](TypeElement.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`end`](TypeElement.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`flags`](TypeElement.md#flags) + +*** + +### ~~initializer?~~ + +> `readonly` `optional` **initializer**: [`Expression`](Expression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8390 + +#### Deprecated + +A property signature cannot have an initializer + +*** + +### kind + +> `readonly` **kind**: [`PropertySignature`](../enumerations/SyntaxKind.md#propertysignature) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:778 + +#### Overrides + +[`TypeElement`](TypeElement.md).[`kind`](TypeElement.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`locals`](TypeElement.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`Modifier`](../type-aliases/Modifier.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:779 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Overrides + +[`TypeElement`](TypeElement.md).[`modifiers`](TypeElement.md#modifiers) + +*** + +### name + +> `readonly` **name**: [`PropertyName`](../type-aliases/PropertyName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:780 + +#### Overrides + +[`TypeElement`](TypeElement.md).[`name`](TypeElement.md#name) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`parent`](TypeElement.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`pos`](TypeElement.md#pos) + +*** + +### questionToken? + +> `readonly` `optional` **questionToken**: [`QuestionToken`](../type-aliases/QuestionToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:781 + +#### Overrides + +[`TypeElement`](TypeElement.md).[`questionToken`](TypeElement.md#questiontoken) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`skipCheck`](TypeElement.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`symbol`](TypeElement.md#symbol) + +*** + +### type? + +> `readonly` `optional` **type**: [`TypeNode`](TypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:782 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`forEachChild`](TypeElement.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getChildAt`](TypeElement.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getChildCount`](TypeElement.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getChildren`](TypeElement.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getEnd`](TypeElement.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getFirstToken`](TypeElement.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getFullStart`](TypeElement.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getFullText`](TypeElement.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getFullWidth`](TypeElement.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getLastToken`](TypeElement.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getLeadingTriviaWidth`](TypeElement.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getSourceFile`](TypeElement.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getStart`](TypeElement.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getText`](TypeElement.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`getWidth`](TypeElement.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/PseudoBigInt.md b/docs/api_docs/namespaces/ts/interfaces/PseudoBigInt.md new file mode 100644 index 0000000000000000000000000000000000000000..759772a385c6ef1c2dc00001ae5c47294c8afaa2 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/PseudoBigInt.md @@ -0,0 +1,27 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / PseudoBigInt + +# Interface: PseudoBigInt + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4507 + +Represents a bigint literal value without requiring bigint support + +## Properties + +### base10Value + +> **base10Value**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4509 + +*** + +### negative + +> **negative**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4508 diff --git a/docs/api_docs/namespaces/ts/interfaces/PunctuationToken.md b/docs/api_docs/namespaces/ts/interfaces/PunctuationToken.md new file mode 100644 index 0000000000000000000000000000000000000000..ad1ffc6134623da5f691ef6f6edd649b7a1ebb7c --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/PunctuationToken.md @@ -0,0 +1,481 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / PunctuationToken + +# Interface: PunctuationToken\ + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:622 + +## Extends + +- [`Token`](Token.md)\<`TKind`\> + +## Type Parameters + +• **TKind** *extends* [`PunctuationSyntaxKind`](../type-aliases/PunctuationSyntaxKind.md) + +## Properties + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Token`](Token.md).[`decorators`](Token.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Token`](Token.md).[`end`](Token.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Token`](Token.md).[`flags`](Token.md#flags) + +*** + +### kind + +> `readonly` **kind**: `TKind` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:619 + +#### Inherited from + +[`Token`](Token.md).[`kind`](Token.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Token`](Token.md).[`locals`](Token.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Token`](Token.md).[`modifiers`](Token.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`Token`](Token.md).[`parent`](Token.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Token`](Token.md).[`pos`](Token.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Token`](Token.md).[`skipCheck`](Token.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Token`](Token.md).[`symbol`](Token.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Token`](Token.md).[`forEachChild`](Token.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Token`](Token.md).[`getChildAt`](Token.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Token`](Token.md).[`getChildCount`](Token.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Token`](Token.md).[`getChildren`](Token.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Token`](Token.md).[`getEnd`](Token.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Token`](Token.md).[`getFirstToken`](Token.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Token`](Token.md).[`getFullStart`](Token.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Token`](Token.md).[`getFullText`](Token.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Token`](Token.md).[`getFullWidth`](Token.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Token`](Token.md).[`getLastToken`](Token.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Token`](Token.md).[`getLeadingTriviaWidth`](Token.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Token`](Token.md).[`getSourceFile`](Token.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Token`](Token.md).[`getStart`](Token.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Token`](Token.md).[`getText`](Token.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Token`](Token.md).[`getWidth`](Token.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/Push.md b/docs/api_docs/namespaces/ts/interfaces/Push.md new file mode 100644 index 0000000000000000000000000000000000000000..11a83f84ade03e848277640bf58c1b96f637d371 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/Push.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / Push + +# Interface: Push\ + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:89 + +Array that is only intended to be pushed to, never read. + +## Type Parameters + +• **T** + +## Methods + +### push() + +> **push**(...`values`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:90 + +#### Parameters + +##### values + +...`T`[] + +#### Returns + +`void` diff --git a/docs/api_docs/namespaces/ts/interfaces/QualifiedName.md b/docs/api_docs/namespaces/ts/interfaces/QualifiedName.md new file mode 100644 index 0000000000000000000000000000000000000000..b5f6d6e05418501eb9edcc98d79fee4b27901f33 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/QualifiedName.md @@ -0,0 +1,493 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / QualifiedName + +# Interface: QualifiedName + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:689 + +## Extends + +- [`Node`](Node.md) + +## Properties + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`decorators`](Node.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Node`](Node.md).[`end`](Node.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Node`](Node.md).[`flags`](Node.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`QualifiedName`](../enumerations/SyntaxKind.md#qualifiedname) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:690 + +#### Overrides + +[`Node`](Node.md).[`kind`](Node.md#kind) + +*** + +### left + +> `readonly` **left**: [`EntityName`](../type-aliases/EntityName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:691 + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Node`](Node.md).[`locals`](Node.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`modifiers`](Node.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`Node`](Node.md).[`parent`](Node.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Node`](Node.md).[`pos`](Node.md#pos) + +*** + +### right + +> `readonly` **right**: [`Identifier`](Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:692 + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Node`](Node.md).[`skipCheck`](Node.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Node`](Node.md).[`symbol`](Node.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Node`](Node.md).[`forEachChild`](Node.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getChildAt`](Node.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getChildCount`](Node.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Node`](Node.md).[`getChildren`](Node.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getEnd`](Node.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getFirstToken`](Node.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullStart`](Node.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getFullText`](Node.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullWidth`](Node.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getLastToken`](Node.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getLeadingTriviaWidth`](Node.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Node`](Node.md).[`getSourceFile`](Node.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getStart`](Node.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getText`](Node.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getWidth`](Node.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/QuickInfo.md b/docs/api_docs/namespaces/ts/interfaces/QuickInfo.md new file mode 100644 index 0000000000000000000000000000000000000000..a1d9e457e21980acd6bda80415a5af77cf688809 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/QuickInfo.md @@ -0,0 +1,57 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / QuickInfo + +# Interface: QuickInfo + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6881 + +## Properties + +### displayParts? + +> `optional` **displayParts**: [`SymbolDisplayPart`](SymbolDisplayPart.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6885 + +*** + +### documentation? + +> `optional` **documentation**: [`SymbolDisplayPart`](SymbolDisplayPart.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6886 + +*** + +### kind + +> **kind**: [`ScriptElementKind`](../enumerations/ScriptElementKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6882 + +*** + +### kindModifiers + +> **kindModifiers**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6883 + +*** + +### tags? + +> `optional` **tags**: [`JSDocTagInfo`](JSDocTagInfo-1.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6887 + +*** + +### textSpan + +> **textSpan**: [`TextSpan`](TextSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6884 diff --git a/docs/api_docs/namespaces/ts/interfaces/RawSourceMap.md b/docs/api_docs/namespaces/ts/interfaces/RawSourceMap.md new file mode 100644 index 0000000000000000000000000000000000000000..2ae216930ff08528ff607639a892d87b448e5c7d --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/RawSourceMap.md @@ -0,0 +1,65 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / RawSourceMap + +# Interface: RawSourceMap + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4272 + +## Properties + +### file + +> **file**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4274 + +*** + +### mappings + +> **mappings**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4278 + +*** + +### names? + +> `optional` **names**: `null` \| `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4279 + +*** + +### sourceRoot? + +> `optional` **sourceRoot**: `null` \| `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4275 + +*** + +### sources + +> **sources**: `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4276 + +*** + +### sourcesContent? + +> `optional` **sourcesContent**: `null` \| (`null` \| `string`)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4277 + +*** + +### version + +> **version**: `3` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4273 diff --git a/docs/api_docs/namespaces/ts/interfaces/ReadBuildProgramHost.md b/docs/api_docs/namespaces/ts/interfaces/ReadBuildProgramHost.md new file mode 100644 index 0000000000000000000000000000000000000000..5869ffa8ac795528a7992d3915257aef4938c04c --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ReadBuildProgramHost.md @@ -0,0 +1,63 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ReadBuildProgramHost + +# Interface: ReadBuildProgramHost + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5774 + +## Methods + +### getCurrentDirectory() + +> **getCurrentDirectory**(): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5776 + +#### Returns + +`string` + +*** + +### getLastCompiledProgram()? + +> `optional` **getLastCompiledProgram**(): [`Program`](Program.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5778 + +#### Returns + +[`Program`](Program.md) + +*** + +### readFile() + +> **readFile**(`fileName`): `undefined` \| `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5777 + +#### Parameters + +##### fileName + +`string` + +#### Returns + +`undefined` \| `string` + +*** + +### useCaseSensitiveFileNames() + +> **useCaseSensitiveFileNames**(): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5775 + +#### Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/interfaces/ReadonlyCollection.md b/docs/api_docs/namespaces/ts/interfaces/ReadonlyCollection.md new file mode 100644 index 0000000000000000000000000000000000000000..703a050a40d99dfab2251afdf299a267c80bbe0c --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ReadonlyCollection.md @@ -0,0 +1,59 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ReadonlyCollection + +# Interface: ReadonlyCollection\ + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:35 + +Common read methods for ES6 Map/Set. + +## Extended by + +- [`Collection`](Collection.md) +- [`ReadonlyESMap`](ReadonlyESMap.md) +- [`ReadonlySet`](ReadonlySet.md) + +## Type Parameters + +• **K** + +## Properties + +### size + +> `readonly` **size**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:36 + +## Methods + +### has() + +> **has**(`key`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:37 + +#### Parameters + +##### key + +`K` + +#### Returns + +`boolean` + +*** + +### keys() + +> **keys**(): [`Iterator`](Iterator.md)\<`K`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:38 + +#### Returns + +[`Iterator`](Iterator.md)\<`K`\> diff --git a/docs/api_docs/namespaces/ts/interfaces/ReadonlyESMap.md b/docs/api_docs/namespaces/ts/interfaces/ReadonlyESMap.md new file mode 100644 index 0000000000000000000000000000000000000000..2b94e013f93448ffb4d24ff01317393ca1fdc8b6 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ReadonlyESMap.md @@ -0,0 +1,137 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ReadonlyESMap + +# Interface: ReadonlyESMap\ + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:46 + +ES6 Map interface, only read methods included. + +## Extends + +- [`ReadonlyCollection`](ReadonlyCollection.md)\<`K`\> + +## Extended by + +- [`ReadonlyMap`](ReadonlyMap.md) +- [`ESMap`](ESMap.md) +- [`ReadonlyUnderscoreEscapedMap`](ReadonlyUnderscoreEscapedMap.md) + +## Type Parameters + +• **K** + +• **V** + +## Properties + +### size + +> `readonly` **size**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:36 + +#### Inherited from + +[`ReadonlyCollection`](ReadonlyCollection.md).[`size`](ReadonlyCollection.md#size) + +## Methods + +### entries() + +> **entries**(): [`Iterator`](Iterator.md)\<\[`K`, `V`\]\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:49 + +#### Returns + +[`Iterator`](Iterator.md)\<\[`K`, `V`\]\> + +*** + +### forEach() + +> **forEach**(`action`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:50 + +#### Parameters + +##### action + +(`value`, `key`) => `void` + +#### Returns + +`void` + +*** + +### get() + +> **get**(`key`): `undefined` \| `V` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:47 + +#### Parameters + +##### key + +`K` + +#### Returns + +`undefined` \| `V` + +*** + +### has() + +> **has**(`key`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:37 + +#### Parameters + +##### key + +`K` + +#### Returns + +`boolean` + +#### Inherited from + +[`ReadonlyCollection`](ReadonlyCollection.md).[`has`](ReadonlyCollection.md#has) + +*** + +### keys() + +> **keys**(): [`Iterator`](Iterator.md)\<`K`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:38 + +#### Returns + +[`Iterator`](Iterator.md)\<`K`\> + +#### Inherited from + +[`ReadonlyCollection`](ReadonlyCollection.md).[`keys`](ReadonlyCollection.md#keys) + +*** + +### values() + +> **values**(): [`Iterator`](Iterator.md)\<`V`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:48 + +#### Returns + +[`Iterator`](Iterator.md)\<`V`\> diff --git a/docs/api_docs/namespaces/ts/interfaces/ReadonlyMap.md b/docs/api_docs/namespaces/ts/interfaces/ReadonlyMap.md new file mode 100644 index 0000000000000000000000000000000000000000..1da5153151e5fb6f96004a05704e37aba8c4dc25 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ReadonlyMap.md @@ -0,0 +1,145 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ReadonlyMap + +# Interface: ReadonlyMap\ + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:55 + +ES6 Map interface, only read methods included. + +## Extends + +- [`ReadonlyESMap`](ReadonlyESMap.md)\<`string`, `T`\> + +## Type Parameters + +• **T** + +## Properties + +### size + +> `readonly` **size**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:36 + +#### Inherited from + +[`ReadonlyESMap`](ReadonlyESMap.md).[`size`](ReadonlyESMap.md#size) + +## Methods + +### entries() + +> **entries**(): [`Iterator`](Iterator.md)\<\[`string`, `T`\]\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:49 + +#### Returns + +[`Iterator`](Iterator.md)\<\[`string`, `T`\]\> + +#### Inherited from + +[`ReadonlyESMap`](ReadonlyESMap.md).[`entries`](ReadonlyESMap.md#entries) + +*** + +### forEach() + +> **forEach**(`action`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:50 + +#### Parameters + +##### action + +(`value`, `key`) => `void` + +#### Returns + +`void` + +#### Inherited from + +[`ReadonlyESMap`](ReadonlyESMap.md).[`forEach`](ReadonlyESMap.md#foreach) + +*** + +### get() + +> **get**(`key`): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:47 + +#### Parameters + +##### key + +`string` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`ReadonlyESMap`](ReadonlyESMap.md).[`get`](ReadonlyESMap.md#get) + +*** + +### has() + +> **has**(`key`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:37 + +#### Parameters + +##### key + +`string` + +#### Returns + +`boolean` + +#### Inherited from + +[`ReadonlyESMap`](ReadonlyESMap.md).[`has`](ReadonlyESMap.md#has) + +*** + +### keys() + +> **keys**(): [`Iterator`](Iterator.md)\<`string`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:38 + +#### Returns + +[`Iterator`](Iterator.md)\<`string`\> + +#### Inherited from + +[`ReadonlyESMap`](ReadonlyESMap.md).[`keys`](ReadonlyESMap.md#keys) + +*** + +### values() + +> **values**(): [`Iterator`](Iterator.md)\<`T`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:48 + +#### Returns + +[`Iterator`](Iterator.md)\<`T`\> + +#### Inherited from + +[`ReadonlyESMap`](ReadonlyESMap.md).[`values`](ReadonlyESMap.md#values) diff --git a/docs/api_docs/namespaces/ts/interfaces/ReadonlySet.md b/docs/api_docs/namespaces/ts/interfaces/ReadonlySet.md new file mode 100644 index 0000000000000000000000000000000000000000..32056a3d9b724379eef2054b8e649f8f6c560d2b --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ReadonlySet.md @@ -0,0 +1,115 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ReadonlySet + +# Interface: ReadonlySet\ + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:67 + +ES6 Set interface, only read methods included. + +## Extends + +- [`ReadonlyCollection`](ReadonlyCollection.md)\<`T`\> + +## Extended by + +- [`Set`](Set.md) + +## Type Parameters + +• **T** + +## Properties + +### size + +> `readonly` **size**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:36 + +#### Inherited from + +[`ReadonlyCollection`](ReadonlyCollection.md).[`size`](ReadonlyCollection.md#size) + +## Methods + +### entries() + +> **entries**(): [`Iterator`](Iterator.md)\<\[`T`, `T`\]\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:70 + +#### Returns + +[`Iterator`](Iterator.md)\<\[`T`, `T`\]\> + +*** + +### forEach() + +> **forEach**(`action`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:71 + +#### Parameters + +##### action + +(`value`, `key`) => `void` + +#### Returns + +`void` + +*** + +### has() + +> **has**(`value`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:68 + +#### Parameters + +##### value + +`T` + +#### Returns + +`boolean` + +#### Overrides + +[`ReadonlyCollection`](ReadonlyCollection.md).[`has`](ReadonlyCollection.md#has) + +*** + +### keys() + +> **keys**(): [`Iterator`](Iterator.md)\<`T`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:38 + +#### Returns + +[`Iterator`](Iterator.md)\<`T`\> + +#### Inherited from + +[`ReadonlyCollection`](ReadonlyCollection.md).[`keys`](ReadonlyCollection.md#keys) + +*** + +### values() + +> **values**(): [`Iterator`](Iterator.md)\<`T`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:69 + +#### Returns + +[`Iterator`](Iterator.md)\<`T`\> diff --git a/docs/api_docs/namespaces/ts/interfaces/ReadonlyTextRange.md b/docs/api_docs/namespaces/ts/interfaces/ReadonlyTextRange.md new file mode 100644 index 0000000000000000000000000000000000000000..e6b7d21800389e8b00d516784a1a61b399d4fd25 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ReadonlyTextRange.md @@ -0,0 +1,30 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ReadonlyTextRange + +# Interface: ReadonlyTextRange + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:101 + +## Extended by + +- [`Node`](Node.md) +- [`NodeArray`](NodeArray.md) + +## Properties + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 diff --git a/docs/api_docs/namespaces/ts/interfaces/ReadonlyUnderscoreEscapedMap.md b/docs/api_docs/namespaces/ts/interfaces/ReadonlyUnderscoreEscapedMap.md new file mode 100644 index 0000000000000000000000000000000000000000..5914ff38aad8f312e3d447a2cc5e7642b87f1caa --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ReadonlyUnderscoreEscapedMap.md @@ -0,0 +1,149 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ReadonlyUnderscoreEscapedMap + +# Interface: ReadonlyUnderscoreEscapedMap\ + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2711 + +ReadonlyMap where keys are `__String`s. + +## Extends + +- [`ReadonlyESMap`](ReadonlyESMap.md)\<[`__String`](../type-aliases/String.md), `T`\> + +## Extended by + +- [`UnderscoreEscapedMap`](UnderscoreEscapedMap.md) + +## Type Parameters + +• **T** + +## Properties + +### size + +> `readonly` **size**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:36 + +#### Inherited from + +[`ReadonlyESMap`](ReadonlyESMap.md).[`size`](ReadonlyESMap.md#size) + +## Methods + +### entries() + +> **entries**(): [`Iterator`](Iterator.md)\<\[[`__String`](../type-aliases/String.md), `T`\]\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:49 + +#### Returns + +[`Iterator`](Iterator.md)\<\[[`__String`](../type-aliases/String.md), `T`\]\> + +#### Inherited from + +[`ReadonlyESMap`](ReadonlyESMap.md).[`entries`](ReadonlyESMap.md#entries) + +*** + +### forEach() + +> **forEach**(`action`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:50 + +#### Parameters + +##### action + +(`value`, `key`) => `void` + +#### Returns + +`void` + +#### Inherited from + +[`ReadonlyESMap`](ReadonlyESMap.md).[`forEach`](ReadonlyESMap.md#foreach) + +*** + +### get() + +> **get**(`key`): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:47 + +#### Parameters + +##### key + +[`__String`](../type-aliases/String.md) + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`ReadonlyESMap`](ReadonlyESMap.md).[`get`](ReadonlyESMap.md#get) + +*** + +### has() + +> **has**(`key`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:37 + +#### Parameters + +##### key + +[`__String`](../type-aliases/String.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`ReadonlyESMap`](ReadonlyESMap.md).[`has`](ReadonlyESMap.md#has) + +*** + +### keys() + +> **keys**(): [`Iterator`](Iterator.md)\<[`__String`](../type-aliases/String.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:38 + +#### Returns + +[`Iterator`](Iterator.md)\<[`__String`](../type-aliases/String.md)\> + +#### Inherited from + +[`ReadonlyESMap`](ReadonlyESMap.md).[`keys`](ReadonlyESMap.md#keys) + +*** + +### values() + +> **values**(): [`Iterator`](Iterator.md)\<`T`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:48 + +#### Returns + +[`Iterator`](Iterator.md)\<`T`\> + +#### Inherited from + +[`ReadonlyESMap`](ReadonlyESMap.md).[`values`](ReadonlyESMap.md#values) diff --git a/docs/api_docs/namespaces/ts/interfaces/RefactorActionInfo.md b/docs/api_docs/namespaces/ts/interfaces/RefactorActionInfo.md new file mode 100644 index 0000000000000000000000000000000000000000..bf6c500f5579375e47ce3d662b06082d62704279 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/RefactorActionInfo.md @@ -0,0 +1,55 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / RefactorActionInfo + +# Interface: RefactorActionInfo + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6663 + +Represents a single refactoring action - for example, the "Extract Method..." refactor might +offer several actions, each corresponding to a surround class or closure to extract into. + +## Properties + +### description + +> **description**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6673 + +A description of this refactoring action to show to the user. +If the parent refactoring is inlined away, this will be the only text shown, +so this description should make sense by itself if the parent is inlineable=true + +*** + +### kind? + +> `optional` **kind**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6682 + +The hierarchical dotted name of the refactor action. + +*** + +### name + +> **name**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6667 + +The programmatic name of the refactoring action + +*** + +### notApplicableReason? + +> `optional` **notApplicableReason**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6678 + +A message to show to the user if the refactoring cannot be applied in +the current context. diff --git a/docs/api_docs/namespaces/ts/interfaces/RefactorEditInfo.md b/docs/api_docs/namespaces/ts/interfaces/RefactorEditInfo.md new file mode 100644 index 0000000000000000000000000000000000000000..9f6526ecee2b2be32205d3ef1bdb801ad9188232 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/RefactorEditInfo.md @@ -0,0 +1,44 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / RefactorEditInfo + +# Interface: RefactorEditInfo + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6688 + +A set of edits to make in response to a refactor action, plus an optional +location where renaming should be invoked from + +## Properties + +### commands? + +> `optional` **commands**: [`InstallPackageAction`](InstallPackageAction.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6692 + +*** + +### edits + +> **edits**: [`FileTextChanges`](FileTextChanges.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6689 + +*** + +### renameFilename? + +> `optional` **renameFilename**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6690 + +*** + +### renameLocation? + +> `optional` **renameLocation**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6691 diff --git a/docs/api_docs/namespaces/ts/interfaces/ReferenceEntry.md b/docs/api_docs/namespaces/ts/interfaces/ReferenceEntry.md new file mode 100644 index 0000000000000000000000000000000000000000..c481497836325159214d470f735293a8682ba0e8 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ReferenceEntry.md @@ -0,0 +1,111 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ReferenceEntry + +# Interface: ReferenceEntry + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6720 + +## Extends + +- [`DocumentSpan`](DocumentSpan.md) + +## Extended by + +- [`ReferencedSymbolEntry`](ReferencedSymbolEntry.md) + +## Properties + +### contextSpan? + +> `optional` **contextSpan**: [`TextSpan`](TextSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6713 + +If DocumentSpan.textSpan is the span for name of the declaration, +then this is the span for relevant declaration + +#### Inherited from + +[`DocumentSpan`](DocumentSpan.md).[`contextSpan`](DocumentSpan.md#contextspan) + +*** + +### fileName + +> **fileName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6702 + +#### Inherited from + +[`DocumentSpan`](DocumentSpan.md).[`fileName`](DocumentSpan.md#filename) + +*** + +### isInString? + +> `optional` **isInString**: `true` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6722 + +*** + +### isWriteAccess + +> **isWriteAccess**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6721 + +*** + +### originalContextSpan? + +> `optional` **originalContextSpan**: [`TextSpan`](TextSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6714 + +#### Inherited from + +[`DocumentSpan`](DocumentSpan.md).[`originalContextSpan`](DocumentSpan.md#originalcontextspan) + +*** + +### originalFileName? + +> `optional` **originalFileName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6708 + +#### Inherited from + +[`DocumentSpan`](DocumentSpan.md).[`originalFileName`](DocumentSpan.md#originalfilename) + +*** + +### originalTextSpan? + +> `optional` **originalTextSpan**: [`TextSpan`](TextSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6707 + +If the span represents a location that was remapped (e.g. via a .d.ts.map file), +then the original filename and span will be specified here + +#### Inherited from + +[`DocumentSpan`](DocumentSpan.md).[`originalTextSpan`](DocumentSpan.md#originaltextspan) + +*** + +### textSpan + +> **textSpan**: [`TextSpan`](TextSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6701 + +#### Inherited from + +[`DocumentSpan`](DocumentSpan.md).[`textSpan`](DocumentSpan.md#textspan) diff --git a/docs/api_docs/namespaces/ts/interfaces/ReferencedSymbol.md b/docs/api_docs/namespaces/ts/interfaces/ReferencedSymbol.md new file mode 100644 index 0000000000000000000000000000000000000000..7edeeefc74939df71089a5b38c842965f81380b1 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ReferencedSymbol.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ReferencedSymbol + +# Interface: ReferencedSymbol + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6835 + +## Properties + +### definition + +> **definition**: [`ReferencedSymbolDefinitionInfo`](ReferencedSymbolDefinitionInfo.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6836 + +*** + +### references + +> **references**: [`ReferencedSymbolEntry`](ReferencedSymbolEntry.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6837 diff --git a/docs/api_docs/namespaces/ts/interfaces/ReferencedSymbolDefinitionInfo.md b/docs/api_docs/namespaces/ts/interfaces/ReferencedSymbolDefinitionInfo.md new file mode 100644 index 0000000000000000000000000000000000000000..65d6897054500581bafad6e52d82fbd0fe09fd48 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ReferencedSymbolDefinitionInfo.md @@ -0,0 +1,159 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ReferencedSymbolDefinitionInfo + +# Interface: ReferencedSymbolDefinitionInfo + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6832 + +## Extends + +- [`DefinitionInfo`](DefinitionInfo.md) + +## Properties + +### containerKind + +> **containerKind**: [`ScriptElementKind`](../enumerations/ScriptElementKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6824 + +#### Inherited from + +[`DefinitionInfo`](DefinitionInfo.md).[`containerKind`](DefinitionInfo.md#containerkind) + +*** + +### containerName + +> **containerName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6825 + +#### Inherited from + +[`DefinitionInfo`](DefinitionInfo.md).[`containerName`](DefinitionInfo.md#containername) + +*** + +### contextSpan? + +> `optional` **contextSpan**: [`TextSpan`](TextSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6713 + +If DocumentSpan.textSpan is the span for name of the declaration, +then this is the span for relevant declaration + +#### Inherited from + +[`DefinitionInfo`](DefinitionInfo.md).[`contextSpan`](DefinitionInfo.md#contextspan) + +*** + +### displayParts + +> **displayParts**: [`SymbolDisplayPart`](SymbolDisplayPart.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6833 + +*** + +### fileName + +> **fileName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6702 + +#### Inherited from + +[`DefinitionInfo`](DefinitionInfo.md).[`fileName`](DefinitionInfo.md#filename) + +*** + +### kind + +> **kind**: [`ScriptElementKind`](../enumerations/ScriptElementKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6822 + +#### Inherited from + +[`DefinitionInfo`](DefinitionInfo.md).[`kind`](DefinitionInfo.md#kind) + +*** + +### name + +> **name**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6823 + +#### Inherited from + +[`DefinitionInfo`](DefinitionInfo.md).[`name`](DefinitionInfo.md#name) + +*** + +### originalContextSpan? + +> `optional` **originalContextSpan**: [`TextSpan`](TextSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6714 + +#### Inherited from + +[`DefinitionInfo`](DefinitionInfo.md).[`originalContextSpan`](DefinitionInfo.md#originalcontextspan) + +*** + +### originalFileName? + +> `optional` **originalFileName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6708 + +#### Inherited from + +[`DefinitionInfo`](DefinitionInfo.md).[`originalFileName`](DefinitionInfo.md#originalfilename) + +*** + +### originalTextSpan? + +> `optional` **originalTextSpan**: [`TextSpan`](TextSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6707 + +If the span represents a location that was remapped (e.g. via a .d.ts.map file), +then the original filename and span will be specified here + +#### Inherited from + +[`DefinitionInfo`](DefinitionInfo.md).[`originalTextSpan`](DefinitionInfo.md#originaltextspan) + +*** + +### textSpan + +> **textSpan**: [`TextSpan`](TextSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6701 + +#### Inherited from + +[`DefinitionInfo`](DefinitionInfo.md).[`textSpan`](DefinitionInfo.md#textspan) + +*** + +### unverified? + +> `optional` **unverified**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6826 + +#### Inherited from + +[`DefinitionInfo`](DefinitionInfo.md).[`unverified`](DefinitionInfo.md#unverified) diff --git a/docs/api_docs/namespaces/ts/interfaces/ReferencedSymbolEntry.md b/docs/api_docs/namespaces/ts/interfaces/ReferencedSymbolEntry.md new file mode 100644 index 0000000000000000000000000000000000000000..153beb128e28572b1bfd934e60eacc5accb2084b --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ReferencedSymbolEntry.md @@ -0,0 +1,123 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ReferencedSymbolEntry + +# Interface: ReferencedSymbolEntry + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6839 + +## Extends + +- [`ReferenceEntry`](ReferenceEntry.md) + +## Properties + +### contextSpan? + +> `optional` **contextSpan**: [`TextSpan`](TextSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6713 + +If DocumentSpan.textSpan is the span for name of the declaration, +then this is the span for relevant declaration + +#### Inherited from + +[`ReferenceEntry`](ReferenceEntry.md).[`contextSpan`](ReferenceEntry.md#contextspan) + +*** + +### fileName + +> **fileName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6702 + +#### Inherited from + +[`ReferenceEntry`](ReferenceEntry.md).[`fileName`](ReferenceEntry.md#filename) + +*** + +### isDefinition? + +> `optional` **isDefinition**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6840 + +*** + +### isInString? + +> `optional` **isInString**: `true` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6722 + +#### Inherited from + +[`ReferenceEntry`](ReferenceEntry.md).[`isInString`](ReferenceEntry.md#isinstring) + +*** + +### isWriteAccess + +> **isWriteAccess**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6721 + +#### Inherited from + +[`ReferenceEntry`](ReferenceEntry.md).[`isWriteAccess`](ReferenceEntry.md#iswriteaccess) + +*** + +### originalContextSpan? + +> `optional` **originalContextSpan**: [`TextSpan`](TextSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6714 + +#### Inherited from + +[`ReferenceEntry`](ReferenceEntry.md).[`originalContextSpan`](ReferenceEntry.md#originalcontextspan) + +*** + +### originalFileName? + +> `optional` **originalFileName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6708 + +#### Inherited from + +[`ReferenceEntry`](ReferenceEntry.md).[`originalFileName`](ReferenceEntry.md#originalfilename) + +*** + +### originalTextSpan? + +> `optional` **originalTextSpan**: [`TextSpan`](TextSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6707 + +If the span represents a location that was remapped (e.g. via a .d.ts.map file), +then the original filename and span will be specified here + +#### Inherited from + +[`ReferenceEntry`](ReferenceEntry.md).[`originalTextSpan`](ReferenceEntry.md#originaltextspan) + +*** + +### textSpan + +> **textSpan**: [`TextSpan`](TextSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6701 + +#### Inherited from + +[`ReferenceEntry`](ReferenceEntry.md).[`textSpan`](ReferenceEntry.md#textspan) diff --git a/docs/api_docs/namespaces/ts/interfaces/RegularExpressionLiteral.md b/docs/api_docs/namespaces/ts/interfaces/RegularExpressionLiteral.md new file mode 100644 index 0000000000000000000000000000000000000000..fdc0d173e4a9869bb543402a111434bd30fa478d --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/RegularExpressionLiteral.md @@ -0,0 +1,597 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / RegularExpressionLiteral + +# Interface: RegularExpressionLiteral + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1229 + +## Extends + +- [`LiteralExpression`](LiteralExpression.md) + +## Properties + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`_expressionBrand`](LiteralExpression.md#_expressionbrand) + +*** + +### \_leftHandSideExpressionBrand + +> **\_leftHandSideExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1086 + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`_leftHandSideExpressionBrand`](LiteralExpression.md#_lefthandsideexpressionbrand) + +*** + +### \_literalExpressionBrand + +> **\_literalExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1227 + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`_literalExpressionBrand`](LiteralExpression.md#_literalexpressionbrand) + +*** + +### \_memberExpressionBrand + +> **\_memberExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1089 + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`_memberExpressionBrand`](LiteralExpression.md#_memberexpressionbrand) + +*** + +### \_primaryExpressionBrand + +> **\_primaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1092 + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`_primaryExpressionBrand`](LiteralExpression.md#_primaryexpressionbrand) + +*** + +### \_unaryExpressionBrand + +> **\_unaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1066 + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`_unaryExpressionBrand`](LiteralExpression.md#_unaryexpressionbrand) + +*** + +### \_updateExpressionBrand + +> **\_updateExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1071 + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`_updateExpressionBrand`](LiteralExpression.md#_updateexpressionbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`decorators`](LiteralExpression.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`end`](LiteralExpression.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`flags`](LiteralExpression.md#flags) + +*** + +### hasExtendedUnicodeEscape? + +> `optional` **hasExtendedUnicodeEscape**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1221 + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`hasExtendedUnicodeEscape`](LiteralExpression.md#hasextendedunicodeescape) + +*** + +### isUnterminated? + +> `optional` **isUnterminated**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1220 + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`isUnterminated`](LiteralExpression.md#isunterminated) + +*** + +### kind + +> `readonly` **kind**: [`RegularExpressionLiteral`](../enumerations/SyntaxKind.md#regularexpressionliteral) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1230 + +#### Overrides + +[`LiteralExpression`](LiteralExpression.md).[`kind`](LiteralExpression.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`locals`](LiteralExpression.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`modifiers`](LiteralExpression.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`parent`](LiteralExpression.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`pos`](LiteralExpression.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`skipCheck`](LiteralExpression.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`symbol`](LiteralExpression.md#symbol) + +*** + +### text + +> **text**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1219 + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`text`](LiteralExpression.md#text) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`forEachChild`](LiteralExpression.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`getChildAt`](LiteralExpression.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`getChildCount`](LiteralExpression.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`getChildren`](LiteralExpression.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`getEnd`](LiteralExpression.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`getFirstToken`](LiteralExpression.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`getFullStart`](LiteralExpression.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`getFullText`](LiteralExpression.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`getFullWidth`](LiteralExpression.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`getLastToken`](LiteralExpression.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`getLeadingTriviaWidth`](LiteralExpression.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`getSourceFile`](LiteralExpression.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`getStart`](LiteralExpression.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`getText`](LiteralExpression.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`getWidth`](LiteralExpression.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/RenameInfoFailure.md b/docs/api_docs/namespaces/ts/interfaces/RenameInfoFailure.md new file mode 100644 index 0000000000000000000000000000000000000000..08f040abe70c4fa3408d04e46dabba67af076802 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/RenameInfoFailure.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / RenameInfoFailure + +# Interface: RenameInfoFailure + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6903 + +## Properties + +### canRename + +> **canRename**: `false` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6904 + +*** + +### localizedErrorMessage + +> **localizedErrorMessage**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6905 diff --git a/docs/api_docs/namespaces/ts/interfaces/RenameInfoOptions.md b/docs/api_docs/namespaces/ts/interfaces/RenameInfoOptions.md new file mode 100644 index 0000000000000000000000000000000000000000..5b00d7afbc4de0f9fd562c0bdc57ffdef2f44cc9 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/RenameInfoOptions.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / RenameInfoOptions + +# Interface: ~~RenameInfoOptions~~ + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6910 + +## Deprecated + +Use `UserPreferences` instead. + +## Properties + +### ~~allowRenameOfImportPath?~~ + +> `readonly` `optional` **allowRenameOfImportPath**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6911 diff --git a/docs/api_docs/namespaces/ts/interfaces/RenameInfoSuccess.md b/docs/api_docs/namespaces/ts/interfaces/RenameInfoSuccess.md new file mode 100644 index 0000000000000000000000000000000000000000..95ab230c91df3435cc1786d8e630da467f7507eb --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/RenameInfoSuccess.md @@ -0,0 +1,68 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / RenameInfoSuccess + +# Interface: RenameInfoSuccess + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6890 + +## Properties + +### canRename + +> **canRename**: `true` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6891 + +*** + +### displayName + +> **displayName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6897 + +*** + +### fileToRename? + +> `optional` **fileToRename**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6896 + +File or directory to rename. +If set, `getEditsForFileRename` should be called instead of `findRenameLocations`. + +*** + +### fullDisplayName + +> **fullDisplayName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6898 + +*** + +### kind + +> **kind**: [`ScriptElementKind`](../enumerations/ScriptElementKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6899 + +*** + +### kindModifiers + +> **kindModifiers**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6900 + +*** + +### triggerSpan + +> **triggerSpan**: [`TextSpan`](TextSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6901 diff --git a/docs/api_docs/namespaces/ts/interfaces/RenameLocation.md b/docs/api_docs/namespaces/ts/interfaces/RenameLocation.md new file mode 100644 index 0000000000000000000000000000000000000000..9693c0548a97b0f4b646d835f4edcd6a6d535e0f --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/RenameLocation.md @@ -0,0 +1,107 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / RenameLocation + +# Interface: RenameLocation + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6716 + +## Extends + +- [`DocumentSpan`](DocumentSpan.md) + +## Properties + +### contextSpan? + +> `optional` **contextSpan**: [`TextSpan`](TextSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6713 + +If DocumentSpan.textSpan is the span for name of the declaration, +then this is the span for relevant declaration + +#### Inherited from + +[`DocumentSpan`](DocumentSpan.md).[`contextSpan`](DocumentSpan.md#contextspan) + +*** + +### fileName + +> **fileName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6702 + +#### Inherited from + +[`DocumentSpan`](DocumentSpan.md).[`fileName`](DocumentSpan.md#filename) + +*** + +### originalContextSpan? + +> `optional` **originalContextSpan**: [`TextSpan`](TextSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6714 + +#### Inherited from + +[`DocumentSpan`](DocumentSpan.md).[`originalContextSpan`](DocumentSpan.md#originalcontextspan) + +*** + +### originalFileName? + +> `optional` **originalFileName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6708 + +#### Inherited from + +[`DocumentSpan`](DocumentSpan.md).[`originalFileName`](DocumentSpan.md#originalfilename) + +*** + +### originalTextSpan? + +> `optional` **originalTextSpan**: [`TextSpan`](TextSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6707 + +If the span represents a location that was remapped (e.g. via a .d.ts.map file), +then the original filename and span will be specified here + +#### Inherited from + +[`DocumentSpan`](DocumentSpan.md).[`originalTextSpan`](DocumentSpan.md#originaltextspan) + +*** + +### prefixText? + +> `readonly` `optional` **prefixText**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6717 + +*** + +### suffixText? + +> `readonly` `optional` **suffixText**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6718 + +*** + +### textSpan + +> **textSpan**: [`TextSpan`](TextSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6701 + +#### Inherited from + +[`DocumentSpan`](DocumentSpan.md).[`textSpan`](DocumentSpan.md#textspan) diff --git a/docs/api_docs/namespaces/ts/interfaces/ReportFileInError.md b/docs/api_docs/namespaces/ts/interfaces/ReportFileInError.md new file mode 100644 index 0000000000000000000000000000000000000000..d561bc7be9f2565e302162f0f19692a41caeb65c --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ReportFileInError.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ReportFileInError + +# Interface: ReportFileInError + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5931 + +## Properties + +### fileName + +> **fileName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5932 + +*** + +### line + +> **line**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5933 diff --git a/docs/api_docs/namespaces/ts/interfaces/ResolveProjectReferencePathHost.md b/docs/api_docs/namespaces/ts/interfaces/ResolveProjectReferencePathHost.md new file mode 100644 index 0000000000000000000000000000000000000000..e547952634ba2cf6a5e168d092303ddf10498000 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ResolveProjectReferencePathHost.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ResolveProjectReferencePathHost + +# Interface: ~~ResolveProjectReferencePathHost~~ + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5619 + +## Deprecated + +## Methods + +### ~~fileExists()~~ + +> **fileExists**(`fileName`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5620 + +#### Parameters + +##### fileName + +`string` + +#### Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/interfaces/ResolvedModule.md b/docs/api_docs/namespaces/ts/interfaces/ResolvedModule.md new file mode 100644 index 0000000000000000000000000000000000000000..b0f072542dc9e5fe6d17d959c88b549b1c56d402 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ResolvedModule.md @@ -0,0 +1,39 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ResolvedModule + +# Interface: ResolvedModule + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3370 + +Represents the result of module resolution. +Module resolution will pick up tsx/jsx/js files even if '--jsx' and '--allowJs' are turned off. +The Program will then filter results based on these flags. + +Prefer to return a `ResolvedModuleFull` so that the file type does not have to be inferred. + +## Extended by + +- [`ResolvedModuleFull`](ResolvedModuleFull.md) + +## Properties + +### isExternalLibraryImport? + +> `optional` **isExternalLibraryImport**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3374 + +True if `resolvedFileName` comes from `node_modules`. + +*** + +### resolvedFileName + +> **resolvedFileName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3372 + +Path of the file the module was resolved to. diff --git a/docs/api_docs/namespaces/ts/interfaces/ResolvedModuleFull.md b/docs/api_docs/namespaces/ts/interfaces/ResolvedModuleFull.md new file mode 100644 index 0000000000000000000000000000000000000000..c022cd02d93dabf1d1f85a7e987e2250e574927b --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ResolvedModuleFull.md @@ -0,0 +1,64 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ResolvedModuleFull + +# Interface: ResolvedModuleFull + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3381 + +ResolvedModule with an explicitly provided `extension` property. +Prefer this over `ResolvedModule`. +If changing this, remember to change `moduleResolutionIsEqualTo`. + +## Extends + +- [`ResolvedModule`](ResolvedModule.md) + +## Properties + +### extension + +> **extension**: [`Extension`](../enumerations/Extension.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3386 + +Extension of resolvedFileName. This must match what's at the end of resolvedFileName. +This is optional for backwards-compatibility, but will be added if not provided. + +*** + +### isExternalLibraryImport? + +> `optional` **isExternalLibraryImport**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3374 + +True if `resolvedFileName` comes from `node_modules`. + +#### Inherited from + +[`ResolvedModule`](ResolvedModule.md).[`isExternalLibraryImport`](ResolvedModule.md#isexternallibraryimport) + +*** + +### packageId? + +> `optional` **packageId**: [`PackageId`](PackageId.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3387 + +*** + +### resolvedFileName + +> **resolvedFileName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3372 + +Path of the file the module was resolved to. + +#### Inherited from + +[`ResolvedModule`](ResolvedModule.md).[`resolvedFileName`](ResolvedModule.md#resolvedfilename) diff --git a/docs/api_docs/namespaces/ts/interfaces/ResolvedModuleSpecifierInfo.md b/docs/api_docs/namespaces/ts/interfaces/ResolvedModuleSpecifierInfo.md new file mode 100644 index 0000000000000000000000000000000000000000..e969832635d7b851c3e4f4db6e0c4c84f9750faa --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ResolvedModuleSpecifierInfo.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ResolvedModuleSpecifierInfo + +# Interface: ResolvedModuleSpecifierInfo + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4360 + +## Properties + +### isBlockedByPackageJsonDependencies + +> **isBlockedByPackageJsonDependencies**: `undefined` \| `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4363 + +*** + +### modulePaths + +> **modulePaths**: `undefined` \| readonly [`ModulePath`](ModulePath.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4361 + +*** + +### moduleSpecifiers + +> **moduleSpecifiers**: `undefined` \| readonly `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4362 diff --git a/docs/api_docs/namespaces/ts/interfaces/ResolvedModuleWithFailedLookupLocations.md b/docs/api_docs/namespaces/ts/interfaces/ResolvedModuleWithFailedLookupLocations.md new file mode 100644 index 0000000000000000000000000000000000000000..bf18eb9acfec6551226eb6018ddbf28ff1e61edf --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ResolvedModuleWithFailedLookupLocations.md @@ -0,0 +1,17 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ResolvedModuleWithFailedLookupLocations + +# Interface: ResolvedModuleWithFailedLookupLocations + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3425 + +## Properties + +### resolvedModule + +> `readonly` **resolvedModule**: `undefined` \| [`ResolvedModuleFull`](ResolvedModuleFull.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3426 diff --git a/docs/api_docs/namespaces/ts/interfaces/ResolvedProjectReference.md b/docs/api_docs/namespaces/ts/interfaces/ResolvedProjectReference.md new file mode 100644 index 0000000000000000000000000000000000000000..15c695aef46f68d7833c5c1c7827dfe754b1c818 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ResolvedProjectReference.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ResolvedProjectReference + +# Interface: ResolvedProjectReference + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2336 + +## Properties + +### commandLine + +> **commandLine**: [`ParsedCommandLine`](ParsedCommandLine.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2337 + +*** + +### references? + +> `optional` **references**: readonly (`undefined` \| [`ResolvedProjectReference`](ResolvedProjectReference.md))[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2339 + +*** + +### sourceFile + +> **sourceFile**: [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2338 diff --git a/docs/api_docs/namespaces/ts/interfaces/ResolvedTypeReferenceDirective.md b/docs/api_docs/namespaces/ts/interfaces/ResolvedTypeReferenceDirective.md new file mode 100644 index 0000000000000000000000000000000000000000..7b335a5bb488799747685c7b4e1a2a4a323055b8 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ResolvedTypeReferenceDirective.md @@ -0,0 +1,43 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ResolvedTypeReferenceDirective + +# Interface: ResolvedTypeReferenceDirective + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3428 + +## Properties + +### isExternalLibraryImport? + +> `optional` **isExternalLibraryImport**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3433 + +True if `resolvedFileName` comes from `node_modules` or `oh_modules`. + +*** + +### packageId? + +> `optional` **packageId**: [`PackageId`](PackageId.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3431 + +*** + +### primary + +> **primary**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3429 + +*** + +### resolvedFileName + +> **resolvedFileName**: `undefined` \| `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3430 diff --git a/docs/api_docs/namespaces/ts/interfaces/ResolvedTypeReferenceDirectiveWithFailedLookupLocations.md b/docs/api_docs/namespaces/ts/interfaces/ResolvedTypeReferenceDirectiveWithFailedLookupLocations.md new file mode 100644 index 0000000000000000000000000000000000000000..792d3c6226de5343f44abc942f2f10cd082526f2 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ResolvedTypeReferenceDirectiveWithFailedLookupLocations.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ResolvedTypeReferenceDirectiveWithFailedLookupLocations + +# Interface: ResolvedTypeReferenceDirectiveWithFailedLookupLocations + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3435 + +## Properties + +### failedLookupLocations + +> `readonly` **failedLookupLocations**: `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3437 + +*** + +### resolvedTypeReferenceDirective + +> `readonly` **resolvedTypeReferenceDirective**: `undefined` \| [`ResolvedTypeReferenceDirective`](ResolvedTypeReferenceDirective.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3436 diff --git a/docs/api_docs/namespaces/ts/interfaces/RestTypeNode.md b/docs/api_docs/namespaces/ts/interfaces/RestTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..e4c0fd3e52eb6f5ca5bd5795c3f23349f541ca3b --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/RestTypeNode.md @@ -0,0 +1,497 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / RestTypeNode + +# Interface: RestTypeNode + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:987 + +## Extends + +- [`TypeNode`](TypeNode.md) + +## Properties + +### \_typeNodeBrand + +> **\_typeNodeBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:912 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`_typeNodeBrand`](TypeNode.md#_typenodebrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`decorators`](TypeNode.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`end`](TypeNode.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`flags`](TypeNode.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`RestType`](../enumerations/SyntaxKind.md#resttype) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:988 + +#### Overrides + +[`TypeNode`](TypeNode.md).[`kind`](TypeNode.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`locals`](TypeNode.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`modifiers`](TypeNode.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`parent`](TypeNode.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`pos`](TypeNode.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`skipCheck`](TypeNode.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`symbol`](TypeNode.md#symbol) + +*** + +### type + +> `readonly` **type**: [`TypeNode`](TypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:989 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`forEachChild`](TypeNode.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getChildAt`](TypeNode.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getChildCount`](TypeNode.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getChildren`](TypeNode.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getEnd`](TypeNode.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFirstToken`](TypeNode.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFullStart`](TypeNode.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFullText`](TypeNode.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFullWidth`](TypeNode.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getLastToken`](TypeNode.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getLeadingTriviaWidth`](TypeNode.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getSourceFile`](TypeNode.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getStart`](TypeNode.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getText`](TypeNode.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getWidth`](TypeNode.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/ReturnStatement.md b/docs/api_docs/namespaces/ts/interfaces/ReturnStatement.md new file mode 100644 index 0000000000000000000000000000000000000000..4d2857b755523548d29cfdd2b49bb6011b710cac --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ReturnStatement.md @@ -0,0 +1,497 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ReturnStatement + +# Interface: ReturnStatement + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1552 + +## Extends + +- [`Statement`](Statement.md) + +## Properties + +### \_statementBrand + +> **\_statementBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1471 + +#### Inherited from + +[`Statement`](Statement.md).[`_statementBrand`](Statement.md#_statementbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Statement`](Statement.md).[`decorators`](Statement.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Statement`](Statement.md).[`end`](Statement.md#end) + +*** + +### expression? + +> `readonly` `optional` **expression**: [`Expression`](Expression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1554 + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Statement`](Statement.md).[`flags`](Statement.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`ReturnStatement`](../enumerations/SyntaxKind.md#returnstatement) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1553 + +#### Overrides + +[`Statement`](Statement.md).[`kind`](Statement.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Statement`](Statement.md).[`locals`](Statement.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Statement`](Statement.md).[`modifiers`](Statement.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`Statement`](Statement.md).[`parent`](Statement.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Statement`](Statement.md).[`pos`](Statement.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Statement`](Statement.md).[`skipCheck`](Statement.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Statement`](Statement.md).[`symbol`](Statement.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Statement`](Statement.md).[`forEachChild`](Statement.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getChildAt`](Statement.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getChildCount`](Statement.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Statement`](Statement.md).[`getChildren`](Statement.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getEnd`](Statement.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getFirstToken`](Statement.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getFullStart`](Statement.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Statement`](Statement.md).[`getFullText`](Statement.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getFullWidth`](Statement.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getLastToken`](Statement.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getLeadingTriviaWidth`](Statement.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getSourceFile`](Statement.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getStart`](Statement.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Statement`](Statement.md).[`getText`](Statement.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getWidth`](Statement.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/SatisfiesExpression.md b/docs/api_docs/namespaces/ts/interfaces/SatisfiesExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..066680797968956768024d6d0a3d5d889c97913a --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/SatisfiesExpression.md @@ -0,0 +1,505 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / SatisfiesExpression + +# Interface: SatisfiesExpression + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1380 + +## Extends + +- [`Expression`](Expression.md) + +## Properties + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`Expression`](Expression.md).[`_expressionBrand`](Expression.md#_expressionbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Expression`](Expression.md).[`decorators`](Expression.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Expression`](Expression.md).[`end`](Expression.md#end) + +*** + +### expression + +> `readonly` **expression**: [`Expression`](Expression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1382 + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Expression`](Expression.md).[`flags`](Expression.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`SatisfiesExpression`](../enumerations/SyntaxKind.md#satisfiesexpression) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1381 + +#### Overrides + +[`Expression`](Expression.md).[`kind`](Expression.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Expression`](Expression.md).[`locals`](Expression.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Expression`](Expression.md).[`modifiers`](Expression.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`Expression`](Expression.md).[`parent`](Expression.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Expression`](Expression.md).[`pos`](Expression.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Expression`](Expression.md).[`skipCheck`](Expression.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Expression`](Expression.md).[`symbol`](Expression.md#symbol) + +*** + +### type + +> `readonly` **type**: [`TypeNode`](TypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1383 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Expression`](Expression.md).[`forEachChild`](Expression.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Expression`](Expression.md).[`getChildAt`](Expression.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getChildCount`](Expression.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Expression`](Expression.md).[`getChildren`](Expression.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getEnd`](Expression.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Expression`](Expression.md).[`getFirstToken`](Expression.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getFullStart`](Expression.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Expression`](Expression.md).[`getFullText`](Expression.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getFullWidth`](Expression.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Expression`](Expression.md).[`getLastToken`](Expression.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getLeadingTriviaWidth`](Expression.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Expression`](Expression.md).[`getSourceFile`](Expression.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getStart`](Expression.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Expression`](Expression.md).[`getText`](Expression.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getWidth`](Expression.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/Scanner.md b/docs/api_docs/namespaces/ts/interfaces/Scanner.md new file mode 100644 index 0000000000000000000000000000000000000000..9e588a9d1a62f472fef818e366998eabbe862c7b --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/Scanner.md @@ -0,0 +1,559 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / Scanner + +# Interface: Scanner + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4574 + +## Methods + +### getStartPos() + +> **getStartPos**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4575 + +#### Returns + +`number` + +*** + +### getText() + +> **getText**(): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4603 + +#### Returns + +`string` + +*** + +### getTextPos() + +> **getTextPos**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4577 + +#### Returns + +`number` + +*** + +### getToken() + +> **getToken**(): [`SyntaxKind`](../enumerations/SyntaxKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4576 + +#### Returns + +[`SyntaxKind`](../enumerations/SyntaxKind.md) + +*** + +### getTokenPos() + +> **getTokenPos**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4578 + +#### Returns + +`number` + +*** + +### getTokenText() + +> **getTokenText**(): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4579 + +#### Returns + +`string` + +*** + +### getTokenValue() + +> **getTokenValue**(): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4580 + +#### Returns + +`string` + +*** + +### hasExtendedUnicodeEscape() + +> **hasExtendedUnicodeEscape**(): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4582 + +#### Returns + +`boolean` + +*** + +### hasPrecedingLineBreak() + +> **hasPrecedingLineBreak**(): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4583 + +#### Returns + +`boolean` + +*** + +### hasUnicodeEscape() + +> **hasUnicodeEscape**(): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4581 + +#### Returns + +`boolean` + +*** + +### isIdentifier() + +> **isIdentifier**(): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4584 + +#### Returns + +`boolean` + +*** + +### isReservedWord() + +> **isReservedWord**(): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4585 + +#### Returns + +`boolean` + +*** + +### isUnterminated() + +> **isUnterminated**(): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4586 + +#### Returns + +`boolean` + +*** + +### lookAhead() + +> **lookAhead**\<`T`\>(`callback`): `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4609 + +#### Type Parameters + +• **T** + +#### Parameters + +##### callback + +() => `T` + +#### Returns + +`T` + +*** + +### reScanAsteriskEqualsToken() + +> **reScanAsteriskEqualsToken**(): [`SyntaxKind`](../enumerations/SyntaxKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4589 + +#### Returns + +[`SyntaxKind`](../enumerations/SyntaxKind.md) + +*** + +### reScanGreaterToken() + +> **reScanGreaterToken**(): [`SyntaxKind`](../enumerations/SyntaxKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4587 + +#### Returns + +[`SyntaxKind`](../enumerations/SyntaxKind.md) + +*** + +### reScanHashToken() + +> **reScanHashToken**(): [`SyntaxKind`](../enumerations/SyntaxKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4597 + +#### Returns + +[`SyntaxKind`](../enumerations/SyntaxKind.md) + +*** + +### reScanInvalidIdentifier() + +> **reScanInvalidIdentifier**(): [`SyntaxKind`](../enumerations/SyntaxKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4599 + +#### Returns + +[`SyntaxKind`](../enumerations/SyntaxKind.md) + +*** + +### reScanJsxAttributeValue() + +> **reScanJsxAttributeValue**(): [`SyntaxKind`](../enumerations/SyntaxKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4594 + +#### Returns + +[`SyntaxKind`](../enumerations/SyntaxKind.md) + +*** + +### reScanJsxToken() + +> **reScanJsxToken**(`allowMultilineJsxText`?): [`JsxTokenSyntaxKind`](../type-aliases/JsxTokenSyntaxKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4595 + +#### Parameters + +##### allowMultilineJsxText? + +`boolean` + +#### Returns + +[`JsxTokenSyntaxKind`](../type-aliases/JsxTokenSyntaxKind.md) + +*** + +### reScanLessThanToken() + +> **reScanLessThanToken**(): [`SyntaxKind`](../enumerations/SyntaxKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4596 + +#### Returns + +[`SyntaxKind`](../enumerations/SyntaxKind.md) + +*** + +### reScanQuestionToken() + +> **reScanQuestionToken**(): [`SyntaxKind`](../enumerations/SyntaxKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4598 + +#### Returns + +[`SyntaxKind`](../enumerations/SyntaxKind.md) + +*** + +### reScanSlashToken() + +> **reScanSlashToken**(): [`SyntaxKind`](../enumerations/SyntaxKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4588 + +#### Returns + +[`SyntaxKind`](../enumerations/SyntaxKind.md) + +*** + +### reScanTemplateHeadOrNoSubstitutionTemplate() + +> **reScanTemplateHeadOrNoSubstitutionTemplate**(): [`SyntaxKind`](../enumerations/SyntaxKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4591 + +#### Returns + +[`SyntaxKind`](../enumerations/SyntaxKind.md) + +*** + +### reScanTemplateToken() + +> **reScanTemplateToken**(`isTaggedTemplate`): [`SyntaxKind`](../enumerations/SyntaxKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4590 + +#### Parameters + +##### isTaggedTemplate + +`boolean` + +#### Returns + +[`SyntaxKind`](../enumerations/SyntaxKind.md) + +*** + +### scan() + +> **scan**(): [`SyntaxKind`](../enumerations/SyntaxKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4602 + +#### Returns + +[`SyntaxKind`](../enumerations/SyntaxKind.md) + +*** + +### scanJsDocToken() + +> **scanJsDocToken**(): [`JSDocSyntaxKind`](../type-aliases/JSDocSyntaxKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4601 + +#### Returns + +[`JSDocSyntaxKind`](../type-aliases/JSDocSyntaxKind.md) + +*** + +### scanJsxAttributeValue() + +> **scanJsxAttributeValue**(): [`SyntaxKind`](../enumerations/SyntaxKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4593 + +#### Returns + +[`SyntaxKind`](../enumerations/SyntaxKind.md) + +*** + +### scanJsxIdentifier() + +> **scanJsxIdentifier**(): [`SyntaxKind`](../enumerations/SyntaxKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4592 + +#### Returns + +[`SyntaxKind`](../enumerations/SyntaxKind.md) + +*** + +### scanJsxToken() + +> **scanJsxToken**(): [`JsxTokenSyntaxKind`](../type-aliases/JsxTokenSyntaxKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4600 + +#### Returns + +[`JsxTokenSyntaxKind`](../type-aliases/JsxTokenSyntaxKind.md) + +*** + +### scanRange() + +> **scanRange**\<`T`\>(`start`, `length`, `callback`): `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4610 + +#### Type Parameters + +• **T** + +#### Parameters + +##### start + +`number` + +##### length + +`number` + +##### callback + +() => `T` + +#### Returns + +`T` + +*** + +### setEtsContext() + +> **setEtsContext**(`isEtsContext`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4612 + +#### Parameters + +##### isEtsContext + +`boolean` + +#### Returns + +`void` + +*** + +### setLanguageVariant() + +> **setLanguageVariant**(`variant`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4607 + +#### Parameters + +##### variant + +[`LanguageVariant`](../enumerations/LanguageVariant.md) + +#### Returns + +`void` + +*** + +### setOnError() + +> **setOnError**(`onError`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4605 + +#### Parameters + +##### onError + +`undefined` | [`ErrorCallback`](../type-aliases/ErrorCallback.md) + +#### Returns + +`void` + +*** + +### setScriptTarget() + +> **setScriptTarget**(`scriptTarget`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4606 + +#### Parameters + +##### scriptTarget + +[`ScriptTarget`](../enumerations/ScriptTarget.md) + +#### Returns + +`void` + +*** + +### setText() + +> **setText**(`text`, `start`?, `length`?): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4604 + +#### Parameters + +##### text + +`undefined` | `string` + +##### start? + +`number` + +##### length? + +`number` + +#### Returns + +`void` + +*** + +### setTextPos() + +> **setTextPos**(`textPos`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4608 + +#### Parameters + +##### textPos + +`number` + +#### Returns + +`void` + +*** + +### tryScan() + +> **tryScan**\<`T`\>(`callback`): `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4611 + +#### Type Parameters + +• **T** + +#### Parameters + +##### callback + +() => `T` + +#### Returns + +`T` diff --git a/docs/api_docs/namespaces/ts/interfaces/ScopedEmitHelper.md b/docs/api_docs/namespaces/ts/interfaces/ScopedEmitHelper.md new file mode 100644 index 0000000000000000000000000000000000000000..03a127acf41b0b7ea7f129d372948c819da8130a --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ScopedEmitHelper.md @@ -0,0 +1,73 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ScopedEmitHelper + +# Interface: ScopedEmitHelper + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3560 + +## Extends + +- [`EmitHelperBase`](EmitHelperBase.md) + +## Properties + +### dependencies? + +> `readonly` `optional` **dependencies**: [`EmitHelper`](../type-aliases/EmitHelper.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3558 + +#### Inherited from + +[`EmitHelperBase`](EmitHelperBase.md).[`dependencies`](EmitHelperBase.md#dependencies) + +*** + +### name + +> `readonly` **name**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3554 + +#### Inherited from + +[`EmitHelperBase`](EmitHelperBase.md).[`name`](EmitHelperBase.md#name) + +*** + +### priority? + +> `readonly` `optional` **priority**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3557 + +#### Inherited from + +[`EmitHelperBase`](EmitHelperBase.md).[`priority`](EmitHelperBase.md#priority) + +*** + +### scoped + +> `readonly` **scoped**: `true` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3561 + +#### Overrides + +[`EmitHelperBase`](EmitHelperBase.md).[`scoped`](EmitHelperBase.md#scoped) + +*** + +### text + +> `readonly` **text**: `string` \| (`node`) => `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3556 + +#### Inherited from + +[`EmitHelperBase`](EmitHelperBase.md).[`text`](EmitHelperBase.md#text) diff --git a/docs/api_docs/namespaces/ts/interfaces/ScriptReferenceHost.md b/docs/api_docs/namespaces/ts/interfaces/ScriptReferenceHost.md new file mode 100644 index 0000000000000000000000000000000000000000..e3868e704484f18246ff4c666dc69a8358ce34df --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ScriptReferenceHost.md @@ -0,0 +1,74 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ScriptReferenceHost + +# Interface: ScriptReferenceHost + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2230 + +## Extended by + +- [`Program`](Program.md) +- [`EmitHost`](EmitHost.md) + +## Methods + +### getCompilerOptions() + +> **getCompilerOptions**(): [`CompilerOptions`](CompilerOptions.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2231 + +#### Returns + +[`CompilerOptions`](CompilerOptions.md) + +*** + +### getCurrentDirectory() + +> **getCurrentDirectory**(): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2234 + +#### Returns + +`string` + +*** + +### getSourceFile() + +> **getSourceFile**(`fileName`): `undefined` \| [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2232 + +#### Parameters + +##### fileName + +`string` + +#### Returns + +`undefined` \| [`SourceFile`](SourceFile.md) + +*** + +### getSourceFileByPath() + +> **getSourceFileByPath**(`path`): `undefined` \| [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2233 + +#### Parameters + +##### path + +[`Path`](../type-aliases/Path.md) + +#### Returns + +`undefined` \| [`SourceFile`](SourceFile.md) diff --git a/docs/api_docs/namespaces/ts/interfaces/SelectionRange.md b/docs/api_docs/namespaces/ts/interfaces/SelectionRange.md new file mode 100644 index 0000000000000000000000000000000000000000..368bfc2802260b61472fe5b459feef3fd383d833 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/SelectionRange.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / SelectionRange + +# Interface: SelectionRange + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6923 + +## Properties + +### parent? + +> `optional` **parent**: [`SelectionRange`](SelectionRange.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6925 + +*** + +### textSpan + +> **textSpan**: [`TextSpan`](TextSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6924 diff --git a/docs/api_docs/namespaces/ts/interfaces/SemanticDiagnosticsBuilderProgram.md b/docs/api_docs/namespaces/ts/interfaces/SemanticDiagnosticsBuilderProgram.md new file mode 100644 index 0000000000000000000000000000000000000000..a58e54e53d33119371471cac4b2087deda38ecec --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/SemanticDiagnosticsBuilderProgram.md @@ -0,0 +1,401 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / SemanticDiagnosticsBuilderProgram + +# Interface: SemanticDiagnosticsBuilderProgram + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5736 + +The builder that caches the semantic diagnostics for the program and handles the changed files and affected files + +## Extends + +- [`BuilderProgram`](BuilderProgram.md) + +## Extended by + +- [`EmitAndSemanticDiagnosticsBuilderProgram`](EmitAndSemanticDiagnosticsBuilderProgram.md) + +## Properties + +### builderProgramForLinter? + +> `optional` **builderProgramForLinter**: [`EmitAndSemanticDiagnosticsBuilderProgram`](EmitAndSemanticDiagnosticsBuilderProgram.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5731 + +#### Inherited from + +[`BuilderProgram`](BuilderProgram.md).[`builderProgramForLinter`](BuilderProgram.md#builderprogramforlinter) + +## Methods + +### emit() + +> **emit**(`targetSourceFile`?, `writeFile`?, `cancellationToken`?, `emitOnlyDtsFiles`?, `customTransformers`?): [`EmitResult`](EmitResult.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5725 + +Emits the JavaScript and declaration files. +When targetSource file is specified, emits the files corresponding to that source file, +otherwise for the whole program. +In case of EmitAndSemanticDiagnosticsBuilderProgram, when targetSourceFile is specified, +it is assumed that that file is handled from affected file list. If targetSourceFile is not specified, +it will only emit all the affected files instead of whole program + +The first of writeFile if provided, writeFile of BuilderProgramHost if provided, writeFile of compiler host +in that order would be used to write the files + +#### Parameters + +##### targetSourceFile? + +[`SourceFile`](SourceFile.md) + +##### writeFile? + +[`WriteFileCallback`](../type-aliases/WriteFileCallback.md) + +##### cancellationToken? + +[`CancellationToken`](CancellationToken.md) + +##### emitOnlyDtsFiles? + +`boolean` + +##### customTransformers? + +[`CustomTransformers`](CustomTransformers.md) + +#### Returns + +[`EmitResult`](EmitResult.md) + +#### Inherited from + +[`BuilderProgram`](BuilderProgram.md).[`emit`](BuilderProgram.md#emit) + +*** + +### getAllDependencies() + +> **getAllDependencies**(`sourceFile`): readonly `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5704 + +Get all the dependencies of the file + +#### Parameters + +##### sourceFile + +[`SourceFile`](SourceFile.md) + +#### Returns + +readonly `string`[] + +#### Inherited from + +[`BuilderProgram`](BuilderProgram.md).[`getAllDependencies`](BuilderProgram.md#getalldependencies) + +*** + +### getCompilerOptions() + +> **getCompilerOptions**(): [`CompilerOptions`](CompilerOptions.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5672 + +Get compiler options of the program + +#### Returns + +[`CompilerOptions`](CompilerOptions.md) + +#### Inherited from + +[`BuilderProgram`](BuilderProgram.md).[`getCompilerOptions`](BuilderProgram.md#getcompileroptions) + +*** + +### getConfigFileParsingDiagnostics() + +> **getConfigFileParsingDiagnostics**(): readonly [`Diagnostic`](Diagnostic.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5692 + +Get the diagnostics from config file parsing + +#### Returns + +readonly [`Diagnostic`](Diagnostic.md)[] + +#### Inherited from + +[`BuilderProgram`](BuilderProgram.md).[`getConfigFileParsingDiagnostics`](BuilderProgram.md#getconfigfileparsingdiagnostics) + +*** + +### getCurrentDirectory() + +> **getCurrentDirectory**(): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5729 + +Get the current directory of the program + +#### Returns + +`string` + +#### Inherited from + +[`BuilderProgram`](BuilderProgram.md).[`getCurrentDirectory`](BuilderProgram.md#getcurrentdirectory) + +*** + +### getDeclarationDiagnostics() + +> **getDeclarationDiagnostics**(`sourceFile`?, `cancellationToken`?): readonly [`DiagnosticWithLocation`](DiagnosticWithLocation.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5700 + +Get the declaration diagnostics, for all source files if source file is not supplied + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### cancellationToken? + +[`CancellationToken`](CancellationToken.md) + +#### Returns + +readonly [`DiagnosticWithLocation`](DiagnosticWithLocation.md)[] + +#### Inherited from + +[`BuilderProgram`](BuilderProgram.md).[`getDeclarationDiagnostics`](BuilderProgram.md#getdeclarationdiagnostics) + +*** + +### getGlobalDiagnostics() + +> **getGlobalDiagnostics**(`cancellationToken`?): readonly [`Diagnostic`](Diagnostic.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5688 + +Get the diagnostics that dont belong to any file + +#### Parameters + +##### cancellationToken? + +[`CancellationToken`](CancellationToken.md) + +#### Returns + +readonly [`Diagnostic`](Diagnostic.md)[] + +#### Inherited from + +[`BuilderProgram`](BuilderProgram.md).[`getGlobalDiagnostics`](BuilderProgram.md#getglobaldiagnostics) + +*** + +### getOptionsDiagnostics() + +> **getOptionsDiagnostics**(`cancellationToken`?): readonly [`Diagnostic`](Diagnostic.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5684 + +Get the diagnostics for compiler options + +#### Parameters + +##### cancellationToken? + +[`CancellationToken`](CancellationToken.md) + +#### Returns + +readonly [`Diagnostic`](Diagnostic.md)[] + +#### Inherited from + +[`BuilderProgram`](BuilderProgram.md).[`getOptionsDiagnostics`](BuilderProgram.md#getoptionsdiagnostics) + +*** + +### getProgram() + +> **getProgram**(): [`Program`](Program.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5668 + +Returns current program + +#### Returns + +[`Program`](Program.md) + +#### Inherited from + +[`BuilderProgram`](BuilderProgram.md).[`getProgram`](BuilderProgram.md#getprogram) + +*** + +### getSemanticDiagnostics() + +> **getSemanticDiagnostics**(`sourceFile`?, `cancellationToken`?): readonly [`Diagnostic`](Diagnostic.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5713 + +Gets the semantic diagnostics from the program corresponding to this state of file (if provided) or whole program +The semantic diagnostics are cached and managed here +Note that it is assumed that when asked about semantic diagnostics through this API, +the file has been taken out of affected files so it is safe to use cache or get from program and cache the diagnostics +In case of SemanticDiagnosticsBuilderProgram if the source file is not provided, +it will iterate through all the affected files, to ensure that cache stays valid and yet provide a way to get all semantic diagnostics + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### cancellationToken? + +[`CancellationToken`](CancellationToken.md) + +#### Returns + +readonly [`Diagnostic`](Diagnostic.md)[] + +#### Inherited from + +[`BuilderProgram`](BuilderProgram.md).[`getSemanticDiagnostics`](BuilderProgram.md#getsemanticdiagnostics) + +*** + +### getSemanticDiagnosticsOfNextAffectedFile() + +> **getSemanticDiagnosticsOfNextAffectedFile**(`cancellationToken`?, `ignoreSourceFile`?): [`AffectedFileResult`](../type-aliases/AffectedFileResult.md)\ + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5741 + +Gets the semantic diagnostics from the program for the next affected file and caches it +Returns undefined if the iteration is complete + +#### Parameters + +##### cancellationToken? + +[`CancellationToken`](CancellationToken.md) + +##### ignoreSourceFile? + +(`sourceFile`) => `boolean` + +#### Returns + +[`AffectedFileResult`](../type-aliases/AffectedFileResult.md)\ + +*** + +### getSourceFile() + +> **getSourceFile**(`fileName`): `undefined` \| [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5676 + +Get the source file in the program with file name + +#### Parameters + +##### fileName + +`string` + +#### Returns + +`undefined` \| [`SourceFile`](SourceFile.md) + +#### Inherited from + +[`BuilderProgram`](BuilderProgram.md).[`getSourceFile`](BuilderProgram.md#getsourcefile) + +*** + +### getSourceFiles() + +> **getSourceFiles**(): readonly [`SourceFile`](SourceFile.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5680 + +Get a list of files in the program + +#### Returns + +readonly [`SourceFile`](SourceFile.md)[] + +#### Inherited from + +[`BuilderProgram`](BuilderProgram.md).[`getSourceFiles`](BuilderProgram.md#getsourcefiles) + +*** + +### getSyntacticDiagnostics() + +> **getSyntacticDiagnostics**(`sourceFile`?, `cancellationToken`?): readonly [`Diagnostic`](Diagnostic.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5696 + +Get the syntax diagnostics, for all source files if source file is not supplied + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### cancellationToken? + +[`CancellationToken`](CancellationToken.md) + +#### Returns + +readonly [`Diagnostic`](Diagnostic.md)[] + +#### Inherited from + +[`BuilderProgram`](BuilderProgram.md).[`getSyntacticDiagnostics`](BuilderProgram.md#getsyntacticdiagnostics) + +*** + +### isFileUpdateInConstEnumCache()? + +> `optional` **isFileUpdateInConstEnumCache**(`sourceFile`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5730 + +#### Parameters + +##### sourceFile + +[`SourceFile`](SourceFile.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`BuilderProgram`](BuilderProgram.md).[`isFileUpdateInConstEnumCache`](BuilderProgram.md#isfileupdateinconstenumcache) diff --git a/docs/api_docs/namespaces/ts/interfaces/SemicolonClassElement.md b/docs/api_docs/namespaces/ts/interfaces/SemicolonClassElement.md new file mode 100644 index 0000000000000000000000000000000000000000..d2de4581b17855d079958b099188a383640a18fb --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/SemicolonClassElement.md @@ -0,0 +1,515 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / SemicolonClassElement + +# Interface: SemicolonClassElement + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:881 + +For when we encounter a semicolon in a class declaration. ES6 allows these as class elements. + +## Extends + +- [`ClassElement`](ClassElement.md) + +## Properties + +### \_classElementBrand + +> **\_classElementBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1633 + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`_classElementBrand`](ClassElement.md#_classelementbrand) + +*** + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`_declarationBrand`](ClassElement.md#_declarationbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`decorators`](ClassElement.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`end`](ClassElement.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`flags`](ClassElement.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`SemicolonClassElement`](../enumerations/SyntaxKind.md#semicolonclasselement) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:882 + +#### Overrides + +[`ClassElement`](ClassElement.md).[`kind`](ClassElement.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`locals`](ClassElement.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`modifiers`](ClassElement.md#modifiers) + +*** + +### name? + +> `readonly` `optional` **name**: [`PropertyName`](../type-aliases/PropertyName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1634 + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`name`](ClassElement.md#name) + +*** + +### parent + +> `readonly` **parent**: [`ClassLikeDeclaration`](../type-aliases/ClassLikeDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:883 + +#### Overrides + +[`ClassElement`](ClassElement.md).[`parent`](ClassElement.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`pos`](ClassElement.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`skipCheck`](ClassElement.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`symbol`](ClassElement.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`forEachChild`](ClassElement.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`getChildAt`](ClassElement.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`getChildCount`](ClassElement.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`getChildren`](ClassElement.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`getEnd`](ClassElement.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`getFirstToken`](ClassElement.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`getFullStart`](ClassElement.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`getFullText`](ClassElement.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`getFullWidth`](ClassElement.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`getLastToken`](ClassElement.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`getLeadingTriviaWidth`](ClassElement.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`getSourceFile`](ClassElement.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`getStart`](ClassElement.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`getText`](ClassElement.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`getWidth`](ClassElement.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/Set.md b/docs/api_docs/namespaces/ts/interfaces/Set.md new file mode 100644 index 0000000000000000000000000000000000000000..c7701bf3c77c7a689a9041105221c405b4376c35 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/Set.md @@ -0,0 +1,179 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / Set + +# Interface: Set\ + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:74 + +ES6 Set interface. + +## Extends + +- [`ReadonlySet`](ReadonlySet.md)\<`T`\>.[`Collection`](Collection.md)\<`T`\> + +## Type Parameters + +• **T** + +## Properties + +### size + +> `readonly` **size**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:36 + +#### Inherited from + +[`Collection`](Collection.md).[`size`](Collection.md#size) + +## Methods + +### add() + +> **add**(`value`): `this` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:75 + +#### Parameters + +##### value + +`T` + +#### Returns + +`this` + +*** + +### clear() + +> **clear**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:43 + +#### Returns + +`void` + +#### Inherited from + +[`Collection`](Collection.md).[`clear`](Collection.md#clear) + +*** + +### delete() + +> **delete**(`value`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:76 + +#### Parameters + +##### value + +`T` + +#### Returns + +`boolean` + +#### Overrides + +[`Collection`](Collection.md).[`delete`](Collection.md#delete) + +*** + +### entries() + +> **entries**(): [`Iterator`](Iterator.md)\<\[`T`, `T`\]\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:70 + +#### Returns + +[`Iterator`](Iterator.md)\<\[`T`, `T`\]\> + +#### Inherited from + +[`ReadonlySet`](ReadonlySet.md).[`entries`](ReadonlySet.md#entries) + +*** + +### forEach() + +> **forEach**(`action`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:71 + +#### Parameters + +##### action + +(`value`, `key`) => `void` + +#### Returns + +`void` + +#### Inherited from + +[`ReadonlySet`](ReadonlySet.md).[`forEach`](ReadonlySet.md#foreach) + +*** + +### has() + +> **has**(`value`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:68 + +#### Parameters + +##### value + +`T` + +#### Returns + +`boolean` + +#### Inherited from + +[`Collection`](Collection.md).[`has`](Collection.md#has) + +*** + +### keys() + +> **keys**(): [`Iterator`](Iterator.md)\<`T`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:38 + +#### Returns + +[`Iterator`](Iterator.md)\<`T`\> + +#### Inherited from + +[`Collection`](Collection.md).[`keys`](Collection.md#keys) + +*** + +### values() + +> **values**(): [`Iterator`](Iterator.md)\<`T`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:69 + +#### Returns + +[`Iterator`](Iterator.md)\<`T`\> + +#### Inherited from + +[`ReadonlySet`](ReadonlySet.md).[`values`](ReadonlySet.md#values) diff --git a/docs/api_docs/namespaces/ts/interfaces/SetAccessorDeclaration.md b/docs/api_docs/namespaces/ts/interfaces/SetAccessorDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..9a422a17e8fb4c58fbf71356307a85eff2570fe6 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/SetAccessorDeclaration.md @@ -0,0 +1,640 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / SetAccessorDeclaration + +# Interface: SetAccessorDeclaration + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:892 + +Several node kinds share function-like features such as a signature, +a name, and a body. These nodes should extend FunctionLikeDeclarationBase. +Examples: +- FunctionDeclaration +- MethodDeclaration +- AccessorDeclaration + +## Extends + +- [`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`ClassElement`](ClassElement.md).[`TypeElement`](TypeElement.md).[`ObjectLiteralElement`](ObjectLiteralElement.md).[`JSDocContainer`](JSDocContainer.md) + +## Properties + +### \_classElementBrand + +> **\_classElementBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1633 + +#### Inherited from + +[`ClassElement`](ClassElement.md).[`_classElementBrand`](ClassElement.md#_classelementbrand) + +*** + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`_declarationBrand`](ObjectLiteralElement.md#_declarationbrand) + +*** + +### \_functionLikeDeclarationBrand + +> **\_functionLikeDeclarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:846 + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`_functionLikeDeclarationBrand`](FunctionLikeDeclarationBase.md#_functionlikedeclarationbrand) + +*** + +### \_objectLiteralBrand + +> **\_objectLiteralBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:798 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`_objectLiteralBrand`](ObjectLiteralElement.md#_objectliteralbrand) + +*** + +### \_typeElementBrand + +> **\_typeElementBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1637 + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`_typeElementBrand`](TypeElement.md#_typeelementbrand) + +*** + +### asteriskToken? + +> `readonly` `optional` **asteriskToken**: [`AsteriskToken`](../type-aliases/AsteriskToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:847 + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`asteriskToken`](FunctionLikeDeclarationBase.md#asterisktoken) + +*** + +### body? + +> `readonly` `optional` **body**: [`Block`](Block.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:897 + +#### Overrides + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`body`](FunctionLikeDeclarationBase.md#body) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`decorators`](ObjectLiteralElement.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`end`](ObjectLiteralElement.md#end) + +*** + +### exclamationToken? + +> `readonly` `optional` **exclamationToken**: [`ExclamationToken`](../type-aliases/ExclamationToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:849 + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`exclamationToken`](FunctionLikeDeclarationBase.md#exclamationtoken) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`flags`](ObjectLiteralElement.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`SetAccessor`](../enumerations/SyntaxKind.md#setaccessor) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:893 + +#### Overrides + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`kind`](ObjectLiteralElement.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`locals`](ObjectLiteralElement.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:895 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Overrides + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`modifiers`](ObjectLiteralElement.md#modifiers) + +*** + +### name + +> `readonly` **name**: [`PropertyName`](../type-aliases/PropertyName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:896 + +#### Overrides + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`name`](ObjectLiteralElement.md#name) + +*** + +### parameters + +> `readonly` **parameters**: [`NodeArray`](NodeArray.md)\<[`ParameterDeclaration`](ParameterDeclaration.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:735 + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`parameters`](FunctionLikeDeclarationBase.md#parameters) + +*** + +### parent + +> `readonly` **parent**: [`ClassLikeDeclaration`](../type-aliases/ClassLikeDeclaration.md) \| [`ObjectLiteralExpression`](ObjectLiteralExpression.md) \| [`InterfaceDeclaration`](InterfaceDeclaration.md) \| [`TypeLiteralNode`](TypeLiteralNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:894 + +#### Overrides + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`parent`](ObjectLiteralElement.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`pos`](ObjectLiteralElement.md#pos) + +*** + +### questionToken? + +> `readonly` `optional` **questionToken**: [`QuestionToken`](../type-aliases/QuestionToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:848 + +#### Inherited from + +[`TypeElement`](TypeElement.md).[`questionToken`](TypeElement.md#questiontoken) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`skipCheck`](ObjectLiteralElement.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`symbol`](ObjectLiteralElement.md#symbol) + +*** + +### type? + +> `readonly` `optional` **type**: [`TypeNode`](TypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:736 + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`type`](FunctionLikeDeclarationBase.md#type) + +*** + +### typeParameters? + +> `readonly` `optional` **typeParameters**: [`NodeArray`](NodeArray.md)\<[`TypeParameterDeclaration`](TypeParameterDeclaration.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:734 + +#### Inherited from + +[`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md).[`typeParameters`](FunctionLikeDeclarationBase.md#typeparameters) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`forEachChild`](ObjectLiteralElement.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getChildAt`](ObjectLiteralElement.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getChildCount`](ObjectLiteralElement.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getChildren`](ObjectLiteralElement.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getEnd`](ObjectLiteralElement.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getFirstToken`](ObjectLiteralElement.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getFullStart`](ObjectLiteralElement.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getFullText`](ObjectLiteralElement.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getFullWidth`](ObjectLiteralElement.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getLastToken`](ObjectLiteralElement.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getLeadingTriviaWidth`](ObjectLiteralElement.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getSourceFile`](ObjectLiteralElement.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getStart`](ObjectLiteralElement.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getText`](ObjectLiteralElement.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getWidth`](ObjectLiteralElement.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/ShorthandPropertyAssignment.md b/docs/api_docs/namespaces/ts/interfaces/ShorthandPropertyAssignment.md new file mode 100644 index 0000000000000000000000000000000000000000..f9ca99c0ba04cd1933c74e8ad2aa3f41cfe74267 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ShorthandPropertyAssignment.md @@ -0,0 +1,546 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ShorthandPropertyAssignment + +# Interface: ShorthandPropertyAssignment + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:809 + +## Extends + +- [`ObjectLiteralElement`](ObjectLiteralElement.md).[`JSDocContainer`](JSDocContainer.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`_declarationBrand`](ObjectLiteralElement.md#_declarationbrand) + +*** + +### \_objectLiteralBrand + +> **\_objectLiteralBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:798 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`_objectLiteralBrand`](ObjectLiteralElement.md#_objectliteralbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`decorators`](ObjectLiteralElement.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`end`](ObjectLiteralElement.md#end) + +*** + +### equalsToken? + +> `readonly` `optional` **equalsToken**: [`EqualsToken`](../type-aliases/EqualsToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:813 + +*** + +### ~~exclamationToken?~~ + +> `readonly` `optional` **exclamationToken**: [`ExclamationToken`](../type-aliases/ExclamationToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8404 + +#### Deprecated + +A shorthand property assignment cannot have an exclamation token + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`flags`](ObjectLiteralElement.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`ShorthandPropertyAssignment`](../enumerations/SyntaxKind.md#shorthandpropertyassignment) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:810 + +#### Overrides + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`kind`](ObjectLiteralElement.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`locals`](ObjectLiteralElement.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`Modifier`](../type-aliases/Modifier.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8400 + +#### Deprecated + +A shorthand property assignment cannot have modifiers + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`modifiers`](ObjectLiteralElement.md#modifiers) + +*** + +### name + +> `readonly` **name**: [`Identifier`](Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:812 + +#### Overrides + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`name`](ObjectLiteralElement.md#name) + +*** + +### objectAssignmentInitializer? + +> `readonly` `optional` **objectAssignmentInitializer**: [`Expression`](Expression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:814 + +*** + +### parent + +> `readonly` **parent**: [`ObjectLiteralExpression`](ObjectLiteralExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:811 + +#### Overrides + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`parent`](ObjectLiteralElement.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`pos`](ObjectLiteralElement.md#pos) + +*** + +### ~~questionToken?~~ + +> `readonly` `optional` **questionToken**: [`QuestionToken`](../type-aliases/QuestionToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8402 + +#### Deprecated + +A shorthand property assignment cannot have a question token + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`skipCheck`](ObjectLiteralElement.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`symbol`](ObjectLiteralElement.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`forEachChild`](ObjectLiteralElement.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getChildAt`](ObjectLiteralElement.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getChildCount`](ObjectLiteralElement.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getChildren`](ObjectLiteralElement.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getEnd`](ObjectLiteralElement.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getFirstToken`](ObjectLiteralElement.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getFullStart`](ObjectLiteralElement.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getFullText`](ObjectLiteralElement.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getFullWidth`](ObjectLiteralElement.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getLastToken`](ObjectLiteralElement.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getLeadingTriviaWidth`](ObjectLiteralElement.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getSourceFile`](ObjectLiteralElement.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getStart`](ObjectLiteralElement.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getText`](ObjectLiteralElement.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getWidth`](ObjectLiteralElement.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/Signature.md b/docs/api_docs/namespaces/ts/interfaces/Signature.md new file mode 100644 index 0000000000000000000000000000000000000000..10bbbe15fa4fb65d1facd826a56e22c44111c286 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/Signature.md @@ -0,0 +1,129 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / Signature + +# Interface: Signature + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2936 + +## Properties + +### declaration? + +> `optional` **declaration**: [`SignatureDeclaration`](../type-aliases/SignatureDeclaration.md) \| [`JSDocSignature`](JSDocSignature.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2937 + +*** + +### parameters + +> **parameters**: readonly [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2939 + +*** + +### typeParameters? + +> `optional` **typeParameters**: readonly [`TypeParameter`](TypeParameter.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2938 + +## Methods + +### getDeclaration() + +> **getDeclaration**(): [`SignatureDeclaration`](../type-aliases/SignatureDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6148 + +#### Returns + +[`SignatureDeclaration`](../type-aliases/SignatureDeclaration.md) + +*** + +### getDocumentationComment() + +> **getDocumentationComment**(`typeChecker`): [`SymbolDisplayPart`](SymbolDisplayPart.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6153 + +#### Parameters + +##### typeChecker + +`undefined` | [`TypeChecker`](TypeChecker.md) + +#### Returns + +[`SymbolDisplayPart`](SymbolDisplayPart.md)[] + +*** + +### getJsDocTags() + +> **getJsDocTags**(): [`JSDocTagInfo`](JSDocTagInfo-1.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6154 + +#### Returns + +[`JSDocTagInfo`](JSDocTagInfo-1.md)[] + +*** + +### getParameters() + +> **getParameters**(): [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6150 + +#### Returns + +[`Symbol`](Symbol.md)[] + +*** + +### getReturnType() + +> **getReturnType**(): [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6152 + +#### Returns + +[`Type`](Type.md) + +*** + +### getTypeParameterAtPosition() + +> **getTypeParameterAtPosition**(`pos`): [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6151 + +#### Parameters + +##### pos + +`number` + +#### Returns + +[`Type`](Type.md) + +*** + +### getTypeParameters() + +> **getTypeParameters**(): `undefined` \| [`TypeParameter`](TypeParameter.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6149 + +#### Returns + +`undefined` \| [`TypeParameter`](TypeParameter.md)[] diff --git a/docs/api_docs/namespaces/ts/interfaces/SignatureDeclarationBase.md b/docs/api_docs/namespaces/ts/interfaces/SignatureDeclarationBase.md new file mode 100644 index 0000000000000000000000000000000000000000..f14912a0df107f158a22f3b12a1ab8f3f3cb77b4 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/SignatureDeclarationBase.md @@ -0,0 +1,535 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / SignatureDeclarationBase + +# Interface: SignatureDeclarationBase + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:731 + +## Extends + +- [`NamedDeclaration`](NamedDeclaration.md).[`JSDocContainer`](JSDocContainer.md) + +## Extended by + +- [`CallSignatureDeclaration`](CallSignatureDeclaration.md) +- [`ConstructSignatureDeclaration`](ConstructSignatureDeclaration.md) +- [`FunctionLikeDeclarationBase`](FunctionLikeDeclarationBase.md) +- [`MethodSignature`](MethodSignature.md) +- [`IndexSignatureDeclaration`](IndexSignatureDeclaration.md) +- [`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md) +- [`JSDocFunctionType`](JSDocFunctionType.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`_declarationBrand`](NamedDeclaration.md#_declarationbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`decorators`](NamedDeclaration.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`end`](NamedDeclaration.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`flags`](NamedDeclaration.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`MethodSignature`](../enumerations/SyntaxKind.md#methodsignature) \| [`MethodDeclaration`](../enumerations/SyntaxKind.md#methoddeclaration) \| [`Constructor`](../enumerations/SyntaxKind.md#constructor) \| [`GetAccessor`](../enumerations/SyntaxKind.md#getaccessor) \| [`SetAccessor`](../enumerations/SyntaxKind.md#setaccessor) \| [`CallSignature`](../enumerations/SyntaxKind.md#callsignature) \| [`ConstructSignature`](../enumerations/SyntaxKind.md#constructsignature) \| [`IndexSignature`](../enumerations/SyntaxKind.md#indexsignature) \| [`FunctionType`](../enumerations/SyntaxKind.md#functiontype) \| [`ConstructorType`](../enumerations/SyntaxKind.md#constructortype) \| [`FunctionExpression`](../enumerations/SyntaxKind.md#functionexpression) \| [`ArrowFunction`](../enumerations/SyntaxKind.md#arrowfunction) \| [`FunctionDeclaration`](../enumerations/SyntaxKind.md#functiondeclaration) \| [`JSDocFunctionType`](../enumerations/SyntaxKind.md#jsdocfunctiontype) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:732 + +#### Overrides + +[`NamedDeclaration`](NamedDeclaration.md).[`kind`](NamedDeclaration.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`locals`](NamedDeclaration.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`modifiers`](NamedDeclaration.md#modifiers) + +*** + +### name? + +> `readonly` `optional` **name**: [`PropertyName`](../type-aliases/PropertyName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:733 + +#### Overrides + +[`NamedDeclaration`](NamedDeclaration.md).[`name`](NamedDeclaration.md#name) + +*** + +### parameters + +> `readonly` **parameters**: [`NodeArray`](NodeArray.md)\<[`ParameterDeclaration`](ParameterDeclaration.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:735 + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`parent`](NamedDeclaration.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`pos`](NamedDeclaration.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`skipCheck`](NamedDeclaration.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`symbol`](NamedDeclaration.md#symbol) + +*** + +### type? + +> `readonly` `optional` **type**: [`TypeNode`](TypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:736 + +*** + +### typeParameters? + +> `readonly` `optional` **typeParameters**: [`NodeArray`](NodeArray.md)\<[`TypeParameterDeclaration`](TypeParameterDeclaration.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:734 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`forEachChild`](NamedDeclaration.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getChildAt`](NamedDeclaration.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getChildCount`](NamedDeclaration.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getChildren`](NamedDeclaration.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getEnd`](NamedDeclaration.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFirstToken`](NamedDeclaration.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFullStart`](NamedDeclaration.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFullText`](NamedDeclaration.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFullWidth`](NamedDeclaration.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getLastToken`](NamedDeclaration.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getLeadingTriviaWidth`](NamedDeclaration.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getSourceFile`](NamedDeclaration.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getStart`](NamedDeclaration.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getText`](NamedDeclaration.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getWidth`](NamedDeclaration.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/SignatureHelpCharacterTypedReason.md b/docs/api_docs/namespaces/ts/interfaces/SignatureHelpCharacterTypedReason.md new file mode 100644 index 0000000000000000000000000000000000000000..2b38c25377cdb662036e9c3dccd64759d9cdb052 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/SignatureHelpCharacterTypedReason.md @@ -0,0 +1,30 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / SignatureHelpCharacterTypedReason + +# Interface: SignatureHelpCharacterTypedReason + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6491 + +Signals that the signature help request came from a user typing a character. +Depending on the character and the syntactic context, the request may or may not be served a result. + +## Properties + +### kind + +> **kind**: `"characterTyped"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6492 + +*** + +### triggerCharacter + +> **triggerCharacter**: [`SignatureHelpTriggerCharacter`](../type-aliases/SignatureHelpTriggerCharacter.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6496 + +Character that was responsible for triggering signature help. diff --git a/docs/api_docs/namespaces/ts/interfaces/SignatureHelpInvokedReason.md b/docs/api_docs/namespaces/ts/interfaces/SignatureHelpInvokedReason.md new file mode 100644 index 0000000000000000000000000000000000000000..e55526afb92697269ad827c9368c16b9ac6f04cc --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/SignatureHelpInvokedReason.md @@ -0,0 +1,28 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / SignatureHelpInvokedReason + +# Interface: SignatureHelpInvokedReason + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6483 + +Signals that the user manually requested signature help. +The language service will unconditionally attempt to provide a result. + +## Properties + +### kind + +> **kind**: `"invoked"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6484 + +*** + +### triggerCharacter? + +> `optional` **triggerCharacter**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6485 diff --git a/docs/api_docs/namespaces/ts/interfaces/SignatureHelpItem.md b/docs/api_docs/namespaces/ts/interfaces/SignatureHelpItem.md new file mode 100644 index 0000000000000000000000000000000000000000..fccd47fe2d5d46c7404cc2f653e73d6404dddab7 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/SignatureHelpItem.md @@ -0,0 +1,71 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / SignatureHelpItem + +# Interface: SignatureHelpItem + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6934 + +Represents a single signature to show in signature help. +The id is used for subsequent calls into the language service to ask questions about the +signature help item in the context of any documents that have been updated. i.e. after +an edit has happened, while signature help is still active, the host can ask important +questions like 'what parameter is the user currently contained within?'. + +## Properties + +### documentation + +> **documentation**: [`SymbolDisplayPart`](SymbolDisplayPart.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6940 + +*** + +### isVariadic + +> **isVariadic**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6935 + +*** + +### parameters + +> **parameters**: [`SignatureHelpParameter`](SignatureHelpParameter.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6939 + +*** + +### prefixDisplayParts + +> **prefixDisplayParts**: [`SymbolDisplayPart`](SymbolDisplayPart.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6936 + +*** + +### separatorDisplayParts + +> **separatorDisplayParts**: [`SymbolDisplayPart`](SymbolDisplayPart.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6938 + +*** + +### suffixDisplayParts + +> **suffixDisplayParts**: [`SymbolDisplayPart`](SymbolDisplayPart.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6937 + +*** + +### tags + +> **tags**: [`JSDocTagInfo`](JSDocTagInfo-1.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6941 diff --git a/docs/api_docs/namespaces/ts/interfaces/SignatureHelpItems.md b/docs/api_docs/namespaces/ts/interfaces/SignatureHelpItems.md new file mode 100644 index 0000000000000000000000000000000000000000..c4343ae89387d8c35e19b305232ba35c1e768fc3 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/SignatureHelpItems.md @@ -0,0 +1,51 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / SignatureHelpItems + +# Interface: SignatureHelpItems + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6946 + +Represents a set of signature help items, and the preferred item that should be selected. + +## Properties + +### applicableSpan + +> **applicableSpan**: [`TextSpan`](TextSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6948 + +*** + +### argumentCount + +> **argumentCount**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6951 + +*** + +### argumentIndex + +> **argumentIndex**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6950 + +*** + +### items + +> **items**: [`SignatureHelpItem`](SignatureHelpItem.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6947 + +*** + +### selectedItemIndex + +> **selectedItemIndex**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6949 diff --git a/docs/api_docs/namespaces/ts/interfaces/SignatureHelpItemsOptions.md b/docs/api_docs/namespaces/ts/interfaces/SignatureHelpItemsOptions.md new file mode 100644 index 0000000000000000000000000000000000000000..98016847b2c6c0a87f38a4062e6ef3ff2c16c16c --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/SignatureHelpItemsOptions.md @@ -0,0 +1,17 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / SignatureHelpItemsOptions + +# Interface: SignatureHelpItemsOptions + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6475 + +## Properties + +### triggerReason? + +> `optional` **triggerReason**: [`SignatureHelpTriggerReason`](../type-aliases/SignatureHelpTriggerReason.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6476 diff --git a/docs/api_docs/namespaces/ts/interfaces/SignatureHelpParameter.md b/docs/api_docs/namespaces/ts/interfaces/SignatureHelpParameter.md new file mode 100644 index 0000000000000000000000000000000000000000..215b5d9b68dad5fc2784fd712fae575c35e7a507 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/SignatureHelpParameter.md @@ -0,0 +1,49 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / SignatureHelpParameter + +# Interface: SignatureHelpParameter + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6916 + +## Properties + +### displayParts + +> **displayParts**: [`SymbolDisplayPart`](SymbolDisplayPart.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6919 + +*** + +### documentation + +> **documentation**: [`SymbolDisplayPart`](SymbolDisplayPart.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6918 + +*** + +### isOptional + +> **isOptional**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6920 + +*** + +### isRest? + +> `optional` **isRest**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6921 + +*** + +### name + +> **name**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6917 diff --git a/docs/api_docs/namespaces/ts/interfaces/SignatureHelpRetriggeredReason.md b/docs/api_docs/namespaces/ts/interfaces/SignatureHelpRetriggeredReason.md new file mode 100644 index 0000000000000000000000000000000000000000..ede5d781155946732722bd45174d6e8ff738d2fc --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/SignatureHelpRetriggeredReason.md @@ -0,0 +1,32 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / SignatureHelpRetriggeredReason + +# Interface: SignatureHelpRetriggeredReason + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6504 + +Signals that this signature help request came from typing a character or moving the cursor. +This should only occur if a signature help session was already active and the editor needs to see if it should adjust. +The language service will unconditionally attempt to provide a result. +`triggerCharacter` can be `undefined` for a retrigger caused by a cursor move. + +## Properties + +### kind + +> **kind**: `"retrigger"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6505 + +*** + +### triggerCharacter? + +> `optional` **triggerCharacter**: [`SignatureHelpRetriggerCharacter`](../type-aliases/SignatureHelpRetriggerCharacter.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6509 + +Character that was responsible for triggering signature help. diff --git a/docs/api_docs/namespaces/ts/interfaces/SolutionBuilder.md b/docs/api_docs/namespaces/ts/interfaces/SolutionBuilder.md new file mode 100644 index 0000000000000000000000000000000000000000..178f621856e44e52df9e2ff493d2bcf04208fa31 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/SolutionBuilder.md @@ -0,0 +1,127 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / SolutionBuilder + +# Interface: SolutionBuilder\ + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5956 + +## Type Parameters + +• **T** *extends* [`BuilderProgram`](BuilderProgram.md) + +## Methods + +### build() + +> **build**(`project`?, `cancellationToken`?, `writeFile`?, `getCustomTransformers`?): [`ExitStatus`](../enumerations/ExitStatus.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5957 + +#### Parameters + +##### project? + +`string` + +##### cancellationToken? + +[`CancellationToken`](CancellationToken.md) + +##### writeFile? + +[`WriteFileCallback`](../type-aliases/WriteFileCallback.md) + +##### getCustomTransformers? + +(`project`) => [`CustomTransformers`](CustomTransformers.md) + +#### Returns + +[`ExitStatus`](../enumerations/ExitStatus.md) + +*** + +### buildReferences() + +> **buildReferences**(`project`, `cancellationToken`?, `writeFile`?, `getCustomTransformers`?): [`ExitStatus`](../enumerations/ExitStatus.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5959 + +#### Parameters + +##### project + +`string` + +##### cancellationToken? + +[`CancellationToken`](CancellationToken.md) + +##### writeFile? + +[`WriteFileCallback`](../type-aliases/WriteFileCallback.md) + +##### getCustomTransformers? + +(`project`) => [`CustomTransformers`](CustomTransformers.md) + +#### Returns + +[`ExitStatus`](../enumerations/ExitStatus.md) + +*** + +### clean() + +> **clean**(`project`?): [`ExitStatus`](../enumerations/ExitStatus.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5958 + +#### Parameters + +##### project? + +`string` + +#### Returns + +[`ExitStatus`](../enumerations/ExitStatus.md) + +*** + +### cleanReferences() + +> **cleanReferences**(`project`?): [`ExitStatus`](../enumerations/ExitStatus.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5960 + +#### Parameters + +##### project? + +`string` + +#### Returns + +[`ExitStatus`](../enumerations/ExitStatus.md) + +*** + +### getNextInvalidatedProject() + +> **getNextInvalidatedProject**(`cancellationToken`?): `undefined` \| [`InvalidatedProject`](../type-aliases/InvalidatedProject.md)\<`T`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5961 + +#### Parameters + +##### cancellationToken? + +[`CancellationToken`](CancellationToken.md) + +#### Returns + +`undefined` \| [`InvalidatedProject`](../type-aliases/InvalidatedProject.md)\<`T`\> diff --git a/docs/api_docs/namespaces/ts/interfaces/SolutionBuilderHost.md b/docs/api_docs/namespaces/ts/interfaces/SolutionBuilderHost.md new file mode 100644 index 0000000000000000000000000000000000000000..9d4b0d4fc355a4ed823bead55c5676beb08da281 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/SolutionBuilderHost.md @@ -0,0 +1,702 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / SolutionBuilderHost + +# Interface: SolutionBuilderHost\ + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5951 + +## Extends + +- [`SolutionBuilderHostBase`](SolutionBuilderHostBase.md)\<`T`\> + +## Type Parameters + +• **T** *extends* [`BuilderProgram`](BuilderProgram.md) + +## Properties + +### createProgram + +> **createProgram**: [`CreateProgram`](../type-aliases/CreateProgram.md)\<`T`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5812 + +Used to create the program when need for program creation or recreation detected + +#### Inherited from + +[`SolutionBuilderHostBase`](SolutionBuilderHostBase.md).[`createProgram`](SolutionBuilderHostBase.md#createprogram) + +*** + +### getCustomTransformers()? + +> `optional` **getCustomTransformers**: (`project`) => `undefined` \| [`CustomTransformers`](CustomTransformers.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5942 + +#### Parameters + +##### project + +`string` + +#### Returns + +`undefined` \| [`CustomTransformers`](CustomTransformers.md) + +#### Inherited from + +[`SolutionBuilderHostBase`](SolutionBuilderHostBase.md).[`getCustomTransformers`](SolutionBuilderHostBase.md#getcustomtransformers) + +*** + +### reportDiagnostic + +> **reportDiagnostic**: [`DiagnosticReporter`](../type-aliases/DiagnosticReporter.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5947 + +#### Inherited from + +[`SolutionBuilderHostBase`](SolutionBuilderHostBase.md).[`reportDiagnostic`](SolutionBuilderHostBase.md#reportdiagnostic) + +*** + +### reportErrorSummary? + +> `optional` **reportErrorSummary**: [`ReportEmitErrorSummary`](../type-aliases/ReportEmitErrorSummary.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5952 + +*** + +### reportSolutionBuilderStatus + +> **reportSolutionBuilderStatus**: [`DiagnosticReporter`](../type-aliases/DiagnosticReporter.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5948 + +#### Inherited from + +[`SolutionBuilderHostBase`](SolutionBuilderHostBase.md).[`reportSolutionBuilderStatus`](SolutionBuilderHostBase.md#reportsolutionbuilderstatus) + +## Methods + +### afterProgramEmitAndDiagnostics()? + +> `optional` **afterProgramEmitAndDiagnostics**(`program`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5949 + +#### Parameters + +##### program + +`T` + +#### Returns + +`void` + +#### Inherited from + +[`SolutionBuilderHostBase`](SolutionBuilderHostBase.md).[`afterProgramEmitAndDiagnostics`](SolutionBuilderHostBase.md#afterprogramemitanddiagnostics) + +*** + +### createDirectory()? + +> `optional` **createDirectory**(`path`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5936 + +#### Parameters + +##### path + +`string` + +#### Returns + +`void` + +#### Inherited from + +[`SolutionBuilderHostBase`](SolutionBuilderHostBase.md).[`createDirectory`](SolutionBuilderHostBase.md#createdirectory) + +*** + +### createHash()? + +> `optional` **createHash**(`data`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5818 + +#### Parameters + +##### data + +`string` + +#### Returns + +`string` + +#### Inherited from + +[`SolutionBuilderHostBase`](SolutionBuilderHostBase.md).[`createHash`](SolutionBuilderHostBase.md#createhash) + +*** + +### deleteFile() + +> **deleteFile**(`fileName`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5945 + +#### Parameters + +##### fileName + +`string` + +#### Returns + +`void` + +#### Inherited from + +[`SolutionBuilderHostBase`](SolutionBuilderHostBase.md).[`deleteFile`](SolutionBuilderHostBase.md#deletefile) + +*** + +### directoryExists()? + +> `optional` **directoryExists**(`path`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5830 + +If provided, used for module resolution as well as to handle directory structure + +#### Parameters + +##### path + +`string` + +#### Returns + +`boolean` + +#### Inherited from + +[`SolutionBuilderHostBase`](SolutionBuilderHostBase.md).[`directoryExists`](SolutionBuilderHostBase.md#directoryexists) + +*** + +### fileExists() + +> **fileExists**(`path`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5823 + +Use to check file presence for source files and +if resolveModuleNames is not provided (complier is in charge of module resolution) then module files as well + +#### Parameters + +##### path + +`string` + +#### Returns + +`boolean` + +#### Inherited from + +[`SolutionBuilderHostBase`](SolutionBuilderHostBase.md).[`fileExists`](SolutionBuilderHostBase.md#fileexists) + +*** + +### getCurrentDirectory() + +> **getCurrentDirectory**(): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5815 + +#### Returns + +`string` + +#### Inherited from + +[`SolutionBuilderHostBase`](SolutionBuilderHostBase.md).[`getCurrentDirectory`](SolutionBuilderHostBase.md#getcurrentdirectory) + +*** + +### getDefaultLibFileName() + +> **getDefaultLibFileName**(`options`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5816 + +#### Parameters + +##### options + +[`CompilerOptions`](CompilerOptions.md) + +#### Returns + +`string` + +#### Inherited from + +[`SolutionBuilderHostBase`](SolutionBuilderHostBase.md).[`getDefaultLibFileName`](SolutionBuilderHostBase.md#getdefaultlibfilename) + +*** + +### getDefaultLibLocation()? + +> `optional` **getDefaultLibLocation**(): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5817 + +#### Returns + +`string` + +#### Inherited from + +[`SolutionBuilderHostBase`](SolutionBuilderHostBase.md).[`getDefaultLibLocation`](SolutionBuilderHostBase.md#getdefaultliblocation) + +*** + +### getDirectories()? + +> `optional` **getDirectories**(`path`): `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5832 + +If provided, used in resolutions as well as handling directory structure + +#### Parameters + +##### path + +`string` + +#### Returns + +`string`[] + +#### Inherited from + +[`SolutionBuilderHostBase`](SolutionBuilderHostBase.md).[`getDirectories`](SolutionBuilderHostBase.md#getdirectories) + +*** + +### getEnvironmentVariable()? + +> `optional` **getEnvironmentVariable**(`name`): `undefined` \| `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5840 + +If provided is used to get the environment variable + +#### Parameters + +##### name + +`string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[`SolutionBuilderHostBase`](SolutionBuilderHostBase.md).[`getEnvironmentVariable`](SolutionBuilderHostBase.md#getenvironmentvariable) + +*** + +### getModifiedTime() + +> **getModifiedTime**(`fileName`): `undefined` \| `Date` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5943 + +#### Parameters + +##### fileName + +`string` + +#### Returns + +`undefined` \| `Date` + +#### Inherited from + +[`SolutionBuilderHostBase`](SolutionBuilderHostBase.md).[`getModifiedTime`](SolutionBuilderHostBase.md#getmodifiedtime) + +*** + +### getModuleResolutionCache()? + +> `optional` **getModuleResolutionCache**(): `undefined` \| [`ModuleResolutionCache`](ModuleResolutionCache.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5850 + +Returns the module resolution cache used by a provided `resolveModuleNames` implementation so that any non-name module resolution operations (eg, package.json lookup) can reuse it + +#### Returns + +`undefined` \| [`ModuleResolutionCache`](ModuleResolutionCache.md) + +#### Inherited from + +[`SolutionBuilderHostBase`](SolutionBuilderHostBase.md).[`getModuleResolutionCache`](SolutionBuilderHostBase.md#getmoduleresolutioncache) + +*** + +### getNewLine() + +> **getNewLine**(): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5814 + +#### Returns + +`string` + +#### Inherited from + +[`SolutionBuilderHostBase`](SolutionBuilderHostBase.md).[`getNewLine`](SolutionBuilderHostBase.md#getnewline) + +*** + +### getParsedCommandLine()? + +> `optional` **getParsedCommandLine**(`fileName`): `undefined` \| [`ParsedCommandLine`](ParsedCommandLine.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5946 + +#### Parameters + +##### fileName + +`string` + +#### Returns + +`undefined` \| [`ParsedCommandLine`](ParsedCommandLine.md) + +#### Inherited from + +[`SolutionBuilderHostBase`](SolutionBuilderHostBase.md).[`getParsedCommandLine`](SolutionBuilderHostBase.md#getparsedcommandline) + +*** + +### hasInvalidatedResolutions()? + +> `optional` **hasInvalidatedResolutions**(`filePath`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5846 + +If provided along with custom resolveModuleNames or resolveTypeReferenceDirectives, used to determine if unchanged file path needs to re-resolve modules/type reference directives + +#### Parameters + +##### filePath + +[`Path`](../type-aliases/Path.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`SolutionBuilderHostBase`](SolutionBuilderHostBase.md).[`hasInvalidatedResolutions`](SolutionBuilderHostBase.md#hasinvalidatedresolutions) + +*** + +### readDirectory()? + +> `optional` **readDirectory**(`path`, `extensions`?, `exclude`?, `include`?, `depth`?): `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5834 + +If provided, used to cache and handle directory structure modifications + +#### Parameters + +##### path + +`string` + +##### extensions? + +readonly `string`[] + +##### exclude? + +readonly `string`[] + +##### include? + +readonly `string`[] + +##### depth? + +`number` + +#### Returns + +`string`[] + +#### Inherited from + +[`SolutionBuilderHostBase`](SolutionBuilderHostBase.md).[`readDirectory`](SolutionBuilderHostBase.md#readdirectory) + +*** + +### readFile() + +> **readFile**(`path`, `encoding`?): `undefined` \| `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5828 + +Use to read file text for source files and +if resolveModuleNames is not provided (complier is in charge of module resolution) then module files as well + +#### Parameters + +##### path + +`string` + +##### encoding? + +`string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[`SolutionBuilderHostBase`](SolutionBuilderHostBase.md).[`readFile`](SolutionBuilderHostBase.md#readfile) + +*** + +### realpath()? + +> `optional` **realpath**(`path`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5836 + +Symbol links resolution + +#### Parameters + +##### path + +`string` + +#### Returns + +`string` + +#### Inherited from + +[`SolutionBuilderHostBase`](SolutionBuilderHostBase.md).[`realpath`](SolutionBuilderHostBase.md#realpath) + +*** + +### resolveModuleNames()? + +> `optional` **resolveModuleNames**(`moduleNames`, `containingFile`, `reusedNames`, `redirectedReference`, `options`, `containingSourceFile`?): (`undefined` \| [`ResolvedModule`](ResolvedModule.md))[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5842 + +If provided, used to resolve the module names, otherwise typescript's default module resolution + +#### Parameters + +##### moduleNames + +`string`[] + +##### containingFile + +`string` + +##### reusedNames + +`undefined` | `string`[] + +##### redirectedReference + +`undefined` | [`ResolvedProjectReference`](ResolvedProjectReference.md) + +##### options + +[`CompilerOptions`](CompilerOptions.md) + +##### containingSourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +(`undefined` \| [`ResolvedModule`](ResolvedModule.md))[] + +#### Inherited from + +[`SolutionBuilderHostBase`](SolutionBuilderHostBase.md).[`resolveModuleNames`](SolutionBuilderHostBase.md#resolvemodulenames) + +*** + +### resolveTypeReferenceDirectives()? + +> `optional` **resolveTypeReferenceDirectives**(`typeReferenceDirectiveNames`, `containingFile`, `redirectedReference`, `options`, `containingFileMode`?): (`undefined` \| [`ResolvedTypeReferenceDirective`](ResolvedTypeReferenceDirective.md))[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5844 + +If provided, used to resolve type reference directives, otherwise typescript's default resolution + +#### Parameters + +##### typeReferenceDirectiveNames + +`string`[] | readonly [`FileReference`](FileReference.md)[] + +##### containingFile + +`string` + +##### redirectedReference + +`undefined` | [`ResolvedProjectReference`](ResolvedProjectReference.md) + +##### options + +[`CompilerOptions`](CompilerOptions.md) + +##### containingFileMode? + +[`CommonJS`](../enumerations/ModuleKind.md#commonjs) | [`ESNext`](../enumerations/ModuleKind.md#esnext) + +#### Returns + +(`undefined` \| [`ResolvedTypeReferenceDirective`](ResolvedTypeReferenceDirective.md))[] + +#### Inherited from + +[`SolutionBuilderHostBase`](SolutionBuilderHostBase.md).[`resolveTypeReferenceDirectives`](SolutionBuilderHostBase.md#resolvetypereferencedirectives) + +*** + +### setModifiedTime() + +> **setModifiedTime**(`fileName`, `date`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5944 + +#### Parameters + +##### fileName + +`string` + +##### date + +`Date` + +#### Returns + +`void` + +#### Inherited from + +[`SolutionBuilderHostBase`](SolutionBuilderHostBase.md).[`setModifiedTime`](SolutionBuilderHostBase.md#setmodifiedtime) + +*** + +### trace()? + +> `optional` **trace**(`s`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5838 + +If provided would be used to write log about compilation + +#### Parameters + +##### s + +`string` + +#### Returns + +`void` + +#### Inherited from + +[`SolutionBuilderHostBase`](SolutionBuilderHostBase.md).[`trace`](SolutionBuilderHostBase.md#trace) + +*** + +### useCaseSensitiveFileNames() + +> **useCaseSensitiveFileNames**(): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5813 + +#### Returns + +`boolean` + +#### Inherited from + +[`SolutionBuilderHostBase`](SolutionBuilderHostBase.md).[`useCaseSensitiveFileNames`](SolutionBuilderHostBase.md#usecasesensitivefilenames) + +*** + +### writeFile()? + +> `optional` **writeFile**(`path`, `data`, `writeByteOrderMark`?): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5941 + +Should provide create directory and writeFile if done of invalidatedProjects is not invoked with +writeFileCallback + +#### Parameters + +##### path + +`string` + +##### data + +`string` + +##### writeByteOrderMark? + +`boolean` + +#### Returns + +`void` + +#### Inherited from + +[`SolutionBuilderHostBase`](SolutionBuilderHostBase.md).[`writeFile`](SolutionBuilderHostBase.md#writefile) diff --git a/docs/api_docs/namespaces/ts/interfaces/SolutionBuilderHostBase.md b/docs/api_docs/namespaces/ts/interfaces/SolutionBuilderHostBase.md new file mode 100644 index 0000000000000000000000000000000000000000..3ecedc1445562f3ce4e5a853175e01b0b0641e2e --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/SolutionBuilderHostBase.md @@ -0,0 +1,659 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / SolutionBuilderHostBase + +# Interface: SolutionBuilderHostBase\ + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5935 + +## Extends + +- [`ProgramHost`](ProgramHost.md)\<`T`\> + +## Extended by + +- [`SolutionBuilderHost`](SolutionBuilderHost.md) +- [`SolutionBuilderWithWatchHost`](SolutionBuilderWithWatchHost.md) + +## Type Parameters + +• **T** *extends* [`BuilderProgram`](BuilderProgram.md) + +## Properties + +### createProgram + +> **createProgram**: [`CreateProgram`](../type-aliases/CreateProgram.md)\<`T`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5812 + +Used to create the program when need for program creation or recreation detected + +#### Inherited from + +[`ProgramHost`](ProgramHost.md).[`createProgram`](ProgramHost.md#createprogram) + +*** + +### getCustomTransformers()? + +> `optional` **getCustomTransformers**: (`project`) => `undefined` \| [`CustomTransformers`](CustomTransformers.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5942 + +#### Parameters + +##### project + +`string` + +#### Returns + +`undefined` \| [`CustomTransformers`](CustomTransformers.md) + +*** + +### reportDiagnostic + +> **reportDiagnostic**: [`DiagnosticReporter`](../type-aliases/DiagnosticReporter.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5947 + +*** + +### reportSolutionBuilderStatus + +> **reportSolutionBuilderStatus**: [`DiagnosticReporter`](../type-aliases/DiagnosticReporter.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5948 + +## Methods + +### afterProgramEmitAndDiagnostics()? + +> `optional` **afterProgramEmitAndDiagnostics**(`program`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5949 + +#### Parameters + +##### program + +`T` + +#### Returns + +`void` + +*** + +### createDirectory()? + +> `optional` **createDirectory**(`path`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5936 + +#### Parameters + +##### path + +`string` + +#### Returns + +`void` + +*** + +### createHash()? + +> `optional` **createHash**(`data`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5818 + +#### Parameters + +##### data + +`string` + +#### Returns + +`string` + +#### Inherited from + +[`ProgramHost`](ProgramHost.md).[`createHash`](ProgramHost.md#createhash) + +*** + +### deleteFile() + +> **deleteFile**(`fileName`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5945 + +#### Parameters + +##### fileName + +`string` + +#### Returns + +`void` + +*** + +### directoryExists()? + +> `optional` **directoryExists**(`path`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5830 + +If provided, used for module resolution as well as to handle directory structure + +#### Parameters + +##### path + +`string` + +#### Returns + +`boolean` + +#### Inherited from + +[`ProgramHost`](ProgramHost.md).[`directoryExists`](ProgramHost.md#directoryexists) + +*** + +### fileExists() + +> **fileExists**(`path`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5823 + +Use to check file presence for source files and +if resolveModuleNames is not provided (complier is in charge of module resolution) then module files as well + +#### Parameters + +##### path + +`string` + +#### Returns + +`boolean` + +#### Inherited from + +[`ProgramHost`](ProgramHost.md).[`fileExists`](ProgramHost.md#fileexists) + +*** + +### getCurrentDirectory() + +> **getCurrentDirectory**(): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5815 + +#### Returns + +`string` + +#### Inherited from + +[`ProgramHost`](ProgramHost.md).[`getCurrentDirectory`](ProgramHost.md#getcurrentdirectory) + +*** + +### getDefaultLibFileName() + +> **getDefaultLibFileName**(`options`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5816 + +#### Parameters + +##### options + +[`CompilerOptions`](CompilerOptions.md) + +#### Returns + +`string` + +#### Inherited from + +[`ProgramHost`](ProgramHost.md).[`getDefaultLibFileName`](ProgramHost.md#getdefaultlibfilename) + +*** + +### getDefaultLibLocation()? + +> `optional` **getDefaultLibLocation**(): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5817 + +#### Returns + +`string` + +#### Inherited from + +[`ProgramHost`](ProgramHost.md).[`getDefaultLibLocation`](ProgramHost.md#getdefaultliblocation) + +*** + +### getDirectories()? + +> `optional` **getDirectories**(`path`): `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5832 + +If provided, used in resolutions as well as handling directory structure + +#### Parameters + +##### path + +`string` + +#### Returns + +`string`[] + +#### Inherited from + +[`ProgramHost`](ProgramHost.md).[`getDirectories`](ProgramHost.md#getdirectories) + +*** + +### getEnvironmentVariable()? + +> `optional` **getEnvironmentVariable**(`name`): `undefined` \| `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5840 + +If provided is used to get the environment variable + +#### Parameters + +##### name + +`string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[`ProgramHost`](ProgramHost.md).[`getEnvironmentVariable`](ProgramHost.md#getenvironmentvariable) + +*** + +### getModifiedTime() + +> **getModifiedTime**(`fileName`): `undefined` \| `Date` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5943 + +#### Parameters + +##### fileName + +`string` + +#### Returns + +`undefined` \| `Date` + +*** + +### getModuleResolutionCache()? + +> `optional` **getModuleResolutionCache**(): `undefined` \| [`ModuleResolutionCache`](ModuleResolutionCache.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5850 + +Returns the module resolution cache used by a provided `resolveModuleNames` implementation so that any non-name module resolution operations (eg, package.json lookup) can reuse it + +#### Returns + +`undefined` \| [`ModuleResolutionCache`](ModuleResolutionCache.md) + +#### Inherited from + +[`ProgramHost`](ProgramHost.md).[`getModuleResolutionCache`](ProgramHost.md#getmoduleresolutioncache) + +*** + +### getNewLine() + +> **getNewLine**(): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5814 + +#### Returns + +`string` + +#### Inherited from + +[`ProgramHost`](ProgramHost.md).[`getNewLine`](ProgramHost.md#getnewline) + +*** + +### getParsedCommandLine()? + +> `optional` **getParsedCommandLine**(`fileName`): `undefined` \| [`ParsedCommandLine`](ParsedCommandLine.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5946 + +#### Parameters + +##### fileName + +`string` + +#### Returns + +`undefined` \| [`ParsedCommandLine`](ParsedCommandLine.md) + +*** + +### hasInvalidatedResolutions()? + +> `optional` **hasInvalidatedResolutions**(`filePath`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5846 + +If provided along with custom resolveModuleNames or resolveTypeReferenceDirectives, used to determine if unchanged file path needs to re-resolve modules/type reference directives + +#### Parameters + +##### filePath + +[`Path`](../type-aliases/Path.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`ProgramHost`](ProgramHost.md).[`hasInvalidatedResolutions`](ProgramHost.md#hasinvalidatedresolutions) + +*** + +### readDirectory()? + +> `optional` **readDirectory**(`path`, `extensions`?, `exclude`?, `include`?, `depth`?): `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5834 + +If provided, used to cache and handle directory structure modifications + +#### Parameters + +##### path + +`string` + +##### extensions? + +readonly `string`[] + +##### exclude? + +readonly `string`[] + +##### include? + +readonly `string`[] + +##### depth? + +`number` + +#### Returns + +`string`[] + +#### Inherited from + +[`ProgramHost`](ProgramHost.md).[`readDirectory`](ProgramHost.md#readdirectory) + +*** + +### readFile() + +> **readFile**(`path`, `encoding`?): `undefined` \| `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5828 + +Use to read file text for source files and +if resolveModuleNames is not provided (complier is in charge of module resolution) then module files as well + +#### Parameters + +##### path + +`string` + +##### encoding? + +`string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[`ProgramHost`](ProgramHost.md).[`readFile`](ProgramHost.md#readfile) + +*** + +### realpath()? + +> `optional` **realpath**(`path`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5836 + +Symbol links resolution + +#### Parameters + +##### path + +`string` + +#### Returns + +`string` + +#### Inherited from + +[`ProgramHost`](ProgramHost.md).[`realpath`](ProgramHost.md#realpath) + +*** + +### resolveModuleNames()? + +> `optional` **resolveModuleNames**(`moduleNames`, `containingFile`, `reusedNames`, `redirectedReference`, `options`, `containingSourceFile`?): (`undefined` \| [`ResolvedModule`](ResolvedModule.md))[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5842 + +If provided, used to resolve the module names, otherwise typescript's default module resolution + +#### Parameters + +##### moduleNames + +`string`[] + +##### containingFile + +`string` + +##### reusedNames + +`undefined` | `string`[] + +##### redirectedReference + +`undefined` | [`ResolvedProjectReference`](ResolvedProjectReference.md) + +##### options + +[`CompilerOptions`](CompilerOptions.md) + +##### containingSourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +(`undefined` \| [`ResolvedModule`](ResolvedModule.md))[] + +#### Inherited from + +[`ProgramHost`](ProgramHost.md).[`resolveModuleNames`](ProgramHost.md#resolvemodulenames) + +*** + +### resolveTypeReferenceDirectives()? + +> `optional` **resolveTypeReferenceDirectives**(`typeReferenceDirectiveNames`, `containingFile`, `redirectedReference`, `options`, `containingFileMode`?): (`undefined` \| [`ResolvedTypeReferenceDirective`](ResolvedTypeReferenceDirective.md))[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5844 + +If provided, used to resolve type reference directives, otherwise typescript's default resolution + +#### Parameters + +##### typeReferenceDirectiveNames + +`string`[] | readonly [`FileReference`](FileReference.md)[] + +##### containingFile + +`string` + +##### redirectedReference + +`undefined` | [`ResolvedProjectReference`](ResolvedProjectReference.md) + +##### options + +[`CompilerOptions`](CompilerOptions.md) + +##### containingFileMode? + +[`CommonJS`](../enumerations/ModuleKind.md#commonjs) | [`ESNext`](../enumerations/ModuleKind.md#esnext) + +#### Returns + +(`undefined` \| [`ResolvedTypeReferenceDirective`](ResolvedTypeReferenceDirective.md))[] + +#### Inherited from + +[`ProgramHost`](ProgramHost.md).[`resolveTypeReferenceDirectives`](ProgramHost.md#resolvetypereferencedirectives) + +*** + +### setModifiedTime() + +> **setModifiedTime**(`fileName`, `date`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5944 + +#### Parameters + +##### fileName + +`string` + +##### date + +`Date` + +#### Returns + +`void` + +*** + +### trace()? + +> `optional` **trace**(`s`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5838 + +If provided would be used to write log about compilation + +#### Parameters + +##### s + +`string` + +#### Returns + +`void` + +#### Inherited from + +[`ProgramHost`](ProgramHost.md).[`trace`](ProgramHost.md#trace) + +*** + +### useCaseSensitiveFileNames() + +> **useCaseSensitiveFileNames**(): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5813 + +#### Returns + +`boolean` + +#### Inherited from + +[`ProgramHost`](ProgramHost.md).[`useCaseSensitiveFileNames`](ProgramHost.md#usecasesensitivefilenames) + +*** + +### writeFile()? + +> `optional` **writeFile**(`path`, `data`, `writeByteOrderMark`?): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5941 + +Should provide create directory and writeFile if done of invalidatedProjects is not invoked with +writeFileCallback + +#### Parameters + +##### path + +`string` + +##### data + +`string` + +##### writeByteOrderMark? + +`boolean` + +#### Returns + +`void` diff --git a/docs/api_docs/namespaces/ts/interfaces/SolutionBuilderWithWatchHost.md b/docs/api_docs/namespaces/ts/interfaces/SolutionBuilderWithWatchHost.md new file mode 100644 index 0000000000000000000000000000000000000000..9c9a91484703f152b003ddac9317e0c47c11984a --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/SolutionBuilderWithWatchHost.md @@ -0,0 +1,860 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / SolutionBuilderWithWatchHost + +# Interface: SolutionBuilderWithWatchHost\ + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5954 + +Host that has watch functionality used in --watch mode + +## Extends + +- [`SolutionBuilderHostBase`](SolutionBuilderHostBase.md)\<`T`\>.[`WatchHost`](WatchHost.md) + +## Type Parameters + +• **T** *extends* [`BuilderProgram`](BuilderProgram.md) + +## Properties + +### createProgram + +> **createProgram**: [`CreateProgram`](../type-aliases/CreateProgram.md)\<`T`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5812 + +Used to create the program when need for program creation or recreation detected + +#### Inherited from + +[`SolutionBuilderHostBase`](SolutionBuilderHostBase.md).[`createProgram`](SolutionBuilderHostBase.md#createprogram) + +*** + +### getCustomTransformers()? + +> `optional` **getCustomTransformers**: (`project`) => `undefined` \| [`CustomTransformers`](CustomTransformers.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5942 + +#### Parameters + +##### project + +`string` + +#### Returns + +`undefined` \| [`CustomTransformers`](CustomTransformers.md) + +#### Inherited from + +[`SolutionBuilderHostBase`](SolutionBuilderHostBase.md).[`getCustomTransformers`](SolutionBuilderHostBase.md#getcustomtransformers) + +*** + +### reportDiagnostic + +> **reportDiagnostic**: [`DiagnosticReporter`](../type-aliases/DiagnosticReporter.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5947 + +#### Inherited from + +[`SolutionBuilderHostBase`](SolutionBuilderHostBase.md).[`reportDiagnostic`](SolutionBuilderHostBase.md#reportdiagnostic) + +*** + +### reportSolutionBuilderStatus + +> **reportSolutionBuilderStatus**: [`DiagnosticReporter`](../type-aliases/DiagnosticReporter.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5948 + +#### Inherited from + +[`SolutionBuilderHostBase`](SolutionBuilderHostBase.md).[`reportSolutionBuilderStatus`](SolutionBuilderHostBase.md#reportsolutionbuilderstatus) + +## Methods + +### afterProgramEmitAndDiagnostics()? + +> `optional` **afterProgramEmitAndDiagnostics**(`program`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5949 + +#### Parameters + +##### program + +`T` + +#### Returns + +`void` + +#### Inherited from + +[`SolutionBuilderHostBase`](SolutionBuilderHostBase.md).[`afterProgramEmitAndDiagnostics`](SolutionBuilderHostBase.md#afterprogramemitanddiagnostics) + +*** + +### clearTimeout()? + +> `optional` **clearTimeout**(`timeoutId`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5806 + +If provided, will be used to reset existing delayed compilation + +#### Parameters + +##### timeoutId + +`any` + +#### Returns + +`void` + +#### Inherited from + +[`WatchHost`](WatchHost.md).[`clearTimeout`](WatchHost.md#cleartimeout) + +*** + +### createDirectory()? + +> `optional` **createDirectory**(`path`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5936 + +#### Parameters + +##### path + +`string` + +#### Returns + +`void` + +#### Inherited from + +[`SolutionBuilderHostBase`](SolutionBuilderHostBase.md).[`createDirectory`](SolutionBuilderHostBase.md#createdirectory) + +*** + +### createHash()? + +> `optional` **createHash**(`data`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5818 + +#### Parameters + +##### data + +`string` + +#### Returns + +`string` + +#### Inherited from + +[`SolutionBuilderHostBase`](SolutionBuilderHostBase.md).[`createHash`](SolutionBuilderHostBase.md#createhash) + +*** + +### deleteFile() + +> **deleteFile**(`fileName`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5945 + +#### Parameters + +##### fileName + +`string` + +#### Returns + +`void` + +#### Inherited from + +[`SolutionBuilderHostBase`](SolutionBuilderHostBase.md).[`deleteFile`](SolutionBuilderHostBase.md#deletefile) + +*** + +### directoryExists()? + +> `optional` **directoryExists**(`path`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5830 + +If provided, used for module resolution as well as to handle directory structure + +#### Parameters + +##### path + +`string` + +#### Returns + +`boolean` + +#### Inherited from + +[`SolutionBuilderHostBase`](SolutionBuilderHostBase.md).[`directoryExists`](SolutionBuilderHostBase.md#directoryexists) + +*** + +### fileExists() + +> **fileExists**(`path`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5823 + +Use to check file presence for source files and +if resolveModuleNames is not provided (complier is in charge of module resolution) then module files as well + +#### Parameters + +##### path + +`string` + +#### Returns + +`boolean` + +#### Inherited from + +[`SolutionBuilderHostBase`](SolutionBuilderHostBase.md).[`fileExists`](SolutionBuilderHostBase.md#fileexists) + +*** + +### getCurrentDirectory() + +> **getCurrentDirectory**(): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5815 + +#### Returns + +`string` + +#### Inherited from + +[`SolutionBuilderHostBase`](SolutionBuilderHostBase.md).[`getCurrentDirectory`](SolutionBuilderHostBase.md#getcurrentdirectory) + +*** + +### getDefaultLibFileName() + +> **getDefaultLibFileName**(`options`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5816 + +#### Parameters + +##### options + +[`CompilerOptions`](CompilerOptions.md) + +#### Returns + +`string` + +#### Inherited from + +[`SolutionBuilderHostBase`](SolutionBuilderHostBase.md).[`getDefaultLibFileName`](SolutionBuilderHostBase.md#getdefaultlibfilename) + +*** + +### getDefaultLibLocation()? + +> `optional` **getDefaultLibLocation**(): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5817 + +#### Returns + +`string` + +#### Inherited from + +[`SolutionBuilderHostBase`](SolutionBuilderHostBase.md).[`getDefaultLibLocation`](SolutionBuilderHostBase.md#getdefaultliblocation) + +*** + +### getDirectories()? + +> `optional` **getDirectories**(`path`): `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5832 + +If provided, used in resolutions as well as handling directory structure + +#### Parameters + +##### path + +`string` + +#### Returns + +`string`[] + +#### Inherited from + +[`SolutionBuilderHostBase`](SolutionBuilderHostBase.md).[`getDirectories`](SolutionBuilderHostBase.md#getdirectories) + +*** + +### getEnvironmentVariable()? + +> `optional` **getEnvironmentVariable**(`name`): `undefined` \| `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5840 + +If provided is used to get the environment variable + +#### Parameters + +##### name + +`string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[`SolutionBuilderHostBase`](SolutionBuilderHostBase.md).[`getEnvironmentVariable`](SolutionBuilderHostBase.md#getenvironmentvariable) + +*** + +### getModifiedTime() + +> **getModifiedTime**(`fileName`): `undefined` \| `Date` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5943 + +#### Parameters + +##### fileName + +`string` + +#### Returns + +`undefined` \| `Date` + +#### Inherited from + +[`SolutionBuilderHostBase`](SolutionBuilderHostBase.md).[`getModifiedTime`](SolutionBuilderHostBase.md#getmodifiedtime) + +*** + +### getModuleResolutionCache()? + +> `optional` **getModuleResolutionCache**(): `undefined` \| [`ModuleResolutionCache`](ModuleResolutionCache.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5850 + +Returns the module resolution cache used by a provided `resolveModuleNames` implementation so that any non-name module resolution operations (eg, package.json lookup) can reuse it + +#### Returns + +`undefined` \| [`ModuleResolutionCache`](ModuleResolutionCache.md) + +#### Inherited from + +[`SolutionBuilderHostBase`](SolutionBuilderHostBase.md).[`getModuleResolutionCache`](SolutionBuilderHostBase.md#getmoduleresolutioncache) + +*** + +### getNewLine() + +> **getNewLine**(): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5814 + +#### Returns + +`string` + +#### Inherited from + +[`SolutionBuilderHostBase`](SolutionBuilderHostBase.md).[`getNewLine`](SolutionBuilderHostBase.md#getnewline) + +*** + +### getParsedCommandLine()? + +> `optional` **getParsedCommandLine**(`fileName`): `undefined` \| [`ParsedCommandLine`](ParsedCommandLine.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5946 + +#### Parameters + +##### fileName + +`string` + +#### Returns + +`undefined` \| [`ParsedCommandLine`](ParsedCommandLine.md) + +#### Inherited from + +[`SolutionBuilderHostBase`](SolutionBuilderHostBase.md).[`getParsedCommandLine`](SolutionBuilderHostBase.md#getparsedcommandline) + +*** + +### hasInvalidatedResolutions()? + +> `optional` **hasInvalidatedResolutions**(`filePath`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5846 + +If provided along with custom resolveModuleNames or resolveTypeReferenceDirectives, used to determine if unchanged file path needs to re-resolve modules/type reference directives + +#### Parameters + +##### filePath + +[`Path`](../type-aliases/Path.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`SolutionBuilderHostBase`](SolutionBuilderHostBase.md).[`hasInvalidatedResolutions`](SolutionBuilderHostBase.md#hasinvalidatedresolutions) + +*** + +### onWatchStatusChange()? + +> `optional` **onWatchStatusChange**(`diagnostic`, `newLine`, `options`, `errorCount`?): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5798 + +If provided, called with Diagnostic message that informs about change in watch status + +#### Parameters + +##### diagnostic + +[`Diagnostic`](Diagnostic.md) + +##### newLine + +`string` + +##### options + +[`CompilerOptions`](CompilerOptions.md) + +##### errorCount? + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`WatchHost`](WatchHost.md).[`onWatchStatusChange`](WatchHost.md#onwatchstatuschange) + +*** + +### readDirectory()? + +> `optional` **readDirectory**(`path`, `extensions`?, `exclude`?, `include`?, `depth`?): `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5834 + +If provided, used to cache and handle directory structure modifications + +#### Parameters + +##### path + +`string` + +##### extensions? + +readonly `string`[] + +##### exclude? + +readonly `string`[] + +##### include? + +readonly `string`[] + +##### depth? + +`number` + +#### Returns + +`string`[] + +#### Inherited from + +[`SolutionBuilderHostBase`](SolutionBuilderHostBase.md).[`readDirectory`](SolutionBuilderHostBase.md#readdirectory) + +*** + +### readFile() + +> **readFile**(`path`, `encoding`?): `undefined` \| `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5828 + +Use to read file text for source files and +if resolveModuleNames is not provided (complier is in charge of module resolution) then module files as well + +#### Parameters + +##### path + +`string` + +##### encoding? + +`string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[`SolutionBuilderHostBase`](SolutionBuilderHostBase.md).[`readFile`](SolutionBuilderHostBase.md#readfile) + +*** + +### realpath()? + +> `optional` **realpath**(`path`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5836 + +Symbol links resolution + +#### Parameters + +##### path + +`string` + +#### Returns + +`string` + +#### Inherited from + +[`SolutionBuilderHostBase`](SolutionBuilderHostBase.md).[`realpath`](SolutionBuilderHostBase.md#realpath) + +*** + +### resolveModuleNames()? + +> `optional` **resolveModuleNames**(`moduleNames`, `containingFile`, `reusedNames`, `redirectedReference`, `options`, `containingSourceFile`?): (`undefined` \| [`ResolvedModule`](ResolvedModule.md))[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5842 + +If provided, used to resolve the module names, otherwise typescript's default module resolution + +#### Parameters + +##### moduleNames + +`string`[] + +##### containingFile + +`string` + +##### reusedNames + +`undefined` | `string`[] + +##### redirectedReference + +`undefined` | [`ResolvedProjectReference`](ResolvedProjectReference.md) + +##### options + +[`CompilerOptions`](CompilerOptions.md) + +##### containingSourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +(`undefined` \| [`ResolvedModule`](ResolvedModule.md))[] + +#### Inherited from + +[`SolutionBuilderHostBase`](SolutionBuilderHostBase.md).[`resolveModuleNames`](SolutionBuilderHostBase.md#resolvemodulenames) + +*** + +### resolveTypeReferenceDirectives()? + +> `optional` **resolveTypeReferenceDirectives**(`typeReferenceDirectiveNames`, `containingFile`, `redirectedReference`, `options`, `containingFileMode`?): (`undefined` \| [`ResolvedTypeReferenceDirective`](ResolvedTypeReferenceDirective.md))[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5844 + +If provided, used to resolve type reference directives, otherwise typescript's default resolution + +#### Parameters + +##### typeReferenceDirectiveNames + +`string`[] | readonly [`FileReference`](FileReference.md)[] + +##### containingFile + +`string` + +##### redirectedReference + +`undefined` | [`ResolvedProjectReference`](ResolvedProjectReference.md) + +##### options + +[`CompilerOptions`](CompilerOptions.md) + +##### containingFileMode? + +[`CommonJS`](../enumerations/ModuleKind.md#commonjs) | [`ESNext`](../enumerations/ModuleKind.md#esnext) + +#### Returns + +(`undefined` \| [`ResolvedTypeReferenceDirective`](ResolvedTypeReferenceDirective.md))[] + +#### Inherited from + +[`SolutionBuilderHostBase`](SolutionBuilderHostBase.md).[`resolveTypeReferenceDirectives`](SolutionBuilderHostBase.md#resolvetypereferencedirectives) + +*** + +### setModifiedTime() + +> **setModifiedTime**(`fileName`, `date`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5944 + +#### Parameters + +##### fileName + +`string` + +##### date + +`Date` + +#### Returns + +`void` + +#### Inherited from + +[`SolutionBuilderHostBase`](SolutionBuilderHostBase.md).[`setModifiedTime`](SolutionBuilderHostBase.md#setmodifiedtime) + +*** + +### setTimeout()? + +> `optional` **setTimeout**(`callback`, `ms`, ...`args`): `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5804 + +If provided, will be used to set delayed compilation, so that multiple changes in short span are compiled together + +#### Parameters + +##### callback + +(...`args`) => `void` + +##### ms + +`number` + +##### args + +...`any`[] + +#### Returns + +`any` + +#### Inherited from + +[`WatchHost`](WatchHost.md).[`setTimeout`](WatchHost.md#settimeout) + +*** + +### trace()? + +> `optional` **trace**(`s`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5838 + +If provided would be used to write log about compilation + +#### Parameters + +##### s + +`string` + +#### Returns + +`void` + +#### Inherited from + +[`SolutionBuilderHostBase`](SolutionBuilderHostBase.md).[`trace`](SolutionBuilderHostBase.md#trace) + +*** + +### useCaseSensitiveFileNames() + +> **useCaseSensitiveFileNames**(): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5813 + +#### Returns + +`boolean` + +#### Inherited from + +[`SolutionBuilderHostBase`](SolutionBuilderHostBase.md).[`useCaseSensitiveFileNames`](SolutionBuilderHostBase.md#usecasesensitivefilenames) + +*** + +### watchDirectory() + +> **watchDirectory**(`path`, `callback`, `recursive`?, `options`?): [`FileWatcher`](FileWatcher.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5802 + +Used to watch resolved module's failed lookup locations, config file specs, type roots where auto type reference directives are added + +#### Parameters + +##### path + +`string` + +##### callback + +[`DirectoryWatcherCallback`](../type-aliases/DirectoryWatcherCallback.md) + +##### recursive? + +`boolean` + +##### options? + +[`WatchOptions`](WatchOptions.md) + +#### Returns + +[`FileWatcher`](FileWatcher.md) + +#### Inherited from + +[`WatchHost`](WatchHost.md).[`watchDirectory`](WatchHost.md#watchdirectory) + +*** + +### watchFile() + +> **watchFile**(`path`, `callback`, `pollingInterval`?, `options`?): [`FileWatcher`](FileWatcher.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5800 + +Used to watch changes in source files, missing files needed to update the program or config file + +#### Parameters + +##### path + +`string` + +##### callback + +[`FileWatcherCallback`](../type-aliases/FileWatcherCallback.md) + +##### pollingInterval? + +`number` + +##### options? + +[`WatchOptions`](WatchOptions.md) + +#### Returns + +[`FileWatcher`](FileWatcher.md) + +#### Inherited from + +[`WatchHost`](WatchHost.md).[`watchFile`](WatchHost.md#watchfile) + +*** + +### writeFile()? + +> `optional` **writeFile**(`path`, `data`, `writeByteOrderMark`?): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5941 + +Should provide create directory and writeFile if done of invalidatedProjects is not invoked with +writeFileCallback + +#### Parameters + +##### path + +`string` + +##### data + +`string` + +##### writeByteOrderMark? + +`boolean` + +#### Returns + +`void` + +#### Inherited from + +[`SolutionBuilderHostBase`](SolutionBuilderHostBase.md).[`writeFile`](SolutionBuilderHostBase.md#writefile) diff --git a/docs/api_docs/namespaces/ts/interfaces/SortedArray.md b/docs/api_docs/namespaces/ts/interfaces/SortedArray.md new file mode 100644 index 0000000000000000000000000000000000000000..8501be7c6b9f5c9f0ad8e8e174a525a1b991269c --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/SortedArray.md @@ -0,0 +1,1443 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / SortedArray + +# Interface: SortedArray\ + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:31 + +## Extends + +- `Array`\<`T`\> + +## Type Parameters + +• **T** + +## Indexable + +\[`n`: `number`\]: `T` + +## Properties + +### \_\_sortedArrayBrand + +> ** \_\_sortedArrayBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:32 + +*** + +### \[unscopables\] + +> `readonly` **\[unscopables\]**: `object` + +Defined in: node\_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:97 + +Is an object whose properties have the value 'true' +when they will be absent when used in a 'with' statement. + +#### Index Signature + +\[`key`: `number`\]: `undefined` \| `boolean` + +#### \[iterator\]? + +> `optional` **\[iterator\]**: `boolean` + +#### \[unscopables\]? + +> `readonly` `optional` **\[unscopables\]**: `boolean` + +Is an object whose properties have the value 'true' +when they will be absent when used in a 'with' statement. + +#### at? + +> `optional` **at**: `boolean` + +#### concat? + +> `optional` **concat**: `boolean` + +#### copyWithin? + +> `optional` **copyWithin**: `boolean` + +#### entries? + +> `optional` **entries**: `boolean` + +#### every? + +> `optional` **every**: `boolean` + +#### fill? + +> `optional` **fill**: `boolean` + +#### filter? + +> `optional` **filter**: `boolean` + +#### find? + +> `optional` **find**: `boolean` + +#### findIndex? + +> `optional` **findIndex**: `boolean` + +#### flat? + +> `optional` **flat**: `boolean` + +#### flatMap? + +> `optional` **flatMap**: `boolean` + +#### forEach? + +> `optional` **forEach**: `boolean` + +#### includes? + +> `optional` **includes**: `boolean` + +#### indexOf? + +> `optional` **indexOf**: `boolean` + +#### join? + +> `optional` **join**: `boolean` + +#### keys? + +> `optional` **keys**: `boolean` + +#### lastIndexOf? + +> `optional` **lastIndexOf**: `boolean` + +#### length? + +> `optional` **length**: `boolean` + +Gets or sets the length of the array. This is a number one higher than the highest index in the array. + +#### map? + +> `optional` **map**: `boolean` + +#### pop? + +> `optional` **pop**: `boolean` + +#### push? + +> `optional` **push**: `boolean` + +#### reduce? + +> `optional` **reduce**: `boolean` + +#### reduceRight? + +> `optional` **reduceRight**: `boolean` + +#### reverse? + +> `optional` **reverse**: `boolean` + +#### shift? + +> `optional` **shift**: `boolean` + +#### slice? + +> `optional` **slice**: `boolean` + +#### some? + +> `optional` **some**: `boolean` + +#### sort? + +> `optional` **sort**: `boolean` + +#### splice? + +> `optional` **splice**: `boolean` + +#### toLocaleString? + +> `optional` **toLocaleString**: `boolean` + +#### toString? + +> `optional` **toString**: `boolean` + +#### unshift? + +> `optional` **unshift**: `boolean` + +#### values? + +> `optional` **values**: `boolean` + +#### Inherited from + +`Array.[unscopables]` + +*** + +### length + +> **length**: `number` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1326 + +Gets or sets the length of the array. This is a number one higher than the highest index in the array. + +#### Inherited from + +`Array.length` + +## Methods + +### \[iterator\]() + +> **\[iterator\]**(): `IterableIterator`\<`T`\> + +Defined in: node\_modules/typescript/lib/lib.es2015.iterable.d.ts:58 + +Iterator + +#### Returns + +`IterableIterator`\<`T`\> + +#### Inherited from + +`Array.[iterator]` + +*** + +### at() + +> **at**(`index`): `undefined` \| `T` + +Defined in: node\_modules/@types/node/compatibility/indexable.d.ts:7 + +#### Parameters + +##### index + +`number` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +`Array.at` + +*** + +### concat() + +#### Call Signature + +> **concat**(...`items`): `T`[] + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1350 + +Combines two or more arrays. +This method returns a new array without modifying any existing arrays. + +##### Parameters + +###### items + +...`ConcatArray`\<`T`\>[] + +Additional arrays and/or items to add to the end of the array. + +##### Returns + +`T`[] + +##### Inherited from + +`Array.concat` + +#### Call Signature + +> **concat**(...`items`): `T`[] + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1356 + +Combines two or more arrays. +This method returns a new array without modifying any existing arrays. + +##### Parameters + +###### items + +...(`T` \| `ConcatArray`\<`T`\>)[] + +Additional arrays and/or items to add to the end of the array. + +##### Returns + +`T`[] + +##### Inherited from + +`Array.concat` + +*** + +### copyWithin() + +> **copyWithin**(`target`, `start`, `end`?): `this` + +Defined in: node\_modules/typescript/lib/lib.es2015.core.d.ts:62 + +Returns the this object after copying a section of the array identified by start and end +to the same array starting at position target + +#### Parameters + +##### target + +`number` + +If target is negative, it is treated as length+target where length is the +length of the array. + +##### start + +`number` + +If start is negative, it is treated as length+start. If end is negative, it +is treated as length+end. + +##### end? + +`number` + +If not specified, length of the this object is used as its default value. + +#### Returns + +`this` + +#### Inherited from + +`Array.copyWithin` + +*** + +### entries() + +> **entries**(): `IterableIterator`\<\[`number`, `T`\]\> + +Defined in: node\_modules/typescript/lib/lib.es2015.iterable.d.ts:63 + +Returns an iterable of key, value pairs for every entry in the array + +#### Returns + +`IterableIterator`\<\[`number`, `T`\]\> + +#### Inherited from + +`Array.entries` + +*** + +### every() + +#### Call Signature + +> **every**\<`S`\>(`predicate`, `thisArg`?): `this is S[]` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1433 + +Determines whether all the members of an array satisfy the specified test. + +##### Type Parameters + +• **S** + +##### Parameters + +###### predicate + +(`value`, `index`, `array`) => `value is S` + +A function that accepts up to three arguments. The every method calls +the predicate function for each element in the array until the predicate returns a value +which is coercible to the Boolean value false, or until the end of the array. + +###### thisArg? + +`any` + +An object to which the this keyword can refer in the predicate function. +If thisArg is omitted, undefined is used as the this value. + +##### Returns + +`this is S[]` + +##### Inherited from + +`Array.every` + +#### Call Signature + +> **every**(`predicate`, `thisArg`?): `boolean` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1442 + +Determines whether all the members of an array satisfy the specified test. + +##### Parameters + +###### predicate + +(`value`, `index`, `array`) => `unknown` + +A function that accepts up to three arguments. The every method calls +the predicate function for each element in the array until the predicate returns a value +which is coercible to the Boolean value false, or until the end of the array. + +###### thisArg? + +`any` + +An object to which the this keyword can refer in the predicate function. +If thisArg is omitted, undefined is used as the this value. + +##### Returns + +`boolean` + +##### Inherited from + +`Array.every` + +*** + +### fill() + +> **fill**(`value`, `start`?, `end`?): `this` + +Defined in: node\_modules/typescript/lib/lib.es2015.core.d.ts:51 + +Changes all array elements from `start` to `end` index to a static `value` and returns the modified array + +#### Parameters + +##### value + +`T` + +value to fill array section with + +##### start? + +`number` + +index to start filling the array at. If start is negative, it is treated as +length+start where length is the length of the array. + +##### end? + +`number` + +index to stop filling the array at. If end is negative, it is treated as +length+end. + +#### Returns + +`this` + +#### Inherited from + +`Array.fill` + +*** + +### filter() + +#### Call Signature + +> **filter**\<`S`\>(`predicate`, `thisArg`?): `S`[] + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1469 + +Returns the elements of an array that meet the condition specified in a callback function. + +##### Type Parameters + +• **S** + +##### Parameters + +###### predicate + +(`value`, `index`, `array`) => `value is S` + +A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array. + +###### thisArg? + +`any` + +An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value. + +##### Returns + +`S`[] + +##### Inherited from + +`Array.filter` + +#### Call Signature + +> **filter**(`predicate`, `thisArg`?): `T`[] + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1475 + +Returns the elements of an array that meet the condition specified in a callback function. + +##### Parameters + +###### predicate + +(`value`, `index`, `array`) => `unknown` + +A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array. + +###### thisArg? + +`any` + +An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value. + +##### Returns + +`T`[] + +##### Inherited from + +`Array.filter` + +*** + +### find() + +#### Call Signature + +> **find**\<`S`\>(`predicate`, `thisArg`?): `undefined` \| `S` + +Defined in: node\_modules/typescript/lib/lib.es2015.core.d.ts:29 + +Returns the value of the first element in the array where predicate is true, and undefined +otherwise. + +##### Type Parameters + +• **S** + +##### Parameters + +###### predicate + +(`value`, `index`, `obj`) => `value is S` + +find calls predicate once for each element of the array, in ascending +order, until it finds one where predicate returns true. If such an element is found, find +immediately returns that element value. Otherwise, find returns undefined. + +###### thisArg? + +`any` + +If provided, it will be used as the this value for each invocation of +predicate. If it is not provided, undefined is used instead. + +##### Returns + +`undefined` \| `S` + +##### Inherited from + +`Array.find` + +#### Call Signature + +> **find**(`predicate`, `thisArg`?): `undefined` \| `T` + +Defined in: node\_modules/typescript/lib/lib.es2015.core.d.ts:30 + +##### Parameters + +###### predicate + +(`value`, `index`, `obj`) => `unknown` + +###### thisArg? + +`any` + +##### Returns + +`undefined` \| `T` + +##### Inherited from + +`Array.find` + +*** + +### findIndex() + +> **findIndex**(`predicate`, `thisArg`?): `number` + +Defined in: node\_modules/typescript/lib/lib.es2015.core.d.ts:41 + +Returns the index of the first element in the array where predicate is true, and -1 +otherwise. + +#### Parameters + +##### predicate + +(`value`, `index`, `obj`) => `unknown` + +find calls predicate once for each element of the array, in ascending +order, until it finds one where predicate returns true. If such an element is found, +findIndex immediately returns that element index. Otherwise, findIndex returns -1. + +##### thisArg? + +`any` + +If provided, it will be used as the this value for each invocation of +predicate. If it is not provided, undefined is used instead. + +#### Returns + +`number` + +#### Inherited from + +`Array.findIndex` + +*** + +### flat() + +> **flat**\<`A`, `D`\>(`this`, `depth`?): `FlatArray`\<`A`, `D`\>[] + +Defined in: node\_modules/typescript/lib/lib.es2019.array.d.ts:75 + +Returns a new array with all sub-array elements concatenated into it recursively up to the +specified depth. + +#### Type Parameters + +• **A** + +• **D** *extends* `number` = `1` + +#### Parameters + +##### this + +`A` + +##### depth? + +`D` + +The maximum recursion depth + +#### Returns + +`FlatArray`\<`A`, `D`\>[] + +#### Inherited from + +`Array.flat` + +*** + +### flatMap() + +> **flatMap**\<`U`, `This`\>(`callback`, `thisArg`?): `U`[] + +Defined in: node\_modules/typescript/lib/lib.es2019.array.d.ts:64 + +Calls a defined callback function on each element of an array. Then, flattens the result into +a new array. +This is identical to a map followed by flat with depth 1. + +#### Type Parameters + +• **U** + +• **This** = `undefined` + +#### Parameters + +##### callback + +(`this`, `value`, `index`, `array`) => `U` \| readonly `U`[] + +A function that accepts up to three arguments. The flatMap method calls the +callback function one time for each element in the array. + +##### thisArg? + +`This` + +An object to which the this keyword can refer in the callback function. If +thisArg is omitted, undefined is used as the this value. + +#### Returns + +`U`[] + +#### Inherited from + +`Array.flatMap` + +*** + +### forEach() + +> **forEach**(`callbackfn`, `thisArg`?): `void` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1457 + +Performs the specified action for each element in an array. + +#### Parameters + +##### callbackfn + +(`value`, `index`, `array`) => `void` + +A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. + +##### thisArg? + +`any` + +An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. + +#### Returns + +`void` + +#### Inherited from + +`Array.forEach` + +*** + +### includes() + +> **includes**(`searchElement`, `fromIndex`?): `boolean` + +Defined in: node\_modules/typescript/lib/lib.es2016.array.include.d.ts:25 + +Determines whether an array includes a certain element, returning true or false as appropriate. + +#### Parameters + +##### searchElement + +`T` + +The element to search for. + +##### fromIndex? + +`number` + +The position in this array at which to begin searching for searchElement. + +#### Returns + +`boolean` + +#### Inherited from + +`Array.includes` + +*** + +### indexOf() + +> **indexOf**(`searchElement`, `fromIndex`?): `number` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1418 + +Returns the index of the first occurrence of a value in an array, or -1 if it is not present. + +#### Parameters + +##### searchElement + +`T` + +The value to locate in the array. + +##### fromIndex? + +`number` + +The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. + +#### Returns + +`number` + +#### Inherited from + +`Array.indexOf` + +*** + +### join() + +> **join**(`separator`?): `string` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1361 + +Adds all the elements of an array into a string, separated by the specified separator string. + +#### Parameters + +##### separator? + +`string` + +A string used to separate one element of the array from the next in the resulting string. If omitted, the array elements are separated with a comma. + +#### Returns + +`string` + +#### Inherited from + +`Array.join` + +*** + +### keys() + +> **keys**(): `IterableIterator`\<`number`\> + +Defined in: node\_modules/typescript/lib/lib.es2015.iterable.d.ts:68 + +Returns an iterable of keys in the array + +#### Returns + +`IterableIterator`\<`number`\> + +#### Inherited from + +`Array.keys` + +*** + +### lastIndexOf() + +> **lastIndexOf**(`searchElement`, `fromIndex`?): `number` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1424 + +Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present. + +#### Parameters + +##### searchElement + +`T` + +The value to locate in the array. + +##### fromIndex? + +`number` + +The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array. + +#### Returns + +`number` + +#### Inherited from + +`Array.lastIndexOf` + +*** + +### map() + +> **map**\<`U`\>(`callbackfn`, `thisArg`?): `U`[] + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1463 + +Calls a defined callback function on each element of an array, and returns an array that contains the results. + +#### Type Parameters + +• **U** + +#### Parameters + +##### callbackfn + +(`value`, `index`, `array`) => `U` + +A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array. + +##### thisArg? + +`any` + +An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. + +#### Returns + +`U`[] + +#### Inherited from + +`Array.map` + +*** + +### pop() + +> **pop**(): `undefined` \| `T` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1339 + +Removes the last element from an array and returns it. +If the array is empty, undefined is returned and the array is not modified. + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +`Array.pop` + +*** + +### push() + +> **push**(...`items`): `number` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1344 + +Appends new elements to the end of an array, and returns the new length of the array. + +#### Parameters + +##### items + +...`T`[] + +New elements to add to the array. + +#### Returns + +`number` + +#### Inherited from + +`Array.push` + +*** + +### reduce() + +#### Call Signature + +> **reduce**(`callbackfn`): `T` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1481 + +Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +##### Parameters + +###### callbackfn + +(`previousValue`, `currentValue`, `currentIndex`, `array`) => `T` + +A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. + +##### Returns + +`T` + +##### Inherited from + +`Array.reduce` + +#### Call Signature + +> **reduce**(`callbackfn`, `initialValue`): `T` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1482 + +##### Parameters + +###### callbackfn + +(`previousValue`, `currentValue`, `currentIndex`, `array`) => `T` + +###### initialValue + +`T` + +##### Returns + +`T` + +##### Inherited from + +`Array.reduce` + +#### Call Signature + +> **reduce**\<`U`\>(`callbackfn`, `initialValue`): `U` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1488 + +Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +##### Type Parameters + +• **U** + +##### Parameters + +###### callbackfn + +(`previousValue`, `currentValue`, `currentIndex`, `array`) => `U` + +A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. + +###### initialValue + +`U` + +If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. + +##### Returns + +`U` + +##### Inherited from + +`Array.reduce` + +*** + +### reduceRight() + +#### Call Signature + +> **reduceRight**(`callbackfn`): `T` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1494 + +Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +##### Parameters + +###### callbackfn + +(`previousValue`, `currentValue`, `currentIndex`, `array`) => `T` + +A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. + +##### Returns + +`T` + +##### Inherited from + +`Array.reduceRight` + +#### Call Signature + +> **reduceRight**(`callbackfn`, `initialValue`): `T` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1495 + +##### Parameters + +###### callbackfn + +(`previousValue`, `currentValue`, `currentIndex`, `array`) => `T` + +###### initialValue + +`T` + +##### Returns + +`T` + +##### Inherited from + +`Array.reduceRight` + +#### Call Signature + +> **reduceRight**\<`U`\>(`callbackfn`, `initialValue`): `U` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1501 + +Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +##### Type Parameters + +• **U** + +##### Parameters + +###### callbackfn + +(`previousValue`, `currentValue`, `currentIndex`, `array`) => `U` + +A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. + +###### initialValue + +`U` + +If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. + +##### Returns + +`U` + +##### Inherited from + +`Array.reduceRight` + +*** + +### reverse() + +> **reverse**(): `T`[] + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1366 + +Reverses the elements in an array in place. +This method mutates the array and returns a reference to the same array. + +#### Returns + +`T`[] + +#### Inherited from + +`Array.reverse` + +*** + +### shift() + +> **shift**(): `undefined` \| `T` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1371 + +Removes the first element from an array and returns it. +If the array is empty, undefined is returned and the array is not modified. + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +`Array.shift` + +*** + +### slice() + +> **slice**(`start`?, `end`?): `T`[] + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1381 + +Returns a copy of a section of an array. +For both start and end, a negative index can be used to indicate an offset from the end of the array. +For example, -2 refers to the second to last element of the array. + +#### Parameters + +##### start? + +`number` + +The beginning index of the specified portion of the array. +If start is undefined, then the slice begins at index 0. + +##### end? + +`number` + +The end index of the specified portion of the array. This is exclusive of the element at the index 'end'. +If end is undefined, then the slice extends to the end of the array. + +#### Returns + +`T`[] + +#### Inherited from + +`Array.slice` + +*** + +### some() + +> **some**(`predicate`, `thisArg`?): `boolean` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1451 + +Determines whether the specified callback function returns true for any element of an array. + +#### Parameters + +##### predicate + +(`value`, `index`, `array`) => `unknown` + +A function that accepts up to three arguments. The some method calls +the predicate function for each element in the array until the predicate returns a value +which is coercible to the Boolean value true, or until the end of the array. + +##### thisArg? + +`any` + +An object to which the this keyword can refer in the predicate function. +If thisArg is omitted, undefined is used as the this value. + +#### Returns + +`boolean` + +#### Inherited from + +`Array.some` + +*** + +### sort() + +> **sort**(`compareFn`?): `this` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1392 + +Sorts an array in place. +This method mutates the array and returns a reference to the same array. + +#### Parameters + +##### compareFn? + +(`a`, `b`) => `number` + +Function used to determine the order of the elements. It is expected to return +a negative value if the first argument is less than the second argument, zero if they're equal, and a positive +value otherwise. If omitted, the elements are sorted in ascending, ASCII character order. +```ts +[11,2,22,1].sort((a, b) => a - b) +``` + +#### Returns + +`this` + +#### Inherited from + +`Array.sort` + +*** + +### splice() + +#### Call Signature + +> **splice**(`start`, `deleteCount`?): `T`[] + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1399 + +Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. + +##### Parameters + +###### start + +`number` + +The zero-based location in the array from which to start removing elements. + +###### deleteCount? + +`number` + +The number of elements to remove. + +##### Returns + +`T`[] + +An array containing the elements that were deleted. + +##### Inherited from + +`Array.splice` + +#### Call Signature + +> **splice**(`start`, `deleteCount`, ...`items`): `T`[] + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1407 + +Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. + +##### Parameters + +###### start + +`number` + +The zero-based location in the array from which to start removing elements. + +###### deleteCount + +`number` + +The number of elements to remove. + +###### items + +...`T`[] + +Elements to insert into the array in place of the deleted elements. + +##### Returns + +`T`[] + +An array containing the elements that were deleted. + +##### Inherited from + +`Array.splice` + +*** + +### toLocaleString() + +> **toLocaleString**(): `string` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1334 + +Returns a string representation of an array. The elements are converted to string using their toLocaleString methods. + +#### Returns + +`string` + +#### Inherited from + +`Array.toLocaleString` + +*** + +### toString() + +> **toString**(): `string` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1330 + +Returns a string representation of an array. + +#### Returns + +`string` + +#### Inherited from + +`Array.toString` + +*** + +### unshift() + +> **unshift**(...`items`): `number` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1412 + +Inserts new elements at the start of an array, and returns the new length of the array. + +#### Parameters + +##### items + +...`T`[] + +Elements to insert at the start of the array. + +#### Returns + +`number` + +#### Inherited from + +`Array.unshift` + +*** + +### values() + +> **values**(): `IterableIterator`\<`T`\> + +Defined in: node\_modules/typescript/lib/lib.es2015.iterable.d.ts:73 + +Returns an iterable of values in the array + +#### Returns + +`IterableIterator`\<`T`\> + +#### Inherited from + +`Array.values` diff --git a/docs/api_docs/namespaces/ts/interfaces/SortedReadonlyArray.md b/docs/api_docs/namespaces/ts/interfaces/SortedReadonlyArray.md new file mode 100644 index 0000000000000000000000000000000000000000..1293a5b7bcf2274183a3a3ddb804f44be2d16d51 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/SortedReadonlyArray.md @@ -0,0 +1,1105 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / SortedReadonlyArray + +# Interface: SortedReadonlyArray\ + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:28 + +## Extends + +- `ReadonlyArray`\<`T`\> + +## Type Parameters + +• **T** + +## Indexable + +\[`n`: `number`\]: `T` + +## Properties + +### \_\_sortedArrayBrand + +> ** \_\_sortedArrayBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:29 + +*** + +### \[unscopables\] + +> `readonly` **\[unscopables\]**: `object` + +Defined in: node\_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:107 + +Is an object whose properties have the value 'true' +when they will be absent when used in a 'with' statement. + +#### Index Signature + +\[`key`: `number`\]: `undefined` \| `boolean` + +#### \[iterator\]? + +> `optional` **\[iterator\]**: `boolean` + +#### \[unscopables\]? + +> `readonly` `optional` **\[unscopables\]**: `boolean` + +Is an object whose properties have the value 'true' +when they will be absent when used in a 'with' statement. + +#### at? + +> `optional` **at**: `boolean` + +#### concat? + +> `optional` **concat**: `boolean` + +#### entries? + +> `optional` **entries**: `boolean` + +#### every? + +> `optional` **every**: `boolean` + +#### filter? + +> `optional` **filter**: `boolean` + +#### find? + +> `optional` **find**: `boolean` + +#### findIndex? + +> `optional` **findIndex**: `boolean` + +#### flat? + +> `optional` **flat**: `boolean` + +#### flatMap? + +> `optional` **flatMap**: `boolean` + +#### forEach? + +> `optional` **forEach**: `boolean` + +#### includes? + +> `optional` **includes**: `boolean` + +#### indexOf? + +> `optional` **indexOf**: `boolean` + +#### join? + +> `optional` **join**: `boolean` + +#### keys? + +> `optional` **keys**: `boolean` + +#### lastIndexOf? + +> `optional` **lastIndexOf**: `boolean` + +#### length? + +> `readonly` `optional` **length**: `boolean` + +Gets the length of the array. This is a number one higher than the highest element defined in an array. + +#### map? + +> `optional` **map**: `boolean` + +#### reduce? + +> `optional` **reduce**: `boolean` + +#### reduceRight? + +> `optional` **reduceRight**: `boolean` + +#### slice? + +> `optional` **slice**: `boolean` + +#### some? + +> `optional` **some**: `boolean` + +#### toLocaleString? + +> `optional` **toLocaleString**: `boolean` + +#### toString? + +> `optional` **toString**: `boolean` + +#### values? + +> `optional` **values**: `boolean` + +#### Inherited from + +`ReadonlyArray.[unscopables]` + +*** + +### length + +> `readonly` **length**: `number` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1192 + +Gets the length of the array. This is a number one higher than the highest element defined in an array. + +#### Inherited from + +`ReadonlyArray.length` + +## Methods + +### \[iterator\]() + +> **\[iterator\]**(): `IterableIterator`\<`T`\> + +Defined in: node\_modules/typescript/lib/lib.es2015.iterable.d.ts:94 + +Iterator of values in the array. + +#### Returns + +`IterableIterator`\<`T`\> + +#### Inherited from + +`ReadonlyArray.[iterator]` + +*** + +### at() + +> **at**(`index`): `undefined` \| `T` + +Defined in: node\_modules/@types/node/compatibility/indexable.d.ts:7 + +#### Parameters + +##### index + +`number` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +`ReadonlyArray.at` + +*** + +### concat() + +#### Call Signature + +> **concat**(...`items`): `T`[] + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1205 + +Combines two or more arrays. + +##### Parameters + +###### items + +...`ConcatArray`\<`T`\>[] + +Additional items to add to the end of array1. + +##### Returns + +`T`[] + +##### Inherited from + +`ReadonlyArray.concat` + +#### Call Signature + +> **concat**(...`items`): `T`[] + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1210 + +Combines two or more arrays. + +##### Parameters + +###### items + +...(`T` \| `ConcatArray`\<`T`\>)[] + +Additional items to add to the end of array1. + +##### Returns + +`T`[] + +##### Inherited from + +`ReadonlyArray.concat` + +*** + +### entries() + +> **entries**(): `IterableIterator`\<\[`number`, `T`\]\> + +Defined in: node\_modules/typescript/lib/lib.es2015.iterable.d.ts:99 + +Returns an iterable of key, value pairs for every entry in the array + +#### Returns + +`IterableIterator`\<\[`number`, `T`\]\> + +#### Inherited from + +`ReadonlyArray.entries` + +*** + +### every() + +#### Call Signature + +> **every**\<`S`\>(`predicate`, `thisArg`?): `this is readonly S[]` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1242 + +Determines whether all the members of an array satisfy the specified test. + +##### Type Parameters + +• **S** + +##### Parameters + +###### predicate + +(`value`, `index`, `array`) => `value is S` + +A function that accepts up to three arguments. The every method calls +the predicate function for each element in the array until the predicate returns a value +which is coercible to the Boolean value false, or until the end of the array. + +###### thisArg? + +`any` + +An object to which the this keyword can refer in the predicate function. +If thisArg is omitted, undefined is used as the this value. + +##### Returns + +`this is readonly S[]` + +##### Inherited from + +`ReadonlyArray.every` + +#### Call Signature + +> **every**(`predicate`, `thisArg`?): `boolean` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1251 + +Determines whether all the members of an array satisfy the specified test. + +##### Parameters + +###### predicate + +(`value`, `index`, `array`) => `unknown` + +A function that accepts up to three arguments. The every method calls +the predicate function for each element in the array until the predicate returns a value +which is coercible to the Boolean value false, or until the end of the array. + +###### thisArg? + +`any` + +An object to which the this keyword can refer in the predicate function. +If thisArg is omitted, undefined is used as the this value. + +##### Returns + +`boolean` + +##### Inherited from + +`ReadonlyArray.every` + +*** + +### filter() + +#### Call Signature + +> **filter**\<`S`\>(`predicate`, `thisArg`?): `S`[] + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1278 + +Returns the elements of an array that meet the condition specified in a callback function. + +##### Type Parameters + +• **S** + +##### Parameters + +###### predicate + +(`value`, `index`, `array`) => `value is S` + +A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array. + +###### thisArg? + +`any` + +An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value. + +##### Returns + +`S`[] + +##### Inherited from + +`ReadonlyArray.filter` + +#### Call Signature + +> **filter**(`predicate`, `thisArg`?): `T`[] + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1284 + +Returns the elements of an array that meet the condition specified in a callback function. + +##### Parameters + +###### predicate + +(`value`, `index`, `array`) => `unknown` + +A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array. + +###### thisArg? + +`any` + +An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value. + +##### Returns + +`T`[] + +##### Inherited from + +`ReadonlyArray.filter` + +*** + +### find() + +#### Call Signature + +> **find**\<`S`\>(`predicate`, `thisArg`?): `undefined` \| `S` + +Defined in: node\_modules/typescript/lib/lib.es2015.core.d.ts:350 + +Returns the value of the first element in the array where predicate is true, and undefined +otherwise. + +##### Type Parameters + +• **S** + +##### Parameters + +###### predicate + +(`value`, `index`, `obj`) => `value is S` + +find calls predicate once for each element of the array, in ascending +order, until it finds one where predicate returns true. If such an element is found, find +immediately returns that element value. Otherwise, find returns undefined. + +###### thisArg? + +`any` + +If provided, it will be used as the this value for each invocation of +predicate. If it is not provided, undefined is used instead. + +##### Returns + +`undefined` \| `S` + +##### Inherited from + +`ReadonlyArray.find` + +#### Call Signature + +> **find**(`predicate`, `thisArg`?): `undefined` \| `T` + +Defined in: node\_modules/typescript/lib/lib.es2015.core.d.ts:351 + +##### Parameters + +###### predicate + +(`value`, `index`, `obj`) => `unknown` + +###### thisArg? + +`any` + +##### Returns + +`undefined` \| `T` + +##### Inherited from + +`ReadonlyArray.find` + +*** + +### findIndex() + +> **findIndex**(`predicate`, `thisArg`?): `number` + +Defined in: node\_modules/typescript/lib/lib.es2015.core.d.ts:362 + +Returns the index of the first element in the array where predicate is true, and -1 +otherwise. + +#### Parameters + +##### predicate + +(`value`, `index`, `obj`) => `unknown` + +find calls predicate once for each element of the array, in ascending +order, until it finds one where predicate returns true. If such an element is found, +findIndex immediately returns that element index. Otherwise, findIndex returns -1. + +##### thisArg? + +`any` + +If provided, it will be used as the this value for each invocation of +predicate. If it is not provided, undefined is used instead. + +#### Returns + +`number` + +#### Inherited from + +`ReadonlyArray.findIndex` + +*** + +### flat() + +> **flat**\<`A`, `D`\>(`this`, `depth`?): `FlatArray`\<`A`, `D`\>[] + +Defined in: node\_modules/typescript/lib/lib.es2019.array.d.ts:47 + +Returns a new array with all sub-array elements concatenated into it recursively up to the +specified depth. + +#### Type Parameters + +• **A** + +• **D** *extends* `number` = `1` + +#### Parameters + +##### this + +`A` + +##### depth? + +`D` + +The maximum recursion depth + +#### Returns + +`FlatArray`\<`A`, `D`\>[] + +#### Inherited from + +`ReadonlyArray.flat` + +*** + +### flatMap() + +> **flatMap**\<`U`, `This`\>(`callback`, `thisArg`?): `U`[] + +Defined in: node\_modules/typescript/lib/lib.es2019.array.d.ts:36 + +Calls a defined callback function on each element of an array. Then, flattens the result into +a new array. +This is identical to a map followed by flat with depth 1. + +#### Type Parameters + +• **U** + +• **This** = `undefined` + +#### Parameters + +##### callback + +(`this`, `value`, `index`, `array`) => `U` \| readonly `U`[] + +A function that accepts up to three arguments. The flatMap method calls the +callback function one time for each element in the array. + +##### thisArg? + +`This` + +An object to which the this keyword can refer in the callback function. If +thisArg is omitted, undefined is used as the this value. + +#### Returns + +`U`[] + +#### Inherited from + +`ReadonlyArray.flatMap` + +*** + +### forEach() + +> **forEach**(`callbackfn`, `thisArg`?): `void` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1266 + +Performs the specified action for each element in an array. + +#### Parameters + +##### callbackfn + +(`value`, `index`, `array`) => `void` + +A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array. + +##### thisArg? + +`any` + +An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. + +#### Returns + +`void` + +#### Inherited from + +`ReadonlyArray.forEach` + +*** + +### includes() + +> **includes**(`searchElement`, `fromIndex`?): `boolean` + +Defined in: node\_modules/typescript/lib/lib.es2016.array.include.d.ts:34 + +Determines whether an array includes a certain element, returning true or false as appropriate. + +#### Parameters + +##### searchElement + +`T` + +The element to search for. + +##### fromIndex? + +`number` + +The position in this array at which to begin searching for searchElement. + +#### Returns + +`boolean` + +#### Inherited from + +`ReadonlyArray.includes` + +*** + +### indexOf() + +> **indexOf**(`searchElement`, `fromIndex`?): `number` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1227 + +Returns the index of the first occurrence of a value in an array. + +#### Parameters + +##### searchElement + +`T` + +The value to locate in the array. + +##### fromIndex? + +`number` + +The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0. + +#### Returns + +`number` + +#### Inherited from + +`ReadonlyArray.indexOf` + +*** + +### join() + +> **join**(`separator`?): `string` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1215 + +Adds all the elements of an array separated by the specified separator string. + +#### Parameters + +##### separator? + +`string` + +A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma. + +#### Returns + +`string` + +#### Inherited from + +`ReadonlyArray.join` + +*** + +### keys() + +> **keys**(): `IterableIterator`\<`number`\> + +Defined in: node\_modules/typescript/lib/lib.es2015.iterable.d.ts:104 + +Returns an iterable of keys in the array + +#### Returns + +`IterableIterator`\<`number`\> + +#### Inherited from + +`ReadonlyArray.keys` + +*** + +### lastIndexOf() + +> **lastIndexOf**(`searchElement`, `fromIndex`?): `number` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1233 + +Returns the index of the last occurrence of a specified value in an array. + +#### Parameters + +##### searchElement + +`T` + +The value to locate in the array. + +##### fromIndex? + +`number` + +The array index at which to begin the search. If fromIndex is omitted, the search starts at the last index in the array. + +#### Returns + +`number` + +#### Inherited from + +`ReadonlyArray.lastIndexOf` + +*** + +### map() + +> **map**\<`U`\>(`callbackfn`, `thisArg`?): `U`[] + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1272 + +Calls a defined callback function on each element of an array, and returns an array that contains the results. + +#### Type Parameters + +• **U** + +#### Parameters + +##### callbackfn + +(`value`, `index`, `array`) => `U` + +A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array. + +##### thisArg? + +`any` + +An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value. + +#### Returns + +`U`[] + +#### Inherited from + +`ReadonlyArray.map` + +*** + +### reduce() + +#### Call Signature + +> **reduce**(`callbackfn`): `T` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1290 + +Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +##### Parameters + +###### callbackfn + +(`previousValue`, `currentValue`, `currentIndex`, `array`) => `T` + +A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. + +##### Returns + +`T` + +##### Inherited from + +`ReadonlyArray.reduce` + +#### Call Signature + +> **reduce**(`callbackfn`, `initialValue`): `T` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1291 + +##### Parameters + +###### callbackfn + +(`previousValue`, `currentValue`, `currentIndex`, `array`) => `T` + +###### initialValue + +`T` + +##### Returns + +`T` + +##### Inherited from + +`ReadonlyArray.reduce` + +#### Call Signature + +> **reduce**\<`U`\>(`callbackfn`, `initialValue`): `U` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1297 + +Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +##### Type Parameters + +• **U** + +##### Parameters + +###### callbackfn + +(`previousValue`, `currentValue`, `currentIndex`, `array`) => `U` + +A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array. + +###### initialValue + +`U` + +If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. + +##### Returns + +`U` + +##### Inherited from + +`ReadonlyArray.reduce` + +*** + +### reduceRight() + +#### Call Signature + +> **reduceRight**(`callbackfn`): `T` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1303 + +Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +##### Parameters + +###### callbackfn + +(`previousValue`, `currentValue`, `currentIndex`, `array`) => `T` + +A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. + +##### Returns + +`T` + +##### Inherited from + +`ReadonlyArray.reduceRight` + +#### Call Signature + +> **reduceRight**(`callbackfn`, `initialValue`): `T` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1304 + +##### Parameters + +###### callbackfn + +(`previousValue`, `currentValue`, `currentIndex`, `array`) => `T` + +###### initialValue + +`T` + +##### Returns + +`T` + +##### Inherited from + +`ReadonlyArray.reduceRight` + +#### Call Signature + +> **reduceRight**\<`U`\>(`callbackfn`, `initialValue`): `U` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1310 + +Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. + +##### Type Parameters + +• **U** + +##### Parameters + +###### callbackfn + +(`previousValue`, `currentValue`, `currentIndex`, `array`) => `U` + +A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array. + +###### initialValue + +`U` + +If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value. + +##### Returns + +`U` + +##### Inherited from + +`ReadonlyArray.reduceRight` + +*** + +### slice() + +> **slice**(`start`?, `end`?): `T`[] + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1221 + +Returns a section of an array. + +#### Parameters + +##### start? + +`number` + +The beginning of the specified portion of the array. + +##### end? + +`number` + +The end of the specified portion of the array. This is exclusive of the element at the index 'end'. + +#### Returns + +`T`[] + +#### Inherited from + +`ReadonlyArray.slice` + +*** + +### some() + +> **some**(`predicate`, `thisArg`?): `boolean` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1260 + +Determines whether the specified callback function returns true for any element of an array. + +#### Parameters + +##### predicate + +(`value`, `index`, `array`) => `unknown` + +A function that accepts up to three arguments. The some method calls +the predicate function for each element in the array until the predicate returns a value +which is coercible to the Boolean value true, or until the end of the array. + +##### thisArg? + +`any` + +An object to which the this keyword can refer in the predicate function. +If thisArg is omitted, undefined is used as the this value. + +#### Returns + +`boolean` + +#### Inherited from + +`ReadonlyArray.some` + +*** + +### toLocaleString() + +> **toLocaleString**(): `string` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1200 + +Returns a string representation of an array. The elements are converted to string using their toLocaleString methods. + +#### Returns + +`string` + +#### Inherited from + +`ReadonlyArray.toLocaleString` + +*** + +### toString() + +> **toString**(): `string` + +Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1196 + +Returns a string representation of an array. + +#### Returns + +`string` + +#### Inherited from + +`ReadonlyArray.toString` + +*** + +### values() + +> **values**(): `IterableIterator`\<`T`\> + +Defined in: node\_modules/typescript/lib/lib.es2015.iterable.d.ts:109 + +Returns an iterable of values in the array + +#### Returns + +`IterableIterator`\<`T`\> + +#### Inherited from + +`ReadonlyArray.values` diff --git a/docs/api_docs/namespaces/ts/interfaces/SourceFile.md b/docs/api_docs/namespaces/ts/interfaces/SourceFile.md new file mode 100644 index 0000000000000000000000000000000000000000..8a74c385052244cf3e208505436c6d6c8a01e403 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/SourceFile.md @@ -0,0 +1,720 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / SourceFile + +# Interface: SourceFile + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2116 + +## Extends + +- [`Declaration`](Declaration.md) + +## Extended by + +- [`JsonSourceFile`](JsonSourceFile.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`Declaration`](Declaration.md).[`_declarationBrand`](Declaration.md#_declarationbrand) + +*** + +### amdDependencies + +> **amdDependencies**: readonly [`AmdDependency`](AmdDependency.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2122 + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Declaration`](Declaration.md).[`decorators`](Declaration.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Declaration`](Declaration.md).[`end`](Declaration.md#end) + +*** + +### endOfFileToken + +> `readonly` **endOfFileToken**: [`Token`](Token.md)\<[`EndOfFileToken`](../enumerations/SyntaxKind.md#endoffiletoken)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2119 + +*** + +### fileName + +> **fileName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2120 + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Declaration`](Declaration.md).[`flags`](Declaration.md#flags) + +*** + +### hasNoDefaultLib + +> **hasNoDefaultLib**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2137 + +lib.d.ts should have a reference comment like + + /// + +If any other file has this comment, it signals not to include lib.d.ts +because this containing file is intended to act as a default library. + +*** + +### impliedNodeFormat? + +> `optional` **impliedNodeFormat**: [`CommonJS`](../enumerations/ModuleKind.md#commonjs) \| [`ESNext`](../enumerations/ModuleKind.md#esnext) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2156 + +When `module` is `Node16` or `NodeNext`, this field controls whether the +source file in question is an ESNext-output-format file, or a CommonJS-output-format +module. This is derived by the module resolver as it looks up the file, since +it is derived from either the file extension of the module, or the containing +`package.json` context, and affects both checking and emit. + +It is _public_ so that (pre)transformers can set this field, +since it switches the builtin `node` module transform. Generally speaking, if unset, +the field is treated as though it is `ModuleKind.CommonJS`. + +Note that this field is only set by the module resolution process when +`moduleResolution` is `Node16` or `NodeNext`, which is implied by the `module` setting +of `Node16` or `NodeNext`, respectively, but may be overriden (eg, by a `moduleResolution` +of `node`). If so, this field will be unset and source files will be considered to be +CommonJS-output-format by the node module transformer and type checker, regardless of extension or context. + +*** + +### isDeclarationFile + +> **isDeclarationFile**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2128 + +*** + +### kind + +> `readonly` **kind**: [`SourceFile`](../enumerations/SyntaxKind.md#sourcefile) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2117 + +#### Overrides + +[`Declaration`](Declaration.md).[`kind`](Declaration.md#kind) + +*** + +### languageVariant + +> **languageVariant**: [`LanguageVariant`](../enumerations/LanguageVariant.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2127 + +*** + +### languageVersion + +> **languageVersion**: [`ScriptTarget`](../enumerations/ScriptTarget.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2138 + +*** + +### libReferenceDirectives + +> **libReferenceDirectives**: readonly [`FileReference`](FileReference.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2126 + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Declaration`](Declaration.md).[`locals`](Declaration.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Declaration`](Declaration.md).[`modifiers`](Declaration.md#modifiers) + +*** + +### moduleName? + +> `optional` **moduleName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2123 + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`Declaration`](Declaration.md).[`parent`](Declaration.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Declaration`](Declaration.md).[`pos`](Declaration.md#pos) + +*** + +### referencedFiles + +> **referencedFiles**: readonly [`FileReference`](FileReference.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2124 + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Declaration`](Declaration.md).[`skipCheck`](Declaration.md#skipcheck) + +*** + +### statements + +> `readonly` **statements**: [`NodeArray`](NodeArray.md)\<[`Statement`](Statement.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2118 + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Declaration`](Declaration.md).[`symbol`](Declaration.md#symbol) + +*** + +### text + +> **text**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2121 + +*** + +### typeReferenceDirectives + +> **typeReferenceDirectives**: readonly [`FileReference`](FileReference.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2125 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Declaration`](Declaration.md).[`forEachChild`](Declaration.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getChildAt`](Declaration.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getChildCount`](Declaration.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Declaration`](Declaration.md).[`getChildren`](Declaration.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getEnd`](Declaration.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFirstToken`](Declaration.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFullStart`](Declaration.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFullText`](Declaration.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFullWidth`](Declaration.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getLastToken`](Declaration.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getLeadingTriviaWidth`](Declaration.md#getleadingtriviawidth) + +*** + +### getLineAndCharacterOfPosition() + +> **getLineAndCharacterOfPosition**(`pos`): [`LineAndCharacter`](LineAndCharacter.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6157 + +#### Parameters + +##### pos + +`number` + +#### Returns + +[`LineAndCharacter`](LineAndCharacter.md) + +*** + +### getLineEndOfPosition() + +> **getLineEndOfPosition**(`pos`): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6158 + +#### Parameters + +##### pos + +`number` + +#### Returns + +`number` + +*** + +### getLineStarts() + +> **getLineStarts**(): readonly `number`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6159 + +#### Returns + +readonly `number`[] + +*** + +### getPositionOfLineAndCharacter() + +> **getPositionOfLineAndCharacter**(`line`, `character`): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6160 + +#### Parameters + +##### line + +`number` + +##### character + +`number` + +#### Returns + +`number` + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getSourceFile`](Declaration.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getStart`](Declaration.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getText`](Declaration.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getWidth`](Declaration.md#getwidth) + +*** + +### update() + +> **update**(`newText`, `textChangeRange`): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6161 + +#### Parameters + +##### newText + +`string` + +##### textChangeRange + +[`TextChangeRange`](TextChangeRange.md) + +#### Returns + +[`SourceFile`](SourceFile.md) diff --git a/docs/api_docs/namespaces/ts/interfaces/SourceFileLike.md b/docs/api_docs/namespaces/ts/interfaces/SourceFileLike.md new file mode 100644 index 0000000000000000000000000000000000000000..67cc7ef13074b634e11b7d307fa8298260cf93fb --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/SourceFileLike.md @@ -0,0 +1,45 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / SourceFileLike + +# Interface: SourceFileLike + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2112 + +Subset of properties from SourceFile that are used in multiple utility functions + +## Properties + +### fileName? + +> `readonly` `optional` **fileName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2114 + +*** + +### text + +> `readonly` **text**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2113 + +## Methods + +### getLineAndCharacterOfPosition() + +> **getLineAndCharacterOfPosition**(`pos`): [`LineAndCharacter`](LineAndCharacter.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6164 + +#### Parameters + +##### pos + +`number` + +#### Returns + +[`LineAndCharacter`](LineAndCharacter.md) diff --git a/docs/api_docs/namespaces/ts/interfaces/SourceFileMayBeEmittedHost.md b/docs/api_docs/namespaces/ts/interfaces/SourceFileMayBeEmittedHost.md new file mode 100644 index 0000000000000000000000000000000000000000..4c4b51b433ba6becc76fc11a12d88df026c639aa --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/SourceFileMayBeEmittedHost.md @@ -0,0 +1,79 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / SourceFileMayBeEmittedHost + +# Interface: SourceFileMayBeEmittedHost + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3578 + +## Extended by + +- [`EmitHost`](EmitHost.md) + +## Methods + +### getCompilerOptions() + +> **getCompilerOptions**(): [`CompilerOptions`](CompilerOptions.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3579 + +#### Returns + +[`CompilerOptions`](CompilerOptions.md) + +*** + +### getResolvedProjectReferenceToRedirect() + +> **getResolvedProjectReferenceToRedirect**(`fileName`): `undefined` \| [`ResolvedProjectReference`](ResolvedProjectReference.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3581 + +#### Parameters + +##### fileName + +`string` + +#### Returns + +`undefined` \| [`ResolvedProjectReference`](ResolvedProjectReference.md) + +*** + +### isSourceFileFromExternalLibrary() + +> **isSourceFileFromExternalLibrary**(`file`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3580 + +#### Parameters + +##### file + +[`SourceFile`](SourceFile.md) + +#### Returns + +`boolean` + +*** + +### isSourceOfProjectReferenceRedirect() + +> **isSourceOfProjectReferenceRedirect**(`fileName`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3582 + +#### Parameters + +##### fileName + +`string` + +#### Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/interfaces/SourceMapGenerator.md b/docs/api_docs/namespaces/ts/interfaces/SourceMapGenerator.md new file mode 100644 index 0000000000000000000000000000000000000000..7c15c9bc6a8c3ef9e30d80c1ca8015a807dc8068 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/SourceMapGenerator.md @@ -0,0 +1,219 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / SourceMapGenerator + +# Interface: SourceMapGenerator + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4284 + +Generates a source map. + +## Methods + +### addMapping() + +#### Call Signature + +> **addMapping**(`generatedLine`, `generatedCharacter`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4301 + +Adds a mapping without source information. + +##### Parameters + +###### generatedLine + +`number` + +###### generatedCharacter + +`number` + +##### Returns + +`void` + +#### Call Signature + +> **addMapping**(`generatedLine`, `generatedCharacter`, `sourceIndex`, `sourceLine`, `sourceCharacter`, `nameIndex`?): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4305 + +Adds a mapping with source information. + +##### Parameters + +###### generatedLine + +`number` + +###### generatedCharacter + +`number` + +###### sourceIndex + +`number` + +###### sourceLine + +`number` + +###### sourceCharacter + +`number` + +###### nameIndex? + +`number` + +##### Returns + +`void` + +*** + +### addName() + +> **addName**(`name`): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4297 + +Adds a name. + +#### Parameters + +##### name + +`string` + +#### Returns + +`number` + +*** + +### addSource() + +> **addSource**(`fileName`): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4289 + +Adds a source to the source map. + +#### Parameters + +##### fileName + +`string` + +#### Returns + +`number` + +*** + +### appendSourceMap() + +> **appendSourceMap**(`generatedLine`, `generatedCharacter`, `sourceMap`, `sourceMapPath`, `start`?, `end`?): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4309 + +Appends a source map. + +#### Parameters + +##### generatedLine + +`number` + +##### generatedCharacter + +`number` + +##### sourceMap + +[`RawSourceMap`](RawSourceMap.md) + +##### sourceMapPath + +`string` + +##### start? + +[`LineAndCharacter`](LineAndCharacter.md) + +##### end? + +[`LineAndCharacter`](LineAndCharacter.md) + +#### Returns + +`void` + +*** + +### getSources() + +> **getSources**(): readonly `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4285 + +#### Returns + +readonly `string`[] + +*** + +### setSourceContent() + +> **setSourceContent**(`sourceIndex`, `content`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4293 + +Set the content for a source. + +#### Parameters + +##### sourceIndex + +`number` + +##### content + +`null` | `string` + +#### Returns + +`void` + +*** + +### toJSON() + +> **toJSON**(): [`RawSourceMap`](RawSourceMap.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4313 + +Gets the source map as a `RawSourceMap` object. + +#### Returns + +[`RawSourceMap`](RawSourceMap.md) + +*** + +### toString() + +> **toString**(): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4317 + +Gets the string representation of the source map. + +#### Returns + +`string` diff --git a/docs/api_docs/namespaces/ts/interfaces/SourceMapGeneratorOptions.md b/docs/api_docs/namespaces/ts/interfaces/SourceMapGeneratorOptions.md new file mode 100644 index 0000000000000000000000000000000000000000..77cb70956fb078f75cd795fb49440a87c3d2fd91 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/SourceMapGeneratorOptions.md @@ -0,0 +1,17 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / SourceMapGeneratorOptions + +# Interface: SourceMapGeneratorOptions + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5531 + +## Properties + +### extendedDiagnostics? + +> `optional` **extendedDiagnostics**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5532 diff --git a/docs/api_docs/namespaces/ts/interfaces/SourceMapRange.md b/docs/api_docs/namespaces/ts/interfaces/SourceMapRange.md new file mode 100644 index 0000000000000000000000000000000000000000..16ea38904e9e072c61eff396618b415dc5780d3a --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/SourceMapRange.md @@ -0,0 +1,45 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / SourceMapRange + +# Interface: SourceMapRange + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3514 + +## Extends + +- [`TextRange`](TextRange.md) + +## Properties + +### end + +> **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:99 + +#### Inherited from + +[`TextRange`](TextRange.md).[`end`](TextRange.md#end) + +*** + +### pos + +> **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:98 + +#### Inherited from + +[`TextRange`](TextRange.md).[`pos`](TextRange.md#pos) + +*** + +### source? + +> `optional` **source**: [`SourceMapSource`](SourceMapSource.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3515 diff --git a/docs/api_docs/namespaces/ts/interfaces/SourceMapSource.md b/docs/api_docs/namespaces/ts/interfaces/SourceMapSource.md new file mode 100644 index 0000000000000000000000000000000000000000..f609d7c5a55463f352c8745fbb0ffa2b55d3b78f --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/SourceMapSource.md @@ -0,0 +1,61 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / SourceMapSource + +# Interface: SourceMapSource + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3517 + +## Properties + +### fileName + +> **fileName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3518 + +*** + +### skipTrivia()? + +> `optional` **skipTrivia**: (`pos`) => `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3520 + +#### Parameters + +##### pos + +`number` + +#### Returns + +`number` + +*** + +### text + +> **text**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3519 + +## Methods + +### getLineAndCharacterOfPosition() + +> **getLineAndCharacterOfPosition**(`pos`): [`LineAndCharacter`](LineAndCharacter.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6167 + +#### Parameters + +##### pos + +`number` + +#### Returns + +[`LineAndCharacter`](LineAndCharacter.md) diff --git a/docs/api_docs/namespaces/ts/interfaces/SourceMapSpan.md b/docs/api_docs/namespaces/ts/interfaces/SourceMapSpan.md new file mode 100644 index 0000000000000000000000000000000000000000..72b93d924bd8ae6cda357dda9e638d5fa7c29472 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/SourceMapSpan.md @@ -0,0 +1,69 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / SourceMapSpan + +# Interface: SourceMapSpan + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2354 + +## Properties + +### emittedColumn + +> **emittedColumn**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2358 + +Column number in the .js file. + +*** + +### emittedLine + +> **emittedLine**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2356 + +Line number in the .js file. + +*** + +### nameIndex? + +> `optional` **nameIndex**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2364 + +Optional name (index into names array) associated with this span. + +*** + +### sourceColumn + +> **sourceColumn**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2362 + +Column number in the .ts file. + +*** + +### sourceIndex + +> **sourceIndex**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2366 + +.ts file (index into sources array) associated with this span + +*** + +### sourceLine + +> **sourceLine**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2360 + +Line number in the .ts file. diff --git a/docs/api_docs/namespaces/ts/interfaces/SpreadAssignment.md b/docs/api_docs/namespaces/ts/interfaces/SpreadAssignment.md new file mode 100644 index 0000000000000000000000000000000000000000..71b20f550fa42421c1a5eb81afd21eae3e1ef598 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/SpreadAssignment.md @@ -0,0 +1,521 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / SpreadAssignment + +# Interface: SpreadAssignment + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:816 + +## Extends + +- [`ObjectLiteralElement`](ObjectLiteralElement.md).[`JSDocContainer`](JSDocContainer.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`_declarationBrand`](ObjectLiteralElement.md#_declarationbrand) + +*** + +### \_objectLiteralBrand + +> **\_objectLiteralBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:798 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`_objectLiteralBrand`](ObjectLiteralElement.md#_objectliteralbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`decorators`](ObjectLiteralElement.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`end`](ObjectLiteralElement.md#end) + +*** + +### expression + +> `readonly` **expression**: [`Expression`](Expression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:819 + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`flags`](ObjectLiteralElement.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`SpreadAssignment`](../enumerations/SyntaxKind.md#spreadassignment) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:817 + +#### Overrides + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`kind`](ObjectLiteralElement.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`locals`](ObjectLiteralElement.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`modifiers`](ObjectLiteralElement.md#modifiers) + +*** + +### name? + +> `readonly` `optional` **name**: [`PropertyName`](../type-aliases/PropertyName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:799 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`name`](ObjectLiteralElement.md#name) + +*** + +### parent + +> `readonly` **parent**: [`ObjectLiteralExpression`](ObjectLiteralExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:818 + +#### Overrides + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`parent`](ObjectLiteralElement.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`pos`](ObjectLiteralElement.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`skipCheck`](ObjectLiteralElement.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`symbol`](ObjectLiteralElement.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`forEachChild`](ObjectLiteralElement.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getChildAt`](ObjectLiteralElement.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getChildCount`](ObjectLiteralElement.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getChildren`](ObjectLiteralElement.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getEnd`](ObjectLiteralElement.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getFirstToken`](ObjectLiteralElement.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getFullStart`](ObjectLiteralElement.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getFullText`](ObjectLiteralElement.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getFullWidth`](ObjectLiteralElement.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getLastToken`](ObjectLiteralElement.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getLeadingTriviaWidth`](ObjectLiteralElement.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getSourceFile`](ObjectLiteralElement.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getStart`](ObjectLiteralElement.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getText`](ObjectLiteralElement.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`ObjectLiteralElement`](ObjectLiteralElement.md).[`getWidth`](ObjectLiteralElement.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/SpreadElement.md b/docs/api_docs/namespaces/ts/interfaces/SpreadElement.md new file mode 100644 index 0000000000000000000000000000000000000000..5ba532c635ec157aa21646b48b9ab1c1a5992091 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/SpreadElement.md @@ -0,0 +1,497 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / SpreadElement + +# Interface: SpreadElement + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1284 + +## Extends + +- [`Expression`](Expression.md) + +## Properties + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`Expression`](Expression.md).[`_expressionBrand`](Expression.md#_expressionbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Expression`](Expression.md).[`decorators`](Expression.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Expression`](Expression.md).[`end`](Expression.md#end) + +*** + +### expression + +> `readonly` **expression**: [`Expression`](Expression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1287 + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Expression`](Expression.md).[`flags`](Expression.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`SpreadElement`](../enumerations/SyntaxKind.md#spreadelement) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1285 + +#### Overrides + +[`Expression`](Expression.md).[`kind`](Expression.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Expression`](Expression.md).[`locals`](Expression.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Expression`](Expression.md).[`modifiers`](Expression.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`CallExpression`](CallExpression.md) \| [`NewExpression`](NewExpression.md) \| [`ArrayLiteralExpression`](ArrayLiteralExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1286 + +#### Overrides + +[`Expression`](Expression.md).[`parent`](Expression.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Expression`](Expression.md).[`pos`](Expression.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Expression`](Expression.md).[`skipCheck`](Expression.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Expression`](Expression.md).[`symbol`](Expression.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Expression`](Expression.md).[`forEachChild`](Expression.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Expression`](Expression.md).[`getChildAt`](Expression.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getChildCount`](Expression.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Expression`](Expression.md).[`getChildren`](Expression.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getEnd`](Expression.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Expression`](Expression.md).[`getFirstToken`](Expression.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getFullStart`](Expression.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Expression`](Expression.md).[`getFullText`](Expression.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getFullWidth`](Expression.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Expression`](Expression.md).[`getLastToken`](Expression.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getLeadingTriviaWidth`](Expression.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Expression`](Expression.md).[`getSourceFile`](Expression.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getStart`](Expression.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Expression`](Expression.md).[`getText`](Expression.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getWidth`](Expression.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/Statement.md b/docs/api_docs/namespaces/ts/interfaces/Statement.md new file mode 100644 index 0000000000000000000000000000000000000000..a689d9aff8c29ae6b36ee5378a51d7b680cd1b62 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/Statement.md @@ -0,0 +1,507 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / Statement + +# Interface: Statement + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1470 + +## Extends + +- [`Node`](Node.md).[`JSDocContainer`](JSDocContainer.md) + +## Extended by + +- [`DeclarationStatement`](DeclarationStatement.md) +- [`NotEmittedStatement`](NotEmittedStatement.md) +- [`EmptyStatement`](EmptyStatement.md) +- [`DebuggerStatement`](DebuggerStatement.md) +- [`Block`](Block.md) +- [`VariableStatement`](VariableStatement.md) +- [`ExpressionStatement`](ExpressionStatement.md) +- [`IfStatement`](IfStatement.md) +- [`IterationStatement`](IterationStatement.md) +- [`BreakStatement`](BreakStatement.md) +- [`ContinueStatement`](ContinueStatement.md) +- [`ReturnStatement`](ReturnStatement.md) +- [`WithStatement`](WithStatement.md) +- [`SwitchStatement`](SwitchStatement.md) +- [`LabeledStatement`](LabeledStatement.md) +- [`ThrowStatement`](ThrowStatement.md) +- [`TryStatement`](TryStatement.md) +- [`ModuleBlock`](ModuleBlock.md) +- [`ImportDeclaration`](ImportDeclaration.md) + +## Properties + +### \_statementBrand + +> **\_statementBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1471 + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`decorators`](Node.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Node`](Node.md).[`end`](Node.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Node`](Node.md).[`flags`](Node.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`SyntaxKind`](../enumerations/SyntaxKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:598 + +#### Inherited from + +[`Node`](Node.md).[`kind`](Node.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Node`](Node.md).[`locals`](Node.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`modifiers`](Node.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`Node`](Node.md).[`parent`](Node.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Node`](Node.md).[`pos`](Node.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Node`](Node.md).[`skipCheck`](Node.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Node`](Node.md).[`symbol`](Node.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Node`](Node.md).[`forEachChild`](Node.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getChildAt`](Node.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getChildCount`](Node.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Node`](Node.md).[`getChildren`](Node.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getEnd`](Node.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getFirstToken`](Node.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullStart`](Node.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getFullText`](Node.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullWidth`](Node.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getLastToken`](Node.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getLeadingTriviaWidth`](Node.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Node`](Node.md).[`getSourceFile`](Node.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getStart`](Node.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getText`](Node.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getWidth`](Node.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/StringLiteral.md b/docs/api_docs/namespaces/ts/interfaces/StringLiteral.md new file mode 100644 index 0000000000000000000000000000000000000000..598a014f925146b53b2cc4253196b3cea6a7fab8 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/StringLiteral.md @@ -0,0 +1,609 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / StringLiteral + +# Interface: StringLiteral + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1039 + +## Extends + +- [`LiteralExpression`](LiteralExpression.md).[`Declaration`](Declaration.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`Declaration`](Declaration.md).[`_declarationBrand`](Declaration.md#_declarationbrand) + +*** + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`_expressionBrand`](LiteralExpression.md#_expressionbrand) + +*** + +### \_leftHandSideExpressionBrand + +> **\_leftHandSideExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1086 + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`_leftHandSideExpressionBrand`](LiteralExpression.md#_lefthandsideexpressionbrand) + +*** + +### \_literalExpressionBrand + +> **\_literalExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1227 + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`_literalExpressionBrand`](LiteralExpression.md#_literalexpressionbrand) + +*** + +### \_memberExpressionBrand + +> **\_memberExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1089 + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`_memberExpressionBrand`](LiteralExpression.md#_memberexpressionbrand) + +*** + +### \_primaryExpressionBrand + +> **\_primaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1092 + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`_primaryExpressionBrand`](LiteralExpression.md#_primaryexpressionbrand) + +*** + +### \_unaryExpressionBrand + +> **\_unaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1066 + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`_unaryExpressionBrand`](LiteralExpression.md#_unaryexpressionbrand) + +*** + +### \_updateExpressionBrand + +> **\_updateExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1071 + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`_updateExpressionBrand`](LiteralExpression.md#_updateexpressionbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Declaration`](Declaration.md).[`decorators`](Declaration.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Declaration`](Declaration.md).[`end`](Declaration.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Declaration`](Declaration.md).[`flags`](Declaration.md#flags) + +*** + +### hasExtendedUnicodeEscape? + +> `optional` **hasExtendedUnicodeEscape**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1221 + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`hasExtendedUnicodeEscape`](LiteralExpression.md#hasextendedunicodeescape) + +*** + +### isUnterminated? + +> `optional` **isUnterminated**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1220 + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`isUnterminated`](LiteralExpression.md#isunterminated) + +*** + +### kind + +> `readonly` **kind**: [`StringLiteral`](../enumerations/SyntaxKind.md#stringliteral) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1040 + +#### Overrides + +[`Declaration`](Declaration.md).[`kind`](Declaration.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Declaration`](Declaration.md).[`locals`](Declaration.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Declaration`](Declaration.md).[`modifiers`](Declaration.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`Declaration`](Declaration.md).[`parent`](Declaration.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Declaration`](Declaration.md).[`pos`](Declaration.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Declaration`](Declaration.md).[`skipCheck`](Declaration.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Declaration`](Declaration.md).[`symbol`](Declaration.md#symbol) + +*** + +### text + +> **text**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1219 + +#### Inherited from + +[`LiteralExpression`](LiteralExpression.md).[`text`](LiteralExpression.md#text) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Declaration`](Declaration.md).[`forEachChild`](Declaration.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getChildAt`](Declaration.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getChildCount`](Declaration.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Declaration`](Declaration.md).[`getChildren`](Declaration.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getEnd`](Declaration.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFirstToken`](Declaration.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFullStart`](Declaration.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFullText`](Declaration.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFullWidth`](Declaration.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getLastToken`](Declaration.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getLeadingTriviaWidth`](Declaration.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getSourceFile`](Declaration.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getStart`](Declaration.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getText`](Declaration.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getWidth`](Declaration.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/StringLiteralType.md b/docs/api_docs/namespaces/ts/interfaces/StringLiteralType.md new file mode 100644 index 0000000000000000000000000000000000000000..1ae7869f8cefc19e2880bdaf464deb79cd6387bd --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/StringLiteralType.md @@ -0,0 +1,483 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / StringLiteralType + +# Interface: StringLiteralType + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2785 + +## Extends + +- [`LiteralType`](LiteralType.md) + +## Properties + +### aliasSymbol? + +> `optional` **aliasSymbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2773 + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`aliasSymbol`](LiteralType.md#aliassymbol) + +*** + +### aliasTypeArguments? + +> `optional` **aliasTypeArguments**: readonly [`Type`](Type.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2774 + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`aliasTypeArguments`](LiteralType.md#aliastypearguments) + +*** + +### flags + +> **flags**: [`TypeFlags`](../enumerations/TypeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2770 + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`flags`](LiteralType.md#flags) + +*** + +### freshType + +> **freshType**: [`LiteralType`](LiteralType.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2778 + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`freshType`](LiteralType.md#freshtype) + +*** + +### pattern? + +> `optional` **pattern**: [`DestructuringPattern`](../type-aliases/DestructuringPattern.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2772 + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`pattern`](LiteralType.md#pattern) + +*** + +### regularType + +> **regularType**: [`LiteralType`](LiteralType.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2779 + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`regularType`](LiteralType.md#regulartype) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2771 + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`symbol`](LiteralType.md#symbol) + +*** + +### value + +> **value**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2786 + +#### Overrides + +[`LiteralType`](LiteralType.md).[`value`](LiteralType.md#value) + +## Methods + +### getApparentProperties() + +> **getApparentProperties**(): [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6124 + +#### Returns + +[`Symbol`](Symbol.md)[] + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`getApparentProperties`](LiteralType.md#getapparentproperties) + +*** + +### getBaseTypes() + +> **getBaseTypes**(): `undefined` \| [`BaseType`](../type-aliases/BaseType.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6129 + +#### Returns + +`undefined` \| [`BaseType`](../type-aliases/BaseType.md)[] + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`getBaseTypes`](LiteralType.md#getbasetypes) + +*** + +### getCallSignatures() + +> **getCallSignatures**(): readonly [`Signature`](Signature.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6125 + +#### Returns + +readonly [`Signature`](Signature.md)[] + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`getCallSignatures`](LiteralType.md#getcallsignatures) + +*** + +### getConstraint() + +> **getConstraint**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6131 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`getConstraint`](LiteralType.md#getconstraint) + +*** + +### getConstructSignatures() + +> **getConstructSignatures**(): readonly [`Signature`](Signature.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6126 + +#### Returns + +readonly [`Signature`](Signature.md)[] + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`getConstructSignatures`](LiteralType.md#getconstructsignatures) + +*** + +### getDefault() + +> **getDefault**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6132 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`getDefault`](LiteralType.md#getdefault) + +*** + +### getFlags() + +> **getFlags**(): [`TypeFlags`](../enumerations/TypeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6120 + +#### Returns + +[`TypeFlags`](../enumerations/TypeFlags.md) + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`getFlags`](LiteralType.md#getflags) + +*** + +### getNonNullableType() + +> **getNonNullableType**(): [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6130 + +#### Returns + +[`Type`](Type.md) + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`getNonNullableType`](LiteralType.md#getnonnullabletype) + +*** + +### getNumberIndexType() + +> **getNumberIndexType**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6128 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`getNumberIndexType`](LiteralType.md#getnumberindextype) + +*** + +### getProperties() + +> **getProperties**(): [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6122 + +#### Returns + +[`Symbol`](Symbol.md)[] + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`getProperties`](LiteralType.md#getproperties) + +*** + +### getProperty() + +> **getProperty**(`propertyName`): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6123 + +#### Parameters + +##### propertyName + +`string` + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`getProperty`](LiteralType.md#getproperty) + +*** + +### getStringIndexType() + +> **getStringIndexType**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6127 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`getStringIndexType`](LiteralType.md#getstringindextype) + +*** + +### getSymbol() + +> **getSymbol**(): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6121 + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`getSymbol`](LiteralType.md#getsymbol) + +*** + +### isClass() + +> **isClass**(): `this is InterfaceType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6141 + +#### Returns + +`this is InterfaceType` + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`isClass`](LiteralType.md#isclass) + +*** + +### isClassOrInterface() + +> **isClassOrInterface**(): `this is InterfaceType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6140 + +#### Returns + +`this is InterfaceType` + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`isClassOrInterface`](LiteralType.md#isclassorinterface) + +*** + +### isIndexType() + +> **isIndexType**(): `this is IndexType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6142 + +#### Returns + +`this is IndexType` + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`isIndexType`](LiteralType.md#isindextype) + +*** + +### isIntersection() + +> **isIntersection**(): `this is IntersectionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6134 + +#### Returns + +`this is IntersectionType` + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`isIntersection`](LiteralType.md#isintersection) + +*** + +### isLiteral() + +> **isLiteral**(): `this is LiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6136 + +#### Returns + +`this is LiteralType` + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`isLiteral`](LiteralType.md#isliteral) + +*** + +### isNumberLiteral() + +> **isNumberLiteral**(): `this is NumberLiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6138 + +#### Returns + +`this is NumberLiteralType` + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`isNumberLiteral`](LiteralType.md#isnumberliteral) + +*** + +### isStringLiteral() + +> **isStringLiteral**(): `this is StringLiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6137 + +#### Returns + +`this is StringLiteralType` + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`isStringLiteral`](LiteralType.md#isstringliteral) + +*** + +### isTypeParameter() + +> **isTypeParameter**(): `this is TypeParameter` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6139 + +#### Returns + +`this is TypeParameter` + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`isTypeParameter`](LiteralType.md#istypeparameter) + +*** + +### isUnion() + +> **isUnion**(): `this is UnionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6133 + +#### Returns + +`this is UnionType` + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`isUnion`](LiteralType.md#isunion) + +*** + +### isUnionOrIntersection() + +> **isUnionOrIntersection**(): `this is UnionOrIntersectionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6135 + +#### Returns + +`this is UnionOrIntersectionType` + +#### Inherited from + +[`LiteralType`](LiteralType.md).[`isUnionOrIntersection`](LiteralType.md#isunionorintersection) diff --git a/docs/api_docs/namespaces/ts/interfaces/StringMappingType.md b/docs/api_docs/namespaces/ts/interfaces/StringMappingType.md new file mode 100644 index 0000000000000000000000000000000000000000..b936441cd2fcc765c1fb8ca84a83e9c7fe9ea04e --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/StringMappingType.md @@ -0,0 +1,455 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / StringMappingType + +# Interface: StringMappingType + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2923 + +## Extends + +- [`InstantiableType`](InstantiableType.md) + +## Properties + +### aliasSymbol? + +> `optional` **aliasSymbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2773 + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`aliasSymbol`](InstantiableType.md#aliassymbol) + +*** + +### aliasTypeArguments? + +> `optional` **aliasTypeArguments**: readonly [`Type`](Type.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2774 + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`aliasTypeArguments`](InstantiableType.md#aliastypearguments) + +*** + +### flags + +> **flags**: [`TypeFlags`](../enumerations/TypeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2770 + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`flags`](InstantiableType.md#flags) + +*** + +### pattern? + +> `optional` **pattern**: [`DestructuringPattern`](../type-aliases/DestructuringPattern.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2772 + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`pattern`](InstantiableType.md#pattern) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2924 + +#### Overrides + +[`InstantiableType`](InstantiableType.md).[`symbol`](InstantiableType.md#symbol) + +*** + +### type + +> **type**: [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2925 + +## Methods + +### getApparentProperties() + +> **getApparentProperties**(): [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6124 + +#### Returns + +[`Symbol`](Symbol.md)[] + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getApparentProperties`](InstantiableType.md#getapparentproperties) + +*** + +### getBaseTypes() + +> **getBaseTypes**(): `undefined` \| [`BaseType`](../type-aliases/BaseType.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6129 + +#### Returns + +`undefined` \| [`BaseType`](../type-aliases/BaseType.md)[] + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getBaseTypes`](InstantiableType.md#getbasetypes) + +*** + +### getCallSignatures() + +> **getCallSignatures**(): readonly [`Signature`](Signature.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6125 + +#### Returns + +readonly [`Signature`](Signature.md)[] + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getCallSignatures`](InstantiableType.md#getcallsignatures) + +*** + +### getConstraint() + +> **getConstraint**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6131 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getConstraint`](InstantiableType.md#getconstraint) + +*** + +### getConstructSignatures() + +> **getConstructSignatures**(): readonly [`Signature`](Signature.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6126 + +#### Returns + +readonly [`Signature`](Signature.md)[] + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getConstructSignatures`](InstantiableType.md#getconstructsignatures) + +*** + +### getDefault() + +> **getDefault**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6132 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getDefault`](InstantiableType.md#getdefault) + +*** + +### getFlags() + +> **getFlags**(): [`TypeFlags`](../enumerations/TypeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6120 + +#### Returns + +[`TypeFlags`](../enumerations/TypeFlags.md) + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getFlags`](InstantiableType.md#getflags) + +*** + +### getNonNullableType() + +> **getNonNullableType**(): [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6130 + +#### Returns + +[`Type`](Type.md) + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getNonNullableType`](InstantiableType.md#getnonnullabletype) + +*** + +### getNumberIndexType() + +> **getNumberIndexType**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6128 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getNumberIndexType`](InstantiableType.md#getnumberindextype) + +*** + +### getProperties() + +> **getProperties**(): [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6122 + +#### Returns + +[`Symbol`](Symbol.md)[] + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getProperties`](InstantiableType.md#getproperties) + +*** + +### getProperty() + +> **getProperty**(`propertyName`): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6123 + +#### Parameters + +##### propertyName + +`string` + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getProperty`](InstantiableType.md#getproperty) + +*** + +### getStringIndexType() + +> **getStringIndexType**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6127 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getStringIndexType`](InstantiableType.md#getstringindextype) + +*** + +### getSymbol() + +> **getSymbol**(): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6121 + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getSymbol`](InstantiableType.md#getsymbol) + +*** + +### isClass() + +> **isClass**(): `this is InterfaceType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6141 + +#### Returns + +`this is InterfaceType` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isClass`](InstantiableType.md#isclass) + +*** + +### isClassOrInterface() + +> **isClassOrInterface**(): `this is InterfaceType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6140 + +#### Returns + +`this is InterfaceType` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isClassOrInterface`](InstantiableType.md#isclassorinterface) + +*** + +### isIndexType() + +> **isIndexType**(): `this is IndexType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6142 + +#### Returns + +`this is IndexType` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isIndexType`](InstantiableType.md#isindextype) + +*** + +### isIntersection() + +> **isIntersection**(): `this is IntersectionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6134 + +#### Returns + +`this is IntersectionType` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isIntersection`](InstantiableType.md#isintersection) + +*** + +### isLiteral() + +> **isLiteral**(): `this is LiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6136 + +#### Returns + +`this is LiteralType` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isLiteral`](InstantiableType.md#isliteral) + +*** + +### isNumberLiteral() + +> **isNumberLiteral**(): `this is NumberLiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6138 + +#### Returns + +`this is NumberLiteralType` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isNumberLiteral`](InstantiableType.md#isnumberliteral) + +*** + +### isStringLiteral() + +> **isStringLiteral**(): `this is StringLiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6137 + +#### Returns + +`this is StringLiteralType` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isStringLiteral`](InstantiableType.md#isstringliteral) + +*** + +### isTypeParameter() + +> **isTypeParameter**(): `this is TypeParameter` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6139 + +#### Returns + +`this is TypeParameter` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isTypeParameter`](InstantiableType.md#istypeparameter) + +*** + +### isUnion() + +> **isUnion**(): `this is UnionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6133 + +#### Returns + +`this is UnionType` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isUnion`](InstantiableType.md#isunion) + +*** + +### isUnionOrIntersection() + +> **isUnionOrIntersection**(): `this is UnionOrIntersectionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6135 + +#### Returns + +`this is UnionOrIntersectionType` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isUnionOrIntersection`](InstantiableType.md#isunionorintersection) diff --git a/docs/api_docs/namespaces/ts/interfaces/StructDeclaration.md b/docs/api_docs/namespaces/ts/interfaces/StructDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..d6b5eeb4718beb3068d9f42e77b2bad6b5e9611b --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/StructDeclaration.md @@ -0,0 +1,551 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / StructDeclaration + +# Interface: StructDeclaration + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1621 + +## Extends + +- [`ClassLikeDeclarationBase`](ClassLikeDeclarationBase.md).[`DeclarationStatement`](DeclarationStatement.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`_declarationBrand`](DeclarationStatement.md#_declarationbrand) + +*** + +### \_statementBrand + +> **\_statementBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1471 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`_statementBrand`](DeclarationStatement.md#_statementbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`decorators`](DeclarationStatement.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`end`](DeclarationStatement.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`flags`](DeclarationStatement.md#flags) + +*** + +### heritageClauses? + +> `readonly` `optional` **heritageClauses**: [`NodeArray`](NodeArray.md)\<[`HeritageClause`](HeritageClause.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1612 + +#### Inherited from + +[`ClassLikeDeclarationBase`](ClassLikeDeclarationBase.md).[`heritageClauses`](ClassLikeDeclarationBase.md#heritageclauses) + +*** + +### kind + +> `readonly` **kind**: [`StructDeclaration`](../enumerations/SyntaxKind.md#structdeclaration) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1622 + +#### Overrides + +[`DeclarationStatement`](DeclarationStatement.md).[`kind`](DeclarationStatement.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`locals`](DeclarationStatement.md#locals) + +*** + +### members + +> `readonly` **members**: [`NodeArray`](NodeArray.md)\<[`ClassElement`](ClassElement.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1613 + +#### Inherited from + +[`ClassLikeDeclarationBase`](ClassLikeDeclarationBase.md).[`members`](ClassLikeDeclarationBase.md#members) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1623 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Overrides + +[`DeclarationStatement`](DeclarationStatement.md).[`modifiers`](DeclarationStatement.md#modifiers) + +*** + +### name? + +> `readonly` `optional` **name**: [`Identifier`](Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1625 + +May be undefined in `export default class { ... }`. + +#### Overrides + +[`DeclarationStatement`](DeclarationStatement.md).[`name`](DeclarationStatement.md#name) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`parent`](DeclarationStatement.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`pos`](DeclarationStatement.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`skipCheck`](DeclarationStatement.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`symbol`](DeclarationStatement.md#symbol) + +*** + +### typeParameters? + +> `readonly` `optional` **typeParameters**: [`NodeArray`](NodeArray.md)\<[`TypeParameterDeclaration`](TypeParameterDeclaration.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1611 + +#### Inherited from + +[`ClassLikeDeclarationBase`](ClassLikeDeclarationBase.md).[`typeParameters`](ClassLikeDeclarationBase.md#typeparameters) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`forEachChild`](DeclarationStatement.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getChildAt`](DeclarationStatement.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getChildCount`](DeclarationStatement.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getChildren`](DeclarationStatement.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getEnd`](DeclarationStatement.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getFirstToken`](DeclarationStatement.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getFullStart`](DeclarationStatement.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getFullText`](DeclarationStatement.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getFullWidth`](DeclarationStatement.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getLastToken`](DeclarationStatement.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getLeadingTriviaWidth`](DeclarationStatement.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getSourceFile`](DeclarationStatement.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getStart`](DeclarationStatement.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getText`](DeclarationStatement.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getWidth`](DeclarationStatement.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/SubstitutionType.md b/docs/api_docs/namespaces/ts/interfaces/SubstitutionType.md new file mode 100644 index 0000000000000000000000000000000000000000..8c9a0af8a49e58fad38dbca4b722ae80c860376e --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/SubstitutionType.md @@ -0,0 +1,471 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / SubstitutionType + +# Interface: SubstitutionType + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2927 + +## Extends + +- [`InstantiableType`](InstantiableType.md) + +## Properties + +### aliasSymbol? + +> `optional` **aliasSymbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2773 + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`aliasSymbol`](InstantiableType.md#aliassymbol) + +*** + +### aliasTypeArguments? + +> `optional` **aliasTypeArguments**: readonly [`Type`](Type.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2774 + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`aliasTypeArguments`](InstantiableType.md#aliastypearguments) + +*** + +### baseType + +> **baseType**: [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2929 + +*** + +### constraint + +> **constraint**: [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2930 + +*** + +### flags + +> **flags**: [`TypeFlags`](../enumerations/TypeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2770 + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`flags`](InstantiableType.md#flags) + +*** + +### objectFlags + +> **objectFlags**: [`ObjectFlags`](../enumerations/ObjectFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2928 + +*** + +### pattern? + +> `optional` **pattern**: [`DestructuringPattern`](../type-aliases/DestructuringPattern.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2772 + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`pattern`](InstantiableType.md#pattern) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2771 + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`symbol`](InstantiableType.md#symbol) + +## Methods + +### getApparentProperties() + +> **getApparentProperties**(): [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6124 + +#### Returns + +[`Symbol`](Symbol.md)[] + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getApparentProperties`](InstantiableType.md#getapparentproperties) + +*** + +### getBaseTypes() + +> **getBaseTypes**(): `undefined` \| [`BaseType`](../type-aliases/BaseType.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6129 + +#### Returns + +`undefined` \| [`BaseType`](../type-aliases/BaseType.md)[] + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getBaseTypes`](InstantiableType.md#getbasetypes) + +*** + +### getCallSignatures() + +> **getCallSignatures**(): readonly [`Signature`](Signature.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6125 + +#### Returns + +readonly [`Signature`](Signature.md)[] + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getCallSignatures`](InstantiableType.md#getcallsignatures) + +*** + +### getConstraint() + +> **getConstraint**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6131 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getConstraint`](InstantiableType.md#getconstraint) + +*** + +### getConstructSignatures() + +> **getConstructSignatures**(): readonly [`Signature`](Signature.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6126 + +#### Returns + +readonly [`Signature`](Signature.md)[] + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getConstructSignatures`](InstantiableType.md#getconstructsignatures) + +*** + +### getDefault() + +> **getDefault**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6132 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getDefault`](InstantiableType.md#getdefault) + +*** + +### getFlags() + +> **getFlags**(): [`TypeFlags`](../enumerations/TypeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6120 + +#### Returns + +[`TypeFlags`](../enumerations/TypeFlags.md) + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getFlags`](InstantiableType.md#getflags) + +*** + +### getNonNullableType() + +> **getNonNullableType**(): [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6130 + +#### Returns + +[`Type`](Type.md) + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getNonNullableType`](InstantiableType.md#getnonnullabletype) + +*** + +### getNumberIndexType() + +> **getNumberIndexType**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6128 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getNumberIndexType`](InstantiableType.md#getnumberindextype) + +*** + +### getProperties() + +> **getProperties**(): [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6122 + +#### Returns + +[`Symbol`](Symbol.md)[] + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getProperties`](InstantiableType.md#getproperties) + +*** + +### getProperty() + +> **getProperty**(`propertyName`): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6123 + +#### Parameters + +##### propertyName + +`string` + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getProperty`](InstantiableType.md#getproperty) + +*** + +### getStringIndexType() + +> **getStringIndexType**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6127 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getStringIndexType`](InstantiableType.md#getstringindextype) + +*** + +### getSymbol() + +> **getSymbol**(): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6121 + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getSymbol`](InstantiableType.md#getsymbol) + +*** + +### isClass() + +> **isClass**(): `this is InterfaceType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6141 + +#### Returns + +`this is InterfaceType` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isClass`](InstantiableType.md#isclass) + +*** + +### isClassOrInterface() + +> **isClassOrInterface**(): `this is InterfaceType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6140 + +#### Returns + +`this is InterfaceType` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isClassOrInterface`](InstantiableType.md#isclassorinterface) + +*** + +### isIndexType() + +> **isIndexType**(): `this is IndexType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6142 + +#### Returns + +`this is IndexType` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isIndexType`](InstantiableType.md#isindextype) + +*** + +### isIntersection() + +> **isIntersection**(): `this is IntersectionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6134 + +#### Returns + +`this is IntersectionType` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isIntersection`](InstantiableType.md#isintersection) + +*** + +### isLiteral() + +> **isLiteral**(): `this is LiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6136 + +#### Returns + +`this is LiteralType` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isLiteral`](InstantiableType.md#isliteral) + +*** + +### isNumberLiteral() + +> **isNumberLiteral**(): `this is NumberLiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6138 + +#### Returns + +`this is NumberLiteralType` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isNumberLiteral`](InstantiableType.md#isnumberliteral) + +*** + +### isStringLiteral() + +> **isStringLiteral**(): `this is StringLiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6137 + +#### Returns + +`this is StringLiteralType` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isStringLiteral`](InstantiableType.md#isstringliteral) + +*** + +### isTypeParameter() + +> **isTypeParameter**(): `this is TypeParameter` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6139 + +#### Returns + +`this is TypeParameter` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isTypeParameter`](InstantiableType.md#istypeparameter) + +*** + +### isUnion() + +> **isUnion**(): `this is UnionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6133 + +#### Returns + +`this is UnionType` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isUnion`](InstantiableType.md#isunion) + +*** + +### isUnionOrIntersection() + +> **isUnionOrIntersection**(): `this is UnionOrIntersectionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6135 + +#### Returns + +`this is UnionOrIntersectionType` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isUnionOrIntersection`](InstantiableType.md#isunionorintersection) diff --git a/docs/api_docs/namespaces/ts/interfaces/SuperCall.md b/docs/api_docs/namespaces/ts/interfaces/SuperCall.md new file mode 100644 index 0000000000000000000000000000000000000000..b44343cc921d8968b98037ffd6dfc690817ecf47 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/SuperCall.md @@ -0,0 +1,585 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / SuperCall + +# Interface: SuperCall + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1347 + +## Extends + +- [`CallExpression`](CallExpression.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`_declarationBrand`](CallExpression.md#_declarationbrand) + +*** + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`_expressionBrand`](CallExpression.md#_expressionbrand) + +*** + +### \_leftHandSideExpressionBrand + +> **\_leftHandSideExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1086 + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`_leftHandSideExpressionBrand`](CallExpression.md#_lefthandsideexpressionbrand) + +*** + +### \_unaryExpressionBrand + +> **\_unaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1066 + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`_unaryExpressionBrand`](CallExpression.md#_unaryexpressionbrand) + +*** + +### \_updateExpressionBrand + +> **\_updateExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1071 + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`_updateExpressionBrand`](CallExpression.md#_updateexpressionbrand) + +*** + +### arguments + +> `readonly` **arguments**: [`NodeArray`](NodeArray.md)\<[`Expression`](Expression.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1341 + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`arguments`](CallExpression.md#arguments) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`decorators`](CallExpression.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`end`](CallExpression.md#end) + +*** + +### expression + +> `readonly` **expression**: [`SuperExpression`](SuperExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1348 + +#### Overrides + +[`CallExpression`](CallExpression.md).[`expression`](CallExpression.md#expression) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`flags`](CallExpression.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`CallExpression`](../enumerations/SyntaxKind.md#callexpression) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1337 + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`kind`](CallExpression.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`locals`](CallExpression.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`modifiers`](CallExpression.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`parent`](CallExpression.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`pos`](CallExpression.md#pos) + +*** + +### questionDotToken? + +> `readonly` `optional` **questionDotToken**: [`QuestionDotToken`](../type-aliases/QuestionDotToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1339 + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`questionDotToken`](CallExpression.md#questiondottoken) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`skipCheck`](CallExpression.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`symbol`](CallExpression.md#symbol) + +*** + +### typeArguments? + +> `readonly` `optional` **typeArguments**: [`NodeArray`](NodeArray.md)\<[`TypeNode`](TypeNode.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1340 + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`typeArguments`](CallExpression.md#typearguments) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`forEachChild`](CallExpression.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`getChildAt`](CallExpression.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`getChildCount`](CallExpression.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`getChildren`](CallExpression.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`getEnd`](CallExpression.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`getFirstToken`](CallExpression.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`getFullStart`](CallExpression.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`getFullText`](CallExpression.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`getFullWidth`](CallExpression.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`getLastToken`](CallExpression.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`getLeadingTriviaWidth`](CallExpression.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`getSourceFile`](CallExpression.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`getStart`](CallExpression.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`getText`](CallExpression.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`CallExpression`](CallExpression.md).[`getWidth`](CallExpression.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/SuperElementAccessExpression.md b/docs/api_docs/namespaces/ts/interfaces/SuperElementAccessExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..917115b9972c272e317ad2c15d4f513b3b53aa43 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/SuperElementAccessExpression.md @@ -0,0 +1,573 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / SuperElementAccessExpression + +# Interface: SuperElementAccessExpression + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1332 + +## Extends + +- [`ElementAccessExpression`](ElementAccessExpression.md) + +## Properties + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`_expressionBrand`](ElementAccessExpression.md#_expressionbrand) + +*** + +### \_leftHandSideExpressionBrand + +> **\_leftHandSideExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1086 + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`_leftHandSideExpressionBrand`](ElementAccessExpression.md#_lefthandsideexpressionbrand) + +*** + +### \_memberExpressionBrand + +> **\_memberExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1089 + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`_memberExpressionBrand`](ElementAccessExpression.md#_memberexpressionbrand) + +*** + +### \_unaryExpressionBrand + +> **\_unaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1066 + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`_unaryExpressionBrand`](ElementAccessExpression.md#_unaryexpressionbrand) + +*** + +### \_updateExpressionBrand + +> **\_updateExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1071 + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`_updateExpressionBrand`](ElementAccessExpression.md#_updateexpressionbrand) + +*** + +### argumentExpression + +> `readonly` **argumentExpression**: [`Expression`](Expression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1327 + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`argumentExpression`](ElementAccessExpression.md#argumentexpression) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`decorators`](ElementAccessExpression.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`end`](ElementAccessExpression.md#end) + +*** + +### expression + +> `readonly` **expression**: [`SuperExpression`](SuperExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1333 + +#### Overrides + +[`ElementAccessExpression`](ElementAccessExpression.md).[`expression`](ElementAccessExpression.md#expression) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`flags`](ElementAccessExpression.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`ElementAccessExpression`](../enumerations/SyntaxKind.md#elementaccessexpression) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1324 + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`kind`](ElementAccessExpression.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`locals`](ElementAccessExpression.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`modifiers`](ElementAccessExpression.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`parent`](ElementAccessExpression.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`pos`](ElementAccessExpression.md#pos) + +*** + +### questionDotToken? + +> `readonly` `optional` **questionDotToken**: [`QuestionDotToken`](../type-aliases/QuestionDotToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1326 + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`questionDotToken`](ElementAccessExpression.md#questiondottoken) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`skipCheck`](ElementAccessExpression.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`symbol`](ElementAccessExpression.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`forEachChild`](ElementAccessExpression.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`getChildAt`](ElementAccessExpression.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`getChildCount`](ElementAccessExpression.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`getChildren`](ElementAccessExpression.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`getEnd`](ElementAccessExpression.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`getFirstToken`](ElementAccessExpression.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`getFullStart`](ElementAccessExpression.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`getFullText`](ElementAccessExpression.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`getFullWidth`](ElementAccessExpression.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`getLastToken`](ElementAccessExpression.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`getLeadingTriviaWidth`](ElementAccessExpression.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`getSourceFile`](ElementAccessExpression.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`getStart`](ElementAccessExpression.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`getText`](ElementAccessExpression.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`ElementAccessExpression`](ElementAccessExpression.md).[`getWidth`](ElementAccessExpression.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/SuperExpression.md b/docs/api_docs/namespaces/ts/interfaces/SuperExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..c5e5dea7b43322bd20f9add929c514b19a21bed7 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/SuperExpression.md @@ -0,0 +1,549 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / SuperExpression + +# Interface: SuperExpression + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1107 + +## Extends + +- [`PrimaryExpression`](PrimaryExpression.md) + +## Properties + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_expressionBrand`](PrimaryExpression.md#_expressionbrand) + +*** + +### \_leftHandSideExpressionBrand + +> **\_leftHandSideExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1086 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_leftHandSideExpressionBrand`](PrimaryExpression.md#_lefthandsideexpressionbrand) + +*** + +### \_memberExpressionBrand + +> **\_memberExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1089 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_memberExpressionBrand`](PrimaryExpression.md#_memberexpressionbrand) + +*** + +### \_primaryExpressionBrand + +> **\_primaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1092 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_primaryExpressionBrand`](PrimaryExpression.md#_primaryexpressionbrand) + +*** + +### \_unaryExpressionBrand + +> **\_unaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1066 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_unaryExpressionBrand`](PrimaryExpression.md#_unaryexpressionbrand) + +*** + +### \_updateExpressionBrand + +> **\_updateExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1071 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_updateExpressionBrand`](PrimaryExpression.md#_updateexpressionbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`decorators`](PrimaryExpression.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`end`](PrimaryExpression.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`flags`](PrimaryExpression.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`SuperKeyword`](../enumerations/SyntaxKind.md#superkeyword) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1108 + +#### Overrides + +[`PrimaryExpression`](PrimaryExpression.md).[`kind`](PrimaryExpression.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`locals`](PrimaryExpression.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`modifiers`](PrimaryExpression.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`parent`](PrimaryExpression.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`pos`](PrimaryExpression.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`skipCheck`](PrimaryExpression.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`symbol`](PrimaryExpression.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`forEachChild`](PrimaryExpression.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getChildAt`](PrimaryExpression.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getChildCount`](PrimaryExpression.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getChildren`](PrimaryExpression.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getEnd`](PrimaryExpression.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFirstToken`](PrimaryExpression.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFullStart`](PrimaryExpression.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFullText`](PrimaryExpression.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFullWidth`](PrimaryExpression.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getLastToken`](PrimaryExpression.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getLeadingTriviaWidth`](PrimaryExpression.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getSourceFile`](PrimaryExpression.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getStart`](PrimaryExpression.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getText`](PrimaryExpression.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getWidth`](PrimaryExpression.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/SuperPropertyAccessExpression.md b/docs/api_docs/namespaces/ts/interfaces/SuperPropertyAccessExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..ca39b9f21236d4cce2fb8ab3dc48aff43621b323 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/SuperPropertyAccessExpression.md @@ -0,0 +1,585 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / SuperPropertyAccessExpression + +# Interface: SuperPropertyAccessExpression + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1314 + +## Extends + +- [`PropertyAccessExpression`](PropertyAccessExpression.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`_declarationBrand`](PropertyAccessExpression.md#_declarationbrand) + +*** + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`_expressionBrand`](PropertyAccessExpression.md#_expressionbrand) + +*** + +### \_leftHandSideExpressionBrand + +> **\_leftHandSideExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1086 + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`_leftHandSideExpressionBrand`](PropertyAccessExpression.md#_lefthandsideexpressionbrand) + +*** + +### \_memberExpressionBrand + +> **\_memberExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1089 + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`_memberExpressionBrand`](PropertyAccessExpression.md#_memberexpressionbrand) + +*** + +### \_unaryExpressionBrand + +> **\_unaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1066 + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`_unaryExpressionBrand`](PropertyAccessExpression.md#_unaryexpressionbrand) + +*** + +### \_updateExpressionBrand + +> **\_updateExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1071 + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`_updateExpressionBrand`](PropertyAccessExpression.md#_updateexpressionbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`decorators`](PropertyAccessExpression.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`end`](PropertyAccessExpression.md#end) + +*** + +### expression + +> `readonly` **expression**: [`SuperExpression`](SuperExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1315 + +#### Overrides + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`expression`](PropertyAccessExpression.md#expression) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`flags`](PropertyAccessExpression.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`PropertyAccessExpression`](../enumerations/SyntaxKind.md#propertyaccessexpression) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1305 + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`kind`](PropertyAccessExpression.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`locals`](PropertyAccessExpression.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`modifiers`](PropertyAccessExpression.md#modifiers) + +*** + +### name + +> `readonly` **name**: [`MemberName`](../type-aliases/MemberName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1308 + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`name`](PropertyAccessExpression.md#name) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`parent`](PropertyAccessExpression.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`pos`](PropertyAccessExpression.md#pos) + +*** + +### questionDotToken? + +> `readonly` `optional` **questionDotToken**: [`QuestionDotToken`](../type-aliases/QuestionDotToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1307 + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`questionDotToken`](PropertyAccessExpression.md#questiondottoken) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`skipCheck`](PropertyAccessExpression.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`symbol`](PropertyAccessExpression.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`forEachChild`](PropertyAccessExpression.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`getChildAt`](PropertyAccessExpression.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`getChildCount`](PropertyAccessExpression.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`getChildren`](PropertyAccessExpression.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`getEnd`](PropertyAccessExpression.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`getFirstToken`](PropertyAccessExpression.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`getFullStart`](PropertyAccessExpression.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`getFullText`](PropertyAccessExpression.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`getFullWidth`](PropertyAccessExpression.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`getLastToken`](PropertyAccessExpression.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`getLeadingTriviaWidth`](PropertyAccessExpression.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`getSourceFile`](PropertyAccessExpression.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`getStart`](PropertyAccessExpression.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`getText`](PropertyAccessExpression.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`PropertyAccessExpression`](PropertyAccessExpression.md).[`getWidth`](PropertyAccessExpression.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/SwitchStatement.md b/docs/api_docs/namespaces/ts/interfaces/SwitchStatement.md new file mode 100644 index 0000000000000000000000000000000000000000..595d5384c1f619f17c4ac37f321af670d395b789 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/SwitchStatement.md @@ -0,0 +1,513 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / SwitchStatement + +# Interface: SwitchStatement + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1561 + +## Extends + +- [`Statement`](Statement.md) + +## Properties + +### \_statementBrand + +> **\_statementBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1471 + +#### Inherited from + +[`Statement`](Statement.md).[`_statementBrand`](Statement.md#_statementbrand) + +*** + +### caseBlock + +> `readonly` **caseBlock**: [`CaseBlock`](CaseBlock.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1564 + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Statement`](Statement.md).[`decorators`](Statement.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Statement`](Statement.md).[`end`](Statement.md#end) + +*** + +### expression + +> `readonly` **expression**: [`Expression`](Expression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1563 + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Statement`](Statement.md).[`flags`](Statement.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`SwitchStatement`](../enumerations/SyntaxKind.md#switchstatement) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1562 + +#### Overrides + +[`Statement`](Statement.md).[`kind`](Statement.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Statement`](Statement.md).[`locals`](Statement.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Statement`](Statement.md).[`modifiers`](Statement.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`Statement`](Statement.md).[`parent`](Statement.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Statement`](Statement.md).[`pos`](Statement.md#pos) + +*** + +### possiblyExhaustive? + +> `optional` **possiblyExhaustive**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1565 + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Statement`](Statement.md).[`skipCheck`](Statement.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Statement`](Statement.md).[`symbol`](Statement.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Statement`](Statement.md).[`forEachChild`](Statement.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getChildAt`](Statement.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getChildCount`](Statement.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Statement`](Statement.md).[`getChildren`](Statement.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getEnd`](Statement.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getFirstToken`](Statement.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getFullStart`](Statement.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Statement`](Statement.md).[`getFullText`](Statement.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getFullWidth`](Statement.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getLastToken`](Statement.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getLeadingTriviaWidth`](Statement.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getSourceFile`](Statement.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getStart`](Statement.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Statement`](Statement.md).[`getText`](Statement.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getWidth`](Statement.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/Symbol.md b/docs/api_docs/namespaces/ts/interfaces/Symbol.md new file mode 100644 index 0000000000000000000000000000000000000000..342d051a626a2c430fe00817c7c19deb63468a1d --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/Symbol.md @@ -0,0 +1,165 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / Symbol + +# Interface: Symbol + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2668 + +## Properties + +### declarations? + +> `optional` **declarations**: [`Declaration`](Declaration.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2671 + +*** + +### escapedName + +> **escapedName**: [`__String`](../type-aliases/String.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2670 + +*** + +### exports? + +> `optional` **exports**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2674 + +*** + +### exportSymbol? + +> `optional` **exportSymbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2676 + +*** + +### flags + +> **flags**: [`SymbolFlags`](../enumerations/SymbolFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2669 + +*** + +### globalExports? + +> `optional` **globalExports**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2675 + +*** + +### members? + +> `optional` **members**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2673 + +*** + +### name + +> `readonly` **name**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6111 + +*** + +### valueDeclaration? + +> `optional` **valueDeclaration**: [`Declaration`](Declaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2672 + +## Methods + +### getDeclarations() + +> **getDeclarations**(): `undefined` \| [`Declaration`](Declaration.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6115 + +#### Returns + +`undefined` \| [`Declaration`](Declaration.md)[] + +*** + +### getDocumentationComment() + +> **getDocumentationComment**(`typeChecker`): [`SymbolDisplayPart`](SymbolDisplayPart.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6116 + +#### Parameters + +##### typeChecker + +`undefined` | [`TypeChecker`](TypeChecker.md) + +#### Returns + +[`SymbolDisplayPart`](SymbolDisplayPart.md)[] + +*** + +### getEscapedName() + +> **getEscapedName**(): [`__String`](../type-aliases/String.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6113 + +#### Returns + +[`__String`](../type-aliases/String.md) + +*** + +### getFlags() + +> **getFlags**(): [`SymbolFlags`](../enumerations/SymbolFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6112 + +#### Returns + +[`SymbolFlags`](../enumerations/SymbolFlags.md) + +*** + +### getJsDocTags() + +> **getJsDocTags**(`checker`?): [`JSDocTagInfo`](JSDocTagInfo-1.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6117 + +#### Parameters + +##### checker? + +[`TypeChecker`](TypeChecker.md) + +#### Returns + +[`JSDocTagInfo`](JSDocTagInfo-1.md)[] + +*** + +### getName() + +> **getName**(): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6114 + +#### Returns + +`string` diff --git a/docs/api_docs/namespaces/ts/interfaces/SymbolDisplayPart.md b/docs/api_docs/namespaces/ts/interfaces/SymbolDisplayPart.md new file mode 100644 index 0000000000000000000000000000000000000000..3b93c0577c2d5a5e145e2ff5ecab104aa18fc7a9 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/SymbolDisplayPart.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / SymbolDisplayPart + +# Interface: SymbolDisplayPart + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2265 + +## Extended by + +- [`JSDocLinkDisplayPart`](JSDocLinkDisplayPart.md) + +## Properties + +### kind + +> **kind**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2267 + +*** + +### text + +> **text**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2266 diff --git a/docs/api_docs/namespaces/ts/interfaces/SymbolTracker.md b/docs/api_docs/namespaces/ts/interfaces/SymbolTracker.md new file mode 100644 index 0000000000000000000000000000000000000000..36dafb81432295539fc1177c010c518478bf8c08 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/SymbolTracker.md @@ -0,0 +1,231 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / SymbolTracker + +# Interface: SymbolTracker + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4376 + +## Properties + +### moduleResolverHost? + +> `optional` **moduleResolverHost**: [`ModuleSpecifierResolutionHost`](ModuleSpecifierResolutionHost.md) & `object` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4384 + +#### Type declaration + +##### getCommonSourceDirectory() + +###### Returns + +`string` + +## Methods + +### reportCyclicStructureError()? + +> `optional` **reportCyclicStructureError**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4381 + +#### Returns + +`void` + +*** + +### reportImportTypeNodeResolutionModeOverride()? + +> `optional` **reportImportTypeNodeResolutionModeOverride**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4391 + +#### Returns + +`void` + +*** + +### reportInaccessibleThisError()? + +> `optional` **reportInaccessibleThisError**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4378 + +#### Returns + +`void` + +*** + +### reportInaccessibleUniqueSymbolError()? + +> `optional` **reportInaccessibleUniqueSymbolError**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4380 + +#### Returns + +`void` + +*** + +### reportLikelyUnsafeImportRequiredError()? + +> `optional` **reportLikelyUnsafeImportRequiredError**(`specifier`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4382 + +#### Parameters + +##### specifier + +`string` + +#### Returns + +`void` + +*** + +### reportNonlocalAugmentation()? + +> `optional` **reportNonlocalAugmentation**(`containingFile`, `parentSymbol`, `augmentingSymbol`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4389 + +#### Parameters + +##### containingFile + +[`SourceFile`](SourceFile.md) + +##### parentSymbol + +[`Symbol`](Symbol.md) + +##### augmentingSymbol + +[`Symbol`](Symbol.md) + +#### Returns + +`void` + +*** + +### reportNonSerializableProperty()? + +> `optional` **reportNonSerializableProperty**(`propertyName`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4390 + +#### Parameters + +##### propertyName + +`string` + +#### Returns + +`void` + +*** + +### reportPrivateInBaseOfClassExpression()? + +> `optional` **reportPrivateInBaseOfClassExpression**(`propertyName`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4379 + +#### Parameters + +##### propertyName + +`string` + +#### Returns + +`void` + +*** + +### reportTruncationError()? + +> `optional` **reportTruncationError**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4383 + +#### Returns + +`void` + +*** + +### trackExternalModuleSymbolOfImportTypeNode()? + +> `optional` **trackExternalModuleSymbolOfImportTypeNode**(`symbol`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4388 + +#### Parameters + +##### symbol + +[`Symbol`](Symbol.md) + +#### Returns + +`void` + +*** + +### trackReferencedAmbientModule()? + +> `optional` **trackReferencedAmbientModule**(`decl`, `symbol`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4387 + +#### Parameters + +##### decl + +[`ModuleDeclaration`](ModuleDeclaration.md) + +##### symbol + +[`Symbol`](Symbol.md) + +#### Returns + +`void` + +*** + +### trackSymbol()? + +> `optional` **trackSymbol**(`symbol`, `enclosingDeclaration`, `meaning`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4377 + +#### Parameters + +##### symbol + +[`Symbol`](Symbol.md) + +##### enclosingDeclaration + +`undefined` | [`Node`](Node.md) + +##### meaning + +[`SymbolFlags`](../enumerations/SymbolFlags.md) + +#### Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/interfaces/SyntaxList.md b/docs/api_docs/namespaces/ts/interfaces/SyntaxList.md new file mode 100644 index 0000000000000000000000000000000000000000..05ddfc4cde913a54283ca8714a9e60e35edaeefe --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/SyntaxList.md @@ -0,0 +1,485 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / SyntaxList + +# Interface: SyntaxList + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4401 + +## Extends + +- [`Node`](Node.md) + +## Properties + +### \_children + +> **\_children**: [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4403 + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`decorators`](Node.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Node`](Node.md).[`end`](Node.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Node`](Node.md).[`flags`](Node.md#flags) + +*** + +### kind + +> **kind**: [`SyntaxList`](../enumerations/SyntaxKind.md#syntaxlist) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4402 + +#### Overrides + +[`Node`](Node.md).[`kind`](Node.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Node`](Node.md).[`locals`](Node.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`modifiers`](Node.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`Node`](Node.md).[`parent`](Node.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Node`](Node.md).[`pos`](Node.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Node`](Node.md).[`skipCheck`](Node.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Node`](Node.md).[`symbol`](Node.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Node`](Node.md).[`forEachChild`](Node.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getChildAt`](Node.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getChildCount`](Node.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Node`](Node.md).[`getChildren`](Node.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getEnd`](Node.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getFirstToken`](Node.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullStart`](Node.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getFullText`](Node.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullWidth`](Node.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getLastToken`](Node.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getLeadingTriviaWidth`](Node.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Node`](Node.md).[`getSourceFile`](Node.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getStart`](Node.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getText`](Node.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getWidth`](Node.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/SynthesizedComment.md b/docs/api_docs/namespaces/ts/interfaces/SynthesizedComment.md new file mode 100644 index 0000000000000000000000000000000000000000..fc135eea1df7b60603ed4af5a3076fc4bffcda44 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/SynthesizedComment.md @@ -0,0 +1,77 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / SynthesizedComment + +# Interface: SynthesizedComment + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1850 + +## Extends + +- [`CommentRange`](CommentRange.md) + +## Properties + +### end + +> **end**: `-1` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1853 + +#### Overrides + +[`CommentRange`](CommentRange.md).[`end`](CommentRange.md#end) + +*** + +### hasLeadingNewline? + +> `optional` **hasLeadingNewline**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1854 + +*** + +### hasTrailingNewLine? + +> `optional` **hasTrailingNewLine**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1847 + +#### Inherited from + +[`CommentRange`](CommentRange.md).[`hasTrailingNewLine`](CommentRange.md#hastrailingnewline) + +*** + +### kind + +> **kind**: [`CommentKind`](../type-aliases/CommentKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1848 + +#### Inherited from + +[`CommentRange`](CommentRange.md).[`kind`](CommentRange.md#kind) + +*** + +### pos + +> **pos**: `-1` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1852 + +#### Overrides + +[`CommentRange`](CommentRange.md).[`pos`](CommentRange.md#pos) + +*** + +### text + +> **text**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1851 diff --git a/docs/api_docs/namespaces/ts/interfaces/SyntheticExpression.md b/docs/api_docs/namespaces/ts/interfaces/SyntheticExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..186c5150397f4a73601b7c377a70f25ed5cec9b9 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/SyntheticExpression.md @@ -0,0 +1,513 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / SyntheticExpression + +# Interface: SyntheticExpression + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1134 + +## Extends + +- [`Expression`](Expression.md) + +## Properties + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`Expression`](Expression.md).[`_expressionBrand`](Expression.md#_expressionbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Expression`](Expression.md).[`decorators`](Expression.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Expression`](Expression.md).[`end`](Expression.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Expression`](Expression.md).[`flags`](Expression.md#flags) + +*** + +### isSpread + +> `readonly` **isSpread**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1136 + +*** + +### kind + +> `readonly` **kind**: [`SyntheticExpression`](../enumerations/SyntaxKind.md#syntheticexpression) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1135 + +#### Overrides + +[`Expression`](Expression.md).[`kind`](Expression.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Expression`](Expression.md).[`locals`](Expression.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Expression`](Expression.md).[`modifiers`](Expression.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`Expression`](Expression.md).[`parent`](Expression.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Expression`](Expression.md).[`pos`](Expression.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Expression`](Expression.md).[`skipCheck`](Expression.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Expression`](Expression.md).[`symbol`](Expression.md#symbol) + +*** + +### tupleNameSource? + +> `readonly` `optional` **tupleNameSource**: [`ParameterDeclaration`](ParameterDeclaration.md) \| [`NamedTupleMember`](NamedTupleMember.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1138 + +*** + +### type + +> `readonly` **type**: [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1137 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Expression`](Expression.md).[`forEachChild`](Expression.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Expression`](Expression.md).[`getChildAt`](Expression.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getChildCount`](Expression.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Expression`](Expression.md).[`getChildren`](Expression.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getEnd`](Expression.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Expression`](Expression.md).[`getFirstToken`](Expression.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getFullStart`](Expression.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Expression`](Expression.md).[`getFullText`](Expression.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getFullWidth`](Expression.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Expression`](Expression.md).[`getLastToken`](Expression.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getLeadingTriviaWidth`](Expression.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Expression`](Expression.md).[`getSourceFile`](Expression.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getStart`](Expression.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Expression`](Expression.md).[`getText`](Expression.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getWidth`](Expression.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/System.md b/docs/api_docs/namespaces/ts/interfaces/System.md new file mode 100644 index 0000000000000000000000000000000000000000..87194043d9fac512ab1165a478e2b2712d6e9a6c --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/System.md @@ -0,0 +1,592 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / System + +# Interface: System + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4523 + +## Properties + +### args + +> **args**: `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4524 + +*** + +### newLine + +> **newLine**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4525 + +*** + +### useCaseSensitiveFileNames + +> **useCaseSensitiveFileNames**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4526 + +## Methods + +### base64decode()? + +> `optional` **base64decode**(`input`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4562 + +#### Parameters + +##### input + +`string` + +#### Returns + +`string` + +*** + +### base64encode()? + +> `optional` **base64encode**(`input`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4563 + +#### Parameters + +##### input + +`string` + +#### Returns + +`string` + +*** + +### clearScreen()? + +> `optional` **clearScreen**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4561 + +#### Returns + +`void` + +*** + +### clearTimeout()? + +> `optional` **clearTimeout**(`timeoutId`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4560 + +#### Parameters + +##### timeoutId + +`any` + +#### Returns + +`void` + +*** + +### createDirectory() + +> **createDirectory**(`path`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4542 + +#### Parameters + +##### path + +`string` + +#### Returns + +`void` + +*** + +### createHash()? + +> `optional` **createHash**(`data`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4553 + +A good implementation is node.js' `crypto.createHash`. (https://nodejs.org/api/crypto.html#crypto_crypto_createhash_algorithm) + +#### Parameters + +##### data + +`string` + +#### Returns + +`string` + +*** + +### createSHA256Hash()? + +> `optional` **createSHA256Hash**(`data`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4555 + +This must be cryptographically secure. Only implement this method using `crypto.createHash("sha256")`. + +#### Parameters + +##### data + +`string` + +#### Returns + +`string` + +*** + +### deleteFile()? + +> `optional` **deleteFile**(`path`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4549 + +#### Parameters + +##### path + +`string` + +#### Returns + +`void` + +*** + +### directoryExists() + +> **directoryExists**(`path`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4541 + +#### Parameters + +##### path + +`string` + +#### Returns + +`boolean` + +*** + +### exit() + +> **exit**(`exitCode`?): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4557 + +#### Parameters + +##### exitCode? + +`number` + +#### Returns + +`void` + +*** + +### fileExists() + +> **fileExists**(`path`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4540 + +#### Parameters + +##### path + +`string` + +#### Returns + +`boolean` + +*** + +### getCurrentDirectory() + +> **getCurrentDirectory**(): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4544 + +#### Returns + +`string` + +*** + +### getDirectories() + +> **getDirectories**(`path`): `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4545 + +#### Parameters + +##### path + +`string` + +#### Returns + +`string`[] + +*** + +### getExecutingFilePath() + +> **getExecutingFilePath**(): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4543 + +#### Returns + +`string` + +*** + +### getFileSize()? + +> `optional` **getFileSize**(`path`): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4531 + +#### Parameters + +##### path + +`string` + +#### Returns + +`number` + +*** + +### getMemoryUsage()? + +> `optional` **getMemoryUsage**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4556 + +#### Returns + +`number` + +*** + +### getModifiedTime()? + +> `optional` **getModifiedTime**(`path`): `undefined` \| `Date` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4547 + +#### Parameters + +##### path + +`string` + +#### Returns + +`undefined` \| `Date` + +*** + +### getWidthOfTerminal()? + +> `optional` **getWidthOfTerminal**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4529 + +#### Returns + +`number` + +*** + +### readDirectory() + +> **readDirectory**(`path`, `extensions`?, `exclude`?, `include`?, `depth`?): `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4546 + +#### Parameters + +##### path + +`string` + +##### extensions? + +readonly `string`[] + +##### exclude? + +readonly `string`[] + +##### include? + +readonly `string`[] + +##### depth? + +`number` + +#### Returns + +`string`[] + +*** + +### readFile() + +> **readFile**(`path`, `encoding`?): `undefined` \| `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4530 + +#### Parameters + +##### path + +`string` + +##### encoding? + +`string` + +#### Returns + +`undefined` \| `string` + +*** + +### realpath()? + +> `optional` **realpath**(`path`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4558 + +#### Parameters + +##### path + +`string` + +#### Returns + +`string` + +*** + +### resolvePath() + +> **resolvePath**(`path`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4539 + +#### Parameters + +##### path + +`string` + +#### Returns + +`string` + +*** + +### setModifiedTime()? + +> `optional` **setModifiedTime**(`path`, `time`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4548 + +#### Parameters + +##### path + +`string` + +##### time + +`Date` + +#### Returns + +`void` + +*** + +### setTimeout()? + +> `optional` **setTimeout**(`callback`, `ms`, ...`args`): `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4559 + +#### Parameters + +##### callback + +(...`args`) => `void` + +##### ms + +`number` + +##### args + +...`any`[] + +#### Returns + +`any` + +*** + +### watchDirectory()? + +> `optional` **watchDirectory**(`path`, `callback`, `recursive`?, `options`?): [`FileWatcher`](FileWatcher.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4538 + +#### Parameters + +##### path + +`string` + +##### callback + +[`DirectoryWatcherCallback`](../type-aliases/DirectoryWatcherCallback.md) + +##### recursive? + +`boolean` + +##### options? + +[`WatchOptions`](WatchOptions.md) + +#### Returns + +[`FileWatcher`](FileWatcher.md) + +*** + +### watchFile()? + +> `optional` **watchFile**(`path`, `callback`, `pollingInterval`?, `options`?): [`FileWatcher`](FileWatcher.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4537 + +#### Parameters + +##### path + +`string` + +##### callback + +[`FileWatcherCallback`](../type-aliases/FileWatcherCallback.md) + +##### pollingInterval? + +`number` + +##### options? + +[`WatchOptions`](WatchOptions.md) + +#### Returns + +[`FileWatcher`](FileWatcher.md) + +#### Polling Interval + +- this parameter is used in polling-based watchers and ignored in watchers that +use native OS file watching + +*** + +### write() + +> **write**(`s`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4527 + +#### Parameters + +##### s + +`string` + +#### Returns + +`void` + +*** + +### writeFile() + +> **writeFile**(`path`, `data`, `writeByteOrderMark`?): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4532 + +#### Parameters + +##### path + +`string` + +##### data + +`string` + +##### writeByteOrderMark? + +`boolean` + +#### Returns + +`void` + +*** + +### writeOutputIsTTY()? + +> `optional` **writeOutputIsTTY**(): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4528 + +#### Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/interfaces/TagCheckConfig.md b/docs/api_docs/namespaces/ts/interfaces/TagCheckConfig.md new file mode 100644 index 0000000000000000000000000000000000000000..52f3dc16d6c49fc0ddf5e96aec13c3a6f1c04302 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/TagCheckConfig.md @@ -0,0 +1,41 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TagCheckConfig + +# Interface: TagCheckConfig + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3462 + +## Properties + +### message + +> **message**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3464 + +*** + +### needConditionCheck + +> **needConditionCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3465 + +*** + +### specifyCheckConditionFuncName + +> **specifyCheckConditionFuncName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3466 + +*** + +### tagName + +> **tagName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3463 diff --git a/docs/api_docs/namespaces/ts/interfaces/TagCheckParam.md b/docs/api_docs/namespaces/ts/interfaces/TagCheckParam.md new file mode 100644 index 0000000000000000000000000000000000000000..cd8a326b30935da02c029af8507a0c48f842e18c --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/TagCheckParam.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TagCheckParam + +# Interface: TagCheckParam + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3458 + +## Properties + +### checkConfig + +> **checkConfig**: [`TagCheckConfig`](TagCheckConfig.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3460 + +*** + +### needCheck + +> **needCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3459 diff --git a/docs/api_docs/namespaces/ts/interfaces/TaggedTemplateExpression.md b/docs/api_docs/namespaces/ts/interfaces/TaggedTemplateExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..619ae9ef45def0665b3ef3cbdfd30bd26ef409d8 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/TaggedTemplateExpression.md @@ -0,0 +1,561 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TaggedTemplateExpression + +# Interface: TaggedTemplateExpression + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1363 + +## Extends + +- [`MemberExpression`](MemberExpression.md) + +## Properties + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`_expressionBrand`](MemberExpression.md#_expressionbrand) + +*** + +### \_leftHandSideExpressionBrand + +> **\_leftHandSideExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1086 + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`_leftHandSideExpressionBrand`](MemberExpression.md#_lefthandsideexpressionbrand) + +*** + +### \_memberExpressionBrand + +> **\_memberExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1089 + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`_memberExpressionBrand`](MemberExpression.md#_memberexpressionbrand) + +*** + +### \_unaryExpressionBrand + +> **\_unaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1066 + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`_unaryExpressionBrand`](MemberExpression.md#_unaryexpressionbrand) + +*** + +### \_updateExpressionBrand + +> **\_updateExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1071 + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`_updateExpressionBrand`](MemberExpression.md#_updateexpressionbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`decorators`](MemberExpression.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`end`](MemberExpression.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`flags`](MemberExpression.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`TaggedTemplateExpression`](../enumerations/SyntaxKind.md#taggedtemplateexpression) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1364 + +#### Overrides + +[`MemberExpression`](MemberExpression.md).[`kind`](MemberExpression.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`locals`](MemberExpression.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`modifiers`](MemberExpression.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`parent`](MemberExpression.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`pos`](MemberExpression.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`skipCheck`](MemberExpression.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`symbol`](MemberExpression.md#symbol) + +*** + +### tag + +> `readonly` **tag**: [`LeftHandSideExpression`](LeftHandSideExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1365 + +*** + +### template + +> `readonly` **template**: [`TemplateLiteral`](../type-aliases/TemplateLiteral.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1367 + +*** + +### typeArguments? + +> `readonly` `optional` **typeArguments**: [`NodeArray`](NodeArray.md)\<[`TypeNode`](TypeNode.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1366 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`forEachChild`](MemberExpression.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`getChildAt`](MemberExpression.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`getChildCount`](MemberExpression.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`getChildren`](MemberExpression.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`getEnd`](MemberExpression.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`getFirstToken`](MemberExpression.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`getFullStart`](MemberExpression.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`getFullText`](MemberExpression.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`getFullWidth`](MemberExpression.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`getLastToken`](MemberExpression.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`getLeadingTriviaWidth`](MemberExpression.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`getSourceFile`](MemberExpression.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`getStart`](MemberExpression.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`getText`](MemberExpression.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`MemberExpression`](MemberExpression.md).[`getWidth`](MemberExpression.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/TemplateExpression.md b/docs/api_docs/namespaces/ts/interfaces/TemplateExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..b52685a3fd116ba957f232b176460b5fa4b003ed --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/TemplateExpression.md @@ -0,0 +1,565 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TemplateExpression + +# Interface: TemplateExpression + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1264 + +## Extends + +- [`PrimaryExpression`](PrimaryExpression.md) + +## Properties + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_expressionBrand`](PrimaryExpression.md#_expressionbrand) + +*** + +### \_leftHandSideExpressionBrand + +> **\_leftHandSideExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1086 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_leftHandSideExpressionBrand`](PrimaryExpression.md#_lefthandsideexpressionbrand) + +*** + +### \_memberExpressionBrand + +> **\_memberExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1089 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_memberExpressionBrand`](PrimaryExpression.md#_memberexpressionbrand) + +*** + +### \_primaryExpressionBrand + +> **\_primaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1092 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_primaryExpressionBrand`](PrimaryExpression.md#_primaryexpressionbrand) + +*** + +### \_unaryExpressionBrand + +> **\_unaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1066 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_unaryExpressionBrand`](PrimaryExpression.md#_unaryexpressionbrand) + +*** + +### \_updateExpressionBrand + +> **\_updateExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1071 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_updateExpressionBrand`](PrimaryExpression.md#_updateexpressionbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`decorators`](PrimaryExpression.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`end`](PrimaryExpression.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`flags`](PrimaryExpression.md#flags) + +*** + +### head + +> `readonly` **head**: [`TemplateHead`](TemplateHead.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1266 + +*** + +### kind + +> `readonly` **kind**: [`TemplateExpression`](../enumerations/SyntaxKind.md#templateexpression) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1265 + +#### Overrides + +[`PrimaryExpression`](PrimaryExpression.md).[`kind`](PrimaryExpression.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`locals`](PrimaryExpression.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`modifiers`](PrimaryExpression.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`parent`](PrimaryExpression.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`pos`](PrimaryExpression.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`skipCheck`](PrimaryExpression.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`symbol`](PrimaryExpression.md#symbol) + +*** + +### templateSpans + +> `readonly` **templateSpans**: [`NodeArray`](NodeArray.md)\<[`TemplateSpan`](TemplateSpan.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1267 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`forEachChild`](PrimaryExpression.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getChildAt`](PrimaryExpression.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getChildCount`](PrimaryExpression.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getChildren`](PrimaryExpression.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getEnd`](PrimaryExpression.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFirstToken`](PrimaryExpression.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFullStart`](PrimaryExpression.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFullText`](PrimaryExpression.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFullWidth`](PrimaryExpression.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getLastToken`](PrimaryExpression.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getLeadingTriviaWidth`](PrimaryExpression.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getSourceFile`](PrimaryExpression.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getStart`](PrimaryExpression.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getText`](PrimaryExpression.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getWidth`](PrimaryExpression.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/TemplateHead.md b/docs/api_docs/namespaces/ts/interfaces/TemplateHead.md new file mode 100644 index 0000000000000000000000000000000000000000..343af82b667825fde72f0c12cc60dbbe8a587b40 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/TemplateHead.md @@ -0,0 +1,525 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TemplateHead + +# Interface: TemplateHead + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1250 + +## Extends + +- [`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md) + +## Properties + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`decorators`](TemplateLiteralLikeNode.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`end`](TemplateLiteralLikeNode.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`flags`](TemplateLiteralLikeNode.md#flags) + +*** + +### hasExtendedUnicodeEscape? + +> `optional` **hasExtendedUnicodeEscape**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1221 + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`hasExtendedUnicodeEscape`](TemplateLiteralLikeNode.md#hasextendedunicodeescape) + +*** + +### isUnterminated? + +> `optional` **isUnterminated**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1220 + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`isUnterminated`](TemplateLiteralLikeNode.md#isunterminated) + +*** + +### kind + +> `readonly` **kind**: [`TemplateHead`](../enumerations/SyntaxKind.md#templatehead) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1251 + +#### Overrides + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`kind`](TemplateLiteralLikeNode.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`locals`](TemplateLiteralLikeNode.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`modifiers`](TemplateLiteralLikeNode.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`TemplateExpression`](TemplateExpression.md) \| [`TemplateLiteralTypeNode`](TemplateLiteralTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1252 + +#### Overrides + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`parent`](TemplateLiteralLikeNode.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`pos`](TemplateLiteralLikeNode.md#pos) + +*** + +### rawText? + +> `optional` **rawText**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1224 + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`rawText`](TemplateLiteralLikeNode.md#rawtext) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`skipCheck`](TemplateLiteralLikeNode.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`symbol`](TemplateLiteralLikeNode.md#symbol) + +*** + +### text + +> **text**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1219 + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`text`](TemplateLiteralLikeNode.md#text) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`forEachChild`](TemplateLiteralLikeNode.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`getChildAt`](TemplateLiteralLikeNode.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`getChildCount`](TemplateLiteralLikeNode.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`getChildren`](TemplateLiteralLikeNode.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`getEnd`](TemplateLiteralLikeNode.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`getFirstToken`](TemplateLiteralLikeNode.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`getFullStart`](TemplateLiteralLikeNode.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`getFullText`](TemplateLiteralLikeNode.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`getFullWidth`](TemplateLiteralLikeNode.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`getLastToken`](TemplateLiteralLikeNode.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`getLeadingTriviaWidth`](TemplateLiteralLikeNode.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`getSourceFile`](TemplateLiteralLikeNode.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`getStart`](TemplateLiteralLikeNode.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`getText`](TemplateLiteralLikeNode.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`getWidth`](TemplateLiteralLikeNode.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/TemplateLiteralLikeNode.md b/docs/api_docs/namespaces/ts/interfaces/TemplateLiteralLikeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..894cbe591d399156ac46cf2fca27f06aa393d034 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/TemplateLiteralLikeNode.md @@ -0,0 +1,528 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TemplateLiteralLikeNode + +# Interface: TemplateLiteralLikeNode + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1223 + +## Extends + +- [`LiteralLikeNode`](LiteralLikeNode.md) + +## Extended by + +- [`NoSubstitutionTemplateLiteral`](NoSubstitutionTemplateLiteral.md) +- [`TemplateHead`](TemplateHead.md) +- [`TemplateMiddle`](TemplateMiddle.md) +- [`TemplateTail`](TemplateTail.md) + +## Properties + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`LiteralLikeNode`](LiteralLikeNode.md).[`decorators`](LiteralLikeNode.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`LiteralLikeNode`](LiteralLikeNode.md).[`end`](LiteralLikeNode.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`LiteralLikeNode`](LiteralLikeNode.md).[`flags`](LiteralLikeNode.md#flags) + +*** + +### hasExtendedUnicodeEscape? + +> `optional` **hasExtendedUnicodeEscape**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1221 + +#### Inherited from + +[`LiteralLikeNode`](LiteralLikeNode.md).[`hasExtendedUnicodeEscape`](LiteralLikeNode.md#hasextendedunicodeescape) + +*** + +### isUnterminated? + +> `optional` **isUnterminated**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1220 + +#### Inherited from + +[`LiteralLikeNode`](LiteralLikeNode.md).[`isUnterminated`](LiteralLikeNode.md#isunterminated) + +*** + +### kind + +> `readonly` **kind**: [`SyntaxKind`](../enumerations/SyntaxKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:598 + +#### Inherited from + +[`LiteralLikeNode`](LiteralLikeNode.md).[`kind`](LiteralLikeNode.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`LiteralLikeNode`](LiteralLikeNode.md).[`locals`](LiteralLikeNode.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`LiteralLikeNode`](LiteralLikeNode.md).[`modifiers`](LiteralLikeNode.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`LiteralLikeNode`](LiteralLikeNode.md).[`parent`](LiteralLikeNode.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`LiteralLikeNode`](LiteralLikeNode.md).[`pos`](LiteralLikeNode.md#pos) + +*** + +### rawText? + +> `optional` **rawText**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1224 + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`LiteralLikeNode`](LiteralLikeNode.md).[`skipCheck`](LiteralLikeNode.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`LiteralLikeNode`](LiteralLikeNode.md).[`symbol`](LiteralLikeNode.md#symbol) + +*** + +### text + +> **text**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1219 + +#### Inherited from + +[`LiteralLikeNode`](LiteralLikeNode.md).[`text`](LiteralLikeNode.md#text) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`LiteralLikeNode`](LiteralLikeNode.md).[`forEachChild`](LiteralLikeNode.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`LiteralLikeNode`](LiteralLikeNode.md).[`getChildAt`](LiteralLikeNode.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`LiteralLikeNode`](LiteralLikeNode.md).[`getChildCount`](LiteralLikeNode.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`LiteralLikeNode`](LiteralLikeNode.md).[`getChildren`](LiteralLikeNode.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`LiteralLikeNode`](LiteralLikeNode.md).[`getEnd`](LiteralLikeNode.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`LiteralLikeNode`](LiteralLikeNode.md).[`getFirstToken`](LiteralLikeNode.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`LiteralLikeNode`](LiteralLikeNode.md).[`getFullStart`](LiteralLikeNode.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`LiteralLikeNode`](LiteralLikeNode.md).[`getFullText`](LiteralLikeNode.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`LiteralLikeNode`](LiteralLikeNode.md).[`getFullWidth`](LiteralLikeNode.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`LiteralLikeNode`](LiteralLikeNode.md).[`getLastToken`](LiteralLikeNode.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`LiteralLikeNode`](LiteralLikeNode.md).[`getLeadingTriviaWidth`](LiteralLikeNode.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`LiteralLikeNode`](LiteralLikeNode.md).[`getSourceFile`](LiteralLikeNode.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`LiteralLikeNode`](LiteralLikeNode.md).[`getStart`](LiteralLikeNode.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`LiteralLikeNode`](LiteralLikeNode.md).[`getText`](LiteralLikeNode.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`LiteralLikeNode`](LiteralLikeNode.md).[`getWidth`](LiteralLikeNode.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/TemplateLiteralType.md b/docs/api_docs/namespaces/ts/interfaces/TemplateLiteralType.md new file mode 100644 index 0000000000000000000000000000000000000000..b2e1258c8dc253a17c9982eddbbee3d81c415503 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/TemplateLiteralType.md @@ -0,0 +1,463 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TemplateLiteralType + +# Interface: TemplateLiteralType + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2919 + +## Extends + +- [`InstantiableType`](InstantiableType.md) + +## Properties + +### aliasSymbol? + +> `optional` **aliasSymbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2773 + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`aliasSymbol`](InstantiableType.md#aliassymbol) + +*** + +### aliasTypeArguments? + +> `optional` **aliasTypeArguments**: readonly [`Type`](Type.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2774 + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`aliasTypeArguments`](InstantiableType.md#aliastypearguments) + +*** + +### flags + +> **flags**: [`TypeFlags`](../enumerations/TypeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2770 + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`flags`](InstantiableType.md#flags) + +*** + +### pattern? + +> `optional` **pattern**: [`DestructuringPattern`](../type-aliases/DestructuringPattern.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2772 + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`pattern`](InstantiableType.md#pattern) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2771 + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`symbol`](InstantiableType.md#symbol) + +*** + +### texts + +> **texts**: readonly `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2920 + +*** + +### types + +> **types**: readonly [`Type`](Type.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2921 + +## Methods + +### getApparentProperties() + +> **getApparentProperties**(): [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6124 + +#### Returns + +[`Symbol`](Symbol.md)[] + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getApparentProperties`](InstantiableType.md#getapparentproperties) + +*** + +### getBaseTypes() + +> **getBaseTypes**(): `undefined` \| [`BaseType`](../type-aliases/BaseType.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6129 + +#### Returns + +`undefined` \| [`BaseType`](../type-aliases/BaseType.md)[] + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getBaseTypes`](InstantiableType.md#getbasetypes) + +*** + +### getCallSignatures() + +> **getCallSignatures**(): readonly [`Signature`](Signature.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6125 + +#### Returns + +readonly [`Signature`](Signature.md)[] + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getCallSignatures`](InstantiableType.md#getcallsignatures) + +*** + +### getConstraint() + +> **getConstraint**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6131 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getConstraint`](InstantiableType.md#getconstraint) + +*** + +### getConstructSignatures() + +> **getConstructSignatures**(): readonly [`Signature`](Signature.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6126 + +#### Returns + +readonly [`Signature`](Signature.md)[] + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getConstructSignatures`](InstantiableType.md#getconstructsignatures) + +*** + +### getDefault() + +> **getDefault**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6132 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getDefault`](InstantiableType.md#getdefault) + +*** + +### getFlags() + +> **getFlags**(): [`TypeFlags`](../enumerations/TypeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6120 + +#### Returns + +[`TypeFlags`](../enumerations/TypeFlags.md) + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getFlags`](InstantiableType.md#getflags) + +*** + +### getNonNullableType() + +> **getNonNullableType**(): [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6130 + +#### Returns + +[`Type`](Type.md) + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getNonNullableType`](InstantiableType.md#getnonnullabletype) + +*** + +### getNumberIndexType() + +> **getNumberIndexType**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6128 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getNumberIndexType`](InstantiableType.md#getnumberindextype) + +*** + +### getProperties() + +> **getProperties**(): [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6122 + +#### Returns + +[`Symbol`](Symbol.md)[] + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getProperties`](InstantiableType.md#getproperties) + +*** + +### getProperty() + +> **getProperty**(`propertyName`): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6123 + +#### Parameters + +##### propertyName + +`string` + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getProperty`](InstantiableType.md#getproperty) + +*** + +### getStringIndexType() + +> **getStringIndexType**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6127 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getStringIndexType`](InstantiableType.md#getstringindextype) + +*** + +### getSymbol() + +> **getSymbol**(): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6121 + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getSymbol`](InstantiableType.md#getsymbol) + +*** + +### isClass() + +> **isClass**(): `this is InterfaceType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6141 + +#### Returns + +`this is InterfaceType` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isClass`](InstantiableType.md#isclass) + +*** + +### isClassOrInterface() + +> **isClassOrInterface**(): `this is InterfaceType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6140 + +#### Returns + +`this is InterfaceType` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isClassOrInterface`](InstantiableType.md#isclassorinterface) + +*** + +### isIndexType() + +> **isIndexType**(): `this is IndexType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6142 + +#### Returns + +`this is IndexType` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isIndexType`](InstantiableType.md#isindextype) + +*** + +### isIntersection() + +> **isIntersection**(): `this is IntersectionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6134 + +#### Returns + +`this is IntersectionType` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isIntersection`](InstantiableType.md#isintersection) + +*** + +### isLiteral() + +> **isLiteral**(): `this is LiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6136 + +#### Returns + +`this is LiteralType` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isLiteral`](InstantiableType.md#isliteral) + +*** + +### isNumberLiteral() + +> **isNumberLiteral**(): `this is NumberLiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6138 + +#### Returns + +`this is NumberLiteralType` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isNumberLiteral`](InstantiableType.md#isnumberliteral) + +*** + +### isStringLiteral() + +> **isStringLiteral**(): `this is StringLiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6137 + +#### Returns + +`this is StringLiteralType` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isStringLiteral`](InstantiableType.md#isstringliteral) + +*** + +### isTypeParameter() + +> **isTypeParameter**(): `this is TypeParameter` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6139 + +#### Returns + +`this is TypeParameter` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isTypeParameter`](InstantiableType.md#istypeparameter) + +*** + +### isUnion() + +> **isUnion**(): `this is UnionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6133 + +#### Returns + +`this is UnionType` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isUnion`](InstantiableType.md#isunion) + +*** + +### isUnionOrIntersection() + +> **isUnionOrIntersection**(): `this is UnionOrIntersectionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6135 + +#### Returns + +`this is UnionOrIntersectionType` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isUnionOrIntersection`](InstantiableType.md#isunionorintersection) diff --git a/docs/api_docs/namespaces/ts/interfaces/TemplateLiteralTypeNode.md b/docs/api_docs/namespaces/ts/interfaces/TemplateLiteralTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..f6635447360eac2e321569a0516c8cccf01ab7c1 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/TemplateLiteralTypeNode.md @@ -0,0 +1,505 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TemplateLiteralTypeNode + +# Interface: TemplateLiteralTypeNode + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1044 + +## Extends + +- [`TypeNode`](TypeNode.md) + +## Properties + +### \_typeNodeBrand + +> **\_typeNodeBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:912 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`_typeNodeBrand`](TypeNode.md#_typenodebrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`decorators`](TypeNode.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`end`](TypeNode.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`flags`](TypeNode.md#flags) + +*** + +### head + +> `readonly` **head**: [`TemplateHead`](TemplateHead.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1046 + +*** + +### kind + +> **kind**: [`TemplateLiteralType`](../enumerations/SyntaxKind.md#templateliteraltype) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1045 + +#### Overrides + +[`TypeNode`](TypeNode.md).[`kind`](TypeNode.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`locals`](TypeNode.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`modifiers`](TypeNode.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`parent`](TypeNode.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`pos`](TypeNode.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`skipCheck`](TypeNode.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`symbol`](TypeNode.md#symbol) + +*** + +### templateSpans + +> `readonly` **templateSpans**: [`NodeArray`](NodeArray.md)\<[`TemplateLiteralTypeSpan`](TemplateLiteralTypeSpan.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1047 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`forEachChild`](TypeNode.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getChildAt`](TypeNode.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getChildCount`](TypeNode.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getChildren`](TypeNode.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getEnd`](TypeNode.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFirstToken`](TypeNode.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFullStart`](TypeNode.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFullText`](TypeNode.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFullWidth`](TypeNode.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getLastToken`](TypeNode.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getLeadingTriviaWidth`](TypeNode.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getSourceFile`](TypeNode.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getStart`](TypeNode.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getText`](TypeNode.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getWidth`](TypeNode.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/TemplateLiteralTypeSpan.md b/docs/api_docs/namespaces/ts/interfaces/TemplateLiteralTypeSpan.md new file mode 100644 index 0000000000000000000000000000000000000000..8140c70bd3035a9d3a562a542fa8623c87e1330f --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/TemplateLiteralTypeSpan.md @@ -0,0 +1,505 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TemplateLiteralTypeSpan + +# Interface: TemplateLiteralTypeSpan + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1049 + +## Extends + +- [`TypeNode`](TypeNode.md) + +## Properties + +### \_typeNodeBrand + +> **\_typeNodeBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:912 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`_typeNodeBrand`](TypeNode.md#_typenodebrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`decorators`](TypeNode.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`end`](TypeNode.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`flags`](TypeNode.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`TemplateLiteralTypeSpan`](../enumerations/SyntaxKind.md#templateliteraltypespan) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1050 + +#### Overrides + +[`TypeNode`](TypeNode.md).[`kind`](TypeNode.md#kind) + +*** + +### literal + +> `readonly` **literal**: [`TemplateMiddle`](TemplateMiddle.md) \| [`TemplateTail`](TemplateTail.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1053 + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`locals`](TypeNode.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`modifiers`](TypeNode.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`TemplateLiteralTypeNode`](TemplateLiteralTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1051 + +#### Overrides + +[`TypeNode`](TypeNode.md).[`parent`](TypeNode.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`pos`](TypeNode.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`skipCheck`](TypeNode.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`symbol`](TypeNode.md#symbol) + +*** + +### type + +> `readonly` **type**: [`TypeNode`](TypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1052 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`forEachChild`](TypeNode.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getChildAt`](TypeNode.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getChildCount`](TypeNode.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getChildren`](TypeNode.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getEnd`](TypeNode.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFirstToken`](TypeNode.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFullStart`](TypeNode.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFullText`](TypeNode.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFullWidth`](TypeNode.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getLastToken`](TypeNode.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getLeadingTriviaWidth`](TypeNode.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getSourceFile`](TypeNode.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getStart`](TypeNode.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getText`](TypeNode.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getWidth`](TypeNode.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/TemplateMiddle.md b/docs/api_docs/namespaces/ts/interfaces/TemplateMiddle.md new file mode 100644 index 0000000000000000000000000000000000000000..53f9ffabfc413f7f488927af367b8a0cc1b2901b --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/TemplateMiddle.md @@ -0,0 +1,525 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TemplateMiddle + +# Interface: TemplateMiddle + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1254 + +## Extends + +- [`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md) + +## Properties + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`decorators`](TemplateLiteralLikeNode.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`end`](TemplateLiteralLikeNode.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`flags`](TemplateLiteralLikeNode.md#flags) + +*** + +### hasExtendedUnicodeEscape? + +> `optional` **hasExtendedUnicodeEscape**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1221 + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`hasExtendedUnicodeEscape`](TemplateLiteralLikeNode.md#hasextendedunicodeescape) + +*** + +### isUnterminated? + +> `optional` **isUnterminated**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1220 + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`isUnterminated`](TemplateLiteralLikeNode.md#isunterminated) + +*** + +### kind + +> `readonly` **kind**: [`TemplateMiddle`](../enumerations/SyntaxKind.md#templatemiddle) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1255 + +#### Overrides + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`kind`](TemplateLiteralLikeNode.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`locals`](TemplateLiteralLikeNode.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`modifiers`](TemplateLiteralLikeNode.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`TemplateSpan`](TemplateSpan.md) \| [`TemplateLiteralTypeSpan`](TemplateLiteralTypeSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1256 + +#### Overrides + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`parent`](TemplateLiteralLikeNode.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`pos`](TemplateLiteralLikeNode.md#pos) + +*** + +### rawText? + +> `optional` **rawText**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1224 + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`rawText`](TemplateLiteralLikeNode.md#rawtext) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`skipCheck`](TemplateLiteralLikeNode.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`symbol`](TemplateLiteralLikeNode.md#symbol) + +*** + +### text + +> **text**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1219 + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`text`](TemplateLiteralLikeNode.md#text) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`forEachChild`](TemplateLiteralLikeNode.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`getChildAt`](TemplateLiteralLikeNode.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`getChildCount`](TemplateLiteralLikeNode.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`getChildren`](TemplateLiteralLikeNode.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`getEnd`](TemplateLiteralLikeNode.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`getFirstToken`](TemplateLiteralLikeNode.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`getFullStart`](TemplateLiteralLikeNode.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`getFullText`](TemplateLiteralLikeNode.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`getFullWidth`](TemplateLiteralLikeNode.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`getLastToken`](TemplateLiteralLikeNode.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`getLeadingTriviaWidth`](TemplateLiteralLikeNode.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`getSourceFile`](TemplateLiteralLikeNode.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`getStart`](TemplateLiteralLikeNode.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`getText`](TemplateLiteralLikeNode.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`getWidth`](TemplateLiteralLikeNode.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/TemplateSpan.md b/docs/api_docs/namespaces/ts/interfaces/TemplateSpan.md new file mode 100644 index 0000000000000000000000000000000000000000..ab8e1b15bcba6423b132ce96aed0550ffb4bef2e --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/TemplateSpan.md @@ -0,0 +1,493 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TemplateSpan + +# Interface: TemplateSpan + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1270 + +## Extends + +- [`Node`](Node.md) + +## Properties + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`decorators`](Node.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Node`](Node.md).[`end`](Node.md#end) + +*** + +### expression + +> `readonly` **expression**: [`Expression`](Expression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1273 + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Node`](Node.md).[`flags`](Node.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`TemplateSpan`](../enumerations/SyntaxKind.md#templatespan) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1271 + +#### Overrides + +[`Node`](Node.md).[`kind`](Node.md#kind) + +*** + +### literal + +> `readonly` **literal**: [`TemplateMiddle`](TemplateMiddle.md) \| [`TemplateTail`](TemplateTail.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1274 + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Node`](Node.md).[`locals`](Node.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`modifiers`](Node.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`TemplateExpression`](TemplateExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1272 + +#### Overrides + +[`Node`](Node.md).[`parent`](Node.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Node`](Node.md).[`pos`](Node.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Node`](Node.md).[`skipCheck`](Node.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Node`](Node.md).[`symbol`](Node.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Node`](Node.md).[`forEachChild`](Node.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getChildAt`](Node.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getChildCount`](Node.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Node`](Node.md).[`getChildren`](Node.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getEnd`](Node.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getFirstToken`](Node.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullStart`](Node.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getFullText`](Node.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullWidth`](Node.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getLastToken`](Node.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getLeadingTriviaWidth`](Node.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Node`](Node.md).[`getSourceFile`](Node.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getStart`](Node.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getText`](Node.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getWidth`](Node.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/TemplateTail.md b/docs/api_docs/namespaces/ts/interfaces/TemplateTail.md new file mode 100644 index 0000000000000000000000000000000000000000..b3a0da4e4abf7a0043a799b74a18d1aa51594bdf --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/TemplateTail.md @@ -0,0 +1,525 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TemplateTail + +# Interface: TemplateTail + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1258 + +## Extends + +- [`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md) + +## Properties + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`decorators`](TemplateLiteralLikeNode.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`end`](TemplateLiteralLikeNode.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`flags`](TemplateLiteralLikeNode.md#flags) + +*** + +### hasExtendedUnicodeEscape? + +> `optional` **hasExtendedUnicodeEscape**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1221 + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`hasExtendedUnicodeEscape`](TemplateLiteralLikeNode.md#hasextendedunicodeescape) + +*** + +### isUnterminated? + +> `optional` **isUnterminated**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1220 + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`isUnterminated`](TemplateLiteralLikeNode.md#isunterminated) + +*** + +### kind + +> `readonly` **kind**: [`TemplateTail`](../enumerations/SyntaxKind.md#templatetail) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1259 + +#### Overrides + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`kind`](TemplateLiteralLikeNode.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`locals`](TemplateLiteralLikeNode.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`modifiers`](TemplateLiteralLikeNode.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`TemplateSpan`](TemplateSpan.md) \| [`TemplateLiteralTypeSpan`](TemplateLiteralTypeSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1260 + +#### Overrides + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`parent`](TemplateLiteralLikeNode.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`pos`](TemplateLiteralLikeNode.md#pos) + +*** + +### rawText? + +> `optional` **rawText**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1224 + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`rawText`](TemplateLiteralLikeNode.md#rawtext) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`skipCheck`](TemplateLiteralLikeNode.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`symbol`](TemplateLiteralLikeNode.md#symbol) + +*** + +### text + +> **text**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1219 + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`text`](TemplateLiteralLikeNode.md#text) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`forEachChild`](TemplateLiteralLikeNode.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`getChildAt`](TemplateLiteralLikeNode.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`getChildCount`](TemplateLiteralLikeNode.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`getChildren`](TemplateLiteralLikeNode.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`getEnd`](TemplateLiteralLikeNode.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`getFirstToken`](TemplateLiteralLikeNode.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`getFullStart`](TemplateLiteralLikeNode.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`getFullText`](TemplateLiteralLikeNode.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`getFullWidth`](TemplateLiteralLikeNode.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`getLastToken`](TemplateLiteralLikeNode.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`getLeadingTriviaWidth`](TemplateLiteralLikeNode.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`getSourceFile`](TemplateLiteralLikeNode.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`getStart`](TemplateLiteralLikeNode.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`getText`](TemplateLiteralLikeNode.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`TemplateLiteralLikeNode`](TemplateLiteralLikeNode.md).[`getWidth`](TemplateLiteralLikeNode.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/TextChange.md b/docs/api_docs/namespaces/ts/interfaces/TextChange.md new file mode 100644 index 0000000000000000000000000000000000000000..89e796dfc372d238f89320f2cb8644d8063f54dc --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/TextChange.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TextChange + +# Interface: TextChange + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6599 + +## Properties + +### newText + +> **newText**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6601 + +*** + +### span + +> **span**: [`TextSpan`](TextSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6600 diff --git a/docs/api_docs/namespaces/ts/interfaces/TextChangeRange.md b/docs/api_docs/namespaces/ts/interfaces/TextChangeRange.md new file mode 100644 index 0000000000000000000000000000000000000000..0d4da26e9cbc7d50afaef1e3339cc3011bbdc76e --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/TextChangeRange.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TextChangeRange + +# Interface: TextChangeRange + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4397 + +## Properties + +### newLength + +> **newLength**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4399 + +*** + +### span + +> **span**: [`TextSpan`](TextSpan.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4398 diff --git a/docs/api_docs/namespaces/ts/interfaces/TextInsertion.md b/docs/api_docs/namespaces/ts/interfaces/TextInsertion.md new file mode 100644 index 0000000000000000000000000000000000000000..e1b7d75141445d0151ce14a948597354614ada1d --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/TextInsertion.md @@ -0,0 +1,27 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TextInsertion + +# Interface: TextInsertion + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6695 + +## Properties + +### caretOffset + +> **caretOffset**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6698 + +The position in newText the caret should point to after the insertion. + +*** + +### newText + +> **newText**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6696 diff --git a/docs/api_docs/namespaces/ts/interfaces/TextRange.md b/docs/api_docs/namespaces/ts/interfaces/TextRange.md new file mode 100644 index 0000000000000000000000000000000000000000..576be10c4fb80d1903a5e83b16cd6958e728f518 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/TextRange.md @@ -0,0 +1,32 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TextRange + +# Interface: TextRange + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:97 + +## Extended by + +- [`FileReference`](FileReference.md) +- [`CheckJsDirective`](CheckJsDirective.md) +- [`CommentRange`](CommentRange.md) +- [`SourceMapRange`](SourceMapRange.md) + +## Properties + +### end + +> **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:99 + +*** + +### pos + +> **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:98 diff --git a/docs/api_docs/namespaces/ts/interfaces/TextSpan.md b/docs/api_docs/namespaces/ts/interfaces/TextSpan.md new file mode 100644 index 0000000000000000000000000000000000000000..fb1391e67b7f20bcb279e939176fe08043a929f8 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/TextSpan.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TextSpan + +# Interface: TextSpan + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4393 + +## Properties + +### length + +> **length**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4395 + +*** + +### start + +> **start**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4394 diff --git a/docs/api_docs/namespaces/ts/interfaces/ThisExpression.md b/docs/api_docs/namespaces/ts/interfaces/ThisExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..bf0cfa4e4d8c3da4acdd47b7ae052144dadbe868 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ThisExpression.md @@ -0,0 +1,549 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ThisExpression + +# Interface: ThisExpression + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1104 + +## Extends + +- [`PrimaryExpression`](PrimaryExpression.md) + +## Properties + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_expressionBrand`](PrimaryExpression.md#_expressionbrand) + +*** + +### \_leftHandSideExpressionBrand + +> **\_leftHandSideExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1086 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_leftHandSideExpressionBrand`](PrimaryExpression.md#_lefthandsideexpressionbrand) + +*** + +### \_memberExpressionBrand + +> **\_memberExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1089 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_memberExpressionBrand`](PrimaryExpression.md#_memberexpressionbrand) + +*** + +### \_primaryExpressionBrand + +> **\_primaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1092 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_primaryExpressionBrand`](PrimaryExpression.md#_primaryexpressionbrand) + +*** + +### \_unaryExpressionBrand + +> **\_unaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1066 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_unaryExpressionBrand`](PrimaryExpression.md#_unaryexpressionbrand) + +*** + +### \_updateExpressionBrand + +> **\_updateExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1071 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_updateExpressionBrand`](PrimaryExpression.md#_updateexpressionbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`decorators`](PrimaryExpression.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`end`](PrimaryExpression.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`flags`](PrimaryExpression.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`ThisKeyword`](../enumerations/SyntaxKind.md#thiskeyword) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1105 + +#### Overrides + +[`PrimaryExpression`](PrimaryExpression.md).[`kind`](PrimaryExpression.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`locals`](PrimaryExpression.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`modifiers`](PrimaryExpression.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`parent`](PrimaryExpression.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`pos`](PrimaryExpression.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`skipCheck`](PrimaryExpression.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`symbol`](PrimaryExpression.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`forEachChild`](PrimaryExpression.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getChildAt`](PrimaryExpression.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getChildCount`](PrimaryExpression.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getChildren`](PrimaryExpression.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getEnd`](PrimaryExpression.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFirstToken`](PrimaryExpression.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFullStart`](PrimaryExpression.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFullText`](PrimaryExpression.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFullWidth`](PrimaryExpression.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getLastToken`](PrimaryExpression.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getLeadingTriviaWidth`](PrimaryExpression.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getSourceFile`](PrimaryExpression.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getStart`](PrimaryExpression.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getText`](PrimaryExpression.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getWidth`](PrimaryExpression.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/ThisTypeNode.md b/docs/api_docs/namespaces/ts/interfaces/ThisTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..e64cf89172fec7a082ff2fdbbebcee54e59ce688 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ThisTypeNode.md @@ -0,0 +1,489 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ThisTypeNode + +# Interface: ThisTypeNode + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:930 + +## Extends + +- [`TypeNode`](TypeNode.md) + +## Properties + +### \_typeNodeBrand + +> **\_typeNodeBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:912 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`_typeNodeBrand`](TypeNode.md#_typenodebrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`decorators`](TypeNode.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`end`](TypeNode.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`flags`](TypeNode.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`ThisType`](../enumerations/SyntaxKind.md#thistype) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:931 + +#### Overrides + +[`TypeNode`](TypeNode.md).[`kind`](TypeNode.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`locals`](TypeNode.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`modifiers`](TypeNode.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`parent`](TypeNode.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`pos`](TypeNode.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`skipCheck`](TypeNode.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`symbol`](TypeNode.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`forEachChild`](TypeNode.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getChildAt`](TypeNode.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getChildCount`](TypeNode.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getChildren`](TypeNode.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getEnd`](TypeNode.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFirstToken`](TypeNode.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFullStart`](TypeNode.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFullText`](TypeNode.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFullWidth`](TypeNode.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getLastToken`](TypeNode.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getLeadingTriviaWidth`](TypeNode.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getSourceFile`](TypeNode.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getStart`](TypeNode.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getText`](TypeNode.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getWidth`](TypeNode.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/ThisTypePredicate.md b/docs/api_docs/namespaces/ts/interfaces/ThisTypePredicate.md new file mode 100644 index 0000000000000000000000000000000000000000..5708756f4a99a59253e5b84ab4f9f9874062b826 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ThisTypePredicate.md @@ -0,0 +1,53 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ThisTypePredicate + +# Interface: ThisTypePredicate + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2581 + +## Extends + +- [`TypePredicateBase`](TypePredicateBase.md) + +## Properties + +### kind + +> **kind**: [`This`](../enumerations/TypePredicateKind.md#this) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2582 + +#### Overrides + +[`TypePredicateBase`](TypePredicateBase.md).[`kind`](TypePredicateBase.md#kind) + +*** + +### parameterIndex + +> **parameterIndex**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2584 + +*** + +### parameterName + +> **parameterName**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2583 + +*** + +### type + +> **type**: [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2585 + +#### Overrides + +[`TypePredicateBase`](TypePredicateBase.md).[`type`](TypePredicateBase.md#type) diff --git a/docs/api_docs/namespaces/ts/interfaces/ThrowStatement.md b/docs/api_docs/namespaces/ts/interfaces/ThrowStatement.md new file mode 100644 index 0000000000000000000000000000000000000000..46539eed5df89eb03e06316646245a97d7d8a18a --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/ThrowStatement.md @@ -0,0 +1,497 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ThrowStatement + +# Interface: ThrowStatement + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1589 + +## Extends + +- [`Statement`](Statement.md) + +## Properties + +### \_statementBrand + +> **\_statementBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1471 + +#### Inherited from + +[`Statement`](Statement.md).[`_statementBrand`](Statement.md#_statementbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Statement`](Statement.md).[`decorators`](Statement.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Statement`](Statement.md).[`end`](Statement.md#end) + +*** + +### expression + +> `readonly` **expression**: [`Expression`](Expression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1591 + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Statement`](Statement.md).[`flags`](Statement.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`ThrowStatement`](../enumerations/SyntaxKind.md#throwstatement) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1590 + +#### Overrides + +[`Statement`](Statement.md).[`kind`](Statement.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Statement`](Statement.md).[`locals`](Statement.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Statement`](Statement.md).[`modifiers`](Statement.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`Statement`](Statement.md).[`parent`](Statement.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Statement`](Statement.md).[`pos`](Statement.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Statement`](Statement.md).[`skipCheck`](Statement.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Statement`](Statement.md).[`symbol`](Statement.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Statement`](Statement.md).[`forEachChild`](Statement.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getChildAt`](Statement.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getChildCount`](Statement.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Statement`](Statement.md).[`getChildren`](Statement.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getEnd`](Statement.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getFirstToken`](Statement.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getFullStart`](Statement.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Statement`](Statement.md).[`getFullText`](Statement.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getFullWidth`](Statement.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getLastToken`](Statement.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getLeadingTriviaWidth`](Statement.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getSourceFile`](Statement.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getStart`](Statement.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Statement`](Statement.md).[`getText`](Statement.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getWidth`](Statement.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/TodoComment.md b/docs/api_docs/namespaces/ts/interfaces/TodoComment.md new file mode 100644 index 0000000000000000000000000000000000000000..287d6ad2abc0350eeeaf0e517cceac3d6c6bbf2c --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/TodoComment.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TodoComment + +# Interface: TodoComment + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6594 + +## Properties + +### descriptor + +> **descriptor**: [`TodoCommentDescriptor`](TodoCommentDescriptor.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6595 + +*** + +### message + +> **message**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6596 + +*** + +### position + +> **position**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6597 diff --git a/docs/api_docs/namespaces/ts/interfaces/TodoCommentDescriptor.md b/docs/api_docs/namespaces/ts/interfaces/TodoCommentDescriptor.md new file mode 100644 index 0000000000000000000000000000000000000000..a9b0ce1af65b6ac4cc06fcf1f2510dc69b69571f --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/TodoCommentDescriptor.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TodoCommentDescriptor + +# Interface: TodoCommentDescriptor + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6590 + +## Properties + +### priority + +> **priority**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6592 + +*** + +### text + +> **text**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6591 diff --git a/docs/api_docs/namespaces/ts/interfaces/Token.md b/docs/api_docs/namespaces/ts/interfaces/Token.md new file mode 100644 index 0000000000000000000000000000000000000000..6932d215844972f944847c8e65a15b8614f228b1 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/Token.md @@ -0,0 +1,486 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / Token + +# Interface: Token\ + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:618 + +## Extends + +- [`Node`](Node.md) + +## Extended by + +- [`PunctuationToken`](PunctuationToken.md) +- [`KeywordToken`](KeywordToken.md) + +## Type Parameters + +• **TKind** *extends* [`SyntaxKind`](../enumerations/SyntaxKind.md) + +## Properties + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`decorators`](Node.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Node`](Node.md).[`end`](Node.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Node`](Node.md).[`flags`](Node.md#flags) + +*** + +### kind + +> `readonly` **kind**: `TKind` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:619 + +#### Overrides + +[`Node`](Node.md).[`kind`](Node.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Node`](Node.md).[`locals`](Node.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`modifiers`](Node.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`Node`](Node.md).[`parent`](Node.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Node`](Node.md).[`pos`](Node.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Node`](Node.md).[`skipCheck`](Node.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Node`](Node.md).[`symbol`](Node.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Node`](Node.md).[`forEachChild`](Node.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getChildAt`](Node.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getChildCount`](Node.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Node`](Node.md).[`getChildren`](Node.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getEnd`](Node.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getFirstToken`](Node.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullStart`](Node.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getFullText`](Node.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullWidth`](Node.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getLastToken`](Node.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getLeadingTriviaWidth`](Node.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Node`](Node.md).[`getSourceFile`](Node.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getStart`](Node.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getText`](Node.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getWidth`](Node.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/TransformationContext.md b/docs/api_docs/namespaces/ts/interfaces/TransformationContext.md new file mode 100644 index 0000000000000000000000000000000000000000..6fa085de0919899ed97391c3f5d529fd04729a11 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/TransformationContext.md @@ -0,0 +1,353 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TransformationContext + +# Interface: TransformationContext + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4095 + +## Extends + +- [`CoreTransformationContext`](CoreTransformationContext.md) + +## Properties + +### factory + +> `readonly` **factory**: [`NodeFactory`](NodeFactory.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4079 + +#### Inherited from + +[`CoreTransformationContext`](CoreTransformationContext.md).[`factory`](CoreTransformationContext.md#factory) + +*** + +### onEmitNode() + +> **onEmitNode**: (`hint`, `node`, `emitCallback`) => `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4129 + +Hook used to allow transformers to capture state before or after +the printer emits a node. + +NOTE: Transformation hooks should only be modified during `Transformer` initialization, +before returning the `NodeTransformer` callback. + +#### Parameters + +##### hint + +[`EmitHint`](../enumerations/EmitHint.md) + +##### node + +[`Node`](Node.md) + +##### emitCallback + +(`hint`, `node`) => `void` + +#### Returns + +`void` + +*** + +### onSubstituteNode() + +> **onSubstituteNode**: (`hint`, `node`) => [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4111 + +Hook used by transformers to substitute expressions just before they +are emitted by the pretty printer. + +NOTE: Transformation hooks should only be modified during `Transformer` initialization, +before returning the `NodeTransformer` callback. + +#### Parameters + +##### hint + +[`EmitHint`](../enumerations/EmitHint.md) + +##### node + +[`Node`](Node.md) + +#### Returns + +[`Node`](Node.md) + +## Methods + +### enableEmitNotification() + +> **enableEmitNotification**(`kind`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4116 + +Enables before/after emit notifications in the pretty printer for the provided +SyntaxKind. + +#### Parameters + +##### kind + +[`SyntaxKind`](../enumerations/SyntaxKind.md) + +#### Returns + +`void` + +*** + +### enableSubstitution() + +> **enableSubstitution**(`kind`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4101 + +Enables expression substitutions in the pretty printer for the provided SyntaxKind. + +#### Parameters + +##### kind + +[`SyntaxKind`](../enumerations/SyntaxKind.md) + +#### Returns + +`void` + +*** + +### endLexicalEnvironment() + +> **endLexicalEnvironment**(): `undefined` \| [`Statement`](Statement.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4089 + +Ends a lexical environment, returning any declarations. + +#### Returns + +`undefined` \| [`Statement`](Statement.md)[] + +#### Inherited from + +[`CoreTransformationContext`](CoreTransformationContext.md).[`endLexicalEnvironment`](CoreTransformationContext.md#endlexicalenvironment) + +*** + +### getCompilerOptions() + +> **getCompilerOptions**(): [`CompilerOptions`](CompilerOptions.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4081 + +Gets the compiler options supplied to the transformer. + +#### Returns + +[`CompilerOptions`](CompilerOptions.md) + +#### Inherited from + +[`CoreTransformationContext`](CoreTransformationContext.md).[`getCompilerOptions`](CoreTransformationContext.md#getcompileroptions) + +*** + +### hoistFunctionDeclaration() + +> **hoistFunctionDeclaration**(`node`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4091 + +Hoists a function declaration to the containing scope. + +#### Parameters + +##### node + +[`FunctionDeclaration`](FunctionDeclaration.md) + +#### Returns + +`void` + +#### Inherited from + +[`CoreTransformationContext`](CoreTransformationContext.md).[`hoistFunctionDeclaration`](CoreTransformationContext.md#hoistfunctiondeclaration) + +*** + +### hoistVariableDeclaration() + +> **hoistVariableDeclaration**(`node`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4093 + +Hoists a variable declaration to the containing scope. + +#### Parameters + +##### node + +[`Identifier`](Identifier.md) + +#### Returns + +`void` + +#### Inherited from + +[`CoreTransformationContext`](CoreTransformationContext.md).[`hoistVariableDeclaration`](CoreTransformationContext.md#hoistvariabledeclaration) + +*** + +### isEmitNotificationEnabled() + +> **isEmitNotificationEnabled**(`node`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4121 + +Determines whether before/after emit notifications should be raised in the pretty +printer when it emits a node. + +#### Parameters + +##### node + +[`Node`](Node.md) + +#### Returns + +`boolean` + +*** + +### isLexicalEnvironmentSuspended()? + +> `optional` **isLexicalEnvironmentSuspended**(): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4131 + +Determines whether the lexical environment is suspended + +#### Returns + +`boolean` + +*** + +### isSubstitutionEnabled() + +> **isSubstitutionEnabled**(`node`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4103 + +Determines whether expression substitutions are enabled for the provided node. + +#### Parameters + +##### node + +[`Node`](Node.md) + +#### Returns + +`boolean` + +*** + +### readEmitHelpers() + +> **readEmitHelpers**(): `undefined` \| [`EmitHelper`](../type-aliases/EmitHelper.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4099 + +Gets and resets the requested non-scoped emit helpers. + +#### Returns + +`undefined` \| [`EmitHelper`](../type-aliases/EmitHelper.md)[] + +*** + +### requestEmitHelper() + +> **requestEmitHelper**(`helper`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4097 + +Records a request for a non-scoped emit helper in the current context. + +#### Parameters + +##### helper + +[`EmitHelper`](../type-aliases/EmitHelper.md) + +#### Returns + +`void` + +*** + +### resumeLexicalEnvironment() + +> **resumeLexicalEnvironment**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4087 + +Resumes a suspended lexical environment, usually before visiting a function body. + +#### Returns + +`void` + +#### Inherited from + +[`CoreTransformationContext`](CoreTransformationContext.md).[`resumeLexicalEnvironment`](CoreTransformationContext.md#resumelexicalenvironment) + +*** + +### startLexicalEnvironment() + +> **startLexicalEnvironment**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4083 + +Starts a new lexical environment. + +#### Returns + +`void` + +#### Inherited from + +[`CoreTransformationContext`](CoreTransformationContext.md).[`startLexicalEnvironment`](CoreTransformationContext.md#startlexicalenvironment) + +*** + +### suspendLexicalEnvironment() + +> **suspendLexicalEnvironment**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4085 + +Suspends the current lexical environment, usually after visiting a parameter list. + +#### Returns + +`void` + +#### Inherited from + +[`CoreTransformationContext`](CoreTransformationContext.md).[`suspendLexicalEnvironment`](CoreTransformationContext.md#suspendlexicalenvironment) diff --git a/docs/api_docs/namespaces/ts/interfaces/TransformationResult.md b/docs/api_docs/namespaces/ts/interfaces/TransformationResult.md new file mode 100644 index 0000000000000000000000000000000000000000..427b03b50e50373f4ec9fa965df0c1681f074a57 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/TransformationResult.md @@ -0,0 +1,131 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TransformationResult + +# Interface: TransformationResult\ + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4133 + +## Type Parameters + +• **T** *extends* [`Node`](Node.md) + +## Properties + +### diagnostics? + +> `optional` **diagnostics**: [`DiagnosticWithLocation`](DiagnosticWithLocation.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4137 + +Gets diagnostics for the transformation. + +*** + +### transformed + +> **transformed**: `T`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4135 + +Gets the transformed source files. + +## Methods + +### dispose() + +> **dispose**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4162 + +Clean up EmitNode entries on any parse-tree nodes. + +#### Returns + +`void` + +*** + +### emitNodeWithNotification() + +> **emitNodeWithNotification**(`hint`, `node`, `emitCallback`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4152 + +Emits a node with possible notification. + +#### Parameters + +##### hint + +[`EmitHint`](../enumerations/EmitHint.md) + +A hint as to the intended usage of the node. + +##### node + +[`Node`](Node.md) + +The node to emit. + +##### emitCallback + +(`hint`, `node`) => `void` + +A callback used to emit the node. + +#### Returns + +`void` + +*** + +### isEmitNotificationEnabled()? + +> `optional` **isEmitNotificationEnabled**(`node`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4158 + +Indicates if a given node needs an emit notification + +#### Parameters + +##### node + +[`Node`](Node.md) + +The node to emit. + +#### Returns + +`boolean` + +*** + +### substituteNode() + +> **substituteNode**(`hint`, `node`): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4144 + +Gets a substitute for a node, if one is available; otherwise, returns the original node. + +#### Parameters + +##### hint + +[`EmitHint`](../enumerations/EmitHint.md) + +A hint as to the intended usage of the node. + +##### node + +[`Node`](Node.md) + +The node to substitute. + +#### Returns + +[`Node`](Node.md) diff --git a/docs/api_docs/namespaces/ts/interfaces/TransientIdentifier.md b/docs/api_docs/namespaces/ts/interfaces/TransientIdentifier.md new file mode 100644 index 0000000000000000000000000000000000000000..076b0a561354df26d233f1425f806a9937b5a6ab --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/TransientIdentifier.md @@ -0,0 +1,620 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TransientIdentifier + +# Interface: TransientIdentifier + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:686 + +## Extends + +- [`Identifier`](Identifier.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`Identifier`](Identifier.md).[`_declarationBrand`](Identifier.md#_declarationbrand) + +*** + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`Identifier`](Identifier.md).[`_expressionBrand`](Identifier.md#_expressionbrand) + +*** + +### \_leftHandSideExpressionBrand + +> **\_leftHandSideExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1086 + +#### Inherited from + +[`Identifier`](Identifier.md).[`_leftHandSideExpressionBrand`](Identifier.md#_lefthandsideexpressionbrand) + +*** + +### \_memberExpressionBrand + +> **\_memberExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1089 + +#### Inherited from + +[`Identifier`](Identifier.md).[`_memberExpressionBrand`](Identifier.md#_memberexpressionbrand) + +*** + +### \_primaryExpressionBrand + +> **\_primaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1092 + +#### Inherited from + +[`Identifier`](Identifier.md).[`_primaryExpressionBrand`](Identifier.md#_primaryexpressionbrand) + +*** + +### \_unaryExpressionBrand + +> **\_unaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1066 + +#### Inherited from + +[`Identifier`](Identifier.md).[`_unaryExpressionBrand`](Identifier.md#_unaryexpressionbrand) + +*** + +### \_updateExpressionBrand + +> **\_updateExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1071 + +#### Inherited from + +[`Identifier`](Identifier.md).[`_updateExpressionBrand`](Identifier.md#_updateexpressionbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Identifier`](Identifier.md).[`decorators`](Identifier.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Identifier`](Identifier.md).[`end`](Identifier.md#end) + +*** + +### escapedText + +> `readonly` **escapedText**: [`__String`](../type-aliases/String.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:682 + +Prefer to use `id.unescapedText`. (Note: This is available only in services, not internally to the TypeScript compiler.) +Text of identifier, but if the identifier begins with two underscores, this will begin with three. + +#### Inherited from + +[`Identifier`](Identifier.md).[`escapedText`](Identifier.md#escapedtext) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Identifier`](Identifier.md).[`flags`](Identifier.md#flags) + +*** + +### isInJSDocNamespace? + +> `optional` **isInJSDocNamespace**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:684 + +#### Inherited from + +[`Identifier`](Identifier.md).[`isInJSDocNamespace`](Identifier.md#isinjsdocnamespace) + +*** + +### kind + +> `readonly` **kind**: [`Identifier`](../enumerations/SyntaxKind.md#identifier) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:677 + +#### Inherited from + +[`Identifier`](Identifier.md).[`kind`](Identifier.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Identifier`](Identifier.md).[`locals`](Identifier.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Identifier`](Identifier.md).[`modifiers`](Identifier.md#modifiers) + +*** + +### originalKeywordKind? + +> `readonly` `optional` **originalKeywordKind**: [`SyntaxKind`](../enumerations/SyntaxKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:683 + +#### Inherited from + +[`Identifier`](Identifier.md).[`originalKeywordKind`](Identifier.md#originalkeywordkind) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`Identifier`](Identifier.md).[`parent`](Identifier.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Identifier`](Identifier.md).[`pos`](Identifier.md#pos) + +*** + +### resolvedSymbol + +> **resolvedSymbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:687 + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Identifier`](Identifier.md).[`skipCheck`](Identifier.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Identifier`](Identifier.md).[`symbol`](Identifier.md#symbol) + +*** + +### text + +> `readonly` **text**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6105 + +#### Inherited from + +[`Identifier`](Identifier.md).[`text`](Identifier.md#text) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Identifier`](Identifier.md).[`forEachChild`](Identifier.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Identifier`](Identifier.md).[`getChildAt`](Identifier.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Identifier`](Identifier.md).[`getChildCount`](Identifier.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Identifier`](Identifier.md).[`getChildren`](Identifier.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Identifier`](Identifier.md).[`getEnd`](Identifier.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Identifier`](Identifier.md).[`getFirstToken`](Identifier.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Identifier`](Identifier.md).[`getFullStart`](Identifier.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Identifier`](Identifier.md).[`getFullText`](Identifier.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Identifier`](Identifier.md).[`getFullWidth`](Identifier.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Identifier`](Identifier.md).[`getLastToken`](Identifier.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Identifier`](Identifier.md).[`getLeadingTriviaWidth`](Identifier.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Identifier`](Identifier.md).[`getSourceFile`](Identifier.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Identifier`](Identifier.md).[`getStart`](Identifier.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Identifier`](Identifier.md).[`getText`](Identifier.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Identifier`](Identifier.md).[`getWidth`](Identifier.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/TranspileOptions.md b/docs/api_docs/namespaces/ts/interfaces/TranspileOptions.md new file mode 100644 index 0000000000000000000000000000000000000000..7007266aeb51069c6ecdf9317b73db9f13046ff1 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/TranspileOptions.md @@ -0,0 +1,57 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TranspileOptions + +# Interface: TranspileOptions + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7414 + +## Properties + +### compilerOptions? + +> `optional` **compilerOptions**: [`CompilerOptions`](CompilerOptions.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7415 + +*** + +### fileName? + +> `optional` **fileName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7416 + +*** + +### moduleName? + +> `optional` **moduleName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7418 + +*** + +### renamedDependencies? + +> `optional` **renamedDependencies**: [`MapLike`](MapLike.md)\<`string`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7419 + +*** + +### reportDiagnostics? + +> `optional` **reportDiagnostics**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7417 + +*** + +### transformers? + +> `optional` **transformers**: [`CustomTransformers`](CustomTransformers.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7420 diff --git a/docs/api_docs/namespaces/ts/interfaces/TranspileOutput.md b/docs/api_docs/namespaces/ts/interfaces/TranspileOutput.md new file mode 100644 index 0000000000000000000000000000000000000000..f9775b40f5fa7738f964dc2ddc10484cac61b166 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/TranspileOutput.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TranspileOutput + +# Interface: TranspileOutput + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7422 + +## Properties + +### diagnostics? + +> `optional` **diagnostics**: [`Diagnostic`](Diagnostic.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7424 + +*** + +### outputText + +> **outputText**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7423 + +*** + +### sourceMapText? + +> `optional` **sourceMapText**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7425 diff --git a/docs/api_docs/namespaces/ts/interfaces/TrueLiteral.md b/docs/api_docs/namespaces/ts/interfaces/TrueLiteral.md new file mode 100644 index 0000000000000000000000000000000000000000..6478da81f91d81766b318140b66b4828f4ff6916 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/TrueLiteral.md @@ -0,0 +1,549 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TrueLiteral + +# Interface: TrueLiteral + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1097 + +## Extends + +- [`PrimaryExpression`](PrimaryExpression.md) + +## Properties + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_expressionBrand`](PrimaryExpression.md#_expressionbrand) + +*** + +### \_leftHandSideExpressionBrand + +> **\_leftHandSideExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1086 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_leftHandSideExpressionBrand`](PrimaryExpression.md#_lefthandsideexpressionbrand) + +*** + +### \_memberExpressionBrand + +> **\_memberExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1089 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_memberExpressionBrand`](PrimaryExpression.md#_memberexpressionbrand) + +*** + +### \_primaryExpressionBrand + +> **\_primaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1092 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_primaryExpressionBrand`](PrimaryExpression.md#_primaryexpressionbrand) + +*** + +### \_unaryExpressionBrand + +> **\_unaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1066 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_unaryExpressionBrand`](PrimaryExpression.md#_unaryexpressionbrand) + +*** + +### \_updateExpressionBrand + +> **\_updateExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1071 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`_updateExpressionBrand`](PrimaryExpression.md#_updateexpressionbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`decorators`](PrimaryExpression.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`end`](PrimaryExpression.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`flags`](PrimaryExpression.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`TrueKeyword`](../enumerations/SyntaxKind.md#truekeyword) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1098 + +#### Overrides + +[`PrimaryExpression`](PrimaryExpression.md).[`kind`](PrimaryExpression.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`locals`](PrimaryExpression.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`modifiers`](PrimaryExpression.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`parent`](PrimaryExpression.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`pos`](PrimaryExpression.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`skipCheck`](PrimaryExpression.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`symbol`](PrimaryExpression.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`forEachChild`](PrimaryExpression.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getChildAt`](PrimaryExpression.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getChildCount`](PrimaryExpression.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getChildren`](PrimaryExpression.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getEnd`](PrimaryExpression.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFirstToken`](PrimaryExpression.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFullStart`](PrimaryExpression.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFullText`](PrimaryExpression.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getFullWidth`](PrimaryExpression.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getLastToken`](PrimaryExpression.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getLeadingTriviaWidth`](PrimaryExpression.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getSourceFile`](PrimaryExpression.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getStart`](PrimaryExpression.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getText`](PrimaryExpression.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`PrimaryExpression`](PrimaryExpression.md).[`getWidth`](PrimaryExpression.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/TryStatement.md b/docs/api_docs/namespaces/ts/interfaces/TryStatement.md new file mode 100644 index 0000000000000000000000000000000000000000..847b0aa805d71958663f4f135a29683d5372ae9c --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/TryStatement.md @@ -0,0 +1,513 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TryStatement + +# Interface: TryStatement + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1593 + +## Extends + +- [`Statement`](Statement.md) + +## Properties + +### \_statementBrand + +> **\_statementBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1471 + +#### Inherited from + +[`Statement`](Statement.md).[`_statementBrand`](Statement.md#_statementbrand) + +*** + +### catchClause? + +> `readonly` `optional` **catchClause**: [`CatchClause`](CatchClause.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1596 + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Statement`](Statement.md).[`decorators`](Statement.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Statement`](Statement.md).[`end`](Statement.md#end) + +*** + +### finallyBlock? + +> `readonly` `optional` **finallyBlock**: [`Block`](Block.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1597 + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Statement`](Statement.md).[`flags`](Statement.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`TryStatement`](../enumerations/SyntaxKind.md#trystatement) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1594 + +#### Overrides + +[`Statement`](Statement.md).[`kind`](Statement.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Statement`](Statement.md).[`locals`](Statement.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Statement`](Statement.md).[`modifiers`](Statement.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`Statement`](Statement.md).[`parent`](Statement.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Statement`](Statement.md).[`pos`](Statement.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Statement`](Statement.md).[`skipCheck`](Statement.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Statement`](Statement.md).[`symbol`](Statement.md#symbol) + +*** + +### tryBlock + +> `readonly` **tryBlock**: [`Block`](Block.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1595 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Statement`](Statement.md).[`forEachChild`](Statement.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getChildAt`](Statement.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getChildCount`](Statement.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Statement`](Statement.md).[`getChildren`](Statement.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getEnd`](Statement.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getFirstToken`](Statement.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getFullStart`](Statement.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Statement`](Statement.md).[`getFullText`](Statement.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getFullWidth`](Statement.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getLastToken`](Statement.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getLeadingTriviaWidth`](Statement.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getSourceFile`](Statement.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getStart`](Statement.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Statement`](Statement.md).[`getText`](Statement.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getWidth`](Statement.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/TsConfigSourceFile.md b/docs/api_docs/namespaces/ts/interfaces/TsConfigSourceFile.md new file mode 100644 index 0000000000000000000000000000000000000000..69e6e950dab0937156c31542d89a96770c25e4b5 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/TsConfigSourceFile.md @@ -0,0 +1,800 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TsConfigSourceFile + +# Interface: TsConfigSourceFile + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2218 + +## Extends + +- [`JsonSourceFile`](JsonSourceFile.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`JsonSourceFile`](JsonSourceFile.md).[`_declarationBrand`](JsonSourceFile.md#_declarationbrand) + +*** + +### amdDependencies + +> **amdDependencies**: readonly [`AmdDependency`](AmdDependency.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2122 + +#### Inherited from + +[`JsonSourceFile`](JsonSourceFile.md).[`amdDependencies`](JsonSourceFile.md#amddependencies) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`JsonSourceFile`](JsonSourceFile.md).[`decorators`](JsonSourceFile.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`JsonSourceFile`](JsonSourceFile.md).[`end`](JsonSourceFile.md#end) + +*** + +### endOfFileToken + +> `readonly` **endOfFileToken**: [`Token`](Token.md)\<[`EndOfFileToken`](../enumerations/SyntaxKind.md#endoffiletoken)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2119 + +#### Inherited from + +[`JsonSourceFile`](JsonSourceFile.md).[`endOfFileToken`](JsonSourceFile.md#endoffiletoken) + +*** + +### extendedSourceFiles? + +> `optional` **extendedSourceFiles**: `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2219 + +*** + +### fileName + +> **fileName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2120 + +#### Inherited from + +[`JsonSourceFile`](JsonSourceFile.md).[`fileName`](JsonSourceFile.md#filename) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`JsonSourceFile`](JsonSourceFile.md).[`flags`](JsonSourceFile.md#flags) + +*** + +### hasNoDefaultLib + +> **hasNoDefaultLib**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2137 + +lib.d.ts should have a reference comment like + + /// + +If any other file has this comment, it signals not to include lib.d.ts +because this containing file is intended to act as a default library. + +#### Inherited from + +[`JsonSourceFile`](JsonSourceFile.md).[`hasNoDefaultLib`](JsonSourceFile.md#hasnodefaultlib) + +*** + +### impliedNodeFormat? + +> `optional` **impliedNodeFormat**: [`CommonJS`](../enumerations/ModuleKind.md#commonjs) \| [`ESNext`](../enumerations/ModuleKind.md#esnext) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2156 + +When `module` is `Node16` or `NodeNext`, this field controls whether the +source file in question is an ESNext-output-format file, or a CommonJS-output-format +module. This is derived by the module resolver as it looks up the file, since +it is derived from either the file extension of the module, or the containing +`package.json` context, and affects both checking and emit. + +It is _public_ so that (pre)transformers can set this field, +since it switches the builtin `node` module transform. Generally speaking, if unset, +the field is treated as though it is `ModuleKind.CommonJS`. + +Note that this field is only set by the module resolution process when +`moduleResolution` is `Node16` or `NodeNext`, which is implied by the `module` setting +of `Node16` or `NodeNext`, respectively, but may be overriden (eg, by a `moduleResolution` +of `node`). If so, this field will be unset and source files will be considered to be +CommonJS-output-format by the node module transformer and type checker, regardless of extension or context. + +#### Inherited from + +[`JsonSourceFile`](JsonSourceFile.md).[`impliedNodeFormat`](JsonSourceFile.md#impliednodeformat) + +*** + +### isDeclarationFile + +> **isDeclarationFile**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2128 + +#### Inherited from + +[`JsonSourceFile`](JsonSourceFile.md).[`isDeclarationFile`](JsonSourceFile.md#isdeclarationfile) + +*** + +### kind + +> `readonly` **kind**: [`SourceFile`](../enumerations/SyntaxKind.md#sourcefile) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2117 + +#### Inherited from + +[`JsonSourceFile`](JsonSourceFile.md).[`kind`](JsonSourceFile.md#kind) + +*** + +### languageVariant + +> **languageVariant**: [`LanguageVariant`](../enumerations/LanguageVariant.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2127 + +#### Inherited from + +[`JsonSourceFile`](JsonSourceFile.md).[`languageVariant`](JsonSourceFile.md#languagevariant) + +*** + +### languageVersion + +> **languageVersion**: [`ScriptTarget`](../enumerations/ScriptTarget.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2138 + +#### Inherited from + +[`JsonSourceFile`](JsonSourceFile.md).[`languageVersion`](JsonSourceFile.md#languageversion) + +*** + +### libReferenceDirectives + +> **libReferenceDirectives**: readonly [`FileReference`](FileReference.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2126 + +#### Inherited from + +[`JsonSourceFile`](JsonSourceFile.md).[`libReferenceDirectives`](JsonSourceFile.md#libreferencedirectives) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`JsonSourceFile`](JsonSourceFile.md).[`locals`](JsonSourceFile.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`JsonSourceFile`](JsonSourceFile.md).[`modifiers`](JsonSourceFile.md#modifiers) + +*** + +### moduleName? + +> `optional` **moduleName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2123 + +#### Inherited from + +[`JsonSourceFile`](JsonSourceFile.md).[`moduleName`](JsonSourceFile.md#modulename) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`JsonSourceFile`](JsonSourceFile.md).[`parent`](JsonSourceFile.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`JsonSourceFile`](JsonSourceFile.md).[`pos`](JsonSourceFile.md#pos) + +*** + +### referencedFiles + +> **referencedFiles**: readonly [`FileReference`](FileReference.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2124 + +#### Inherited from + +[`JsonSourceFile`](JsonSourceFile.md).[`referencedFiles`](JsonSourceFile.md#referencedfiles) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`JsonSourceFile`](JsonSourceFile.md).[`skipCheck`](JsonSourceFile.md#skipcheck) + +*** + +### statements + +> `readonly` **statements**: [`NodeArray`](NodeArray.md)\<[`JsonObjectExpressionStatement`](JsonObjectExpressionStatement.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2216 + +#### Inherited from + +[`JsonSourceFile`](JsonSourceFile.md).[`statements`](JsonSourceFile.md#statements) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`JsonSourceFile`](JsonSourceFile.md).[`symbol`](JsonSourceFile.md#symbol) + +*** + +### text + +> **text**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2121 + +#### Inherited from + +[`JsonSourceFile`](JsonSourceFile.md).[`text`](JsonSourceFile.md#text) + +*** + +### typeReferenceDirectives + +> **typeReferenceDirectives**: readonly [`FileReference`](FileReference.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2125 + +#### Inherited from + +[`JsonSourceFile`](JsonSourceFile.md).[`typeReferenceDirectives`](JsonSourceFile.md#typereferencedirectives) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`JsonSourceFile`](JsonSourceFile.md).[`forEachChild`](JsonSourceFile.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`JsonSourceFile`](JsonSourceFile.md).[`getChildAt`](JsonSourceFile.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`JsonSourceFile`](JsonSourceFile.md).[`getChildCount`](JsonSourceFile.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`JsonSourceFile`](JsonSourceFile.md).[`getChildren`](JsonSourceFile.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`JsonSourceFile`](JsonSourceFile.md).[`getEnd`](JsonSourceFile.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`JsonSourceFile`](JsonSourceFile.md).[`getFirstToken`](JsonSourceFile.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`JsonSourceFile`](JsonSourceFile.md).[`getFullStart`](JsonSourceFile.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`JsonSourceFile`](JsonSourceFile.md).[`getFullText`](JsonSourceFile.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`JsonSourceFile`](JsonSourceFile.md).[`getFullWidth`](JsonSourceFile.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`JsonSourceFile`](JsonSourceFile.md).[`getLastToken`](JsonSourceFile.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`JsonSourceFile`](JsonSourceFile.md).[`getLeadingTriviaWidth`](JsonSourceFile.md#getleadingtriviawidth) + +*** + +### getLineAndCharacterOfPosition() + +> **getLineAndCharacterOfPosition**(`pos`): [`LineAndCharacter`](LineAndCharacter.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6157 + +#### Parameters + +##### pos + +`number` + +#### Returns + +[`LineAndCharacter`](LineAndCharacter.md) + +#### Inherited from + +[`JsonSourceFile`](JsonSourceFile.md).[`getLineAndCharacterOfPosition`](JsonSourceFile.md#getlineandcharacterofposition) + +*** + +### getLineEndOfPosition() + +> **getLineEndOfPosition**(`pos`): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6158 + +#### Parameters + +##### pos + +`number` + +#### Returns + +`number` + +#### Inherited from + +[`JsonSourceFile`](JsonSourceFile.md).[`getLineEndOfPosition`](JsonSourceFile.md#getlineendofposition) + +*** + +### getLineStarts() + +> **getLineStarts**(): readonly `number`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6159 + +#### Returns + +readonly `number`[] + +#### Inherited from + +[`JsonSourceFile`](JsonSourceFile.md).[`getLineStarts`](JsonSourceFile.md#getlinestarts) + +*** + +### getPositionOfLineAndCharacter() + +> **getPositionOfLineAndCharacter**(`line`, `character`): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6160 + +#### Parameters + +##### line + +`number` + +##### character + +`number` + +#### Returns + +`number` + +#### Inherited from + +[`JsonSourceFile`](JsonSourceFile.md).[`getPositionOfLineAndCharacter`](JsonSourceFile.md#getpositionoflineandcharacter) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`JsonSourceFile`](JsonSourceFile.md).[`getSourceFile`](JsonSourceFile.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`JsonSourceFile`](JsonSourceFile.md).[`getStart`](JsonSourceFile.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`JsonSourceFile`](JsonSourceFile.md).[`getText`](JsonSourceFile.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`JsonSourceFile`](JsonSourceFile.md).[`getWidth`](JsonSourceFile.md#getwidth) + +*** + +### update() + +> **update**(`newText`, `textChangeRange`): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6161 + +#### Parameters + +##### newText + +`string` + +##### textChangeRange + +[`TextChangeRange`](TextChangeRange.md) + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`JsonSourceFile`](JsonSourceFile.md).[`update`](JsonSourceFile.md#update) diff --git a/docs/api_docs/namespaces/ts/interfaces/TupleType.md b/docs/api_docs/namespaces/ts/interfaces/TupleType.md new file mode 100644 index 0000000000000000000000000000000000000000..7f32a436abf09ccfb93871221e15d831aa85eed7 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/TupleType.md @@ -0,0 +1,601 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TupleType + +# Interface: TupleType + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2862 + +Class and interface types (ObjectFlags.Class and ObjectFlags.Interface). + +## Extends + +- [`GenericType`](GenericType.md) + +## Properties + +### aliasSymbol? + +> `optional` **aliasSymbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2773 + +#### Inherited from + +[`GenericType`](GenericType.md).[`aliasSymbol`](GenericType.md#aliassymbol) + +*** + +### aliasTypeArguments? + +> `optional` **aliasTypeArguments**: readonly [`Type`](Type.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2774 + +#### Inherited from + +[`GenericType`](GenericType.md).[`aliasTypeArguments`](GenericType.md#aliastypearguments) + +*** + +### combinedFlags + +> **combinedFlags**: [`ElementFlags`](../enumerations/ElementFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2867 + +*** + +### elementFlags + +> **elementFlags**: readonly [`ElementFlags`](../enumerations/ElementFlags.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2863 + +*** + +### fixedLength + +> **fixedLength**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2865 + +*** + +### flags + +> **flags**: [`TypeFlags`](../enumerations/TypeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2770 + +#### Inherited from + +[`GenericType`](GenericType.md).[`flags`](GenericType.md#flags) + +*** + +### hasRestElement + +> **hasRestElement**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2866 + +*** + +### labeledElementDeclarations? + +> `optional` **labeledElementDeclarations**: readonly ([`ParameterDeclaration`](ParameterDeclaration.md) \| [`NamedTupleMember`](NamedTupleMember.md))[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2869 + +*** + +### localTypeParameters + +> **localTypeParameters**: `undefined` \| [`TypeParameter`](TypeParameter.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2824 + +#### Inherited from + +[`GenericType`](GenericType.md).[`localTypeParameters`](GenericType.md#localtypeparameters) + +*** + +### minLength + +> **minLength**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2864 + +*** + +### node? + +> `optional` **node**: [`TypeReferenceNode`](TypeReferenceNode.md) \| [`ArrayTypeNode`](ArrayTypeNode.md) \| [`TupleTypeNode`](TupleTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2846 + +#### Inherited from + +[`GenericType`](GenericType.md).[`node`](GenericType.md#node) + +*** + +### objectFlags + +> **objectFlags**: [`ObjectFlags`](../enumerations/ObjectFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2818 + +#### Inherited from + +[`GenericType`](GenericType.md).[`objectFlags`](GenericType.md#objectflags) + +*** + +### outerTypeParameters + +> **outerTypeParameters**: `undefined` \| [`TypeParameter`](TypeParameter.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2823 + +#### Inherited from + +[`GenericType`](GenericType.md).[`outerTypeParameters`](GenericType.md#outertypeparameters) + +*** + +### pattern? + +> `optional` **pattern**: [`DestructuringPattern`](../type-aliases/DestructuringPattern.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2772 + +#### Inherited from + +[`GenericType`](GenericType.md).[`pattern`](GenericType.md#pattern) + +*** + +### readonly + +> **readonly**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2868 + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2771 + +#### Inherited from + +[`GenericType`](GenericType.md).[`symbol`](GenericType.md#symbol) + +*** + +### target + +> **target**: [`GenericType`](GenericType.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2845 + +#### Inherited from + +[`GenericType`](GenericType.md).[`target`](GenericType.md#target) + +*** + +### thisType + +> **thisType**: `undefined` \| [`TypeParameter`](TypeParameter.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2825 + +#### Inherited from + +[`GenericType`](GenericType.md).[`thisType`](GenericType.md#thistype) + +*** + +### typeArguments? + +> `optional` **typeArguments**: readonly [`Type`](Type.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6145 + +#### Inherited from + +[`GenericType`](GenericType.md).[`typeArguments`](GenericType.md#typearguments) + +*** + +### typeParameters + +> **typeParameters**: `undefined` \| [`TypeParameter`](TypeParameter.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2822 + +#### Inherited from + +[`GenericType`](GenericType.md).[`typeParameters`](GenericType.md#typeparameters) + +## Methods + +### getApparentProperties() + +> **getApparentProperties**(): [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6124 + +#### Returns + +[`Symbol`](Symbol.md)[] + +#### Inherited from + +[`GenericType`](GenericType.md).[`getApparentProperties`](GenericType.md#getapparentproperties) + +*** + +### getBaseTypes() + +> **getBaseTypes**(): `undefined` \| [`BaseType`](../type-aliases/BaseType.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6129 + +#### Returns + +`undefined` \| [`BaseType`](../type-aliases/BaseType.md)[] + +#### Inherited from + +[`GenericType`](GenericType.md).[`getBaseTypes`](GenericType.md#getbasetypes) + +*** + +### getCallSignatures() + +> **getCallSignatures**(): readonly [`Signature`](Signature.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6125 + +#### Returns + +readonly [`Signature`](Signature.md)[] + +#### Inherited from + +[`GenericType`](GenericType.md).[`getCallSignatures`](GenericType.md#getcallsignatures) + +*** + +### getConstraint() + +> **getConstraint**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6131 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`GenericType`](GenericType.md).[`getConstraint`](GenericType.md#getconstraint) + +*** + +### getConstructSignatures() + +> **getConstructSignatures**(): readonly [`Signature`](Signature.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6126 + +#### Returns + +readonly [`Signature`](Signature.md)[] + +#### Inherited from + +[`GenericType`](GenericType.md).[`getConstructSignatures`](GenericType.md#getconstructsignatures) + +*** + +### getDefault() + +> **getDefault**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6132 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`GenericType`](GenericType.md).[`getDefault`](GenericType.md#getdefault) + +*** + +### getFlags() + +> **getFlags**(): [`TypeFlags`](../enumerations/TypeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6120 + +#### Returns + +[`TypeFlags`](../enumerations/TypeFlags.md) + +#### Inherited from + +[`GenericType`](GenericType.md).[`getFlags`](GenericType.md#getflags) + +*** + +### getNonNullableType() + +> **getNonNullableType**(): [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6130 + +#### Returns + +[`Type`](Type.md) + +#### Inherited from + +[`GenericType`](GenericType.md).[`getNonNullableType`](GenericType.md#getnonnullabletype) + +*** + +### getNumberIndexType() + +> **getNumberIndexType**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6128 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`GenericType`](GenericType.md).[`getNumberIndexType`](GenericType.md#getnumberindextype) + +*** + +### getProperties() + +> **getProperties**(): [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6122 + +#### Returns + +[`Symbol`](Symbol.md)[] + +#### Inherited from + +[`GenericType`](GenericType.md).[`getProperties`](GenericType.md#getproperties) + +*** + +### getProperty() + +> **getProperty**(`propertyName`): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6123 + +#### Parameters + +##### propertyName + +`string` + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +#### Inherited from + +[`GenericType`](GenericType.md).[`getProperty`](GenericType.md#getproperty) + +*** + +### getStringIndexType() + +> **getStringIndexType**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6127 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`GenericType`](GenericType.md).[`getStringIndexType`](GenericType.md#getstringindextype) + +*** + +### getSymbol() + +> **getSymbol**(): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6121 + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +#### Inherited from + +[`GenericType`](GenericType.md).[`getSymbol`](GenericType.md#getsymbol) + +*** + +### isClass() + +> **isClass**(): `this is InterfaceType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6141 + +#### Returns + +`this is InterfaceType` + +#### Inherited from + +[`GenericType`](GenericType.md).[`isClass`](GenericType.md#isclass) + +*** + +### isClassOrInterface() + +> **isClassOrInterface**(): `this is InterfaceType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6140 + +#### Returns + +`this is InterfaceType` + +#### Inherited from + +[`GenericType`](GenericType.md).[`isClassOrInterface`](GenericType.md#isclassorinterface) + +*** + +### isIndexType() + +> **isIndexType**(): `this is IndexType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6142 + +#### Returns + +`this is IndexType` + +#### Inherited from + +[`GenericType`](GenericType.md).[`isIndexType`](GenericType.md#isindextype) + +*** + +### isIntersection() + +> **isIntersection**(): `this is IntersectionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6134 + +#### Returns + +`this is IntersectionType` + +#### Inherited from + +[`GenericType`](GenericType.md).[`isIntersection`](GenericType.md#isintersection) + +*** + +### isLiteral() + +> **isLiteral**(): `this is LiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6136 + +#### Returns + +`this is LiteralType` + +#### Inherited from + +[`GenericType`](GenericType.md).[`isLiteral`](GenericType.md#isliteral) + +*** + +### isNumberLiteral() + +> **isNumberLiteral**(): `this is NumberLiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6138 + +#### Returns + +`this is NumberLiteralType` + +#### Inherited from + +[`GenericType`](GenericType.md).[`isNumberLiteral`](GenericType.md#isnumberliteral) + +*** + +### isStringLiteral() + +> **isStringLiteral**(): `this is StringLiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6137 + +#### Returns + +`this is StringLiteralType` + +#### Inherited from + +[`GenericType`](GenericType.md).[`isStringLiteral`](GenericType.md#isstringliteral) + +*** + +### isTypeParameter() + +> **isTypeParameter**(): `this is TypeParameter` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6139 + +#### Returns + +`this is TypeParameter` + +#### Inherited from + +[`GenericType`](GenericType.md).[`isTypeParameter`](GenericType.md#istypeparameter) + +*** + +### isUnion() + +> **isUnion**(): `this is UnionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6133 + +#### Returns + +`this is UnionType` + +#### Inherited from + +[`GenericType`](GenericType.md).[`isUnion`](GenericType.md#isunion) + +*** + +### isUnionOrIntersection() + +> **isUnionOrIntersection**(): `this is UnionOrIntersectionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6135 + +#### Returns + +`this is UnionOrIntersectionType` + +#### Inherited from + +[`GenericType`](GenericType.md).[`isUnionOrIntersection`](GenericType.md#isunionorintersection) diff --git a/docs/api_docs/namespaces/ts/interfaces/TupleTypeNode.md b/docs/api_docs/namespaces/ts/interfaces/TupleTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..ec03cdb6a9be59125db45906762a28ec948901e9 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/TupleTypeNode.md @@ -0,0 +1,497 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TupleTypeNode + +# Interface: TupleTypeNode + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:972 + +## Extends + +- [`TypeNode`](TypeNode.md) + +## Properties + +### \_typeNodeBrand + +> **\_typeNodeBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:912 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`_typeNodeBrand`](TypeNode.md#_typenodebrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`decorators`](TypeNode.md#decorators) + +*** + +### elements + +> `readonly` **elements**: [`NodeArray`](NodeArray.md)\<[`TypeNode`](TypeNode.md) \| [`NamedTupleMember`](NamedTupleMember.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:974 + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`end`](TypeNode.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`flags`](TypeNode.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`TupleType`](../enumerations/SyntaxKind.md#tupletype) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:973 + +#### Overrides + +[`TypeNode`](TypeNode.md).[`kind`](TypeNode.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`locals`](TypeNode.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`modifiers`](TypeNode.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`parent`](TypeNode.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`pos`](TypeNode.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`skipCheck`](TypeNode.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`symbol`](TypeNode.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`forEachChild`](TypeNode.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getChildAt`](TypeNode.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getChildCount`](TypeNode.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getChildren`](TypeNode.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getEnd`](TypeNode.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFirstToken`](TypeNode.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFullStart`](TypeNode.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFullText`](TypeNode.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFullWidth`](TypeNode.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getLastToken`](TypeNode.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getLeadingTriviaWidth`](TypeNode.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getSourceFile`](TypeNode.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getStart`](TypeNode.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getText`](TypeNode.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getWidth`](TypeNode.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/TupleTypeReference.md b/docs/api_docs/namespaces/ts/interfaces/TupleTypeReference.md new file mode 100644 index 0000000000000000000000000000000000000000..8b80903d16bfeadb77c69bd6fd3e4ef08b6d05e3 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/TupleTypeReference.md @@ -0,0 +1,504 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TupleTypeReference + +# Interface: TupleTypeReference + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2871 + +Type references (ObjectFlags.Reference). When a class or interface has type parameters or +a "this" type, references to the class or interface are made using type references. The +typeArguments property specifies the types to substitute for the type parameters of the +class or interface and optionally includes an extra element that specifies the type to +substitute for "this" in the resulting instantiation. When no extra argument is present, +the type reference itself is substituted for "this". The typeArguments property is undefined +if the class or interface has no type parameters and the reference isn't specifying an +explicit "this" argument. + +## Extends + +- [`TypeReference`](TypeReference.md) + +## Properties + +### aliasSymbol? + +> `optional` **aliasSymbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2773 + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`aliasSymbol`](TypeReference.md#aliassymbol) + +*** + +### aliasTypeArguments? + +> `optional` **aliasTypeArguments**: readonly [`Type`](Type.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2774 + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`aliasTypeArguments`](TypeReference.md#aliastypearguments) + +*** + +### flags + +> **flags**: [`TypeFlags`](../enumerations/TypeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2770 + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`flags`](TypeReference.md#flags) + +*** + +### node? + +> `optional` **node**: [`TypeReferenceNode`](TypeReferenceNode.md) \| [`ArrayTypeNode`](ArrayTypeNode.md) \| [`TupleTypeNode`](TupleTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2846 + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`node`](TypeReference.md#node) + +*** + +### objectFlags + +> **objectFlags**: [`ObjectFlags`](../enumerations/ObjectFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2818 + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`objectFlags`](TypeReference.md#objectflags) + +*** + +### pattern? + +> `optional` **pattern**: [`DestructuringPattern`](../type-aliases/DestructuringPattern.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2772 + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`pattern`](TypeReference.md#pattern) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2771 + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`symbol`](TypeReference.md#symbol) + +*** + +### target + +> **target**: [`TupleType`](TupleType.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2872 + +#### Overrides + +[`TypeReference`](TypeReference.md).[`target`](TypeReference.md#target) + +*** + +### typeArguments? + +> `optional` **typeArguments**: readonly [`Type`](Type.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6145 + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`typeArguments`](TypeReference.md#typearguments) + +## Methods + +### getApparentProperties() + +> **getApparentProperties**(): [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6124 + +#### Returns + +[`Symbol`](Symbol.md)[] + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`getApparentProperties`](TypeReference.md#getapparentproperties) + +*** + +### getBaseTypes() + +> **getBaseTypes**(): `undefined` \| [`BaseType`](../type-aliases/BaseType.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6129 + +#### Returns + +`undefined` \| [`BaseType`](../type-aliases/BaseType.md)[] + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`getBaseTypes`](TypeReference.md#getbasetypes) + +*** + +### getCallSignatures() + +> **getCallSignatures**(): readonly [`Signature`](Signature.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6125 + +#### Returns + +readonly [`Signature`](Signature.md)[] + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`getCallSignatures`](TypeReference.md#getcallsignatures) + +*** + +### getConstraint() + +> **getConstraint**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6131 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`getConstraint`](TypeReference.md#getconstraint) + +*** + +### getConstructSignatures() + +> **getConstructSignatures**(): readonly [`Signature`](Signature.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6126 + +#### Returns + +readonly [`Signature`](Signature.md)[] + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`getConstructSignatures`](TypeReference.md#getconstructsignatures) + +*** + +### getDefault() + +> **getDefault**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6132 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`getDefault`](TypeReference.md#getdefault) + +*** + +### getFlags() + +> **getFlags**(): [`TypeFlags`](../enumerations/TypeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6120 + +#### Returns + +[`TypeFlags`](../enumerations/TypeFlags.md) + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`getFlags`](TypeReference.md#getflags) + +*** + +### getNonNullableType() + +> **getNonNullableType**(): [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6130 + +#### Returns + +[`Type`](Type.md) + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`getNonNullableType`](TypeReference.md#getnonnullabletype) + +*** + +### getNumberIndexType() + +> **getNumberIndexType**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6128 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`getNumberIndexType`](TypeReference.md#getnumberindextype) + +*** + +### getProperties() + +> **getProperties**(): [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6122 + +#### Returns + +[`Symbol`](Symbol.md)[] + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`getProperties`](TypeReference.md#getproperties) + +*** + +### getProperty() + +> **getProperty**(`propertyName`): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6123 + +#### Parameters + +##### propertyName + +`string` + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`getProperty`](TypeReference.md#getproperty) + +*** + +### getStringIndexType() + +> **getStringIndexType**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6127 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`getStringIndexType`](TypeReference.md#getstringindextype) + +*** + +### getSymbol() + +> **getSymbol**(): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6121 + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`getSymbol`](TypeReference.md#getsymbol) + +*** + +### isClass() + +> **isClass**(): `this is InterfaceType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6141 + +#### Returns + +`this is InterfaceType` + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`isClass`](TypeReference.md#isclass) + +*** + +### isClassOrInterface() + +> **isClassOrInterface**(): `this is InterfaceType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6140 + +#### Returns + +`this is InterfaceType` + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`isClassOrInterface`](TypeReference.md#isclassorinterface) + +*** + +### isIndexType() + +> **isIndexType**(): `this is IndexType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6142 + +#### Returns + +`this is IndexType` + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`isIndexType`](TypeReference.md#isindextype) + +*** + +### isIntersection() + +> **isIntersection**(): `this is IntersectionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6134 + +#### Returns + +`this is IntersectionType` + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`isIntersection`](TypeReference.md#isintersection) + +*** + +### isLiteral() + +> **isLiteral**(): `this is LiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6136 + +#### Returns + +`this is LiteralType` + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`isLiteral`](TypeReference.md#isliteral) + +*** + +### isNumberLiteral() + +> **isNumberLiteral**(): `this is NumberLiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6138 + +#### Returns + +`this is NumberLiteralType` + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`isNumberLiteral`](TypeReference.md#isnumberliteral) + +*** + +### isStringLiteral() + +> **isStringLiteral**(): `this is StringLiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6137 + +#### Returns + +`this is StringLiteralType` + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`isStringLiteral`](TypeReference.md#isstringliteral) + +*** + +### isTypeParameter() + +> **isTypeParameter**(): `this is TypeParameter` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6139 + +#### Returns + +`this is TypeParameter` + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`isTypeParameter`](TypeReference.md#istypeparameter) + +*** + +### isUnion() + +> **isUnion**(): `this is UnionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6133 + +#### Returns + +`this is UnionType` + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`isUnion`](TypeReference.md#isunion) + +*** + +### isUnionOrIntersection() + +> **isUnionOrIntersection**(): `this is UnionOrIntersectionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6135 + +#### Returns + +`this is UnionOrIntersectionType` + +#### Inherited from + +[`TypeReference`](TypeReference.md).[`isUnionOrIntersection`](TypeReference.md#isunionorintersection) diff --git a/docs/api_docs/namespaces/ts/interfaces/Type.md b/docs/api_docs/namespaces/ts/interfaces/Type.md new file mode 100644 index 0000000000000000000000000000000000000000..d7d42dccfdac00099e96037fbac19881ed15fd5e --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/Type.md @@ -0,0 +1,340 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / Type + +# Interface: Type + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2769 + +## Extended by + +- [`LiteralType`](LiteralType.md) +- [`UniqueESSymbolType`](UniqueESSymbolType.md) +- [`EnumType`](EnumType.md) +- [`ObjectType`](ObjectType.md) +- [`UnionOrIntersectionType`](UnionOrIntersectionType.md) +- [`InstantiableType`](InstantiableType.md) + +## Properties + +### aliasSymbol? + +> `optional` **aliasSymbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2773 + +*** + +### aliasTypeArguments? + +> `optional` **aliasTypeArguments**: readonly [`Type`](Type.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2774 + +*** + +### flags + +> **flags**: [`TypeFlags`](../enumerations/TypeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2770 + +*** + +### pattern? + +> `optional` **pattern**: [`DestructuringPattern`](../type-aliases/DestructuringPattern.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2772 + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2771 + +## Methods + +### getApparentProperties() + +> **getApparentProperties**(): [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6124 + +#### Returns + +[`Symbol`](Symbol.md)[] + +*** + +### getBaseTypes() + +> **getBaseTypes**(): `undefined` \| [`BaseType`](../type-aliases/BaseType.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6129 + +#### Returns + +`undefined` \| [`BaseType`](../type-aliases/BaseType.md)[] + +*** + +### getCallSignatures() + +> **getCallSignatures**(): readonly [`Signature`](Signature.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6125 + +#### Returns + +readonly [`Signature`](Signature.md)[] + +*** + +### getConstraint() + +> **getConstraint**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6131 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +*** + +### getConstructSignatures() + +> **getConstructSignatures**(): readonly [`Signature`](Signature.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6126 + +#### Returns + +readonly [`Signature`](Signature.md)[] + +*** + +### getDefault() + +> **getDefault**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6132 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +*** + +### getFlags() + +> **getFlags**(): [`TypeFlags`](../enumerations/TypeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6120 + +#### Returns + +[`TypeFlags`](../enumerations/TypeFlags.md) + +*** + +### getNonNullableType() + +> **getNonNullableType**(): [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6130 + +#### Returns + +[`Type`](Type.md) + +*** + +### getNumberIndexType() + +> **getNumberIndexType**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6128 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +*** + +### getProperties() + +> **getProperties**(): [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6122 + +#### Returns + +[`Symbol`](Symbol.md)[] + +*** + +### getProperty() + +> **getProperty**(`propertyName`): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6123 + +#### Parameters + +##### propertyName + +`string` + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +*** + +### getStringIndexType() + +> **getStringIndexType**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6127 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +*** + +### getSymbol() + +> **getSymbol**(): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6121 + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +*** + +### isClass() + +> **isClass**(): `this is InterfaceType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6141 + +#### Returns + +`this is InterfaceType` + +*** + +### isClassOrInterface() + +> **isClassOrInterface**(): `this is InterfaceType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6140 + +#### Returns + +`this is InterfaceType` + +*** + +### isIndexType() + +> **isIndexType**(): `this is IndexType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6142 + +#### Returns + +`this is IndexType` + +*** + +### isIntersection() + +> **isIntersection**(): `this is IntersectionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6134 + +#### Returns + +`this is IntersectionType` + +*** + +### isLiteral() + +> **isLiteral**(): `this is LiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6136 + +#### Returns + +`this is LiteralType` + +*** + +### isNumberLiteral() + +> **isNumberLiteral**(): `this is NumberLiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6138 + +#### Returns + +`this is NumberLiteralType` + +*** + +### isStringLiteral() + +> **isStringLiteral**(): `this is StringLiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6137 + +#### Returns + +`this is StringLiteralType` + +*** + +### isTypeParameter() + +> **isTypeParameter**(): `this is TypeParameter` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6139 + +#### Returns + +`this is TypeParameter` + +*** + +### isUnion() + +> **isUnion**(): `this is UnionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6133 + +#### Returns + +`this is UnionType` + +*** + +### isUnionOrIntersection() + +> **isUnionOrIntersection**(): `this is UnionOrIntersectionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6135 + +#### Returns + +`this is UnionOrIntersectionType` diff --git a/docs/api_docs/namespaces/ts/interfaces/TypeAcquisition.md b/docs/api_docs/namespaces/ts/interfaces/TypeAcquisition.md new file mode 100644 index 0000000000000000000000000000000000000000..d7884882874f9b2ad62f3a503a24c36a6fdf0613 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/TypeAcquisition.md @@ -0,0 +1,58 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TypeAcquisition + +# Interface: TypeAcquisition + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3234 + +## Indexable + +\[`option`: `string`\]: [`CompilerOptionsValue`](../type-aliases/CompilerOptionsValue.md) + +## Properties + +### disableFilenameBasedTypeAcquisition? + +> `optional` **disableFilenameBasedTypeAcquisition**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3243 + +*** + +### enable? + +> `optional` **enable**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3240 + +*** + +### ~~enableAutoDiscovery?~~ + +> `optional` **enableAutoDiscovery**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3239 + +#### Deprecated + +typingOptions.enableAutoDiscovery +Use typeAcquisition.enable instead. + +*** + +### exclude? + +> `optional` **exclude**: `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3242 + +*** + +### include? + +> `optional` **include**: `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3241 diff --git a/docs/api_docs/namespaces/ts/interfaces/TypeAliasDeclaration.md b/docs/api_docs/namespaces/ts/interfaces/TypeAliasDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..113db2d5a1305a5483838d65bb597edd55ecad63 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/TypeAliasDeclaration.md @@ -0,0 +1,529 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TypeAliasDeclaration + +# Interface: TypeAliasDeclaration + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1655 + +## Extends + +- [`DeclarationStatement`](DeclarationStatement.md).[`JSDocContainer`](JSDocContainer.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`_declarationBrand`](DeclarationStatement.md#_declarationbrand) + +*** + +### \_statementBrand + +> **\_statementBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1471 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`_statementBrand`](DeclarationStatement.md#_statementbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`decorators`](DeclarationStatement.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`end`](DeclarationStatement.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`flags`](DeclarationStatement.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`TypeAliasDeclaration`](../enumerations/SyntaxKind.md#typealiasdeclaration) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1656 + +#### Overrides + +[`DeclarationStatement`](DeclarationStatement.md).[`kind`](DeclarationStatement.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`locals`](DeclarationStatement.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`Modifier`](../type-aliases/Modifier.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1657 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Overrides + +[`DeclarationStatement`](DeclarationStatement.md).[`modifiers`](DeclarationStatement.md#modifiers) + +*** + +### name + +> `readonly` **name**: [`Identifier`](Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1658 + +#### Overrides + +[`DeclarationStatement`](DeclarationStatement.md).[`name`](DeclarationStatement.md#name) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`parent`](DeclarationStatement.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`pos`](DeclarationStatement.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`skipCheck`](DeclarationStatement.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`symbol`](DeclarationStatement.md#symbol) + +*** + +### type + +> `readonly` **type**: [`TypeNode`](TypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1660 + +*** + +### typeParameters? + +> `readonly` `optional` **typeParameters**: [`NodeArray`](NodeArray.md)\<[`TypeParameterDeclaration`](TypeParameterDeclaration.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1659 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`forEachChild`](DeclarationStatement.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getChildAt`](DeclarationStatement.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getChildCount`](DeclarationStatement.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getChildren`](DeclarationStatement.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getEnd`](DeclarationStatement.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getFirstToken`](DeclarationStatement.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getFullStart`](DeclarationStatement.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getFullText`](DeclarationStatement.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getFullWidth`](DeclarationStatement.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getLastToken`](DeclarationStatement.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getLeadingTriviaWidth`](DeclarationStatement.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getSourceFile`](DeclarationStatement.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getStart`](DeclarationStatement.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getText`](DeclarationStatement.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`DeclarationStatement`](DeclarationStatement.md).[`getWidth`](DeclarationStatement.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/TypeAssertion.md b/docs/api_docs/namespaces/ts/interfaces/TypeAssertion.md new file mode 100644 index 0000000000000000000000000000000000000000..2e2aa0444c45474e85430d1e64283491d575cf41 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/TypeAssertion.md @@ -0,0 +1,517 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TypeAssertion + +# Interface: TypeAssertion + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1375 + +## Extends + +- [`UnaryExpression`](UnaryExpression.md) + +## Properties + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`_expressionBrand`](UnaryExpression.md#_expressionbrand) + +*** + +### \_unaryExpressionBrand + +> **\_unaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1066 + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`_unaryExpressionBrand`](UnaryExpression.md#_unaryexpressionbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`decorators`](UnaryExpression.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`end`](UnaryExpression.md#end) + +*** + +### expression + +> `readonly` **expression**: [`UnaryExpression`](UnaryExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1378 + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`flags`](UnaryExpression.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`TypeAssertionExpression`](../enumerations/SyntaxKind.md#typeassertionexpression) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1376 + +#### Overrides + +[`UnaryExpression`](UnaryExpression.md).[`kind`](UnaryExpression.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`locals`](UnaryExpression.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`modifiers`](UnaryExpression.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`parent`](UnaryExpression.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`pos`](UnaryExpression.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`skipCheck`](UnaryExpression.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`symbol`](UnaryExpression.md#symbol) + +*** + +### type + +> `readonly` **type**: [`TypeNode`](TypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1377 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`forEachChild`](UnaryExpression.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getChildAt`](UnaryExpression.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getChildCount`](UnaryExpression.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getChildren`](UnaryExpression.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getEnd`](UnaryExpression.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getFirstToken`](UnaryExpression.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getFullStart`](UnaryExpression.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getFullText`](UnaryExpression.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getFullWidth`](UnaryExpression.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getLastToken`](UnaryExpression.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getLeadingTriviaWidth`](UnaryExpression.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getSourceFile`](UnaryExpression.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getStart`](UnaryExpression.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getText`](UnaryExpression.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getWidth`](UnaryExpression.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/TypeChecker.md b/docs/api_docs/namespaces/ts/interfaces/TypeChecker.md new file mode 100644 index 0000000000000000000000000000000000000000..b0c57db5cb6721bb42984cc75628da3e210f6293 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/TypeChecker.md @@ -0,0 +1,1464 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TypeChecker + +# Interface: TypeChecker + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2384 + +## Properties + +### getIndexInfosOfIndexSymbol() + +> **getIndexInfosOfIndexSymbol**: (`indexSymbol`) => [`IndexInfo`](IndexInfo.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2392 + +#### Parameters + +##### indexSymbol + +[`Symbol`](Symbol.md) + +#### Returns + +[`IndexInfo`](IndexInfo.md)[] + +## Methods + +### clearConstEnumRelate()? + +> `optional` **clearConstEnumRelate**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2486 + +#### Returns + +`void` + +*** + +### deleteConstEnumRelate()? + +> `optional` **deleteConstEnumRelate**(`path`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2487 + +#### Parameters + +##### path + +`string` + +#### Returns + +`void` + +*** + +### getAliasedSymbol() + +> **getAliasedSymbol**(`symbol`): [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2467 + +Follow all aliases to get the original symbol. + +#### Parameters + +##### symbol + +[`Symbol`](Symbol.md) + +#### Returns + +[`Symbol`](Symbol.md) + +*** + +### getAmbientModules() + +> **getAmbientModules**(): [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2473 + +#### Returns + +[`Symbol`](Symbol.md)[] + +*** + +### getApparentType() + +> **getApparentType**(`type`): [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2475 + +#### Parameters + +##### type + +[`Type`](Type.md) + +#### Returns + +[`Type`](Type.md) + +*** + +### getAugmentedPropertiesOfType() + +> **getAugmentedPropertiesOfType**(`type`): [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2448 + +#### Parameters + +##### type + +[`Type`](Type.md) + +#### Returns + +[`Symbol`](Symbol.md)[] + +*** + +### getBaseConstraintOfType() + +> **getBaseConstraintOfType**(`type`): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2476 + +#### Parameters + +##### type + +[`Type`](Type.md) + +#### Returns + +`undefined` \| [`Type`](Type.md) + +*** + +### getBaseTypeOfLiteralType() + +> **getBaseTypeOfLiteralType**(`type`): [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2396 + +#### Parameters + +##### type + +[`Type`](Type.md) + +#### Returns + +[`Type`](Type.md) + +*** + +### getBaseTypes() + +> **getBaseTypes**(`type`): [`BaseType`](../type-aliases/BaseType.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2395 + +#### Parameters + +##### type + +[`InterfaceType`](InterfaceType.md) + +#### Returns + +[`BaseType`](../type-aliases/BaseType.md)[] + +*** + +### getConstantValue() + +> **getConstantValue**(`node`): `undefined` \| `string` \| `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2464 + +#### Parameters + +##### node + +[`EnumMember`](EnumMember.md) | [`PropertyAccessExpression`](PropertyAccessExpression.md) | [`ElementAccessExpression`](ElementAccessExpression.md) + +#### Returns + +`undefined` \| `string` \| `number` + +*** + +### getConstEnumRelate()? + +> `optional` **getConstEnumRelate**(): [`ESMap`](ESMap.md)\<`string`, [`ESMap`](ESMap.md)\<`string`, `string`\>\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2485 + +#### Returns + +[`ESMap`](ESMap.md)\<`string`, [`ESMap`](ESMap.md)\<`string`, `string`\>\> + +*** + +### getContextualType() + +> **getContextualType**(`node`): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2451 + +#### Parameters + +##### node + +[`Expression`](Expression.md) + +#### Returns + +`undefined` \| [`Type`](Type.md) + +*** + +### getDeclaredTypeOfSymbol() + +> **getDeclaredTypeOfSymbol**(`symbol`): [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2386 + +#### Parameters + +##### symbol + +[`Symbol`](Symbol.md) + +#### Returns + +[`Type`](Type.md) + +*** + +### getDefaultFromTypeParameter() + +> **getDefaultFromTypeParameter**(`type`): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2477 + +#### Parameters + +##### type + +[`Type`](Type.md) + +#### Returns + +`undefined` \| [`Type`](Type.md) + +*** + +### getExportsOfModule() + +> **getExportsOfModule**(`moduleSymbol`): [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2470 + +#### Parameters + +##### moduleSymbol + +[`Symbol`](Symbol.md) + +#### Returns + +[`Symbol`](Symbol.md)[] + +*** + +### getExportSpecifierLocalTargetSymbol() + +> **getExportSpecifierLocalTargetSymbol**(`location`): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2428 + +#### Parameters + +##### location + +[`Identifier`](Identifier.md) | [`ExportSpecifier`](ExportSpecifier.md) + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +*** + +### getExportSymbolOfSymbol() + +> **getExportSymbolOfSymbol**(`symbol`): [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2437 + +If a symbol is a local symbol with an associated exported symbol, returns the exported symbol. +Otherwise returns its input. +For example, at `export type T = number;`: + - `getSymbolAtLocation` at the location `T` will return the exported symbol for `T`. + - But the result of `getSymbolsInScope` will contain the *local* symbol for `T`, not the exported symbol. + - Calling `getExportSymbolOfSymbol` on that local symbol will return the exported symbol. + +#### Parameters + +##### symbol + +[`Symbol`](Symbol.md) + +#### Returns + +[`Symbol`](Symbol.md) + +*** + +### getFullyQualifiedName() + +> **getFullyQualifiedName**(`symbol`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2447 + +#### Parameters + +##### symbol + +[`Symbol`](Symbol.md) + +#### Returns + +`string` + +*** + +### getImmediateAliasedSymbol() + +> **getImmediateAliasedSymbol**(`symbol`): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2469 + +Follow a *single* alias to get the immediately aliased symbol. + +#### Parameters + +##### symbol + +[`Symbol`](Symbol.md) + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +*** + +### getIndexInfoOfType() + +> **getIndexInfoOfType**(`type`, `kind`): `undefined` \| [`IndexInfo`](IndexInfo.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2390 + +#### Parameters + +##### type + +[`Type`](Type.md) + +##### kind + +[`IndexKind`](../enumerations/IndexKind.md) + +#### Returns + +`undefined` \| [`IndexInfo`](IndexInfo.md) + +*** + +### getIndexInfosOfType() + +> **getIndexInfosOfType**(`type`): readonly [`IndexInfo`](IndexInfo.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2391 + +#### Parameters + +##### type + +[`Type`](Type.md) + +#### Returns + +readonly [`IndexInfo`](IndexInfo.md)[] + +*** + +### getIndexTypeOfType() + +> **getIndexTypeOfType**(`type`, `kind`): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2394 + +#### Parameters + +##### type + +[`Type`](Type.md) + +##### kind + +[`IndexKind`](../enumerations/IndexKind.md) + +#### Returns + +`undefined` \| [`Type`](Type.md) + +*** + +### getJsxIntrinsicTagNamesAt() + +> **getJsxIntrinsicTagNamesAt**(`location`): [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2471 + +#### Parameters + +##### location + +[`Node`](Node.md) + +#### Returns + +[`Symbol`](Symbol.md)[] + +*** + +### getNonNullableType() + +> **getNonNullableType**(`type`): [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2400 + +#### Parameters + +##### type + +[`Type`](Type.md) + +#### Returns + +[`Type`](Type.md) + +*** + +### getNullableType() + +> **getNullableType**(`type`, `flags`): [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2399 + +#### Parameters + +##### type + +[`Type`](Type.md) + +##### flags + +[`TypeFlags`](../enumerations/TypeFlags.md) + +#### Returns + +[`Type`](Type.md) + +*** + +### getPrivateIdentifierPropertyOfType() + +> **getPrivateIdentifierPropertyOfType**(`leftType`, `name`, `location`): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2389 + +#### Parameters + +##### leftType + +[`Type`](Type.md) + +##### name + +`string` + +##### location + +[`Node`](Node.md) + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +*** + +### getPropertiesOfType() + +> **getPropertiesOfType**(`type`): [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2387 + +#### Parameters + +##### type + +[`Type`](Type.md) + +#### Returns + +[`Symbol`](Symbol.md)[] + +*** + +### getPropertyOfType() + +> **getPropertyOfType**(`type`, `propertyName`): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2388 + +#### Parameters + +##### type + +[`Type`](Type.md) + +##### propertyName + +`string` + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +*** + +### getPropertySymbolOfDestructuringAssignment() + +> **getPropertySymbolOfDestructuringAssignment**(`location`): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2438 + +#### Parameters + +##### location + +[`Identifier`](Identifier.md) + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +*** + +### getResolvedSignature() + +> **getResolvedSignature**(`node`, `candidatesOutArray`?, `argumentCount`?): `undefined` \| [`Signature`](Signature.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2457 + +returns unknownSignature in the case of an error. +returns undefined if the node is not valid. + +#### Parameters + +##### node + +[`CallLikeExpression`](../type-aliases/CallLikeExpression.md) + +##### candidatesOutArray? + +[`Signature`](Signature.md)[] + +##### argumentCount? + +`number` + +Apparent number of arguments, passed in case of a possibly incomplete call. This should come from an ArgumentListInfo. See `signatureHelp.ts`. + +#### Returns + +`undefined` \| [`Signature`](Signature.md) + +*** + +### getReturnTypeOfSignature() + +> **getReturnTypeOfSignature**(`signature`): [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2398 + +#### Parameters + +##### signature + +[`Signature`](Signature.md) + +#### Returns + +[`Type`](Type.md) + +*** + +### getRootSymbols() + +> **getRootSymbols**(`symbol`): readonly [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2449 + +#### Parameters + +##### symbol + +[`Symbol`](Symbol.md) + +#### Returns + +readonly [`Symbol`](Symbol.md)[] + +*** + +### getShorthandAssignmentValueSymbol() + +> **getShorthandAssignmentValueSymbol**(`location`): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2427 + +The function returns the value (local variable) symbol of an identifier in the short-hand property assignment. +This is necessary as an identifier in short-hand property assignment can contains two meaning: property name and property value. + +#### Parameters + +##### location + +`undefined` | [`Node`](Node.md) + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +*** + +### getSignatureFromDeclaration() + +> **getSignatureFromDeclaration**(`declaration`): `undefined` \| [`Signature`](Signature.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2459 + +#### Parameters + +##### declaration + +[`SignatureDeclaration`](../type-aliases/SignatureDeclaration.md) + +#### Returns + +`undefined` \| [`Signature`](Signature.md) + +*** + +### getSignaturesOfType() + +> **getSignaturesOfType**(`type`, `kind`): readonly [`Signature`](Signature.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2393 + +#### Parameters + +##### type + +[`Type`](Type.md) + +##### kind + +[`SignatureKind`](../enumerations/SignatureKind.md) + +#### Returns + +readonly [`Signature`](Signature.md)[] + +*** + +### getSymbolAtLocation() + +> **getSymbolAtLocation**(`node`): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2421 + +#### Parameters + +##### node + +[`Node`](Node.md) + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +*** + +### getSymbolOfExpando() + +> **getSymbolOfExpando**(`node`, `allowDeclaration`): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2450 + +#### Parameters + +##### node + +[`Node`](Node.md) + +##### allowDeclaration + +`boolean` + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +*** + +### getSymbolsInScope() + +> **getSymbolsInScope**(`location`, `meaning`): [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2420 + +#### Parameters + +##### location + +[`Node`](Node.md) + +##### meaning + +[`SymbolFlags`](../enumerations/SymbolFlags.md) + +#### Returns + +[`Symbol`](Symbol.md)[] + +*** + +### getSymbolsOfParameterPropertyDeclaration() + +> **getSymbolsOfParameterPropertyDeclaration**(`parameter`, `parameterName`): [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2422 + +#### Parameters + +##### parameter + +[`ParameterDeclaration`](ParameterDeclaration.md) + +##### parameterName + +`string` + +#### Returns + +[`Symbol`](Symbol.md)[] + +*** + +### getTypeArguments() + +> **getTypeArguments**(`type`): readonly [`Type`](Type.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2401 + +#### Parameters + +##### type + +[`TypeReference`](TypeReference.md) + +#### Returns + +readonly [`Type`](Type.md)[] + +*** + +### getTypeAtLocation() + +> **getTypeAtLocation**(`node`): [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2440 + +#### Parameters + +##### node + +[`Node`](Node.md) + +#### Returns + +[`Type`](Type.md) + +*** + +### getTypeFromTypeNode() + +> **getTypeFromTypeNode**(`node`): [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2442 + +#### Parameters + +##### node + +[`TypeNode`](TypeNode.md) + +#### Returns + +[`Type`](Type.md) + +*** + +### getTypeOfAssignmentPattern() + +> **getTypeOfAssignmentPattern**(`pattern`): [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2439 + +#### Parameters + +##### pattern + +[`AssignmentPattern`](../type-aliases/AssignmentPattern.md) + +#### Returns + +[`Type`](Type.md) + +*** + +### getTypeOfSymbolAtLocation() + +> **getTypeOfSymbolAtLocation**(`symbol`, `node`): [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2385 + +#### Parameters + +##### symbol + +[`Symbol`](Symbol.md) + +##### node + +[`Node`](Node.md) + +#### Returns + +[`Type`](Type.md) + +*** + +### getTypePredicateOfSignature() + +> **getTypePredicateOfSignature**(`signature`): `undefined` \| [`TypePredicate`](../type-aliases/TypePredicate.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2478 + +#### Parameters + +##### signature + +[`Signature`](Signature.md) + +#### Returns + +`undefined` \| [`TypePredicate`](../type-aliases/TypePredicate.md) + +*** + +### getWidenedType() + +> **getWidenedType**(`type`): [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2397 + +#### Parameters + +##### type + +[`Type`](Type.md) + +#### Returns + +[`Type`](Type.md) + +*** + +### indexInfoToIndexSignatureDeclaration() + +> **indexInfoToIndexSignatureDeclaration**(`indexInfo`, `enclosingDeclaration`, `flags`): `undefined` \| [`IndexSignatureDeclaration`](IndexSignatureDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2409 + +Note that the resulting nodes cannot be checked. + +#### Parameters + +##### indexInfo + +[`IndexInfo`](IndexInfo.md) + +##### enclosingDeclaration + +`undefined` | [`Node`](Node.md) + +##### flags + +`undefined` | [`NodeBuilderFlags`](../enumerations/NodeBuilderFlags.md) + +#### Returns + +`undefined` \| [`IndexSignatureDeclaration`](IndexSignatureDeclaration.md) + +*** + +### isArgumentsSymbol() + +> **isArgumentsSymbol**(`symbol`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2462 + +#### Parameters + +##### symbol + +[`Symbol`](Symbol.md) + +#### Returns + +`boolean` + +*** + +### isImplementationOfOverload() + +> **isImplementationOfOverload**(`node`): `undefined` \| `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2460 + +#### Parameters + +##### node + +[`SignatureDeclaration`](../type-aliases/SignatureDeclaration.md) + +#### Returns + +`undefined` \| `boolean` + +*** + +### isOptionalParameter() + +> **isOptionalParameter**(`node`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2472 + +#### Parameters + +##### node + +[`ParameterDeclaration`](ParameterDeclaration.md) + +#### Returns + +`boolean` + +*** + +### isUndefinedSymbol() + +> **isUndefinedSymbol**(`symbol`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2461 + +#### Parameters + +##### symbol + +[`Symbol`](Symbol.md) + +#### Returns + +`boolean` + +*** + +### isUnknownSymbol() + +> **isUnknownSymbol**(`symbol`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2463 + +#### Parameters + +##### symbol + +[`Symbol`](Symbol.md) + +#### Returns + +`boolean` + +*** + +### isValidPropertyAccess() + +> **isValidPropertyAccess**(`node`, `propertyName`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2465 + +#### Parameters + +##### node + +[`PropertyAccessExpression`](PropertyAccessExpression.md) | [`QualifiedName`](QualifiedName.md) | [`ImportTypeNode`](ImportTypeNode.md) + +##### propertyName + +`string` + +#### Returns + +`boolean` + +*** + +### runWithCancellationToken() + +> **runWithCancellationToken**\<`T`\>(`token`, `cb`): `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2484 + +Depending on the operation performed, it may be appropriate to throw away the checker +if the cancellation token is triggered. Typically, if it is used for error checking +and the operation is cancelled, then it should be discarded, otherwise it is safe to keep. + +#### Type Parameters + +• **T** + +#### Parameters + +##### token + +[`CancellationToken`](CancellationToken.md) + +##### cb + +(`checker`) => `T` + +#### Returns + +`T` + +*** + +### signatureToSignatureDeclaration() + +> **signatureToSignatureDeclaration**(`signature`, `kind`, `enclosingDeclaration`, `flags`): `undefined` \| SignatureDeclaration & \{ typeArguments?: NodeArray\ \| undefined; \} + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2405 + +Note that the resulting nodes cannot be checked. + +#### Parameters + +##### signature + +[`Signature`](Signature.md) + +##### kind + +[`SyntaxKind`](../enumerations/SyntaxKind.md) + +##### enclosingDeclaration + +`undefined` | [`Node`](Node.md) + +##### flags + +`undefined` | [`NodeBuilderFlags`](../enumerations/NodeBuilderFlags.md) + +#### Returns + +`undefined` \| SignatureDeclaration & \{ typeArguments?: NodeArray\ \| undefined; \} + +*** + +### signatureToString() + +> **signatureToString**(`signature`, `enclosingDeclaration`?, `flags`?, `kind`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2443 + +#### Parameters + +##### signature + +[`Signature`](Signature.md) + +##### enclosingDeclaration? + +[`Node`](Node.md) + +##### flags? + +[`TypeFormatFlags`](../enumerations/TypeFormatFlags.md) + +##### kind? + +[`SignatureKind`](../enumerations/SignatureKind.md) + +#### Returns + +`string` + +*** + +### symbolToEntityName() + +> **symbolToEntityName**(`symbol`, `meaning`, `enclosingDeclaration`, `flags`): `undefined` \| [`EntityName`](../type-aliases/EntityName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2411 + +Note that the resulting nodes cannot be checked. + +#### Parameters + +##### symbol + +[`Symbol`](Symbol.md) + +##### meaning + +[`SymbolFlags`](../enumerations/SymbolFlags.md) + +##### enclosingDeclaration + +`undefined` | [`Node`](Node.md) + +##### flags + +`undefined` | [`NodeBuilderFlags`](../enumerations/NodeBuilderFlags.md) + +#### Returns + +`undefined` \| [`EntityName`](../type-aliases/EntityName.md) + +*** + +### symbolToExpression() + +> **symbolToExpression**(`symbol`, `meaning`, `enclosingDeclaration`, `flags`): `undefined` \| [`Expression`](Expression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2413 + +Note that the resulting nodes cannot be checked. + +#### Parameters + +##### symbol + +[`Symbol`](Symbol.md) + +##### meaning + +[`SymbolFlags`](../enumerations/SymbolFlags.md) + +##### enclosingDeclaration + +`undefined` | [`Node`](Node.md) + +##### flags + +`undefined` | [`NodeBuilderFlags`](../enumerations/NodeBuilderFlags.md) + +#### Returns + +`undefined` \| [`Expression`](Expression.md) + +*** + +### symbolToParameterDeclaration() + +> **symbolToParameterDeclaration**(`symbol`, `enclosingDeclaration`, `flags`): `undefined` \| [`ParameterDeclaration`](ParameterDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2417 + +Note that the resulting nodes cannot be checked. + +#### Parameters + +##### symbol + +[`Symbol`](Symbol.md) + +##### enclosingDeclaration + +`undefined` | [`Node`](Node.md) + +##### flags + +`undefined` | [`NodeBuilderFlags`](../enumerations/NodeBuilderFlags.md) + +#### Returns + +`undefined` \| [`ParameterDeclaration`](ParameterDeclaration.md) + +*** + +### symbolToString() + +> **symbolToString**(`symbol`, `enclosingDeclaration`?, `meaning`?, `flags`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2445 + +#### Parameters + +##### symbol + +[`Symbol`](Symbol.md) + +##### enclosingDeclaration? + +[`Node`](Node.md) + +##### meaning? + +[`SymbolFlags`](../enumerations/SymbolFlags.md) + +##### flags? + +[`SymbolFormatFlags`](../enumerations/SymbolFormatFlags.md) + +#### Returns + +`string` + +*** + +### symbolToTypeParameterDeclarations() + +> **symbolToTypeParameterDeclarations**(`symbol`, `enclosingDeclaration`, `flags`): `undefined` \| [`NodeArray`](NodeArray.md)\<[`TypeParameterDeclaration`](TypeParameterDeclaration.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2415 + +Note that the resulting nodes cannot be checked. + +#### Parameters + +##### symbol + +[`Symbol`](Symbol.md) + +##### enclosingDeclaration + +`undefined` | [`Node`](Node.md) + +##### flags + +`undefined` | [`NodeBuilderFlags`](../enumerations/NodeBuilderFlags.md) + +#### Returns + +`undefined` \| [`NodeArray`](NodeArray.md)\<[`TypeParameterDeclaration`](TypeParameterDeclaration.md)\> + +*** + +### tryGetMemberInModuleExports() + +> **tryGetMemberInModuleExports**(`memberName`, `moduleSymbol`): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2474 + +#### Parameters + +##### memberName + +`string` + +##### moduleSymbol + +[`Symbol`](Symbol.md) + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +*** + +### tryGetResolvedSignatureWithoutCheck() + +> **tryGetResolvedSignatureWithoutCheck**(`node`, `candidatesOutArray`?, `argumentCount`?): `undefined` \| [`Signature`](Signature.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2458 + +#### Parameters + +##### node + +[`CallLikeExpression`](../type-aliases/CallLikeExpression.md) + +##### candidatesOutArray? + +[`Signature`](Signature.md)[] + +##### argumentCount? + +`number` + +#### Returns + +`undefined` \| [`Signature`](Signature.md) + +*** + +### tryGetTypeAtLocationWithoutCheck() + +> **tryGetTypeAtLocationWithoutCheck**(`node`): [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2441 + +#### Parameters + +##### node + +[`Node`](Node.md) + +#### Returns + +[`Type`](Type.md) + +*** + +### typeParameterToDeclaration() + +> **typeParameterToDeclaration**(`parameter`, `enclosingDeclaration`, `flags`): `undefined` \| [`TypeParameterDeclaration`](TypeParameterDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2419 + +Note that the resulting nodes cannot be checked. + +#### Parameters + +##### parameter + +[`TypeParameter`](TypeParameter.md) + +##### enclosingDeclaration + +`undefined` | [`Node`](Node.md) + +##### flags + +`undefined` | [`NodeBuilderFlags`](../enumerations/NodeBuilderFlags.md) + +#### Returns + +`undefined` \| [`TypeParameterDeclaration`](TypeParameterDeclaration.md) + +*** + +### typePredicateToString() + +> **typePredicateToString**(`predicate`, `enclosingDeclaration`?, `flags`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2446 + +#### Parameters + +##### predicate + +[`TypePredicate`](../type-aliases/TypePredicate.md) + +##### enclosingDeclaration? + +[`Node`](Node.md) + +##### flags? + +[`TypeFormatFlags`](../enumerations/TypeFormatFlags.md) + +#### Returns + +`string` + +*** + +### typeToString() + +> **typeToString**(`type`, `enclosingDeclaration`?, `flags`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2444 + +#### Parameters + +##### type + +[`Type`](Type.md) + +##### enclosingDeclaration? + +[`Node`](Node.md) + +##### flags? + +[`TypeFormatFlags`](../enumerations/TypeFormatFlags.md) + +#### Returns + +`string` + +*** + +### typeToTypeNode() + +> **typeToTypeNode**(`type`, `enclosingDeclaration`, `flags`): `undefined` \| [`TypeNode`](TypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2403 + +Note that the resulting nodes cannot be checked. + +#### Parameters + +##### type + +[`Type`](Type.md) + +##### enclosingDeclaration + +`undefined` | [`Node`](Node.md) + +##### flags + +`undefined` | [`NodeBuilderFlags`](../enumerations/NodeBuilderFlags.md) + +#### Returns + +`undefined` \| [`TypeNode`](TypeNode.md) diff --git a/docs/api_docs/namespaces/ts/interfaces/TypeElement.md b/docs/api_docs/namespaces/ts/interfaces/TypeElement.md new file mode 100644 index 0000000000000000000000000000000000000000..fe9079bdbf07644ef362b6af132c77cf8919b35a --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/TypeElement.md @@ -0,0 +1,527 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TypeElement + +# Interface: TypeElement + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1636 + +## Extends + +- [`NamedDeclaration`](NamedDeclaration.md) + +## Extended by + +- [`CallSignatureDeclaration`](CallSignatureDeclaration.md) +- [`ConstructSignatureDeclaration`](ConstructSignatureDeclaration.md) +- [`PropertySignature`](PropertySignature.md) +- [`MethodSignature`](MethodSignature.md) +- [`GetAccessorDeclaration`](GetAccessorDeclaration.md) +- [`SetAccessorDeclaration`](SetAccessorDeclaration.md) +- [`IndexSignatureDeclaration`](IndexSignatureDeclaration.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`_declarationBrand`](NamedDeclaration.md#_declarationbrand) + +*** + +### \_typeElementBrand + +> **\_typeElementBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1637 + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`decorators`](NamedDeclaration.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`end`](NamedDeclaration.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`flags`](NamedDeclaration.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`SyntaxKind`](../enumerations/SyntaxKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:598 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`kind`](NamedDeclaration.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`locals`](NamedDeclaration.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`modifiers`](NamedDeclaration.md#modifiers) + +*** + +### name? + +> `readonly` `optional` **name**: [`PropertyName`](../type-aliases/PropertyName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1638 + +#### Overrides + +[`NamedDeclaration`](NamedDeclaration.md).[`name`](NamedDeclaration.md#name) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`parent`](NamedDeclaration.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`pos`](NamedDeclaration.md#pos) + +*** + +### questionToken? + +> `readonly` `optional` **questionToken**: [`QuestionToken`](../type-aliases/QuestionToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1639 + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`skipCheck`](NamedDeclaration.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`symbol`](NamedDeclaration.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`forEachChild`](NamedDeclaration.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getChildAt`](NamedDeclaration.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getChildCount`](NamedDeclaration.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getChildren`](NamedDeclaration.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getEnd`](NamedDeclaration.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFirstToken`](NamedDeclaration.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFullStart`](NamedDeclaration.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFullText`](NamedDeclaration.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFullWidth`](NamedDeclaration.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getLastToken`](NamedDeclaration.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getLeadingTriviaWidth`](NamedDeclaration.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getSourceFile`](NamedDeclaration.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getStart`](NamedDeclaration.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getText`](NamedDeclaration.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getWidth`](NamedDeclaration.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/TypeLiteralNode.md b/docs/api_docs/namespaces/ts/interfaces/TypeLiteralNode.md new file mode 100644 index 0000000000000000000000000000000000000000..00d6246c7b059822603fae3caea705234536a6e6 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/TypeLiteralNode.md @@ -0,0 +1,509 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TypeLiteralNode + +# Interface: TypeLiteralNode + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:964 + +## Extends + +- [`TypeNode`](TypeNode.md).[`Declaration`](Declaration.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`Declaration`](Declaration.md).[`_declarationBrand`](Declaration.md#_declarationbrand) + +*** + +### \_typeNodeBrand + +> **\_typeNodeBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:912 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`_typeNodeBrand`](TypeNode.md#_typenodebrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Declaration`](Declaration.md).[`decorators`](Declaration.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Declaration`](Declaration.md).[`end`](Declaration.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Declaration`](Declaration.md).[`flags`](Declaration.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`TypeLiteral`](../enumerations/SyntaxKind.md#typeliteral) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:965 + +#### Overrides + +[`Declaration`](Declaration.md).[`kind`](Declaration.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Declaration`](Declaration.md).[`locals`](Declaration.md#locals) + +*** + +### members + +> `readonly` **members**: [`NodeArray`](NodeArray.md)\<[`TypeElement`](TypeElement.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:966 + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Declaration`](Declaration.md).[`modifiers`](Declaration.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`Declaration`](Declaration.md).[`parent`](Declaration.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Declaration`](Declaration.md).[`pos`](Declaration.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Declaration`](Declaration.md).[`skipCheck`](Declaration.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Declaration`](Declaration.md).[`symbol`](Declaration.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Declaration`](Declaration.md).[`forEachChild`](Declaration.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getChildAt`](Declaration.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getChildCount`](Declaration.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Declaration`](Declaration.md).[`getChildren`](Declaration.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getEnd`](Declaration.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFirstToken`](Declaration.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFullStart`](Declaration.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFullText`](Declaration.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getFullWidth`](Declaration.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getLastToken`](Declaration.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getLeadingTriviaWidth`](Declaration.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Declaration`](Declaration.md).[`getSourceFile`](Declaration.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getStart`](Declaration.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getText`](Declaration.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Declaration`](Declaration.md).[`getWidth`](Declaration.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/TypeNode.md b/docs/api_docs/namespaces/ts/interfaces/TypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..6235ef5194979778f9ff6c001cd23824d7f3e90a --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/TypeNode.md @@ -0,0 +1,512 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TypeNode + +# Interface: TypeNode + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:911 + +## Extends + +- [`Node`](Node.md) + +## Extended by + +- [`KeywordTypeNode`](KeywordTypeNode.md) +- [`ThisTypeNode`](ThisTypeNode.md) +- [`FunctionOrConstructorTypeNodeBase`](FunctionOrConstructorTypeNodeBase.md) +- [`NodeWithTypeArguments`](NodeWithTypeArguments.md) +- [`TypePredicateNode`](TypePredicateNode.md) +- [`TypeLiteralNode`](TypeLiteralNode.md) +- [`ArrayTypeNode`](ArrayTypeNode.md) +- [`TupleTypeNode`](TupleTypeNode.md) +- [`NamedTupleMember`](NamedTupleMember.md) +- [`OptionalTypeNode`](OptionalTypeNode.md) +- [`RestTypeNode`](RestTypeNode.md) +- [`UnionTypeNode`](UnionTypeNode.md) +- [`IntersectionTypeNode`](IntersectionTypeNode.md) +- [`ConditionalTypeNode`](ConditionalTypeNode.md) +- [`InferTypeNode`](InferTypeNode.md) +- [`ParenthesizedTypeNode`](ParenthesizedTypeNode.md) +- [`TypeOperatorNode`](TypeOperatorNode.md) +- [`IndexedAccessTypeNode`](IndexedAccessTypeNode.md) +- [`MappedTypeNode`](MappedTypeNode.md) +- [`LiteralTypeNode`](LiteralTypeNode.md) +- [`TemplateLiteralTypeNode`](TemplateLiteralTypeNode.md) +- [`TemplateLiteralTypeSpan`](TemplateLiteralTypeSpan.md) +- [`JSDocTypeExpression`](JSDocTypeExpression.md) +- [`JSDocType`](JSDocType.md) + +## Properties + +### \_typeNodeBrand + +> **\_typeNodeBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:912 + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`decorators`](Node.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Node`](Node.md).[`end`](Node.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Node`](Node.md).[`flags`](Node.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`SyntaxKind`](../enumerations/SyntaxKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:598 + +#### Inherited from + +[`Node`](Node.md).[`kind`](Node.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Node`](Node.md).[`locals`](Node.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`modifiers`](Node.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`Node`](Node.md).[`parent`](Node.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Node`](Node.md).[`pos`](Node.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Node`](Node.md).[`skipCheck`](Node.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Node`](Node.md).[`symbol`](Node.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Node`](Node.md).[`forEachChild`](Node.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getChildAt`](Node.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getChildCount`](Node.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Node`](Node.md).[`getChildren`](Node.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getEnd`](Node.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getFirstToken`](Node.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullStart`](Node.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getFullText`](Node.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullWidth`](Node.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getLastToken`](Node.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getLeadingTriviaWidth`](Node.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Node`](Node.md).[`getSourceFile`](Node.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getStart`](Node.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getText`](Node.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getWidth`](Node.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/TypeOfExpression.md b/docs/api_docs/namespaces/ts/interfaces/TypeOfExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..cce53b054a9f63c66cb803cb636fa604c1e1f2fb --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/TypeOfExpression.md @@ -0,0 +1,509 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TypeOfExpression + +# Interface: TypeOfExpression + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1117 + +## Extends + +- [`UnaryExpression`](UnaryExpression.md) + +## Properties + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`_expressionBrand`](UnaryExpression.md#_expressionbrand) + +*** + +### \_unaryExpressionBrand + +> **\_unaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1066 + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`_unaryExpressionBrand`](UnaryExpression.md#_unaryexpressionbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`decorators`](UnaryExpression.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`end`](UnaryExpression.md#end) + +*** + +### expression + +> `readonly` **expression**: [`UnaryExpression`](UnaryExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1119 + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`flags`](UnaryExpression.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`TypeOfExpression`](../enumerations/SyntaxKind.md#typeofexpression) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1118 + +#### Overrides + +[`UnaryExpression`](UnaryExpression.md).[`kind`](UnaryExpression.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`locals`](UnaryExpression.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`modifiers`](UnaryExpression.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`parent`](UnaryExpression.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`pos`](UnaryExpression.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`skipCheck`](UnaryExpression.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`symbol`](UnaryExpression.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`forEachChild`](UnaryExpression.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getChildAt`](UnaryExpression.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getChildCount`](UnaryExpression.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getChildren`](UnaryExpression.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getEnd`](UnaryExpression.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getFirstToken`](UnaryExpression.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getFullStart`](UnaryExpression.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getFullText`](UnaryExpression.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getFullWidth`](UnaryExpression.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getLastToken`](UnaryExpression.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getLeadingTriviaWidth`](UnaryExpression.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getSourceFile`](UnaryExpression.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getStart`](UnaryExpression.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getText`](UnaryExpression.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getWidth`](UnaryExpression.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/TypeOperatorNode.md b/docs/api_docs/namespaces/ts/interfaces/TypeOperatorNode.md new file mode 100644 index 0000000000000000000000000000000000000000..6999c729fd58af499a82ed79fc220d0b9fcacef1 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/TypeOperatorNode.md @@ -0,0 +1,505 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TypeOperatorNode + +# Interface: TypeOperatorNode + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1015 + +## Extends + +- [`TypeNode`](TypeNode.md) + +## Properties + +### \_typeNodeBrand + +> **\_typeNodeBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:912 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`_typeNodeBrand`](TypeNode.md#_typenodebrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`decorators`](TypeNode.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`end`](TypeNode.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`flags`](TypeNode.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`TypeOperator`](../enumerations/SyntaxKind.md#typeoperator) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1016 + +#### Overrides + +[`TypeNode`](TypeNode.md).[`kind`](TypeNode.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`locals`](TypeNode.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`modifiers`](TypeNode.md#modifiers) + +*** + +### operator + +> `readonly` **operator**: [`KeyOfKeyword`](../enumerations/SyntaxKind.md#keyofkeyword) \| [`ReadonlyKeyword`](../enumerations/SyntaxKind.md#readonlykeyword) \| [`UniqueKeyword`](../enumerations/SyntaxKind.md#uniquekeyword) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1017 + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`parent`](TypeNode.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`pos`](TypeNode.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`skipCheck`](TypeNode.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`symbol`](TypeNode.md#symbol) + +*** + +### type + +> `readonly` **type**: [`TypeNode`](TypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1018 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`forEachChild`](TypeNode.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getChildAt`](TypeNode.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getChildCount`](TypeNode.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getChildren`](TypeNode.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getEnd`](TypeNode.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFirstToken`](TypeNode.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFullStart`](TypeNode.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFullText`](TypeNode.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFullWidth`](TypeNode.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getLastToken`](TypeNode.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getLeadingTriviaWidth`](TypeNode.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getSourceFile`](TypeNode.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getStart`](TypeNode.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getText`](TypeNode.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getWidth`](TypeNode.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/TypeParameter.md b/docs/api_docs/namespaces/ts/interfaces/TypeParameter.md new file mode 100644 index 0000000000000000000000000000000000000000..ef5151b063008717662236ea121bd00c5d01cbaf --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/TypeParameter.md @@ -0,0 +1,447 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TypeParameter + +# Interface: TypeParameter + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2888 + +## Extends + +- [`InstantiableType`](InstantiableType.md) + +## Properties + +### aliasSymbol? + +> `optional` **aliasSymbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2773 + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`aliasSymbol`](InstantiableType.md#aliassymbol) + +*** + +### aliasTypeArguments? + +> `optional` **aliasTypeArguments**: readonly [`Type`](Type.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2774 + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`aliasTypeArguments`](InstantiableType.md#aliastypearguments) + +*** + +### flags + +> **flags**: [`TypeFlags`](../enumerations/TypeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2770 + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`flags`](InstantiableType.md#flags) + +*** + +### pattern? + +> `optional` **pattern**: [`DestructuringPattern`](../type-aliases/DestructuringPattern.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2772 + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`pattern`](InstantiableType.md#pattern) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2771 + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`symbol`](InstantiableType.md#symbol) + +## Methods + +### getApparentProperties() + +> **getApparentProperties**(): [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6124 + +#### Returns + +[`Symbol`](Symbol.md)[] + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getApparentProperties`](InstantiableType.md#getapparentproperties) + +*** + +### getBaseTypes() + +> **getBaseTypes**(): `undefined` \| [`BaseType`](../type-aliases/BaseType.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6129 + +#### Returns + +`undefined` \| [`BaseType`](../type-aliases/BaseType.md)[] + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getBaseTypes`](InstantiableType.md#getbasetypes) + +*** + +### getCallSignatures() + +> **getCallSignatures**(): readonly [`Signature`](Signature.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6125 + +#### Returns + +readonly [`Signature`](Signature.md)[] + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getCallSignatures`](InstantiableType.md#getcallsignatures) + +*** + +### getConstraint() + +> **getConstraint**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6131 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getConstraint`](InstantiableType.md#getconstraint) + +*** + +### getConstructSignatures() + +> **getConstructSignatures**(): readonly [`Signature`](Signature.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6126 + +#### Returns + +readonly [`Signature`](Signature.md)[] + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getConstructSignatures`](InstantiableType.md#getconstructsignatures) + +*** + +### getDefault() + +> **getDefault**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6132 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getDefault`](InstantiableType.md#getdefault) + +*** + +### getFlags() + +> **getFlags**(): [`TypeFlags`](../enumerations/TypeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6120 + +#### Returns + +[`TypeFlags`](../enumerations/TypeFlags.md) + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getFlags`](InstantiableType.md#getflags) + +*** + +### getNonNullableType() + +> **getNonNullableType**(): [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6130 + +#### Returns + +[`Type`](Type.md) + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getNonNullableType`](InstantiableType.md#getnonnullabletype) + +*** + +### getNumberIndexType() + +> **getNumberIndexType**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6128 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getNumberIndexType`](InstantiableType.md#getnumberindextype) + +*** + +### getProperties() + +> **getProperties**(): [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6122 + +#### Returns + +[`Symbol`](Symbol.md)[] + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getProperties`](InstantiableType.md#getproperties) + +*** + +### getProperty() + +> **getProperty**(`propertyName`): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6123 + +#### Parameters + +##### propertyName + +`string` + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getProperty`](InstantiableType.md#getproperty) + +*** + +### getStringIndexType() + +> **getStringIndexType**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6127 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getStringIndexType`](InstantiableType.md#getstringindextype) + +*** + +### getSymbol() + +> **getSymbol**(): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6121 + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`getSymbol`](InstantiableType.md#getsymbol) + +*** + +### isClass() + +> **isClass**(): `this is InterfaceType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6141 + +#### Returns + +`this is InterfaceType` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isClass`](InstantiableType.md#isclass) + +*** + +### isClassOrInterface() + +> **isClassOrInterface**(): `this is InterfaceType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6140 + +#### Returns + +`this is InterfaceType` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isClassOrInterface`](InstantiableType.md#isclassorinterface) + +*** + +### isIndexType() + +> **isIndexType**(): `this is IndexType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6142 + +#### Returns + +`this is IndexType` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isIndexType`](InstantiableType.md#isindextype) + +*** + +### isIntersection() + +> **isIntersection**(): `this is IntersectionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6134 + +#### Returns + +`this is IntersectionType` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isIntersection`](InstantiableType.md#isintersection) + +*** + +### isLiteral() + +> **isLiteral**(): `this is LiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6136 + +#### Returns + +`this is LiteralType` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isLiteral`](InstantiableType.md#isliteral) + +*** + +### isNumberLiteral() + +> **isNumberLiteral**(): `this is NumberLiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6138 + +#### Returns + +`this is NumberLiteralType` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isNumberLiteral`](InstantiableType.md#isnumberliteral) + +*** + +### isStringLiteral() + +> **isStringLiteral**(): `this is StringLiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6137 + +#### Returns + +`this is StringLiteralType` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isStringLiteral`](InstantiableType.md#isstringliteral) + +*** + +### isTypeParameter() + +> **isTypeParameter**(): `this is TypeParameter` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6139 + +#### Returns + +`this is TypeParameter` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isTypeParameter`](InstantiableType.md#istypeparameter) + +*** + +### isUnion() + +> **isUnion**(): `this is UnionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6133 + +#### Returns + +`this is UnionType` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isUnion`](InstantiableType.md#isunion) + +*** + +### isUnionOrIntersection() + +> **isUnionOrIntersection**(): `this is UnionOrIntersectionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6135 + +#### Returns + +`this is UnionOrIntersectionType` + +#### Inherited from + +[`InstantiableType`](InstantiableType.md).[`isUnionOrIntersection`](InstantiableType.md#isunionorintersection) diff --git a/docs/api_docs/namespaces/ts/interfaces/TypeParameterDeclaration.md b/docs/api_docs/namespaces/ts/interfaces/TypeParameterDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..ccec62c43c8eb0c1cda58b3783483c6d35e8f31b --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/TypeParameterDeclaration.md @@ -0,0 +1,527 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TypeParameterDeclaration + +# Interface: TypeParameterDeclaration + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:721 + +## Extends + +- [`NamedDeclaration`](NamedDeclaration.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`_declarationBrand`](NamedDeclaration.md#_declarationbrand) + +*** + +### constraint? + +> `readonly` `optional` **constraint**: [`TypeNode`](TypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:727 + +Note: Consider calling `getEffectiveConstraintOfTypeParameter` + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`decorators`](NamedDeclaration.md#decorators) + +*** + +### default? + +> `readonly` `optional` **default**: [`TypeNode`](TypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:728 + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`end`](NamedDeclaration.md#end) + +*** + +### expression? + +> `optional` **expression**: [`Expression`](Expression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:729 + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`flags`](NamedDeclaration.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`TypeParameter`](../enumerations/SyntaxKind.md#typeparameter) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:722 + +#### Overrides + +[`NamedDeclaration`](NamedDeclaration.md).[`kind`](NamedDeclaration.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`locals`](NamedDeclaration.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`Modifier`](../type-aliases/Modifier.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:724 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Overrides + +[`NamedDeclaration`](NamedDeclaration.md).[`modifiers`](NamedDeclaration.md#modifiers) + +*** + +### name + +> `readonly` **name**: [`Identifier`](Identifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:725 + +#### Overrides + +[`NamedDeclaration`](NamedDeclaration.md).[`name`](NamedDeclaration.md#name) + +*** + +### parent + +> `readonly` **parent**: [`DeclarationWithTypeParameterChildren`](../type-aliases/DeclarationWithTypeParameterChildren.md) \| [`InferTypeNode`](InferTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:723 + +#### Overrides + +[`NamedDeclaration`](NamedDeclaration.md).[`parent`](NamedDeclaration.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`pos`](NamedDeclaration.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`skipCheck`](NamedDeclaration.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`symbol`](NamedDeclaration.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`forEachChild`](NamedDeclaration.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getChildAt`](NamedDeclaration.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getChildCount`](NamedDeclaration.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getChildren`](NamedDeclaration.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getEnd`](NamedDeclaration.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFirstToken`](NamedDeclaration.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFullStart`](NamedDeclaration.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFullText`](NamedDeclaration.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFullWidth`](NamedDeclaration.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getLastToken`](NamedDeclaration.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getLeadingTriviaWidth`](NamedDeclaration.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getSourceFile`](NamedDeclaration.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getStart`](NamedDeclaration.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getText`](NamedDeclaration.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getWidth`](NamedDeclaration.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/TypePredicateBase.md b/docs/api_docs/namespaces/ts/interfaces/TypePredicateBase.md new file mode 100644 index 0000000000000000000000000000000000000000..60299cc948c87c78002855b1a6c81286f792776e --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/TypePredicateBase.md @@ -0,0 +1,32 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TypePredicateBase + +# Interface: TypePredicateBase + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2577 + +## Extended by + +- [`ThisTypePredicate`](ThisTypePredicate.md) +- [`IdentifierTypePredicate`](IdentifierTypePredicate.md) +- [`AssertsThisTypePredicate`](AssertsThisTypePredicate.md) +- [`AssertsIdentifierTypePredicate`](AssertsIdentifierTypePredicate.md) + +## Properties + +### kind + +> **kind**: [`TypePredicateKind`](../enumerations/TypePredicateKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2578 + +*** + +### type + +> **type**: `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2579 diff --git a/docs/api_docs/namespaces/ts/interfaces/TypePredicateNode.md b/docs/api_docs/namespaces/ts/interfaces/TypePredicateNode.md new file mode 100644 index 0000000000000000000000000000000000000000..329f4012d298fdb46b0db43abb5811d7f025d7fc --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/TypePredicateNode.md @@ -0,0 +1,513 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TypePredicateNode + +# Interface: TypePredicateNode + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:953 + +## Extends + +- [`TypeNode`](TypeNode.md) + +## Properties + +### \_typeNodeBrand + +> **\_typeNodeBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:912 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`_typeNodeBrand`](TypeNode.md#_typenodebrand) + +*** + +### assertsModifier? + +> `readonly` `optional` **assertsModifier**: [`AssertsKeyword`](../type-aliases/AssertsKeyword.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:956 + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`decorators`](TypeNode.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`end`](TypeNode.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`flags`](TypeNode.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`TypePredicate`](../enumerations/SyntaxKind.md#typepredicate) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:954 + +#### Overrides + +[`TypeNode`](TypeNode.md).[`kind`](TypeNode.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`locals`](TypeNode.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`modifiers`](TypeNode.md#modifiers) + +*** + +### parameterName + +> `readonly` **parameterName**: [`Identifier`](Identifier.md) \| [`ThisTypeNode`](ThisTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:957 + +*** + +### parent + +> `readonly` **parent**: [`SignatureDeclaration`](../type-aliases/SignatureDeclaration.md) \| [`JSDocTypeExpression`](JSDocTypeExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:955 + +#### Overrides + +[`TypeNode`](TypeNode.md).[`parent`](TypeNode.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`pos`](TypeNode.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`skipCheck`](TypeNode.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`symbol`](TypeNode.md#symbol) + +*** + +### type? + +> `readonly` `optional` **type**: [`TypeNode`](TypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:958 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`forEachChild`](TypeNode.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getChildAt`](TypeNode.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getChildCount`](TypeNode.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getChildren`](TypeNode.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getEnd`](TypeNode.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFirstToken`](TypeNode.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFullStart`](TypeNode.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFullText`](TypeNode.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFullWidth`](TypeNode.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getLastToken`](TypeNode.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getLeadingTriviaWidth`](TypeNode.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getSourceFile`](TypeNode.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getStart`](TypeNode.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getText`](TypeNode.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getWidth`](TypeNode.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/TypeQueryNode.md b/docs/api_docs/namespaces/ts/interfaces/TypeQueryNode.md new file mode 100644 index 0000000000000000000000000000000000000000..0d88e80379686cff1aca3c249be7b4b5cce9ba8f --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/TypeQueryNode.md @@ -0,0 +1,509 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TypeQueryNode + +# Interface: TypeQueryNode + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:960 + +## Extends + +- [`NodeWithTypeArguments`](NodeWithTypeArguments.md) + +## Properties + +### \_typeNodeBrand + +> **\_typeNodeBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:912 + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`_typeNodeBrand`](NodeWithTypeArguments.md#_typenodebrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`decorators`](NodeWithTypeArguments.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`end`](NodeWithTypeArguments.md#end) + +*** + +### exprName + +> `readonly` **exprName**: [`EntityName`](../type-aliases/EntityName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:962 + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`flags`](NodeWithTypeArguments.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`TypeQuery`](../enumerations/SyntaxKind.md#typequery) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:961 + +#### Overrides + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`kind`](NodeWithTypeArguments.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`locals`](NodeWithTypeArguments.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`modifiers`](NodeWithTypeArguments.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`parent`](NodeWithTypeArguments.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`pos`](NodeWithTypeArguments.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`skipCheck`](NodeWithTypeArguments.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`symbol`](NodeWithTypeArguments.md#symbol) + +*** + +### typeArguments? + +> `readonly` `optional` **typeArguments**: [`NodeArray`](NodeArray.md)\<[`TypeNode`](TypeNode.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:946 + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`typeArguments`](NodeWithTypeArguments.md#typearguments) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`forEachChild`](NodeWithTypeArguments.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`getChildAt`](NodeWithTypeArguments.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`getChildCount`](NodeWithTypeArguments.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`getChildren`](NodeWithTypeArguments.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`getEnd`](NodeWithTypeArguments.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`getFirstToken`](NodeWithTypeArguments.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`getFullStart`](NodeWithTypeArguments.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`getFullText`](NodeWithTypeArguments.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`getFullWidth`](NodeWithTypeArguments.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`getLastToken`](NodeWithTypeArguments.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`getLeadingTriviaWidth`](NodeWithTypeArguments.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`getSourceFile`](NodeWithTypeArguments.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`getStart`](NodeWithTypeArguments.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`getText`](NodeWithTypeArguments.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`getWidth`](NodeWithTypeArguments.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/TypeReference.md b/docs/api_docs/namespaces/ts/interfaces/TypeReference.md new file mode 100644 index 0000000000000000000000000000000000000000..09c4bd7451c12063d3de92661584b438113203c4 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/TypeReference.md @@ -0,0 +1,498 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TypeReference + +# Interface: TypeReference + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2844 + +Type references (ObjectFlags.Reference). When a class or interface has type parameters or +a "this" type, references to the class or interface are made using type references. The +typeArguments property specifies the types to substitute for the type parameters of the +class or interface and optionally includes an extra element that specifies the type to +substitute for "this" in the resulting instantiation. When no extra argument is present, +the type reference itself is substituted for "this". The typeArguments property is undefined +if the class or interface has no type parameters and the reference isn't specifying an +explicit "this" argument. + +## Extends + +- [`ObjectType`](ObjectType.md) + +## Extended by + +- [`DeferredTypeReference`](DeferredTypeReference.md) +- [`GenericType`](GenericType.md) +- [`TupleTypeReference`](TupleTypeReference.md) + +## Properties + +### aliasSymbol? + +> `optional` **aliasSymbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2773 + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`aliasSymbol`](ObjectType.md#aliassymbol) + +*** + +### aliasTypeArguments? + +> `optional` **aliasTypeArguments**: readonly [`Type`](Type.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2774 + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`aliasTypeArguments`](ObjectType.md#aliastypearguments) + +*** + +### flags + +> **flags**: [`TypeFlags`](../enumerations/TypeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2770 + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`flags`](ObjectType.md#flags) + +*** + +### node? + +> `optional` **node**: [`TypeReferenceNode`](TypeReferenceNode.md) \| [`ArrayTypeNode`](ArrayTypeNode.md) \| [`TupleTypeNode`](TupleTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2846 + +*** + +### objectFlags + +> **objectFlags**: [`ObjectFlags`](../enumerations/ObjectFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2818 + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`objectFlags`](ObjectType.md#objectflags) + +*** + +### pattern? + +> `optional` **pattern**: [`DestructuringPattern`](../type-aliases/DestructuringPattern.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2772 + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`pattern`](ObjectType.md#pattern) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2771 + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`symbol`](ObjectType.md#symbol) + +*** + +### target + +> **target**: [`GenericType`](GenericType.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2845 + +*** + +### typeArguments? + +> `optional` **typeArguments**: readonly [`Type`](Type.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6145 + +## Methods + +### getApparentProperties() + +> **getApparentProperties**(): [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6124 + +#### Returns + +[`Symbol`](Symbol.md)[] + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`getApparentProperties`](ObjectType.md#getapparentproperties) + +*** + +### getBaseTypes() + +> **getBaseTypes**(): `undefined` \| [`BaseType`](../type-aliases/BaseType.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6129 + +#### Returns + +`undefined` \| [`BaseType`](../type-aliases/BaseType.md)[] + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`getBaseTypes`](ObjectType.md#getbasetypes) + +*** + +### getCallSignatures() + +> **getCallSignatures**(): readonly [`Signature`](Signature.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6125 + +#### Returns + +readonly [`Signature`](Signature.md)[] + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`getCallSignatures`](ObjectType.md#getcallsignatures) + +*** + +### getConstraint() + +> **getConstraint**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6131 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`getConstraint`](ObjectType.md#getconstraint) + +*** + +### getConstructSignatures() + +> **getConstructSignatures**(): readonly [`Signature`](Signature.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6126 + +#### Returns + +readonly [`Signature`](Signature.md)[] + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`getConstructSignatures`](ObjectType.md#getconstructsignatures) + +*** + +### getDefault() + +> **getDefault**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6132 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`getDefault`](ObjectType.md#getdefault) + +*** + +### getFlags() + +> **getFlags**(): [`TypeFlags`](../enumerations/TypeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6120 + +#### Returns + +[`TypeFlags`](../enumerations/TypeFlags.md) + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`getFlags`](ObjectType.md#getflags) + +*** + +### getNonNullableType() + +> **getNonNullableType**(): [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6130 + +#### Returns + +[`Type`](Type.md) + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`getNonNullableType`](ObjectType.md#getnonnullabletype) + +*** + +### getNumberIndexType() + +> **getNumberIndexType**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6128 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`getNumberIndexType`](ObjectType.md#getnumberindextype) + +*** + +### getProperties() + +> **getProperties**(): [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6122 + +#### Returns + +[`Symbol`](Symbol.md)[] + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`getProperties`](ObjectType.md#getproperties) + +*** + +### getProperty() + +> **getProperty**(`propertyName`): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6123 + +#### Parameters + +##### propertyName + +`string` + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`getProperty`](ObjectType.md#getproperty) + +*** + +### getStringIndexType() + +> **getStringIndexType**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6127 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`getStringIndexType`](ObjectType.md#getstringindextype) + +*** + +### getSymbol() + +> **getSymbol**(): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6121 + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`getSymbol`](ObjectType.md#getsymbol) + +*** + +### isClass() + +> **isClass**(): `this is InterfaceType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6141 + +#### Returns + +`this is InterfaceType` + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`isClass`](ObjectType.md#isclass) + +*** + +### isClassOrInterface() + +> **isClassOrInterface**(): `this is InterfaceType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6140 + +#### Returns + +`this is InterfaceType` + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`isClassOrInterface`](ObjectType.md#isclassorinterface) + +*** + +### isIndexType() + +> **isIndexType**(): `this is IndexType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6142 + +#### Returns + +`this is IndexType` + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`isIndexType`](ObjectType.md#isindextype) + +*** + +### isIntersection() + +> **isIntersection**(): `this is IntersectionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6134 + +#### Returns + +`this is IntersectionType` + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`isIntersection`](ObjectType.md#isintersection) + +*** + +### isLiteral() + +> **isLiteral**(): `this is LiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6136 + +#### Returns + +`this is LiteralType` + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`isLiteral`](ObjectType.md#isliteral) + +*** + +### isNumberLiteral() + +> **isNumberLiteral**(): `this is NumberLiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6138 + +#### Returns + +`this is NumberLiteralType` + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`isNumberLiteral`](ObjectType.md#isnumberliteral) + +*** + +### isStringLiteral() + +> **isStringLiteral**(): `this is StringLiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6137 + +#### Returns + +`this is StringLiteralType` + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`isStringLiteral`](ObjectType.md#isstringliteral) + +*** + +### isTypeParameter() + +> **isTypeParameter**(): `this is TypeParameter` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6139 + +#### Returns + +`this is TypeParameter` + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`isTypeParameter`](ObjectType.md#istypeparameter) + +*** + +### isUnion() + +> **isUnion**(): `this is UnionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6133 + +#### Returns + +`this is UnionType` + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`isUnion`](ObjectType.md#isunion) + +*** + +### isUnionOrIntersection() + +> **isUnionOrIntersection**(): `this is UnionOrIntersectionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6135 + +#### Returns + +`this is UnionOrIntersectionType` + +#### Inherited from + +[`ObjectType`](ObjectType.md).[`isUnionOrIntersection`](ObjectType.md#isunionorintersection) diff --git a/docs/api_docs/namespaces/ts/interfaces/TypeReferenceDirectiveResolutionCache.md b/docs/api_docs/namespaces/ts/interfaces/TypeReferenceDirectiveResolutionCache.md new file mode 100644 index 0000000000000000000000000000000000000000..44bbb563ca0311cb16063383d2cef89a6d818540 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/TypeReferenceDirectiveResolutionCache.md @@ -0,0 +1,83 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TypeReferenceDirectiveResolutionCache + +# Interface: TypeReferenceDirectiveResolutionCache + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5362 + +Cached resolutions per containing directory. +This assumes that any module id will have the same resolution for sibling files located in the same folder. + +## Extends + +- [`PerDirectoryResolutionCache`](PerDirectoryResolutionCache.md)\<[`ResolvedTypeReferenceDirectiveWithFailedLookupLocations`](ResolvedTypeReferenceDirectiveWithFailedLookupLocations.md)\>.[`PackageJsonInfoCache`](PackageJsonInfoCache.md) + +## Methods + +### clear() + +> **clear**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5378 + +#### Returns + +`void` + +#### Inherited from + +[`PackageJsonInfoCache`](PackageJsonInfoCache.md).[`clear`](PackageJsonInfoCache.md#clear) + +*** + +### getOrCreateCacheForDirectory() + +> **getOrCreateCacheForDirectory**(`directoryName`, `redirectedReference`?): [`ModeAwareCache`](ModeAwareCache.md)\<[`ResolvedTypeReferenceDirectiveWithFailedLookupLocations`](ResolvedTypeReferenceDirectiveWithFailedLookupLocations.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5377 + +#### Parameters + +##### directoryName + +`string` + +##### redirectedReference? + +[`ResolvedProjectReference`](ResolvedProjectReference.md) + +#### Returns + +[`ModeAwareCache`](ModeAwareCache.md)\<[`ResolvedTypeReferenceDirectiveWithFailedLookupLocations`](ResolvedTypeReferenceDirectiveWithFailedLookupLocations.md)\> + +#### Inherited from + +[`PerDirectoryResolutionCache`](PerDirectoryResolutionCache.md).[`getOrCreateCacheForDirectory`](PerDirectoryResolutionCache.md#getorcreatecachefordirectory) + +*** + +### update() + +> **update**(`options`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5383 + +Updates with the current compilerOptions the cache will operate with. + This updates the redirects map as well if needed so module resolutions are cached if they can across the projects + +#### Parameters + +##### options + +[`CompilerOptions`](CompilerOptions.md) + +#### Returns + +`void` + +#### Inherited from + +[`PerDirectoryResolutionCache`](PerDirectoryResolutionCache.md).[`update`](PerDirectoryResolutionCache.md#update) diff --git a/docs/api_docs/namespaces/ts/interfaces/TypeReferenceNode.md b/docs/api_docs/namespaces/ts/interfaces/TypeReferenceNode.md new file mode 100644 index 0000000000000000000000000000000000000000..0c75ea7c64bc5164716d2270c9152d0b5849df7e --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/TypeReferenceNode.md @@ -0,0 +1,509 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TypeReferenceNode + +# Interface: TypeReferenceNode + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:949 + +## Extends + +- [`NodeWithTypeArguments`](NodeWithTypeArguments.md) + +## Properties + +### \_typeNodeBrand + +> **\_typeNodeBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:912 + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`_typeNodeBrand`](NodeWithTypeArguments.md#_typenodebrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`decorators`](NodeWithTypeArguments.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`end`](NodeWithTypeArguments.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`flags`](NodeWithTypeArguments.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`TypeReference`](../enumerations/SyntaxKind.md#typereference) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:950 + +#### Overrides + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`kind`](NodeWithTypeArguments.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`locals`](NodeWithTypeArguments.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`modifiers`](NodeWithTypeArguments.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`parent`](NodeWithTypeArguments.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`pos`](NodeWithTypeArguments.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`skipCheck`](NodeWithTypeArguments.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`symbol`](NodeWithTypeArguments.md#symbol) + +*** + +### typeArguments? + +> `readonly` `optional` **typeArguments**: [`NodeArray`](NodeArray.md)\<[`TypeNode`](TypeNode.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:946 + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`typeArguments`](NodeWithTypeArguments.md#typearguments) + +*** + +### typeName + +> `readonly` **typeName**: [`EntityName`](../type-aliases/EntityName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:951 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`forEachChild`](NodeWithTypeArguments.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`getChildAt`](NodeWithTypeArguments.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`getChildCount`](NodeWithTypeArguments.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`getChildren`](NodeWithTypeArguments.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`getEnd`](NodeWithTypeArguments.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`getFirstToken`](NodeWithTypeArguments.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`getFullStart`](NodeWithTypeArguments.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`getFullText`](NodeWithTypeArguments.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`getFullWidth`](NodeWithTypeArguments.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`getLastToken`](NodeWithTypeArguments.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`getLeadingTriviaWidth`](NodeWithTypeArguments.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`getSourceFile`](NodeWithTypeArguments.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`getStart`](NodeWithTypeArguments.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`getText`](NodeWithTypeArguments.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`NodeWithTypeArguments`](NodeWithTypeArguments.md).[`getWidth`](NodeWithTypeArguments.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/UnaryExpression.md b/docs/api_docs/namespaces/ts/interfaces/UnaryExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..b1365338843b8816acf851d022b7fc5c01174d9f --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/UnaryExpression.md @@ -0,0 +1,506 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / UnaryExpression + +# Interface: UnaryExpression + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1065 + +## Extends + +- [`Expression`](Expression.md) + +## Extended by + +- [`UpdateExpression`](UpdateExpression.md) +- [`DeleteExpression`](DeleteExpression.md) +- [`TypeOfExpression`](TypeOfExpression.md) +- [`VoidExpression`](VoidExpression.md) +- [`AwaitExpression`](AwaitExpression.md) +- [`TypeAssertion`](TypeAssertion.md) + +## Properties + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`Expression`](Expression.md).[`_expressionBrand`](Expression.md#_expressionbrand) + +*** + +### \_unaryExpressionBrand + +> **\_unaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1066 + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Expression`](Expression.md).[`decorators`](Expression.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Expression`](Expression.md).[`end`](Expression.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Expression`](Expression.md).[`flags`](Expression.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`SyntaxKind`](../enumerations/SyntaxKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:598 + +#### Inherited from + +[`Expression`](Expression.md).[`kind`](Expression.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Expression`](Expression.md).[`locals`](Expression.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Expression`](Expression.md).[`modifiers`](Expression.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`Expression`](Expression.md).[`parent`](Expression.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Expression`](Expression.md).[`pos`](Expression.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Expression`](Expression.md).[`skipCheck`](Expression.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Expression`](Expression.md).[`symbol`](Expression.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Expression`](Expression.md).[`forEachChild`](Expression.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Expression`](Expression.md).[`getChildAt`](Expression.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getChildCount`](Expression.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Expression`](Expression.md).[`getChildren`](Expression.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getEnd`](Expression.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Expression`](Expression.md).[`getFirstToken`](Expression.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getFullStart`](Expression.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Expression`](Expression.md).[`getFullText`](Expression.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getFullWidth`](Expression.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Expression`](Expression.md).[`getLastToken`](Expression.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getLeadingTriviaWidth`](Expression.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Expression`](Expression.md).[`getSourceFile`](Expression.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getStart`](Expression.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Expression`](Expression.md).[`getText`](Expression.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getWidth`](Expression.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/UnderscoreEscapedMap.md b/docs/api_docs/namespaces/ts/interfaces/UnderscoreEscapedMap.md new file mode 100644 index 0000000000000000000000000000000000000000..09c8244fe55fadffeee8da4020bd205f4f22eab1 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/UnderscoreEscapedMap.md @@ -0,0 +1,209 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / UnderscoreEscapedMap + +# Interface: UnderscoreEscapedMap\ + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2714 + +Map where keys are `__String`s. + +## Extends + +- [`ESMap`](ESMap.md)\<[`__String`](../type-aliases/String.md), `T`\>.[`ReadonlyUnderscoreEscapedMap`](ReadonlyUnderscoreEscapedMap.md)\<`T`\> + +## Type Parameters + +• **T** + +## Properties + +### size + +> `readonly` **size**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:36 + +#### Inherited from + +[`ReadonlyUnderscoreEscapedMap`](ReadonlyUnderscoreEscapedMap.md).[`size`](ReadonlyUnderscoreEscapedMap.md#size) + +## Methods + +### clear() + +> **clear**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:43 + +#### Returns + +`void` + +#### Inherited from + +[`ESMap`](ESMap.md).[`clear`](ESMap.md#clear) + +*** + +### delete() + +> **delete**(`key`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:42 + +#### Parameters + +##### key + +[`__String`](../type-aliases/String.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`ESMap`](ESMap.md).[`delete`](ESMap.md#delete) + +*** + +### entries() + +> **entries**(): [`Iterator`](Iterator.md)\<\[[`__String`](../type-aliases/String.md), `T`\]\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:49 + +#### Returns + +[`Iterator`](Iterator.md)\<\[[`__String`](../type-aliases/String.md), `T`\]\> + +#### Inherited from + +[`ReadonlyUnderscoreEscapedMap`](ReadonlyUnderscoreEscapedMap.md).[`entries`](ReadonlyUnderscoreEscapedMap.md#entries) + +*** + +### forEach() + +> **forEach**(`action`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:50 + +#### Parameters + +##### action + +(`value`, `key`) => `void` + +#### Returns + +`void` + +#### Inherited from + +[`ReadonlyUnderscoreEscapedMap`](ReadonlyUnderscoreEscapedMap.md).[`forEach`](ReadonlyUnderscoreEscapedMap.md#foreach) + +*** + +### get() + +> **get**(`key`): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:47 + +#### Parameters + +##### key + +[`__String`](../type-aliases/String.md) + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`ReadonlyUnderscoreEscapedMap`](ReadonlyUnderscoreEscapedMap.md).[`get`](ReadonlyUnderscoreEscapedMap.md#get) + +*** + +### has() + +> **has**(`key`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:37 + +#### Parameters + +##### key + +[`__String`](../type-aliases/String.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`ReadonlyUnderscoreEscapedMap`](ReadonlyUnderscoreEscapedMap.md).[`has`](ReadonlyUnderscoreEscapedMap.md#has) + +*** + +### keys() + +> **keys**(): [`Iterator`](Iterator.md)\<[`__String`](../type-aliases/String.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:38 + +#### Returns + +[`Iterator`](Iterator.md)\<[`__String`](../type-aliases/String.md)\> + +#### Inherited from + +[`ReadonlyUnderscoreEscapedMap`](ReadonlyUnderscoreEscapedMap.md).[`keys`](ReadonlyUnderscoreEscapedMap.md#keys) + +*** + +### set() + +> **set**(`key`, `value`): `this` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:59 + +#### Parameters + +##### key + +[`__String`](../type-aliases/String.md) + +##### value + +`T` + +#### Returns + +`this` + +#### Inherited from + +[`ESMap`](ESMap.md).[`set`](ESMap.md#set) + +*** + +### values() + +> **values**(): [`Iterator`](Iterator.md)\<`T`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:48 + +#### Returns + +[`Iterator`](Iterator.md)\<`T`\> + +#### Inherited from + +[`ReadonlyUnderscoreEscapedMap`](ReadonlyUnderscoreEscapedMap.md).[`values`](ReadonlyUnderscoreEscapedMap.md#values) diff --git a/docs/api_docs/namespaces/ts/interfaces/UnionOrIntersectionType.md b/docs/api_docs/namespaces/ts/interfaces/UnionOrIntersectionType.md new file mode 100644 index 0000000000000000000000000000000000000000..068d3586ef087d0f151cb64c526715cadba1f057 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/UnionOrIntersectionType.md @@ -0,0 +1,460 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / UnionOrIntersectionType + +# Interface: UnionOrIntersectionType + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2874 + +## Extends + +- [`Type`](Type.md) + +## Extended by + +- [`UnionType`](UnionType.md) +- [`IntersectionType`](IntersectionType.md) + +## Properties + +### aliasSymbol? + +> `optional` **aliasSymbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2773 + +#### Inherited from + +[`Type`](Type.md).[`aliasSymbol`](Type.md#aliassymbol) + +*** + +### aliasTypeArguments? + +> `optional` **aliasTypeArguments**: readonly [`Type`](Type.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2774 + +#### Inherited from + +[`Type`](Type.md).[`aliasTypeArguments`](Type.md#aliastypearguments) + +*** + +### flags + +> **flags**: [`TypeFlags`](../enumerations/TypeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2770 + +#### Inherited from + +[`Type`](Type.md).[`flags`](Type.md#flags) + +*** + +### pattern? + +> `optional` **pattern**: [`DestructuringPattern`](../type-aliases/DestructuringPattern.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2772 + +#### Inherited from + +[`Type`](Type.md).[`pattern`](Type.md#pattern) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2771 + +#### Inherited from + +[`Type`](Type.md).[`symbol`](Type.md#symbol) + +*** + +### types + +> **types**: [`Type`](Type.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2875 + +## Methods + +### getApparentProperties() + +> **getApparentProperties**(): [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6124 + +#### Returns + +[`Symbol`](Symbol.md)[] + +#### Inherited from + +[`Type`](Type.md).[`getApparentProperties`](Type.md#getapparentproperties) + +*** + +### getBaseTypes() + +> **getBaseTypes**(): `undefined` \| [`BaseType`](../type-aliases/BaseType.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6129 + +#### Returns + +`undefined` \| [`BaseType`](../type-aliases/BaseType.md)[] + +#### Inherited from + +[`Type`](Type.md).[`getBaseTypes`](Type.md#getbasetypes) + +*** + +### getCallSignatures() + +> **getCallSignatures**(): readonly [`Signature`](Signature.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6125 + +#### Returns + +readonly [`Signature`](Signature.md)[] + +#### Inherited from + +[`Type`](Type.md).[`getCallSignatures`](Type.md#getcallsignatures) + +*** + +### getConstraint() + +> **getConstraint**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6131 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`Type`](Type.md).[`getConstraint`](Type.md#getconstraint) + +*** + +### getConstructSignatures() + +> **getConstructSignatures**(): readonly [`Signature`](Signature.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6126 + +#### Returns + +readonly [`Signature`](Signature.md)[] + +#### Inherited from + +[`Type`](Type.md).[`getConstructSignatures`](Type.md#getconstructsignatures) + +*** + +### getDefault() + +> **getDefault**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6132 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`Type`](Type.md).[`getDefault`](Type.md#getdefault) + +*** + +### getFlags() + +> **getFlags**(): [`TypeFlags`](../enumerations/TypeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6120 + +#### Returns + +[`TypeFlags`](../enumerations/TypeFlags.md) + +#### Inherited from + +[`Type`](Type.md).[`getFlags`](Type.md#getflags) + +*** + +### getNonNullableType() + +> **getNonNullableType**(): [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6130 + +#### Returns + +[`Type`](Type.md) + +#### Inherited from + +[`Type`](Type.md).[`getNonNullableType`](Type.md#getnonnullabletype) + +*** + +### getNumberIndexType() + +> **getNumberIndexType**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6128 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`Type`](Type.md).[`getNumberIndexType`](Type.md#getnumberindextype) + +*** + +### getProperties() + +> **getProperties**(): [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6122 + +#### Returns + +[`Symbol`](Symbol.md)[] + +#### Inherited from + +[`Type`](Type.md).[`getProperties`](Type.md#getproperties) + +*** + +### getProperty() + +> **getProperty**(`propertyName`): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6123 + +#### Parameters + +##### propertyName + +`string` + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +#### Inherited from + +[`Type`](Type.md).[`getProperty`](Type.md#getproperty) + +*** + +### getStringIndexType() + +> **getStringIndexType**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6127 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`Type`](Type.md).[`getStringIndexType`](Type.md#getstringindextype) + +*** + +### getSymbol() + +> **getSymbol**(): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6121 + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +#### Inherited from + +[`Type`](Type.md).[`getSymbol`](Type.md#getsymbol) + +*** + +### isClass() + +> **isClass**(): `this is InterfaceType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6141 + +#### Returns + +`this is InterfaceType` + +#### Inherited from + +[`Type`](Type.md).[`isClass`](Type.md#isclass) + +*** + +### isClassOrInterface() + +> **isClassOrInterface**(): `this is InterfaceType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6140 + +#### Returns + +`this is InterfaceType` + +#### Inherited from + +[`Type`](Type.md).[`isClassOrInterface`](Type.md#isclassorinterface) + +*** + +### isIndexType() + +> **isIndexType**(): `this is IndexType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6142 + +#### Returns + +`this is IndexType` + +#### Inherited from + +[`Type`](Type.md).[`isIndexType`](Type.md#isindextype) + +*** + +### isIntersection() + +> **isIntersection**(): `this is IntersectionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6134 + +#### Returns + +`this is IntersectionType` + +#### Inherited from + +[`Type`](Type.md).[`isIntersection`](Type.md#isintersection) + +*** + +### isLiteral() + +> **isLiteral**(): `this is LiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6136 + +#### Returns + +`this is LiteralType` + +#### Inherited from + +[`Type`](Type.md).[`isLiteral`](Type.md#isliteral) + +*** + +### isNumberLiteral() + +> **isNumberLiteral**(): `this is NumberLiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6138 + +#### Returns + +`this is NumberLiteralType` + +#### Inherited from + +[`Type`](Type.md).[`isNumberLiteral`](Type.md#isnumberliteral) + +*** + +### isStringLiteral() + +> **isStringLiteral**(): `this is StringLiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6137 + +#### Returns + +`this is StringLiteralType` + +#### Inherited from + +[`Type`](Type.md).[`isStringLiteral`](Type.md#isstringliteral) + +*** + +### isTypeParameter() + +> **isTypeParameter**(): `this is TypeParameter` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6139 + +#### Returns + +`this is TypeParameter` + +#### Inherited from + +[`Type`](Type.md).[`isTypeParameter`](Type.md#istypeparameter) + +*** + +### isUnion() + +> **isUnion**(): `this is UnionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6133 + +#### Returns + +`this is UnionType` + +#### Inherited from + +[`Type`](Type.md).[`isUnion`](Type.md#isunion) + +*** + +### isUnionOrIntersection() + +> **isUnionOrIntersection**(): `this is UnionOrIntersectionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6135 + +#### Returns + +`this is UnionOrIntersectionType` + +#### Inherited from + +[`Type`](Type.md).[`isUnionOrIntersection`](Type.md#isunionorintersection) diff --git a/docs/api_docs/namespaces/ts/interfaces/UnionType.md b/docs/api_docs/namespaces/ts/interfaces/UnionType.md new file mode 100644 index 0000000000000000000000000000000000000000..bbfabe3e8e63d6d444b7e1b28076d7a5a463f2ab --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/UnionType.md @@ -0,0 +1,459 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / UnionType + +# Interface: UnionType + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2877 + +## Extends + +- [`UnionOrIntersectionType`](UnionOrIntersectionType.md) + +## Properties + +### aliasSymbol? + +> `optional` **aliasSymbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2773 + +#### Inherited from + +[`UnionOrIntersectionType`](UnionOrIntersectionType.md).[`aliasSymbol`](UnionOrIntersectionType.md#aliassymbol) + +*** + +### aliasTypeArguments? + +> `optional` **aliasTypeArguments**: readonly [`Type`](Type.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2774 + +#### Inherited from + +[`UnionOrIntersectionType`](UnionOrIntersectionType.md).[`aliasTypeArguments`](UnionOrIntersectionType.md#aliastypearguments) + +*** + +### flags + +> **flags**: [`TypeFlags`](../enumerations/TypeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2770 + +#### Inherited from + +[`UnionOrIntersectionType`](UnionOrIntersectionType.md).[`flags`](UnionOrIntersectionType.md#flags) + +*** + +### pattern? + +> `optional` **pattern**: [`DestructuringPattern`](../type-aliases/DestructuringPattern.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2772 + +#### Inherited from + +[`UnionOrIntersectionType`](UnionOrIntersectionType.md).[`pattern`](UnionOrIntersectionType.md#pattern) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2771 + +#### Inherited from + +[`UnionOrIntersectionType`](UnionOrIntersectionType.md).[`symbol`](UnionOrIntersectionType.md#symbol) + +*** + +### types + +> **types**: [`Type`](Type.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2875 + +#### Inherited from + +[`UnionOrIntersectionType`](UnionOrIntersectionType.md).[`types`](UnionOrIntersectionType.md#types) + +## Methods + +### getApparentProperties() + +> **getApparentProperties**(): [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6124 + +#### Returns + +[`Symbol`](Symbol.md)[] + +#### Inherited from + +[`UnionOrIntersectionType`](UnionOrIntersectionType.md).[`getApparentProperties`](UnionOrIntersectionType.md#getapparentproperties) + +*** + +### getBaseTypes() + +> **getBaseTypes**(): `undefined` \| [`BaseType`](../type-aliases/BaseType.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6129 + +#### Returns + +`undefined` \| [`BaseType`](../type-aliases/BaseType.md)[] + +#### Inherited from + +[`UnionOrIntersectionType`](UnionOrIntersectionType.md).[`getBaseTypes`](UnionOrIntersectionType.md#getbasetypes) + +*** + +### getCallSignatures() + +> **getCallSignatures**(): readonly [`Signature`](Signature.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6125 + +#### Returns + +readonly [`Signature`](Signature.md)[] + +#### Inherited from + +[`UnionOrIntersectionType`](UnionOrIntersectionType.md).[`getCallSignatures`](UnionOrIntersectionType.md#getcallsignatures) + +*** + +### getConstraint() + +> **getConstraint**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6131 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`UnionOrIntersectionType`](UnionOrIntersectionType.md).[`getConstraint`](UnionOrIntersectionType.md#getconstraint) + +*** + +### getConstructSignatures() + +> **getConstructSignatures**(): readonly [`Signature`](Signature.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6126 + +#### Returns + +readonly [`Signature`](Signature.md)[] + +#### Inherited from + +[`UnionOrIntersectionType`](UnionOrIntersectionType.md).[`getConstructSignatures`](UnionOrIntersectionType.md#getconstructsignatures) + +*** + +### getDefault() + +> **getDefault**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6132 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`UnionOrIntersectionType`](UnionOrIntersectionType.md).[`getDefault`](UnionOrIntersectionType.md#getdefault) + +*** + +### getFlags() + +> **getFlags**(): [`TypeFlags`](../enumerations/TypeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6120 + +#### Returns + +[`TypeFlags`](../enumerations/TypeFlags.md) + +#### Inherited from + +[`UnionOrIntersectionType`](UnionOrIntersectionType.md).[`getFlags`](UnionOrIntersectionType.md#getflags) + +*** + +### getNonNullableType() + +> **getNonNullableType**(): [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6130 + +#### Returns + +[`Type`](Type.md) + +#### Inherited from + +[`UnionOrIntersectionType`](UnionOrIntersectionType.md).[`getNonNullableType`](UnionOrIntersectionType.md#getnonnullabletype) + +*** + +### getNumberIndexType() + +> **getNumberIndexType**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6128 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`UnionOrIntersectionType`](UnionOrIntersectionType.md).[`getNumberIndexType`](UnionOrIntersectionType.md#getnumberindextype) + +*** + +### getProperties() + +> **getProperties**(): [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6122 + +#### Returns + +[`Symbol`](Symbol.md)[] + +#### Inherited from + +[`UnionOrIntersectionType`](UnionOrIntersectionType.md).[`getProperties`](UnionOrIntersectionType.md#getproperties) + +*** + +### getProperty() + +> **getProperty**(`propertyName`): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6123 + +#### Parameters + +##### propertyName + +`string` + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +#### Inherited from + +[`UnionOrIntersectionType`](UnionOrIntersectionType.md).[`getProperty`](UnionOrIntersectionType.md#getproperty) + +*** + +### getStringIndexType() + +> **getStringIndexType**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6127 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`UnionOrIntersectionType`](UnionOrIntersectionType.md).[`getStringIndexType`](UnionOrIntersectionType.md#getstringindextype) + +*** + +### getSymbol() + +> **getSymbol**(): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6121 + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +#### Inherited from + +[`UnionOrIntersectionType`](UnionOrIntersectionType.md).[`getSymbol`](UnionOrIntersectionType.md#getsymbol) + +*** + +### isClass() + +> **isClass**(): `this is InterfaceType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6141 + +#### Returns + +`this is InterfaceType` + +#### Inherited from + +[`UnionOrIntersectionType`](UnionOrIntersectionType.md).[`isClass`](UnionOrIntersectionType.md#isclass) + +*** + +### isClassOrInterface() + +> **isClassOrInterface**(): `this is InterfaceType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6140 + +#### Returns + +`this is InterfaceType` + +#### Inherited from + +[`UnionOrIntersectionType`](UnionOrIntersectionType.md).[`isClassOrInterface`](UnionOrIntersectionType.md#isclassorinterface) + +*** + +### isIndexType() + +> **isIndexType**(): `this is IndexType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6142 + +#### Returns + +`this is IndexType` + +#### Inherited from + +[`UnionOrIntersectionType`](UnionOrIntersectionType.md).[`isIndexType`](UnionOrIntersectionType.md#isindextype) + +*** + +### isIntersection() + +> **isIntersection**(): `this is IntersectionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6134 + +#### Returns + +`this is IntersectionType` + +#### Inherited from + +[`UnionOrIntersectionType`](UnionOrIntersectionType.md).[`isIntersection`](UnionOrIntersectionType.md#isintersection) + +*** + +### isLiteral() + +> **isLiteral**(): `this is LiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6136 + +#### Returns + +`this is LiteralType` + +#### Inherited from + +[`UnionOrIntersectionType`](UnionOrIntersectionType.md).[`isLiteral`](UnionOrIntersectionType.md#isliteral) + +*** + +### isNumberLiteral() + +> **isNumberLiteral**(): `this is NumberLiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6138 + +#### Returns + +`this is NumberLiteralType` + +#### Inherited from + +[`UnionOrIntersectionType`](UnionOrIntersectionType.md).[`isNumberLiteral`](UnionOrIntersectionType.md#isnumberliteral) + +*** + +### isStringLiteral() + +> **isStringLiteral**(): `this is StringLiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6137 + +#### Returns + +`this is StringLiteralType` + +#### Inherited from + +[`UnionOrIntersectionType`](UnionOrIntersectionType.md).[`isStringLiteral`](UnionOrIntersectionType.md#isstringliteral) + +*** + +### isTypeParameter() + +> **isTypeParameter**(): `this is TypeParameter` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6139 + +#### Returns + +`this is TypeParameter` + +#### Inherited from + +[`UnionOrIntersectionType`](UnionOrIntersectionType.md).[`isTypeParameter`](UnionOrIntersectionType.md#istypeparameter) + +*** + +### isUnion() + +> **isUnion**(): `this is UnionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6133 + +#### Returns + +`this is UnionType` + +#### Inherited from + +[`UnionOrIntersectionType`](UnionOrIntersectionType.md).[`isUnion`](UnionOrIntersectionType.md#isunion) + +*** + +### isUnionOrIntersection() + +> **isUnionOrIntersection**(): `this is UnionOrIntersectionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6135 + +#### Returns + +`this is UnionOrIntersectionType` + +#### Inherited from + +[`UnionOrIntersectionType`](UnionOrIntersectionType.md).[`isUnionOrIntersection`](UnionOrIntersectionType.md#isunionorintersection) diff --git a/docs/api_docs/namespaces/ts/interfaces/UnionTypeNode.md b/docs/api_docs/namespaces/ts/interfaces/UnionTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..ccab75cd68fc9cea6a82e36bc7e52567c0d841fe --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/UnionTypeNode.md @@ -0,0 +1,497 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / UnionTypeNode + +# Interface: UnionTypeNode + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:992 + +## Extends + +- [`TypeNode`](TypeNode.md) + +## Properties + +### \_typeNodeBrand + +> **\_typeNodeBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:912 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`_typeNodeBrand`](TypeNode.md#_typenodebrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`decorators`](TypeNode.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`end`](TypeNode.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`flags`](TypeNode.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`UnionType`](../enumerations/SyntaxKind.md#uniontype) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:993 + +#### Overrides + +[`TypeNode`](TypeNode.md).[`kind`](TypeNode.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`locals`](TypeNode.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`modifiers`](TypeNode.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`parent`](TypeNode.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`pos`](TypeNode.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`skipCheck`](TypeNode.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`symbol`](TypeNode.md#symbol) + +*** + +### types + +> `readonly` **types**: [`NodeArray`](NodeArray.md)\<[`TypeNode`](TypeNode.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:994 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`forEachChild`](TypeNode.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getChildAt`](TypeNode.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getChildCount`](TypeNode.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getChildren`](TypeNode.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getEnd`](TypeNode.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFirstToken`](TypeNode.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFullStart`](TypeNode.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFullText`](TypeNode.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getFullWidth`](TypeNode.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getLastToken`](TypeNode.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getLeadingTriviaWidth`](TypeNode.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getSourceFile`](TypeNode.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getStart`](TypeNode.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getText`](TypeNode.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`TypeNode`](TypeNode.md).[`getWidth`](TypeNode.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/UniqueESSymbolType.md b/docs/api_docs/namespaces/ts/interfaces/UniqueESSymbolType.md new file mode 100644 index 0000000000000000000000000000000000000000..25e10f679e9bacef933f93d265e8d2c6845c98fe --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/UniqueESSymbolType.md @@ -0,0 +1,455 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / UniqueESSymbolType + +# Interface: UniqueESSymbolType + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2781 + +## Extends + +- [`Type`](Type.md) + +## Properties + +### aliasSymbol? + +> `optional` **aliasSymbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2773 + +#### Inherited from + +[`Type`](Type.md).[`aliasSymbol`](Type.md#aliassymbol) + +*** + +### aliasTypeArguments? + +> `optional` **aliasTypeArguments**: readonly [`Type`](Type.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2774 + +#### Inherited from + +[`Type`](Type.md).[`aliasTypeArguments`](Type.md#aliastypearguments) + +*** + +### escapedName + +> **escapedName**: [`__String`](../type-aliases/String.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2783 + +*** + +### flags + +> **flags**: [`TypeFlags`](../enumerations/TypeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2770 + +#### Inherited from + +[`Type`](Type.md).[`flags`](Type.md#flags) + +*** + +### pattern? + +> `optional` **pattern**: [`DestructuringPattern`](../type-aliases/DestructuringPattern.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2772 + +#### Inherited from + +[`Type`](Type.md).[`pattern`](Type.md#pattern) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2782 + +#### Overrides + +[`Type`](Type.md).[`symbol`](Type.md#symbol) + +## Methods + +### getApparentProperties() + +> **getApparentProperties**(): [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6124 + +#### Returns + +[`Symbol`](Symbol.md)[] + +#### Inherited from + +[`Type`](Type.md).[`getApparentProperties`](Type.md#getapparentproperties) + +*** + +### getBaseTypes() + +> **getBaseTypes**(): `undefined` \| [`BaseType`](../type-aliases/BaseType.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6129 + +#### Returns + +`undefined` \| [`BaseType`](../type-aliases/BaseType.md)[] + +#### Inherited from + +[`Type`](Type.md).[`getBaseTypes`](Type.md#getbasetypes) + +*** + +### getCallSignatures() + +> **getCallSignatures**(): readonly [`Signature`](Signature.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6125 + +#### Returns + +readonly [`Signature`](Signature.md)[] + +#### Inherited from + +[`Type`](Type.md).[`getCallSignatures`](Type.md#getcallsignatures) + +*** + +### getConstraint() + +> **getConstraint**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6131 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`Type`](Type.md).[`getConstraint`](Type.md#getconstraint) + +*** + +### getConstructSignatures() + +> **getConstructSignatures**(): readonly [`Signature`](Signature.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6126 + +#### Returns + +readonly [`Signature`](Signature.md)[] + +#### Inherited from + +[`Type`](Type.md).[`getConstructSignatures`](Type.md#getconstructsignatures) + +*** + +### getDefault() + +> **getDefault**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6132 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`Type`](Type.md).[`getDefault`](Type.md#getdefault) + +*** + +### getFlags() + +> **getFlags**(): [`TypeFlags`](../enumerations/TypeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6120 + +#### Returns + +[`TypeFlags`](../enumerations/TypeFlags.md) + +#### Inherited from + +[`Type`](Type.md).[`getFlags`](Type.md#getflags) + +*** + +### getNonNullableType() + +> **getNonNullableType**(): [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6130 + +#### Returns + +[`Type`](Type.md) + +#### Inherited from + +[`Type`](Type.md).[`getNonNullableType`](Type.md#getnonnullabletype) + +*** + +### getNumberIndexType() + +> **getNumberIndexType**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6128 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`Type`](Type.md).[`getNumberIndexType`](Type.md#getnumberindextype) + +*** + +### getProperties() + +> **getProperties**(): [`Symbol`](Symbol.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6122 + +#### Returns + +[`Symbol`](Symbol.md)[] + +#### Inherited from + +[`Type`](Type.md).[`getProperties`](Type.md#getproperties) + +*** + +### getProperty() + +> **getProperty**(`propertyName`): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6123 + +#### Parameters + +##### propertyName + +`string` + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +#### Inherited from + +[`Type`](Type.md).[`getProperty`](Type.md#getproperty) + +*** + +### getStringIndexType() + +> **getStringIndexType**(): `undefined` \| [`Type`](Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6127 + +#### Returns + +`undefined` \| [`Type`](Type.md) + +#### Inherited from + +[`Type`](Type.md).[`getStringIndexType`](Type.md#getstringindextype) + +*** + +### getSymbol() + +> **getSymbol**(): `undefined` \| [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6121 + +#### Returns + +`undefined` \| [`Symbol`](Symbol.md) + +#### Inherited from + +[`Type`](Type.md).[`getSymbol`](Type.md#getsymbol) + +*** + +### isClass() + +> **isClass**(): `this is InterfaceType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6141 + +#### Returns + +`this is InterfaceType` + +#### Inherited from + +[`Type`](Type.md).[`isClass`](Type.md#isclass) + +*** + +### isClassOrInterface() + +> **isClassOrInterface**(): `this is InterfaceType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6140 + +#### Returns + +`this is InterfaceType` + +#### Inherited from + +[`Type`](Type.md).[`isClassOrInterface`](Type.md#isclassorinterface) + +*** + +### isIndexType() + +> **isIndexType**(): `this is IndexType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6142 + +#### Returns + +`this is IndexType` + +#### Inherited from + +[`Type`](Type.md).[`isIndexType`](Type.md#isindextype) + +*** + +### isIntersection() + +> **isIntersection**(): `this is IntersectionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6134 + +#### Returns + +`this is IntersectionType` + +#### Inherited from + +[`Type`](Type.md).[`isIntersection`](Type.md#isintersection) + +*** + +### isLiteral() + +> **isLiteral**(): `this is LiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6136 + +#### Returns + +`this is LiteralType` + +#### Inherited from + +[`Type`](Type.md).[`isLiteral`](Type.md#isliteral) + +*** + +### isNumberLiteral() + +> **isNumberLiteral**(): `this is NumberLiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6138 + +#### Returns + +`this is NumberLiteralType` + +#### Inherited from + +[`Type`](Type.md).[`isNumberLiteral`](Type.md#isnumberliteral) + +*** + +### isStringLiteral() + +> **isStringLiteral**(): `this is StringLiteralType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6137 + +#### Returns + +`this is StringLiteralType` + +#### Inherited from + +[`Type`](Type.md).[`isStringLiteral`](Type.md#isstringliteral) + +*** + +### isTypeParameter() + +> **isTypeParameter**(): `this is TypeParameter` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6139 + +#### Returns + +`this is TypeParameter` + +#### Inherited from + +[`Type`](Type.md).[`isTypeParameter`](Type.md#istypeparameter) + +*** + +### isUnion() + +> **isUnion**(): `this is UnionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6133 + +#### Returns + +`this is UnionType` + +#### Inherited from + +[`Type`](Type.md).[`isUnion`](Type.md#isunion) + +*** + +### isUnionOrIntersection() + +> **isUnionOrIntersection**(): `this is UnionOrIntersectionType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6135 + +#### Returns + +`this is UnionOrIntersectionType` + +#### Inherited from + +[`Type`](Type.md).[`isUnionOrIntersection`](Type.md#isunionorintersection) diff --git a/docs/api_docs/namespaces/ts/interfaces/UnparsedPrepend.md b/docs/api_docs/namespaces/ts/interfaces/UnparsedPrepend.md new file mode 100644 index 0000000000000000000000000000000000000000..2374a88f86c8d64bc3e813c3f0aa95c37571e429 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/UnparsedPrepend.md @@ -0,0 +1,497 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / UnparsedPrepend + +# Interface: UnparsedPrepend + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2201 + +## Extends + +- [`UnparsedSection`](UnparsedSection.md) + +## Properties + +### data + +> `readonly` **data**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2204 + +#### Overrides + +[`UnparsedSection`](UnparsedSection.md).[`data`](UnparsedSection.md#data) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`decorators`](UnparsedSection.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`end`](UnparsedSection.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`flags`](UnparsedSection.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`UnparsedPrepend`](../enumerations/SyntaxKind.md#unparsedprepend) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2202 + +#### Overrides + +[`UnparsedSection`](UnparsedSection.md).[`kind`](UnparsedSection.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`locals`](UnparsedSection.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`modifiers`](UnparsedSection.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`UnparsedSource`](UnparsedSource.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2203 + +#### Overrides + +[`UnparsedSection`](UnparsedSection.md).[`parent`](UnparsedSection.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`pos`](UnparsedSection.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`skipCheck`](UnparsedSection.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`symbol`](UnparsedSection.md#symbol) + +*** + +### texts + +> `readonly` **texts**: readonly [`UnparsedTextLike`](UnparsedTextLike.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2205 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`forEachChild`](UnparsedSection.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`getChildAt`](UnparsedSection.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`getChildCount`](UnparsedSection.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`getChildren`](UnparsedSection.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`getEnd`](UnparsedSection.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`getFirstToken`](UnparsedSection.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`getFullStart`](UnparsedSection.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`getFullText`](UnparsedSection.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`getFullWidth`](UnparsedSection.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`getLastToken`](UnparsedSection.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`getLeadingTriviaWidth`](UnparsedSection.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`getSourceFile`](UnparsedSection.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`getStart`](UnparsedSection.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`getText`](UnparsedSection.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`getWidth`](UnparsedSection.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/UnparsedPrologue.md b/docs/api_docs/namespaces/ts/interfaces/UnparsedPrologue.md new file mode 100644 index 0000000000000000000000000000000000000000..0b16b9c05c316899cf2aebd431453a8061e02af1 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/UnparsedPrologue.md @@ -0,0 +1,489 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / UnparsedPrologue + +# Interface: UnparsedPrologue + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2196 + +## Extends + +- [`UnparsedSection`](UnparsedSection.md) + +## Properties + +### data + +> `readonly` **data**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2199 + +#### Overrides + +[`UnparsedSection`](UnparsedSection.md).[`data`](UnparsedSection.md#data) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`decorators`](UnparsedSection.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`end`](UnparsedSection.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`flags`](UnparsedSection.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`UnparsedPrologue`](../enumerations/SyntaxKind.md#unparsedprologue) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2197 + +#### Overrides + +[`UnparsedSection`](UnparsedSection.md).[`kind`](UnparsedSection.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`locals`](UnparsedSection.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`modifiers`](UnparsedSection.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`UnparsedSource`](UnparsedSource.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2198 + +#### Overrides + +[`UnparsedSection`](UnparsedSection.md).[`parent`](UnparsedSection.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`pos`](UnparsedSection.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`skipCheck`](UnparsedSection.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`symbol`](UnparsedSection.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`forEachChild`](UnparsedSection.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`getChildAt`](UnparsedSection.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`getChildCount`](UnparsedSection.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`getChildren`](UnparsedSection.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`getEnd`](UnparsedSection.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`getFirstToken`](UnparsedSection.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`getFullStart`](UnparsedSection.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`getFullText`](UnparsedSection.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`getFullWidth`](UnparsedSection.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`getLastToken`](UnparsedSection.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`getLeadingTriviaWidth`](UnparsedSection.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`getSourceFile`](UnparsedSection.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`getStart`](UnparsedSection.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`getText`](UnparsedSection.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`getWidth`](UnparsedSection.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/UnparsedSection.md b/docs/api_docs/namespaces/ts/interfaces/UnparsedSection.md new file mode 100644 index 0000000000000000000000000000000000000000..b8afa7abb51c1ce9999993873b8337a6305e3896 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/UnparsedSection.md @@ -0,0 +1,492 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / UnparsedSection + +# Interface: UnparsedSection + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2191 + +## Extends + +- [`Node`](Node.md) + +## Extended by + +- [`UnparsedPrologue`](UnparsedPrologue.md) +- [`UnparsedPrepend`](UnparsedPrepend.md) +- [`UnparsedTextLike`](UnparsedTextLike.md) +- [`UnparsedSyntheticReference`](UnparsedSyntheticReference.md) + +## Properties + +### data? + +> `readonly` `optional` **data**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2194 + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`decorators`](Node.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Node`](Node.md).[`end`](Node.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Node`](Node.md).[`flags`](Node.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`SyntaxKind`](../enumerations/SyntaxKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2192 + +#### Overrides + +[`Node`](Node.md).[`kind`](Node.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Node`](Node.md).[`locals`](Node.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`modifiers`](Node.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`UnparsedSource`](UnparsedSource.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2193 + +#### Overrides + +[`Node`](Node.md).[`parent`](Node.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Node`](Node.md).[`pos`](Node.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Node`](Node.md).[`skipCheck`](Node.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Node`](Node.md).[`symbol`](Node.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Node`](Node.md).[`forEachChild`](Node.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getChildAt`](Node.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getChildCount`](Node.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Node`](Node.md).[`getChildren`](Node.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getEnd`](Node.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getFirstToken`](Node.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullStart`](Node.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getFullText`](Node.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullWidth`](Node.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getLastToken`](Node.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getLeadingTriviaWidth`](Node.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Node`](Node.md).[`getSourceFile`](Node.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getStart`](Node.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getText`](Node.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getWidth`](Node.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/UnparsedSource.md b/docs/api_docs/namespaces/ts/interfaces/UnparsedSource.md new file mode 100644 index 0000000000000000000000000000000000000000..4e062b690aafc08de25259e7bf1051458c063454 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/UnparsedSource.md @@ -0,0 +1,573 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / UnparsedSource + +# Interface: UnparsedSource + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2174 + +## Extends + +- [`Node`](Node.md) + +## Properties + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`decorators`](Node.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Node`](Node.md).[`end`](Node.md#end) + +*** + +### fileName + +> **fileName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2176 + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Node`](Node.md).[`flags`](Node.md#flags) + +*** + +### hasNoDefaultLib? + +> `optional` **hasNoDefaultLib**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2183 + +*** + +### helpers + +> **helpers**: `undefined` \| readonly [`UnscopedEmitHelper`](UnscopedEmitHelper.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2179 + +*** + +### kind + +> `readonly` **kind**: [`UnparsedSource`](../enumerations/SyntaxKind.md#unparsedsource) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2175 + +#### Overrides + +[`Node`](Node.md).[`kind`](Node.md#kind) + +*** + +### libReferenceDirectives + +> **libReferenceDirectives**: readonly [`FileReference`](FileReference.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2182 + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Node`](Node.md).[`locals`](Node.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`modifiers`](Node.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`Node`](Node.md).[`parent`](Node.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Node`](Node.md).[`pos`](Node.md#pos) + +*** + +### prologues + +> `readonly` **prologues**: readonly [`UnparsedPrologue`](UnparsedPrologue.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2178 + +*** + +### referencedFiles + +> **referencedFiles**: readonly [`FileReference`](FileReference.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2180 + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Node`](Node.md).[`skipCheck`](Node.md#skipcheck) + +*** + +### sourceMapPath? + +> `optional` **sourceMapPath**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2184 + +*** + +### sourceMapText? + +> `optional` **sourceMapText**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2185 + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Node`](Node.md).[`symbol`](Node.md#symbol) + +*** + +### syntheticReferences? + +> `readonly` `optional` **syntheticReferences**: readonly [`UnparsedSyntheticReference`](UnparsedSyntheticReference.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2186 + +*** + +### text + +> **text**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2177 + +*** + +### texts + +> `readonly` **texts**: readonly [`UnparsedSourceText`](../type-aliases/UnparsedSourceText.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2187 + +*** + +### typeReferenceDirectives + +> **typeReferenceDirectives**: `undefined` \| readonly [`FileReference`](FileReference.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2181 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Node`](Node.md).[`forEachChild`](Node.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getChildAt`](Node.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getChildCount`](Node.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Node`](Node.md).[`getChildren`](Node.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getEnd`](Node.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getFirstToken`](Node.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullStart`](Node.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getFullText`](Node.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullWidth`](Node.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getLastToken`](Node.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getLeadingTriviaWidth`](Node.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Node`](Node.md).[`getSourceFile`](Node.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getStart`](Node.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getText`](Node.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getWidth`](Node.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/UnparsedSyntheticReference.md b/docs/api_docs/namespaces/ts/interfaces/UnparsedSyntheticReference.md new file mode 100644 index 0000000000000000000000000000000000000000..cdb66fca560e72e1bbf296fa72264045474d8ee4 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/UnparsedSyntheticReference.md @@ -0,0 +1,489 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / UnparsedSyntheticReference + +# Interface: UnparsedSyntheticReference + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2211 + +## Extends + +- [`UnparsedSection`](UnparsedSection.md) + +## Properties + +### data? + +> `readonly` `optional` **data**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2194 + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`data`](UnparsedSection.md#data) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`decorators`](UnparsedSection.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`end`](UnparsedSection.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`flags`](UnparsedSection.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`UnparsedSyntheticReference`](../enumerations/SyntaxKind.md#unparsedsyntheticreference) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2212 + +#### Overrides + +[`UnparsedSection`](UnparsedSection.md).[`kind`](UnparsedSection.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`locals`](UnparsedSection.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`modifiers`](UnparsedSection.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`UnparsedSource`](UnparsedSource.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2213 + +#### Overrides + +[`UnparsedSection`](UnparsedSection.md).[`parent`](UnparsedSection.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`pos`](UnparsedSection.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`skipCheck`](UnparsedSection.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`symbol`](UnparsedSection.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`forEachChild`](UnparsedSection.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`getChildAt`](UnparsedSection.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`getChildCount`](UnparsedSection.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`getChildren`](UnparsedSection.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`getEnd`](UnparsedSection.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`getFirstToken`](UnparsedSection.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`getFullStart`](UnparsedSection.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`getFullText`](UnparsedSection.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`getFullWidth`](UnparsedSection.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`getLastToken`](UnparsedSection.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`getLeadingTriviaWidth`](UnparsedSection.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`getSourceFile`](UnparsedSection.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`getStart`](UnparsedSection.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`getText`](UnparsedSection.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`getWidth`](UnparsedSection.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/UnparsedTextLike.md b/docs/api_docs/namespaces/ts/interfaces/UnparsedTextLike.md new file mode 100644 index 0000000000000000000000000000000000000000..42b221d26b1b42bca1896c90dceabe126093066c --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/UnparsedTextLike.md @@ -0,0 +1,489 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / UnparsedTextLike + +# Interface: UnparsedTextLike + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2207 + +## Extends + +- [`UnparsedSection`](UnparsedSection.md) + +## Properties + +### data? + +> `readonly` `optional` **data**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2194 + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`data`](UnparsedSection.md#data) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`decorators`](UnparsedSection.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`end`](UnparsedSection.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`flags`](UnparsedSection.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`UnparsedText`](../enumerations/SyntaxKind.md#unparsedtext) \| [`UnparsedInternalText`](../enumerations/SyntaxKind.md#unparsedinternaltext) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2208 + +#### Overrides + +[`UnparsedSection`](UnparsedSection.md).[`kind`](UnparsedSection.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`locals`](UnparsedSection.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`modifiers`](UnparsedSection.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`UnparsedSource`](UnparsedSource.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2209 + +#### Overrides + +[`UnparsedSection`](UnparsedSection.md).[`parent`](UnparsedSection.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`pos`](UnparsedSection.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`skipCheck`](UnparsedSection.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`symbol`](UnparsedSection.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`forEachChild`](UnparsedSection.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`getChildAt`](UnparsedSection.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`getChildCount`](UnparsedSection.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`getChildren`](UnparsedSection.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`getEnd`](UnparsedSection.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`getFirstToken`](UnparsedSection.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`getFullStart`](UnparsedSection.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`getFullText`](UnparsedSection.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`getFullWidth`](UnparsedSection.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`getLastToken`](UnparsedSection.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`getLeadingTriviaWidth`](UnparsedSection.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`getSourceFile`](UnparsedSection.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`getStart`](UnparsedSection.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`getText`](UnparsedSection.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`UnparsedSection`](UnparsedSection.md).[`getWidth`](UnparsedSection.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/UnscopedEmitHelper.md b/docs/api_docs/namespaces/ts/interfaces/UnscopedEmitHelper.md new file mode 100644 index 0000000000000000000000000000000000000000..21e7ad9f444d870ae9d8ad920def11ded16c02b0 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/UnscopedEmitHelper.md @@ -0,0 +1,73 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / UnscopedEmitHelper + +# Interface: UnscopedEmitHelper + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3563 + +## Extends + +- [`EmitHelperBase`](EmitHelperBase.md) + +## Properties + +### dependencies? + +> `readonly` `optional` **dependencies**: [`EmitHelper`](../type-aliases/EmitHelper.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3558 + +#### Inherited from + +[`EmitHelperBase`](EmitHelperBase.md).[`dependencies`](EmitHelperBase.md#dependencies) + +*** + +### name + +> `readonly` **name**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3554 + +#### Inherited from + +[`EmitHelperBase`](EmitHelperBase.md).[`name`](EmitHelperBase.md#name) + +*** + +### priority? + +> `readonly` `optional` **priority**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3557 + +#### Inherited from + +[`EmitHelperBase`](EmitHelperBase.md).[`priority`](EmitHelperBase.md#priority) + +*** + +### scoped + +> `readonly` **scoped**: `false` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3564 + +#### Overrides + +[`EmitHelperBase`](EmitHelperBase.md).[`scoped`](EmitHelperBase.md#scoped) + +*** + +### text + +> `readonly` **text**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3565 + +#### Overrides + +[`EmitHelperBase`](EmitHelperBase.md).[`text`](EmitHelperBase.md#text) diff --git a/docs/api_docs/namespaces/ts/interfaces/UpdateBundleProject.md b/docs/api_docs/namespaces/ts/interfaces/UpdateBundleProject.md new file mode 100644 index 0000000000000000000000000000000000000000..98be3181da9861b3e8c5ad007d3db2ac792ef942 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/UpdateBundleProject.md @@ -0,0 +1,127 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / UpdateBundleProject + +# Interface: UpdateBundleProject\ + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6005 + +## Extends + +- [`InvalidatedProjectBase`](InvalidatedProjectBase.md) + +## Type Parameters + +• **T** *extends* [`BuilderProgram`](BuilderProgram.md) + +## Properties + +### kind + +> `readonly` **kind**: [`UpdateBundle`](../enumerations/InvalidatedProjectKind.md#updatebundle) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6006 + +#### Overrides + +[`InvalidatedProjectBase`](InvalidatedProjectBase.md).[`kind`](InvalidatedProjectBase.md#kind) + +*** + +### project + +> `readonly` **project**: [`ResolvedConfigFileName`](../type-aliases/ResolvedConfigFileName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5978 + +#### Inherited from + +[`InvalidatedProjectBase`](InvalidatedProjectBase.md).[`project`](InvalidatedProjectBase.md#project) + +## Methods + +### done() + +> **done**(`cancellationToken`?, `writeFile`?, `customTransformers`?): [`ExitStatus`](../enumerations/ExitStatus.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5982 + +To dispose this project and ensure that all the necessary actions are taken and state is updated accordingly + +#### Parameters + +##### cancellationToken? + +[`CancellationToken`](CancellationToken.md) + +##### writeFile? + +[`WriteFileCallback`](../type-aliases/WriteFileCallback.md) + +##### customTransformers? + +[`CustomTransformers`](CustomTransformers.md) + +#### Returns + +[`ExitStatus`](../enumerations/ExitStatus.md) + +#### Inherited from + +[`InvalidatedProjectBase`](InvalidatedProjectBase.md).[`done`](InvalidatedProjectBase.md#done) + +*** + +### emit() + +> **emit**(`writeFile`?, `customTransformers`?): `undefined` \| [`EmitResult`](EmitResult.md) \| [`BuildInvalidedProject`](BuildInvalidedProject.md)\<`T`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6007 + +#### Parameters + +##### writeFile? + +[`WriteFileCallback`](../type-aliases/WriteFileCallback.md) + +##### customTransformers? + +[`CustomTransformers`](CustomTransformers.md) + +#### Returns + +`undefined` \| [`EmitResult`](EmitResult.md) \| [`BuildInvalidedProject`](BuildInvalidedProject.md)\<`T`\> + +*** + +### getCompilerOptions() + +> **getCompilerOptions**(): [`CompilerOptions`](CompilerOptions.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5983 + +#### Returns + +[`CompilerOptions`](CompilerOptions.md) + +#### Inherited from + +[`InvalidatedProjectBase`](InvalidatedProjectBase.md).[`getCompilerOptions`](InvalidatedProjectBase.md#getcompileroptions) + +*** + +### getCurrentDirectory() + +> **getCurrentDirectory**(): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5984 + +#### Returns + +`string` + +#### Inherited from + +[`InvalidatedProjectBase`](InvalidatedProjectBase.md).[`getCurrentDirectory`](InvalidatedProjectBase.md#getcurrentdirectory) diff --git a/docs/api_docs/namespaces/ts/interfaces/UpdateExpression.md b/docs/api_docs/namespaces/ts/interfaces/UpdateExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..86c61899ea84edb2e167c800c574b7469befc461 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/UpdateExpression.md @@ -0,0 +1,515 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / UpdateExpression + +# Interface: UpdateExpression + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1070 + +## Extends + +- [`UnaryExpression`](UnaryExpression.md) + +## Extended by + +- [`PrefixUnaryExpression`](PrefixUnaryExpression.md) +- [`PostfixUnaryExpression`](PostfixUnaryExpression.md) +- [`LeftHandSideExpression`](LeftHandSideExpression.md) + +## Properties + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`_expressionBrand`](UnaryExpression.md#_expressionbrand) + +*** + +### \_unaryExpressionBrand + +> **\_unaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1066 + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`_unaryExpressionBrand`](UnaryExpression.md#_unaryexpressionbrand) + +*** + +### \_updateExpressionBrand + +> **\_updateExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1071 + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`decorators`](UnaryExpression.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`end`](UnaryExpression.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`flags`](UnaryExpression.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`SyntaxKind`](../enumerations/SyntaxKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:598 + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`kind`](UnaryExpression.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`locals`](UnaryExpression.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`modifiers`](UnaryExpression.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`parent`](UnaryExpression.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`pos`](UnaryExpression.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`skipCheck`](UnaryExpression.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`symbol`](UnaryExpression.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`forEachChild`](UnaryExpression.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getChildAt`](UnaryExpression.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getChildCount`](UnaryExpression.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getChildren`](UnaryExpression.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getEnd`](UnaryExpression.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getFirstToken`](UnaryExpression.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getFullStart`](UnaryExpression.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getFullText`](UnaryExpression.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getFullWidth`](UnaryExpression.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getLastToken`](UnaryExpression.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getLeadingTriviaWidth`](UnaryExpression.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getSourceFile`](UnaryExpression.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getStart`](UnaryExpression.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getText`](UnaryExpression.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getWidth`](UnaryExpression.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/UpdateOutputFileStampsProject.md b/docs/api_docs/namespaces/ts/interfaces/UpdateOutputFileStampsProject.md new file mode 100644 index 0000000000000000000000000000000000000000..f03802207ea823b0be3fc00aa7083bd8427f3173 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/UpdateOutputFileStampsProject.md @@ -0,0 +1,113 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / UpdateOutputFileStampsProject + +# Interface: UpdateOutputFileStampsProject + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5986 + +## Extends + +- [`InvalidatedProjectBase`](InvalidatedProjectBase.md) + +## Properties + +### kind + +> `readonly` **kind**: [`UpdateOutputFileStamps`](../enumerations/InvalidatedProjectKind.md#updateoutputfilestamps) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5987 + +#### Overrides + +[`InvalidatedProjectBase`](InvalidatedProjectBase.md).[`kind`](InvalidatedProjectBase.md#kind) + +*** + +### project + +> `readonly` **project**: [`ResolvedConfigFileName`](../type-aliases/ResolvedConfigFileName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5978 + +#### Inherited from + +[`InvalidatedProjectBase`](InvalidatedProjectBase.md).[`project`](InvalidatedProjectBase.md#project) + +## Methods + +### done() + +> **done**(`cancellationToken`?, `writeFile`?, `customTransformers`?): [`ExitStatus`](../enumerations/ExitStatus.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5982 + +To dispose this project and ensure that all the necessary actions are taken and state is updated accordingly + +#### Parameters + +##### cancellationToken? + +[`CancellationToken`](CancellationToken.md) + +##### writeFile? + +[`WriteFileCallback`](../type-aliases/WriteFileCallback.md) + +##### customTransformers? + +[`CustomTransformers`](CustomTransformers.md) + +#### Returns + +[`ExitStatus`](../enumerations/ExitStatus.md) + +#### Inherited from + +[`InvalidatedProjectBase`](InvalidatedProjectBase.md).[`done`](InvalidatedProjectBase.md#done) + +*** + +### getCompilerOptions() + +> **getCompilerOptions**(): [`CompilerOptions`](CompilerOptions.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5983 + +#### Returns + +[`CompilerOptions`](CompilerOptions.md) + +#### Inherited from + +[`InvalidatedProjectBase`](InvalidatedProjectBase.md).[`getCompilerOptions`](InvalidatedProjectBase.md#getcompileroptions) + +*** + +### getCurrentDirectory() + +> **getCurrentDirectory**(): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5984 + +#### Returns + +`string` + +#### Inherited from + +[`InvalidatedProjectBase`](InvalidatedProjectBase.md).[`getCurrentDirectory`](InvalidatedProjectBase.md#getcurrentdirectory) + +*** + +### updateOutputFileStatmps() + +> **updateOutputFileStatmps**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5988 + +#### Returns + +`void` diff --git a/docs/api_docs/namespaces/ts/interfaces/UserPreferences.md b/docs/api_docs/namespaces/ts/interfaces/UserPreferences.md new file mode 100644 index 0000000000000000000000000000000000000000..bb265436723f68a3be454c86bf0c300f391f6f51 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/UserPreferences.md @@ -0,0 +1,239 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / UserPreferences + +# Interface: UserPreferences + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4475 + +## Extended by + +- [`GetCompletionsAtPositionOptions`](GetCompletionsAtPositionOptions.md) + +## Properties + +### allowIncompleteCompletions? + +> `readonly` `optional` **allowIncompleteCompletions**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4486 + +*** + +### allowRenameOfImportPath? + +> `readonly` `optional` **allowRenameOfImportPath**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4503 + +*** + +### allowTextChangesInNewFiles? + +> `readonly` `optional` **allowTextChangesInNewFiles**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4490 + +*** + +### autoImportFileExcludePatterns? + +> `readonly` `optional` **autoImportFileExcludePatterns**: `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4504 + +*** + +### disableSuggestions? + +> `readonly` `optional` **disableSuggestions**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4476 + +*** + +### importModuleSpecifierEnding? + +> `readonly` `optional` **importModuleSpecifierEnding**: `"index"` \| `"auto"` \| `"minimal"` \| `"js"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4489 + +Determines whether we import `foo/index.ts` as "foo", "foo/index", or "foo/index.js" + +*** + +### importModuleSpecifierPreference? + +> `readonly` `optional` **importModuleSpecifierPreference**: `"shortest"` \| `"project-relative"` \| `"relative"` \| `"non-relative"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4487 + +*** + +### includeAutomaticOptionalChainCompletions? + +> `readonly` `optional` **includeAutomaticOptionalChainCompletions**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4481 + +*** + +### includeCompletionsForImportStatements? + +> `readonly` `optional` **includeCompletionsForImportStatements**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4479 + +*** + +### includeCompletionsForModuleExports? + +> `readonly` `optional` **includeCompletionsForModuleExports**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4478 + +*** + +### includeCompletionsWithClassMemberSnippets? + +> `readonly` `optional` **includeCompletionsWithClassMemberSnippets**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4483 + +*** + +### includeCompletionsWithInsertText? + +> `readonly` `optional` **includeCompletionsWithInsertText**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4482 + +*** + +### includeCompletionsWithObjectLiteralMethodSnippets? + +> `readonly` `optional` **includeCompletionsWithObjectLiteralMethodSnippets**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4484 + +*** + +### includeCompletionsWithSnippetText? + +> `readonly` `optional` **includeCompletionsWithSnippetText**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4480 + +*** + +### includeInlayEnumMemberValueHints? + +> `readonly` `optional` **includeInlayEnumMemberValueHints**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4502 + +*** + +### includeInlayFunctionLikeReturnTypeHints? + +> `readonly` `optional` **includeInlayFunctionLikeReturnTypeHints**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4501 + +*** + +### includeInlayFunctionParameterTypeHints? + +> `readonly` `optional` **includeInlayFunctionParameterTypeHints**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4497 + +*** + +### includeInlayParameterNameHints? + +> `readonly` `optional` **includeInlayParameterNameHints**: `"all"` \| `"none"` \| `"literals"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4495 + +*** + +### includeInlayParameterNameHintsWhenArgumentMatchesName? + +> `readonly` `optional` **includeInlayParameterNameHintsWhenArgumentMatchesName**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4496 + +*** + +### includeInlayPropertyDeclarationTypeHints? + +> `readonly` `optional` **includeInlayPropertyDeclarationTypeHints**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4500 + +*** + +### includeInlayVariableTypeHints? + +> `readonly` `optional` **includeInlayVariableTypeHints**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4498 + +*** + +### includeInlayVariableTypeHintsWhenTypeMatchesName? + +> `readonly` `optional` **includeInlayVariableTypeHintsWhenTypeMatchesName**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4499 + +*** + +### includePackageJsonAutoImports? + +> `readonly` `optional` **includePackageJsonAutoImports**: `"on"` \| `"off"` \| `"auto"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4492 + +*** + +### jsxAttributeCompletionStyle? + +> `readonly` `optional` **jsxAttributeCompletionStyle**: `"auto"` \| `"braces"` \| `"none"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4494 + +*** + +### providePrefixAndSuffixTextForRename? + +> `readonly` `optional` **providePrefixAndSuffixTextForRename**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4491 + +*** + +### provideRefactorNotApplicableReason? + +> `readonly` `optional` **provideRefactorNotApplicableReason**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4493 + +*** + +### quotePreference? + +> `readonly` `optional` **quotePreference**: `"auto"` \| `"double"` \| `"single"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4477 + +*** + +### useLabelDetailsInCompletionEntries? + +> `readonly` `optional` **useLabelDetailsInCompletionEntries**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4485 diff --git a/docs/api_docs/namespaces/ts/interfaces/VariableDeclaration.md b/docs/api_docs/namespaces/ts/interfaces/VariableDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..1be5bed827d14fabe6128effb382f7336a315541 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/VariableDeclaration.md @@ -0,0 +1,525 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / VariableDeclaration + +# Interface: VariableDeclaration + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:746 + +## Extends + +- [`NamedDeclaration`](NamedDeclaration.md).[`JSDocContainer`](JSDocContainer.md) + +## Properties + +### \_declarationBrand + +> **\_declarationBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:699 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`_declarationBrand`](NamedDeclaration.md#_declarationbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`decorators`](NamedDeclaration.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`end`](NamedDeclaration.md#end) + +*** + +### exclamationToken? + +> `readonly` `optional` **exclamationToken**: [`ExclamationToken`](../type-aliases/ExclamationToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:750 + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`flags`](NamedDeclaration.md#flags) + +*** + +### initializer? + +> `readonly` `optional` **initializer**: [`Expression`](Expression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:752 + +*** + +### kind + +> `readonly` **kind**: [`VariableDeclaration`](../enumerations/SyntaxKind.md#variabledeclaration) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:747 + +#### Overrides + +[`NamedDeclaration`](NamedDeclaration.md).[`kind`](NamedDeclaration.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`locals`](NamedDeclaration.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`modifiers`](NamedDeclaration.md#modifiers) + +*** + +### name + +> `readonly` **name**: [`BindingName`](../type-aliases/BindingName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:749 + +#### Overrides + +[`NamedDeclaration`](NamedDeclaration.md).[`name`](NamedDeclaration.md#name) + +*** + +### parent + +> `readonly` **parent**: [`VariableDeclarationList`](VariableDeclarationList.md) \| [`CatchClause`](CatchClause.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:748 + +#### Overrides + +[`NamedDeclaration`](NamedDeclaration.md).[`parent`](NamedDeclaration.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`pos`](NamedDeclaration.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`skipCheck`](NamedDeclaration.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`symbol`](NamedDeclaration.md#symbol) + +*** + +### type? + +> `readonly` `optional` **type**: [`TypeNode`](TypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:751 + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`forEachChild`](NamedDeclaration.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getChildAt`](NamedDeclaration.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getChildCount`](NamedDeclaration.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getChildren`](NamedDeclaration.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getEnd`](NamedDeclaration.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFirstToken`](NamedDeclaration.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFullStart`](NamedDeclaration.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFullText`](NamedDeclaration.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getFullWidth`](NamedDeclaration.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getLastToken`](NamedDeclaration.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getLeadingTriviaWidth`](NamedDeclaration.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getSourceFile`](NamedDeclaration.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getStart`](NamedDeclaration.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getText`](NamedDeclaration.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`NamedDeclaration`](NamedDeclaration.md).[`getWidth`](NamedDeclaration.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/VariableDeclarationList.md b/docs/api_docs/namespaces/ts/interfaces/VariableDeclarationList.md new file mode 100644 index 0000000000000000000000000000000000000000..510583609460a7fb5d60c26d32eebfbe137d4033 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/VariableDeclarationList.md @@ -0,0 +1,485 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / VariableDeclarationList + +# Interface: VariableDeclarationList + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:754 + +## Extends + +- [`Node`](Node.md) + +## Properties + +### declarations + +> `readonly` **declarations**: [`NodeArray`](NodeArray.md)\<[`VariableDeclaration`](VariableDeclaration.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:757 + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`decorators`](Node.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Node`](Node.md).[`end`](Node.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Node`](Node.md).[`flags`](Node.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`VariableDeclarationList`](../enumerations/SyntaxKind.md#variabledeclarationlist) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:755 + +#### Overrides + +[`Node`](Node.md).[`kind`](Node.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Node`](Node.md).[`locals`](Node.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Node`](Node.md).[`modifiers`](Node.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`VariableStatement`](VariableStatement.md) \| [`ForStatement`](ForStatement.md) \| [`ForOfStatement`](ForOfStatement.md) \| [`ForInStatement`](ForInStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:756 + +#### Overrides + +[`Node`](Node.md).[`parent`](Node.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Node`](Node.md).[`pos`](Node.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Node`](Node.md).[`skipCheck`](Node.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Node`](Node.md).[`symbol`](Node.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Node`](Node.md).[`forEachChild`](Node.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getChildAt`](Node.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getChildCount`](Node.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Node`](Node.md).[`getChildren`](Node.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getEnd`](Node.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getFirstToken`](Node.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullStart`](Node.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getFullText`](Node.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getFullWidth`](Node.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Node`](Node.md).[`getLastToken`](Node.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getLeadingTriviaWidth`](Node.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Node`](Node.md).[`getSourceFile`](Node.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getStart`](Node.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Node`](Node.md).[`getText`](Node.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Node`](Node.md).[`getWidth`](Node.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/VariableStatement.md b/docs/api_docs/namespaces/ts/interfaces/VariableStatement.md new file mode 100644 index 0000000000000000000000000000000000000000..3af81552bfaa405ac3c55ad473a8284c2c710d26 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/VariableStatement.md @@ -0,0 +1,497 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / VariableStatement + +# Interface: VariableStatement + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1498 + +## Extends + +- [`Statement`](Statement.md) + +## Properties + +### \_statementBrand + +> **\_statementBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1471 + +#### Inherited from + +[`Statement`](Statement.md).[`_statementBrand`](Statement.md#_statementbrand) + +*** + +### declarationList + +> `readonly` **declarationList**: [`VariableDeclarationList`](VariableDeclarationList.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1501 + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Statement`](Statement.md).[`decorators`](Statement.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Statement`](Statement.md).[`end`](Statement.md#end) + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Statement`](Statement.md).[`flags`](Statement.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`VariableStatement`](../enumerations/SyntaxKind.md#variablestatement) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1499 + +#### Overrides + +[`Statement`](Statement.md).[`kind`](Statement.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Statement`](Statement.md).[`locals`](Statement.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`Modifier`](../type-aliases/Modifier.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1500 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Overrides + +[`Statement`](Statement.md).[`modifiers`](Statement.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`Statement`](Statement.md).[`parent`](Statement.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Statement`](Statement.md).[`pos`](Statement.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Statement`](Statement.md).[`skipCheck`](Statement.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Statement`](Statement.md).[`symbol`](Statement.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Statement`](Statement.md).[`forEachChild`](Statement.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getChildAt`](Statement.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getChildCount`](Statement.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Statement`](Statement.md).[`getChildren`](Statement.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getEnd`](Statement.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getFirstToken`](Statement.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getFullStart`](Statement.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Statement`](Statement.md).[`getFullText`](Statement.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getFullWidth`](Statement.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getLastToken`](Statement.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getLeadingTriviaWidth`](Statement.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getSourceFile`](Statement.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getStart`](Statement.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Statement`](Statement.md).[`getText`](Statement.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getWidth`](Statement.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/VoidExpression.md b/docs/api_docs/namespaces/ts/interfaces/VoidExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..70a2851b4a45a294e1125147c4153a8cb463ca35 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/VoidExpression.md @@ -0,0 +1,509 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / VoidExpression + +# Interface: VoidExpression + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1121 + +## Extends + +- [`UnaryExpression`](UnaryExpression.md) + +## Properties + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`_expressionBrand`](UnaryExpression.md#_expressionbrand) + +*** + +### \_unaryExpressionBrand + +> **\_unaryExpressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1066 + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`_unaryExpressionBrand`](UnaryExpression.md#_unaryexpressionbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`decorators`](UnaryExpression.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`end`](UnaryExpression.md#end) + +*** + +### expression + +> `readonly` **expression**: [`UnaryExpression`](UnaryExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1123 + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`flags`](UnaryExpression.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`VoidExpression`](../enumerations/SyntaxKind.md#voidexpression) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1122 + +#### Overrides + +[`UnaryExpression`](UnaryExpression.md).[`kind`](UnaryExpression.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`locals`](UnaryExpression.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`modifiers`](UnaryExpression.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`parent`](UnaryExpression.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`pos`](UnaryExpression.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`skipCheck`](UnaryExpression.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`symbol`](UnaryExpression.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`forEachChild`](UnaryExpression.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getChildAt`](UnaryExpression.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getChildCount`](UnaryExpression.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getChildren`](UnaryExpression.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getEnd`](UnaryExpression.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getFirstToken`](UnaryExpression.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getFullStart`](UnaryExpression.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getFullText`](UnaryExpression.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getFullWidth`](UnaryExpression.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getLastToken`](UnaryExpression.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getLeadingTriviaWidth`](UnaryExpression.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getSourceFile`](UnaryExpression.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getStart`](UnaryExpression.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getText`](UnaryExpression.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`UnaryExpression`](UnaryExpression.md).[`getWidth`](UnaryExpression.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/Watch.md b/docs/api_docs/namespaces/ts/interfaces/Watch.md new file mode 100644 index 0000000000000000000000000000000000000000..0dd4af0147218aa806bd92253d8b6284603c914e --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/Watch.md @@ -0,0 +1,46 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / Watch + +# Interface: Watch\ + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5888 + +## Extended by + +- [`WatchOfConfigFile`](WatchOfConfigFile.md) +- [`WatchOfFilesAndCompilerOptions`](WatchOfFilesAndCompilerOptions.md) + +## Type Parameters + +• **T** + +## Methods + +### close() + +> **close**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5892 + +Closes the watch + +#### Returns + +`void` + +*** + +### getProgram() + +> **getProgram**(): `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5890 + +Synchronize with host and get updated program + +#### Returns + +`T` diff --git a/docs/api_docs/namespaces/ts/interfaces/WatchCompilerHost.md b/docs/api_docs/namespaces/ts/interfaces/WatchCompilerHost.md new file mode 100644 index 0000000000000000000000000000000000000000..7ccc94f08f59a45ca615ebd14dbfc7d12257a874 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/WatchCompilerHost.md @@ -0,0 +1,704 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / WatchCompilerHost + +# Interface: WatchCompilerHost\ + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5852 + +Host that has watch functionality used in --watch mode + +## Extends + +- [`ProgramHost`](ProgramHost.md)\<`T`\>.[`WatchHost`](WatchHost.md) + +## Extended by + +- [`WatchCompilerHostOfFilesAndCompilerOptions`](WatchCompilerHostOfFilesAndCompilerOptions.md) +- [`WatchCompilerHostOfConfigFile`](WatchCompilerHostOfConfigFile.md) + +## Type Parameters + +• **T** *extends* [`BuilderProgram`](BuilderProgram.md) + +## Properties + +### createProgram + +> **createProgram**: [`CreateProgram`](../type-aliases/CreateProgram.md)\<`T`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5812 + +Used to create the program when need for program creation or recreation detected + +#### Inherited from + +[`ProgramHost`](ProgramHost.md).[`createProgram`](ProgramHost.md#createprogram) + +## Methods + +### afterProgramCreate()? + +> `optional` **afterProgramCreate**(`program`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5858 + +If provided, callback to invoke after every new program creation + +#### Parameters + +##### program + +`T` + +#### Returns + +`void` + +*** + +### clearTimeout()? + +> `optional` **clearTimeout**(`timeoutId`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5806 + +If provided, will be used to reset existing delayed compilation + +#### Parameters + +##### timeoutId + +`any` + +#### Returns + +`void` + +#### Inherited from + +[`WatchHost`](WatchHost.md).[`clearTimeout`](WatchHost.md#cleartimeout) + +*** + +### createHash()? + +> `optional` **createHash**(`data`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5818 + +#### Parameters + +##### data + +`string` + +#### Returns + +`string` + +#### Inherited from + +[`ProgramHost`](ProgramHost.md).[`createHash`](ProgramHost.md#createhash) + +*** + +### directoryExists()? + +> `optional` **directoryExists**(`path`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5830 + +If provided, used for module resolution as well as to handle directory structure + +#### Parameters + +##### path + +`string` + +#### Returns + +`boolean` + +#### Inherited from + +[`ProgramHost`](ProgramHost.md).[`directoryExists`](ProgramHost.md#directoryexists) + +*** + +### fileExists() + +> **fileExists**(`path`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5823 + +Use to check file presence for source files and +if resolveModuleNames is not provided (complier is in charge of module resolution) then module files as well + +#### Parameters + +##### path + +`string` + +#### Returns + +`boolean` + +#### Inherited from + +[`ProgramHost`](ProgramHost.md).[`fileExists`](ProgramHost.md#fileexists) + +*** + +### getCurrentDirectory() + +> **getCurrentDirectory**(): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5815 + +#### Returns + +`string` + +#### Inherited from + +[`ProgramHost`](ProgramHost.md).[`getCurrentDirectory`](ProgramHost.md#getcurrentdirectory) + +*** + +### getDefaultLibFileName() + +> **getDefaultLibFileName**(`options`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5816 + +#### Parameters + +##### options + +[`CompilerOptions`](CompilerOptions.md) + +#### Returns + +`string` + +#### Inherited from + +[`ProgramHost`](ProgramHost.md).[`getDefaultLibFileName`](ProgramHost.md#getdefaultlibfilename) + +*** + +### getDefaultLibLocation()? + +> `optional` **getDefaultLibLocation**(): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5817 + +#### Returns + +`string` + +#### Inherited from + +[`ProgramHost`](ProgramHost.md).[`getDefaultLibLocation`](ProgramHost.md#getdefaultliblocation) + +*** + +### getDirectories()? + +> `optional` **getDirectories**(`path`): `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5832 + +If provided, used in resolutions as well as handling directory structure + +#### Parameters + +##### path + +`string` + +#### Returns + +`string`[] + +#### Inherited from + +[`ProgramHost`](ProgramHost.md).[`getDirectories`](ProgramHost.md#getdirectories) + +*** + +### getEnvironmentVariable()? + +> `optional` **getEnvironmentVariable**(`name`): `undefined` \| `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5840 + +If provided is used to get the environment variable + +#### Parameters + +##### name + +`string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[`ProgramHost`](ProgramHost.md).[`getEnvironmentVariable`](ProgramHost.md#getenvironmentvariable) + +*** + +### getModuleResolutionCache()? + +> `optional` **getModuleResolutionCache**(): `undefined` \| [`ModuleResolutionCache`](ModuleResolutionCache.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5850 + +Returns the module resolution cache used by a provided `resolveModuleNames` implementation so that any non-name module resolution operations (eg, package.json lookup) can reuse it + +#### Returns + +`undefined` \| [`ModuleResolutionCache`](ModuleResolutionCache.md) + +#### Inherited from + +[`ProgramHost`](ProgramHost.md).[`getModuleResolutionCache`](ProgramHost.md#getmoduleresolutioncache) + +*** + +### getNewLine() + +> **getNewLine**(): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5814 + +#### Returns + +`string` + +#### Inherited from + +[`ProgramHost`](ProgramHost.md).[`getNewLine`](ProgramHost.md#getnewline) + +*** + +### getParsedCommandLine()? + +> `optional` **getParsedCommandLine**(`fileName`): `undefined` \| [`ParsedCommandLine`](ParsedCommandLine.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5856 + +If provided, use this method to get parsed command lines for referenced projects + +#### Parameters + +##### fileName + +`string` + +#### Returns + +`undefined` \| [`ParsedCommandLine`](ParsedCommandLine.md) + +*** + +### hasInvalidatedResolutions()? + +> `optional` **hasInvalidatedResolutions**(`filePath`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5846 + +If provided along with custom resolveModuleNames or resolveTypeReferenceDirectives, used to determine if unchanged file path needs to re-resolve modules/type reference directives + +#### Parameters + +##### filePath + +[`Path`](../type-aliases/Path.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`ProgramHost`](ProgramHost.md).[`hasInvalidatedResolutions`](ProgramHost.md#hasinvalidatedresolutions) + +*** + +### onWatchStatusChange()? + +> `optional` **onWatchStatusChange**(`diagnostic`, `newLine`, `options`, `errorCount`?): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5798 + +If provided, called with Diagnostic message that informs about change in watch status + +#### Parameters + +##### diagnostic + +[`Diagnostic`](Diagnostic.md) + +##### newLine + +`string` + +##### options + +[`CompilerOptions`](CompilerOptions.md) + +##### errorCount? + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`WatchHost`](WatchHost.md).[`onWatchStatusChange`](WatchHost.md#onwatchstatuschange) + +*** + +### readDirectory()? + +> `optional` **readDirectory**(`path`, `extensions`?, `exclude`?, `include`?, `depth`?): `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5834 + +If provided, used to cache and handle directory structure modifications + +#### Parameters + +##### path + +`string` + +##### extensions? + +readonly `string`[] + +##### exclude? + +readonly `string`[] + +##### include? + +readonly `string`[] + +##### depth? + +`number` + +#### Returns + +`string`[] + +#### Inherited from + +[`ProgramHost`](ProgramHost.md).[`readDirectory`](ProgramHost.md#readdirectory) + +*** + +### readFile() + +> **readFile**(`path`, `encoding`?): `undefined` \| `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5828 + +Use to read file text for source files and +if resolveModuleNames is not provided (complier is in charge of module resolution) then module files as well + +#### Parameters + +##### path + +`string` + +##### encoding? + +`string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[`ProgramHost`](ProgramHost.md).[`readFile`](ProgramHost.md#readfile) + +*** + +### realpath()? + +> `optional` **realpath**(`path`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5836 + +Symbol links resolution + +#### Parameters + +##### path + +`string` + +#### Returns + +`string` + +#### Inherited from + +[`ProgramHost`](ProgramHost.md).[`realpath`](ProgramHost.md#realpath) + +*** + +### resolveModuleNames()? + +> `optional` **resolveModuleNames**(`moduleNames`, `containingFile`, `reusedNames`, `redirectedReference`, `options`, `containingSourceFile`?): (`undefined` \| [`ResolvedModule`](ResolvedModule.md))[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5842 + +If provided, used to resolve the module names, otherwise typescript's default module resolution + +#### Parameters + +##### moduleNames + +`string`[] + +##### containingFile + +`string` + +##### reusedNames + +`undefined` | `string`[] + +##### redirectedReference + +`undefined` | [`ResolvedProjectReference`](ResolvedProjectReference.md) + +##### options + +[`CompilerOptions`](CompilerOptions.md) + +##### containingSourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +(`undefined` \| [`ResolvedModule`](ResolvedModule.md))[] + +#### Inherited from + +[`ProgramHost`](ProgramHost.md).[`resolveModuleNames`](ProgramHost.md#resolvemodulenames) + +*** + +### resolveTypeReferenceDirectives()? + +> `optional` **resolveTypeReferenceDirectives**(`typeReferenceDirectiveNames`, `containingFile`, `redirectedReference`, `options`, `containingFileMode`?): (`undefined` \| [`ResolvedTypeReferenceDirective`](ResolvedTypeReferenceDirective.md))[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5844 + +If provided, used to resolve type reference directives, otherwise typescript's default resolution + +#### Parameters + +##### typeReferenceDirectiveNames + +`string`[] | readonly [`FileReference`](FileReference.md)[] + +##### containingFile + +`string` + +##### redirectedReference + +`undefined` | [`ResolvedProjectReference`](ResolvedProjectReference.md) + +##### options + +[`CompilerOptions`](CompilerOptions.md) + +##### containingFileMode? + +[`CommonJS`](../enumerations/ModuleKind.md#commonjs) | [`ESNext`](../enumerations/ModuleKind.md#esnext) + +#### Returns + +(`undefined` \| [`ResolvedTypeReferenceDirective`](ResolvedTypeReferenceDirective.md))[] + +#### Inherited from + +[`ProgramHost`](ProgramHost.md).[`resolveTypeReferenceDirectives`](ProgramHost.md#resolvetypereferencedirectives) + +*** + +### setTimeout()? + +> `optional` **setTimeout**(`callback`, `ms`, ...`args`): `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5804 + +If provided, will be used to set delayed compilation, so that multiple changes in short span are compiled together + +#### Parameters + +##### callback + +(...`args`) => `void` + +##### ms + +`number` + +##### args + +...`any`[] + +#### Returns + +`any` + +#### Inherited from + +[`WatchHost`](WatchHost.md).[`setTimeout`](WatchHost.md#settimeout) + +*** + +### trace()? + +> `optional` **trace**(`s`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5838 + +If provided would be used to write log about compilation + +#### Parameters + +##### s + +`string` + +#### Returns + +`void` + +#### Inherited from + +[`ProgramHost`](ProgramHost.md).[`trace`](ProgramHost.md#trace) + +*** + +### useCaseSensitiveFileNames() + +> **useCaseSensitiveFileNames**(): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5813 + +#### Returns + +`boolean` + +#### Inherited from + +[`ProgramHost`](ProgramHost.md).[`useCaseSensitiveFileNames`](ProgramHost.md#usecasesensitivefilenames) + +*** + +### useSourceOfProjectReferenceRedirect()? + +> `optional` **useSourceOfProjectReferenceRedirect**(): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5854 + +Instead of using output d.ts file from project reference, use its source file + +#### Returns + +`boolean` + +*** + +### watchDirectory() + +> **watchDirectory**(`path`, `callback`, `recursive`?, `options`?): [`FileWatcher`](FileWatcher.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5802 + +Used to watch resolved module's failed lookup locations, config file specs, type roots where auto type reference directives are added + +#### Parameters + +##### path + +`string` + +##### callback + +[`DirectoryWatcherCallback`](../type-aliases/DirectoryWatcherCallback.md) + +##### recursive? + +`boolean` + +##### options? + +[`WatchOptions`](WatchOptions.md) + +#### Returns + +[`FileWatcher`](FileWatcher.md) + +#### Inherited from + +[`WatchHost`](WatchHost.md).[`watchDirectory`](WatchHost.md#watchdirectory) + +*** + +### watchFile() + +> **watchFile**(`path`, `callback`, `pollingInterval`?, `options`?): [`FileWatcher`](FileWatcher.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5800 + +Used to watch changes in source files, missing files needed to update the program or config file + +#### Parameters + +##### path + +`string` + +##### callback + +[`FileWatcherCallback`](../type-aliases/FileWatcherCallback.md) + +##### pollingInterval? + +`number` + +##### options? + +[`WatchOptions`](WatchOptions.md) + +#### Returns + +[`FileWatcher`](FileWatcher.md) + +#### Inherited from + +[`WatchHost`](WatchHost.md).[`watchFile`](WatchHost.md#watchfile) diff --git a/docs/api_docs/namespaces/ts/interfaces/WatchCompilerHostOfConfigFile.md b/docs/api_docs/namespaces/ts/interfaces/WatchCompilerHostOfConfigFile.md new file mode 100644 index 0000000000000000000000000000000000000000..74189c72a3719fb3735055a576cc81dd3c029c75 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/WatchCompilerHostOfConfigFile.md @@ -0,0 +1,762 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / WatchCompilerHostOfConfigFile + +# Interface: WatchCompilerHostOfConfigFile\ + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5875 + +Host to create watch with config file + +## Extends + +- [`WatchCompilerHost`](WatchCompilerHost.md)\<`T`\>.[`ConfigFileDiagnosticsReporter`](ConfigFileDiagnosticsReporter.md) + +## Type Parameters + +• **T** *extends* [`BuilderProgram`](BuilderProgram.md) + +## Properties + +### configFileName + +> **configFileName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5877 + +Name of the config file to compile + +*** + +### createProgram + +> **createProgram**: [`CreateProgram`](../type-aliases/CreateProgram.md)\<`T`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5812 + +Used to create the program when need for program creation or recreation detected + +#### Inherited from + +[`WatchCompilerHost`](WatchCompilerHost.md).[`createProgram`](WatchCompilerHost.md#createprogram) + +*** + +### extraFileExtensions? + +> `optional` **extraFileExtensions**: readonly [`FileExtensionInfo`](FileExtensionInfo.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5881 + +*** + +### onUnRecoverableConfigFileDiagnostic + +> **onUnRecoverableConfigFileDiagnostic**: [`DiagnosticReporter`](../type-aliases/DiagnosticReporter.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5267 + +Reports unrecoverable error when parsing config file + +#### Inherited from + +[`ConfigFileDiagnosticsReporter`](ConfigFileDiagnosticsReporter.md).[`onUnRecoverableConfigFileDiagnostic`](ConfigFileDiagnosticsReporter.md#onunrecoverableconfigfilediagnostic) + +*** + +### optionsToExtend? + +> `optional` **optionsToExtend**: [`CompilerOptions`](CompilerOptions.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5879 + +Options to extend + +*** + +### watchOptionsToExtend? + +> `optional` **watchOptionsToExtend**: [`WatchOptions`](WatchOptions.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5880 + +## Methods + +### afterProgramCreate()? + +> `optional` **afterProgramCreate**(`program`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5858 + +If provided, callback to invoke after every new program creation + +#### Parameters + +##### program + +`T` + +#### Returns + +`void` + +#### Inherited from + +[`WatchCompilerHost`](WatchCompilerHost.md).[`afterProgramCreate`](WatchCompilerHost.md#afterprogramcreate) + +*** + +### clearTimeout()? + +> `optional` **clearTimeout**(`timeoutId`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5806 + +If provided, will be used to reset existing delayed compilation + +#### Parameters + +##### timeoutId + +`any` + +#### Returns + +`void` + +#### Inherited from + +[`WatchCompilerHost`](WatchCompilerHost.md).[`clearTimeout`](WatchCompilerHost.md#cleartimeout) + +*** + +### createHash()? + +> `optional` **createHash**(`data`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5818 + +#### Parameters + +##### data + +`string` + +#### Returns + +`string` + +#### Inherited from + +[`WatchCompilerHost`](WatchCompilerHost.md).[`createHash`](WatchCompilerHost.md#createhash) + +*** + +### directoryExists()? + +> `optional` **directoryExists**(`path`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5830 + +If provided, used for module resolution as well as to handle directory structure + +#### Parameters + +##### path + +`string` + +#### Returns + +`boolean` + +#### Inherited from + +[`WatchCompilerHost`](WatchCompilerHost.md).[`directoryExists`](WatchCompilerHost.md#directoryexists) + +*** + +### fileExists() + +> **fileExists**(`path`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5823 + +Use to check file presence for source files and +if resolveModuleNames is not provided (complier is in charge of module resolution) then module files as well + +#### Parameters + +##### path + +`string` + +#### Returns + +`boolean` + +#### Inherited from + +[`WatchCompilerHost`](WatchCompilerHost.md).[`fileExists`](WatchCompilerHost.md#fileexists) + +*** + +### getCurrentDirectory() + +> **getCurrentDirectory**(): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5815 + +#### Returns + +`string` + +#### Inherited from + +[`WatchCompilerHost`](WatchCompilerHost.md).[`getCurrentDirectory`](WatchCompilerHost.md#getcurrentdirectory) + +*** + +### getDefaultLibFileName() + +> **getDefaultLibFileName**(`options`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5816 + +#### Parameters + +##### options + +[`CompilerOptions`](CompilerOptions.md) + +#### Returns + +`string` + +#### Inherited from + +[`WatchCompilerHost`](WatchCompilerHost.md).[`getDefaultLibFileName`](WatchCompilerHost.md#getdefaultlibfilename) + +*** + +### getDefaultLibLocation()? + +> `optional` **getDefaultLibLocation**(): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5817 + +#### Returns + +`string` + +#### Inherited from + +[`WatchCompilerHost`](WatchCompilerHost.md).[`getDefaultLibLocation`](WatchCompilerHost.md#getdefaultliblocation) + +*** + +### getDirectories()? + +> `optional` **getDirectories**(`path`): `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5832 + +If provided, used in resolutions as well as handling directory structure + +#### Parameters + +##### path + +`string` + +#### Returns + +`string`[] + +#### Inherited from + +[`WatchCompilerHost`](WatchCompilerHost.md).[`getDirectories`](WatchCompilerHost.md#getdirectories) + +*** + +### getEnvironmentVariable()? + +> `optional` **getEnvironmentVariable**(`name`): `undefined` \| `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5840 + +If provided is used to get the environment variable + +#### Parameters + +##### name + +`string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[`WatchCompilerHost`](WatchCompilerHost.md).[`getEnvironmentVariable`](WatchCompilerHost.md#getenvironmentvariable) + +*** + +### getModuleResolutionCache()? + +> `optional` **getModuleResolutionCache**(): `undefined` \| [`ModuleResolutionCache`](ModuleResolutionCache.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5850 + +Returns the module resolution cache used by a provided `resolveModuleNames` implementation so that any non-name module resolution operations (eg, package.json lookup) can reuse it + +#### Returns + +`undefined` \| [`ModuleResolutionCache`](ModuleResolutionCache.md) + +#### Inherited from + +[`WatchCompilerHost`](WatchCompilerHost.md).[`getModuleResolutionCache`](WatchCompilerHost.md#getmoduleresolutioncache) + +*** + +### getNewLine() + +> **getNewLine**(): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5814 + +#### Returns + +`string` + +#### Inherited from + +[`WatchCompilerHost`](WatchCompilerHost.md).[`getNewLine`](WatchCompilerHost.md#getnewline) + +*** + +### getParsedCommandLine()? + +> `optional` **getParsedCommandLine**(`fileName`): `undefined` \| [`ParsedCommandLine`](ParsedCommandLine.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5856 + +If provided, use this method to get parsed command lines for referenced projects + +#### Parameters + +##### fileName + +`string` + +#### Returns + +`undefined` \| [`ParsedCommandLine`](ParsedCommandLine.md) + +#### Inherited from + +[`WatchCompilerHost`](WatchCompilerHost.md).[`getParsedCommandLine`](WatchCompilerHost.md#getparsedcommandline) + +*** + +### hasInvalidatedResolutions()? + +> `optional` **hasInvalidatedResolutions**(`filePath`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5846 + +If provided along with custom resolveModuleNames or resolveTypeReferenceDirectives, used to determine if unchanged file path needs to re-resolve modules/type reference directives + +#### Parameters + +##### filePath + +[`Path`](../type-aliases/Path.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`WatchCompilerHost`](WatchCompilerHost.md).[`hasInvalidatedResolutions`](WatchCompilerHost.md#hasinvalidatedresolutions) + +*** + +### onWatchStatusChange()? + +> `optional` **onWatchStatusChange**(`diagnostic`, `newLine`, `options`, `errorCount`?): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5798 + +If provided, called with Diagnostic message that informs about change in watch status + +#### Parameters + +##### diagnostic + +[`Diagnostic`](Diagnostic.md) + +##### newLine + +`string` + +##### options + +[`CompilerOptions`](CompilerOptions.md) + +##### errorCount? + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`WatchCompilerHost`](WatchCompilerHost.md).[`onWatchStatusChange`](WatchCompilerHost.md#onwatchstatuschange) + +*** + +### readDirectory() + +> **readDirectory**(`path`, `extensions`?, `exclude`?, `include`?, `depth`?): `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5886 + +Used to generate source file names from the config file and its include, exclude, files rules +and also to cache the directory stucture + +#### Parameters + +##### path + +`string` + +##### extensions? + +readonly `string`[] + +##### exclude? + +readonly `string`[] + +##### include? + +readonly `string`[] + +##### depth? + +`number` + +#### Returns + +`string`[] + +#### Overrides + +[`WatchCompilerHost`](WatchCompilerHost.md).[`readDirectory`](WatchCompilerHost.md#readdirectory) + +*** + +### readFile() + +> **readFile**(`path`, `encoding`?): `undefined` \| `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5828 + +Use to read file text for source files and +if resolveModuleNames is not provided (complier is in charge of module resolution) then module files as well + +#### Parameters + +##### path + +`string` + +##### encoding? + +`string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[`WatchCompilerHost`](WatchCompilerHost.md).[`readFile`](WatchCompilerHost.md#readfile) + +*** + +### realpath()? + +> `optional` **realpath**(`path`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5836 + +Symbol links resolution + +#### Parameters + +##### path + +`string` + +#### Returns + +`string` + +#### Inherited from + +[`WatchCompilerHost`](WatchCompilerHost.md).[`realpath`](WatchCompilerHost.md#realpath) + +*** + +### resolveModuleNames()? + +> `optional` **resolveModuleNames**(`moduleNames`, `containingFile`, `reusedNames`, `redirectedReference`, `options`, `containingSourceFile`?): (`undefined` \| [`ResolvedModule`](ResolvedModule.md))[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5842 + +If provided, used to resolve the module names, otherwise typescript's default module resolution + +#### Parameters + +##### moduleNames + +`string`[] + +##### containingFile + +`string` + +##### reusedNames + +`undefined` | `string`[] + +##### redirectedReference + +`undefined` | [`ResolvedProjectReference`](ResolvedProjectReference.md) + +##### options + +[`CompilerOptions`](CompilerOptions.md) + +##### containingSourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +(`undefined` \| [`ResolvedModule`](ResolvedModule.md))[] + +#### Inherited from + +[`WatchCompilerHost`](WatchCompilerHost.md).[`resolveModuleNames`](WatchCompilerHost.md#resolvemodulenames) + +*** + +### resolveTypeReferenceDirectives()? + +> `optional` **resolveTypeReferenceDirectives**(`typeReferenceDirectiveNames`, `containingFile`, `redirectedReference`, `options`, `containingFileMode`?): (`undefined` \| [`ResolvedTypeReferenceDirective`](ResolvedTypeReferenceDirective.md))[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5844 + +If provided, used to resolve type reference directives, otherwise typescript's default resolution + +#### Parameters + +##### typeReferenceDirectiveNames + +`string`[] | readonly [`FileReference`](FileReference.md)[] + +##### containingFile + +`string` + +##### redirectedReference + +`undefined` | [`ResolvedProjectReference`](ResolvedProjectReference.md) + +##### options + +[`CompilerOptions`](CompilerOptions.md) + +##### containingFileMode? + +[`CommonJS`](../enumerations/ModuleKind.md#commonjs) | [`ESNext`](../enumerations/ModuleKind.md#esnext) + +#### Returns + +(`undefined` \| [`ResolvedTypeReferenceDirective`](ResolvedTypeReferenceDirective.md))[] + +#### Inherited from + +[`WatchCompilerHost`](WatchCompilerHost.md).[`resolveTypeReferenceDirectives`](WatchCompilerHost.md#resolvetypereferencedirectives) + +*** + +### setTimeout()? + +> `optional` **setTimeout**(`callback`, `ms`, ...`args`): `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5804 + +If provided, will be used to set delayed compilation, so that multiple changes in short span are compiled together + +#### Parameters + +##### callback + +(...`args`) => `void` + +##### ms + +`number` + +##### args + +...`any`[] + +#### Returns + +`any` + +#### Inherited from + +[`WatchCompilerHost`](WatchCompilerHost.md).[`setTimeout`](WatchCompilerHost.md#settimeout) + +*** + +### trace()? + +> `optional` **trace**(`s`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5838 + +If provided would be used to write log about compilation + +#### Parameters + +##### s + +`string` + +#### Returns + +`void` + +#### Inherited from + +[`WatchCompilerHost`](WatchCompilerHost.md).[`trace`](WatchCompilerHost.md#trace) + +*** + +### useCaseSensitiveFileNames() + +> **useCaseSensitiveFileNames**(): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5813 + +#### Returns + +`boolean` + +#### Inherited from + +[`WatchCompilerHost`](WatchCompilerHost.md).[`useCaseSensitiveFileNames`](WatchCompilerHost.md#usecasesensitivefilenames) + +*** + +### useSourceOfProjectReferenceRedirect()? + +> `optional` **useSourceOfProjectReferenceRedirect**(): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5854 + +Instead of using output d.ts file from project reference, use its source file + +#### Returns + +`boolean` + +#### Inherited from + +[`WatchCompilerHost`](WatchCompilerHost.md).[`useSourceOfProjectReferenceRedirect`](WatchCompilerHost.md#usesourceofprojectreferenceredirect) + +*** + +### watchDirectory() + +> **watchDirectory**(`path`, `callback`, `recursive`?, `options`?): [`FileWatcher`](FileWatcher.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5802 + +Used to watch resolved module's failed lookup locations, config file specs, type roots where auto type reference directives are added + +#### Parameters + +##### path + +`string` + +##### callback + +[`DirectoryWatcherCallback`](../type-aliases/DirectoryWatcherCallback.md) + +##### recursive? + +`boolean` + +##### options? + +[`WatchOptions`](WatchOptions.md) + +#### Returns + +[`FileWatcher`](FileWatcher.md) + +#### Inherited from + +[`WatchCompilerHost`](WatchCompilerHost.md).[`watchDirectory`](WatchCompilerHost.md#watchdirectory) + +*** + +### watchFile() + +> **watchFile**(`path`, `callback`, `pollingInterval`?, `options`?): [`FileWatcher`](FileWatcher.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5800 + +Used to watch changes in source files, missing files needed to update the program or config file + +#### Parameters + +##### path + +`string` + +##### callback + +[`FileWatcherCallback`](../type-aliases/FileWatcherCallback.md) + +##### pollingInterval? + +`number` + +##### options? + +[`WatchOptions`](WatchOptions.md) + +#### Returns + +[`FileWatcher`](FileWatcher.md) + +#### Inherited from + +[`WatchCompilerHost`](WatchCompilerHost.md).[`watchFile`](WatchCompilerHost.md#watchfile) diff --git a/docs/api_docs/namespaces/ts/interfaces/WatchCompilerHostOfFilesAndCompilerOptions.md b/docs/api_docs/namespaces/ts/interfaces/WatchCompilerHostOfFilesAndCompilerOptions.md new file mode 100644 index 0000000000000000000000000000000000000000..13d84e6b63bfeec248bae55509b1998d5b55af7c --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/WatchCompilerHostOfFilesAndCompilerOptions.md @@ -0,0 +1,749 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / WatchCompilerHostOfFilesAndCompilerOptions + +# Interface: WatchCompilerHostOfFilesAndCompilerOptions\ + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5863 + +Host to create watch with root files and options + +## Extends + +- [`WatchCompilerHost`](WatchCompilerHost.md)\<`T`\> + +## Type Parameters + +• **T** *extends* [`BuilderProgram`](BuilderProgram.md) + +## Properties + +### createProgram + +> **createProgram**: [`CreateProgram`](../type-aliases/CreateProgram.md)\<`T`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5812 + +Used to create the program when need for program creation or recreation detected + +#### Inherited from + +[`WatchCompilerHost`](WatchCompilerHost.md).[`createProgram`](WatchCompilerHost.md#createprogram) + +*** + +### options + +> **options**: [`CompilerOptions`](CompilerOptions.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5867 + +Compiler options + +*** + +### projectReferences? + +> `optional` **projectReferences**: readonly [`ProjectReference`](ProjectReference.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5870 + +Project References + +*** + +### rootFiles + +> **rootFiles**: `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5865 + +root files to use to generate program + +*** + +### watchOptions? + +> `optional` **watchOptions**: [`WatchOptions`](WatchOptions.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5868 + +## Methods + +### afterProgramCreate()? + +> `optional` **afterProgramCreate**(`program`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5858 + +If provided, callback to invoke after every new program creation + +#### Parameters + +##### program + +`T` + +#### Returns + +`void` + +#### Inherited from + +[`WatchCompilerHost`](WatchCompilerHost.md).[`afterProgramCreate`](WatchCompilerHost.md#afterprogramcreate) + +*** + +### clearTimeout()? + +> `optional` **clearTimeout**(`timeoutId`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5806 + +If provided, will be used to reset existing delayed compilation + +#### Parameters + +##### timeoutId + +`any` + +#### Returns + +`void` + +#### Inherited from + +[`WatchCompilerHost`](WatchCompilerHost.md).[`clearTimeout`](WatchCompilerHost.md#cleartimeout) + +*** + +### createHash()? + +> `optional` **createHash**(`data`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5818 + +#### Parameters + +##### data + +`string` + +#### Returns + +`string` + +#### Inherited from + +[`WatchCompilerHost`](WatchCompilerHost.md).[`createHash`](WatchCompilerHost.md#createhash) + +*** + +### directoryExists()? + +> `optional` **directoryExists**(`path`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5830 + +If provided, used for module resolution as well as to handle directory structure + +#### Parameters + +##### path + +`string` + +#### Returns + +`boolean` + +#### Inherited from + +[`WatchCompilerHost`](WatchCompilerHost.md).[`directoryExists`](WatchCompilerHost.md#directoryexists) + +*** + +### fileExists() + +> **fileExists**(`path`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5823 + +Use to check file presence for source files and +if resolveModuleNames is not provided (complier is in charge of module resolution) then module files as well + +#### Parameters + +##### path + +`string` + +#### Returns + +`boolean` + +#### Inherited from + +[`WatchCompilerHost`](WatchCompilerHost.md).[`fileExists`](WatchCompilerHost.md#fileexists) + +*** + +### getCurrentDirectory() + +> **getCurrentDirectory**(): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5815 + +#### Returns + +`string` + +#### Inherited from + +[`WatchCompilerHost`](WatchCompilerHost.md).[`getCurrentDirectory`](WatchCompilerHost.md#getcurrentdirectory) + +*** + +### getDefaultLibFileName() + +> **getDefaultLibFileName**(`options`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5816 + +#### Parameters + +##### options + +[`CompilerOptions`](CompilerOptions.md) + +#### Returns + +`string` + +#### Inherited from + +[`WatchCompilerHost`](WatchCompilerHost.md).[`getDefaultLibFileName`](WatchCompilerHost.md#getdefaultlibfilename) + +*** + +### getDefaultLibLocation()? + +> `optional` **getDefaultLibLocation**(): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5817 + +#### Returns + +`string` + +#### Inherited from + +[`WatchCompilerHost`](WatchCompilerHost.md).[`getDefaultLibLocation`](WatchCompilerHost.md#getdefaultliblocation) + +*** + +### getDirectories()? + +> `optional` **getDirectories**(`path`): `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5832 + +If provided, used in resolutions as well as handling directory structure + +#### Parameters + +##### path + +`string` + +#### Returns + +`string`[] + +#### Inherited from + +[`WatchCompilerHost`](WatchCompilerHost.md).[`getDirectories`](WatchCompilerHost.md#getdirectories) + +*** + +### getEnvironmentVariable()? + +> `optional` **getEnvironmentVariable**(`name`): `undefined` \| `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5840 + +If provided is used to get the environment variable + +#### Parameters + +##### name + +`string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[`WatchCompilerHost`](WatchCompilerHost.md).[`getEnvironmentVariable`](WatchCompilerHost.md#getenvironmentvariable) + +*** + +### getModuleResolutionCache()? + +> `optional` **getModuleResolutionCache**(): `undefined` \| [`ModuleResolutionCache`](ModuleResolutionCache.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5850 + +Returns the module resolution cache used by a provided `resolveModuleNames` implementation so that any non-name module resolution operations (eg, package.json lookup) can reuse it + +#### Returns + +`undefined` \| [`ModuleResolutionCache`](ModuleResolutionCache.md) + +#### Inherited from + +[`WatchCompilerHost`](WatchCompilerHost.md).[`getModuleResolutionCache`](WatchCompilerHost.md#getmoduleresolutioncache) + +*** + +### getNewLine() + +> **getNewLine**(): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5814 + +#### Returns + +`string` + +#### Inherited from + +[`WatchCompilerHost`](WatchCompilerHost.md).[`getNewLine`](WatchCompilerHost.md#getnewline) + +*** + +### getParsedCommandLine()? + +> `optional` **getParsedCommandLine**(`fileName`): `undefined` \| [`ParsedCommandLine`](ParsedCommandLine.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5856 + +If provided, use this method to get parsed command lines for referenced projects + +#### Parameters + +##### fileName + +`string` + +#### Returns + +`undefined` \| [`ParsedCommandLine`](ParsedCommandLine.md) + +#### Inherited from + +[`WatchCompilerHost`](WatchCompilerHost.md).[`getParsedCommandLine`](WatchCompilerHost.md#getparsedcommandline) + +*** + +### hasInvalidatedResolutions()? + +> `optional` **hasInvalidatedResolutions**(`filePath`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5846 + +If provided along with custom resolveModuleNames or resolveTypeReferenceDirectives, used to determine if unchanged file path needs to re-resolve modules/type reference directives + +#### Parameters + +##### filePath + +[`Path`](../type-aliases/Path.md) + +#### Returns + +`boolean` + +#### Inherited from + +[`WatchCompilerHost`](WatchCompilerHost.md).[`hasInvalidatedResolutions`](WatchCompilerHost.md#hasinvalidatedresolutions) + +*** + +### onWatchStatusChange()? + +> `optional` **onWatchStatusChange**(`diagnostic`, `newLine`, `options`, `errorCount`?): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5798 + +If provided, called with Diagnostic message that informs about change in watch status + +#### Parameters + +##### diagnostic + +[`Diagnostic`](Diagnostic.md) + +##### newLine + +`string` + +##### options + +[`CompilerOptions`](CompilerOptions.md) + +##### errorCount? + +`number` + +#### Returns + +`void` + +#### Inherited from + +[`WatchCompilerHost`](WatchCompilerHost.md).[`onWatchStatusChange`](WatchCompilerHost.md#onwatchstatuschange) + +*** + +### readDirectory()? + +> `optional` **readDirectory**(`path`, `extensions`?, `exclude`?, `include`?, `depth`?): `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5834 + +If provided, used to cache and handle directory structure modifications + +#### Parameters + +##### path + +`string` + +##### extensions? + +readonly `string`[] + +##### exclude? + +readonly `string`[] + +##### include? + +readonly `string`[] + +##### depth? + +`number` + +#### Returns + +`string`[] + +#### Inherited from + +[`WatchCompilerHost`](WatchCompilerHost.md).[`readDirectory`](WatchCompilerHost.md#readdirectory) + +*** + +### readFile() + +> **readFile**(`path`, `encoding`?): `undefined` \| `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5828 + +Use to read file text for source files and +if resolveModuleNames is not provided (complier is in charge of module resolution) then module files as well + +#### Parameters + +##### path + +`string` + +##### encoding? + +`string` + +#### Returns + +`undefined` \| `string` + +#### Inherited from + +[`WatchCompilerHost`](WatchCompilerHost.md).[`readFile`](WatchCompilerHost.md#readfile) + +*** + +### realpath()? + +> `optional` **realpath**(`path`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5836 + +Symbol links resolution + +#### Parameters + +##### path + +`string` + +#### Returns + +`string` + +#### Inherited from + +[`WatchCompilerHost`](WatchCompilerHost.md).[`realpath`](WatchCompilerHost.md#realpath) + +*** + +### resolveModuleNames()? + +> `optional` **resolveModuleNames**(`moduleNames`, `containingFile`, `reusedNames`, `redirectedReference`, `options`, `containingSourceFile`?): (`undefined` \| [`ResolvedModule`](ResolvedModule.md))[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5842 + +If provided, used to resolve the module names, otherwise typescript's default module resolution + +#### Parameters + +##### moduleNames + +`string`[] + +##### containingFile + +`string` + +##### reusedNames + +`undefined` | `string`[] + +##### redirectedReference + +`undefined` | [`ResolvedProjectReference`](ResolvedProjectReference.md) + +##### options + +[`CompilerOptions`](CompilerOptions.md) + +##### containingSourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +(`undefined` \| [`ResolvedModule`](ResolvedModule.md))[] + +#### Inherited from + +[`WatchCompilerHost`](WatchCompilerHost.md).[`resolveModuleNames`](WatchCompilerHost.md#resolvemodulenames) + +*** + +### resolveTypeReferenceDirectives()? + +> `optional` **resolveTypeReferenceDirectives**(`typeReferenceDirectiveNames`, `containingFile`, `redirectedReference`, `options`, `containingFileMode`?): (`undefined` \| [`ResolvedTypeReferenceDirective`](ResolvedTypeReferenceDirective.md))[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5844 + +If provided, used to resolve type reference directives, otherwise typescript's default resolution + +#### Parameters + +##### typeReferenceDirectiveNames + +`string`[] | readonly [`FileReference`](FileReference.md)[] + +##### containingFile + +`string` + +##### redirectedReference + +`undefined` | [`ResolvedProjectReference`](ResolvedProjectReference.md) + +##### options + +[`CompilerOptions`](CompilerOptions.md) + +##### containingFileMode? + +[`CommonJS`](../enumerations/ModuleKind.md#commonjs) | [`ESNext`](../enumerations/ModuleKind.md#esnext) + +#### Returns + +(`undefined` \| [`ResolvedTypeReferenceDirective`](ResolvedTypeReferenceDirective.md))[] + +#### Inherited from + +[`WatchCompilerHost`](WatchCompilerHost.md).[`resolveTypeReferenceDirectives`](WatchCompilerHost.md#resolvetypereferencedirectives) + +*** + +### setTimeout()? + +> `optional` **setTimeout**(`callback`, `ms`, ...`args`): `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5804 + +If provided, will be used to set delayed compilation, so that multiple changes in short span are compiled together + +#### Parameters + +##### callback + +(...`args`) => `void` + +##### ms + +`number` + +##### args + +...`any`[] + +#### Returns + +`any` + +#### Inherited from + +[`WatchCompilerHost`](WatchCompilerHost.md).[`setTimeout`](WatchCompilerHost.md#settimeout) + +*** + +### trace()? + +> `optional` **trace**(`s`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5838 + +If provided would be used to write log about compilation + +#### Parameters + +##### s + +`string` + +#### Returns + +`void` + +#### Inherited from + +[`WatchCompilerHost`](WatchCompilerHost.md).[`trace`](WatchCompilerHost.md#trace) + +*** + +### useCaseSensitiveFileNames() + +> **useCaseSensitiveFileNames**(): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5813 + +#### Returns + +`boolean` + +#### Inherited from + +[`WatchCompilerHost`](WatchCompilerHost.md).[`useCaseSensitiveFileNames`](WatchCompilerHost.md#usecasesensitivefilenames) + +*** + +### useSourceOfProjectReferenceRedirect()? + +> `optional` **useSourceOfProjectReferenceRedirect**(): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5854 + +Instead of using output d.ts file from project reference, use its source file + +#### Returns + +`boolean` + +#### Inherited from + +[`WatchCompilerHost`](WatchCompilerHost.md).[`useSourceOfProjectReferenceRedirect`](WatchCompilerHost.md#usesourceofprojectreferenceredirect) + +*** + +### watchDirectory() + +> **watchDirectory**(`path`, `callback`, `recursive`?, `options`?): [`FileWatcher`](FileWatcher.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5802 + +Used to watch resolved module's failed lookup locations, config file specs, type roots where auto type reference directives are added + +#### Parameters + +##### path + +`string` + +##### callback + +[`DirectoryWatcherCallback`](../type-aliases/DirectoryWatcherCallback.md) + +##### recursive? + +`boolean` + +##### options? + +[`WatchOptions`](WatchOptions.md) + +#### Returns + +[`FileWatcher`](FileWatcher.md) + +#### Inherited from + +[`WatchCompilerHost`](WatchCompilerHost.md).[`watchDirectory`](WatchCompilerHost.md#watchdirectory) + +*** + +### watchFile() + +> **watchFile**(`path`, `callback`, `pollingInterval`?, `options`?): [`FileWatcher`](FileWatcher.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5800 + +Used to watch changes in source files, missing files needed to update the program or config file + +#### Parameters + +##### path + +`string` + +##### callback + +[`FileWatcherCallback`](../type-aliases/FileWatcherCallback.md) + +##### pollingInterval? + +`number` + +##### options? + +[`WatchOptions`](WatchOptions.md) + +#### Returns + +[`FileWatcher`](FileWatcher.md) + +#### Inherited from + +[`WatchCompilerHost`](WatchCompilerHost.md).[`watchFile`](WatchCompilerHost.md#watchfile) diff --git a/docs/api_docs/namespaces/ts/interfaces/WatchHost.md b/docs/api_docs/namespaces/ts/interfaces/WatchHost.md new file mode 100644 index 0000000000000000000000000000000000000000..43694b0ebdd3db2e2104e1ed6a8e230920f6060b --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/WatchHost.md @@ -0,0 +1,160 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / WatchHost + +# Interface: WatchHost + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5796 + +Host that has watch functionality used in --watch mode + +## Extended by + +- [`WatchCompilerHost`](WatchCompilerHost.md) +- [`SolutionBuilderWithWatchHost`](SolutionBuilderWithWatchHost.md) + +## Methods + +### clearTimeout()? + +> `optional` **clearTimeout**(`timeoutId`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5806 + +If provided, will be used to reset existing delayed compilation + +#### Parameters + +##### timeoutId + +`any` + +#### Returns + +`void` + +*** + +### onWatchStatusChange()? + +> `optional` **onWatchStatusChange**(`diagnostic`, `newLine`, `options`, `errorCount`?): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5798 + +If provided, called with Diagnostic message that informs about change in watch status + +#### Parameters + +##### diagnostic + +[`Diagnostic`](Diagnostic.md) + +##### newLine + +`string` + +##### options + +[`CompilerOptions`](CompilerOptions.md) + +##### errorCount? + +`number` + +#### Returns + +`void` + +*** + +### setTimeout()? + +> `optional` **setTimeout**(`callback`, `ms`, ...`args`): `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5804 + +If provided, will be used to set delayed compilation, so that multiple changes in short span are compiled together + +#### Parameters + +##### callback + +(...`args`) => `void` + +##### ms + +`number` + +##### args + +...`any`[] + +#### Returns + +`any` + +*** + +### watchDirectory() + +> **watchDirectory**(`path`, `callback`, `recursive`?, `options`?): [`FileWatcher`](FileWatcher.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5802 + +Used to watch resolved module's failed lookup locations, config file specs, type roots where auto type reference directives are added + +#### Parameters + +##### path + +`string` + +##### callback + +[`DirectoryWatcherCallback`](../type-aliases/DirectoryWatcherCallback.md) + +##### recursive? + +`boolean` + +##### options? + +[`WatchOptions`](WatchOptions.md) + +#### Returns + +[`FileWatcher`](FileWatcher.md) + +*** + +### watchFile() + +> **watchFile**(`path`, `callback`, `pollingInterval`?, `options`?): [`FileWatcher`](FileWatcher.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5800 + +Used to watch changes in source files, missing files needed to update the program or config file + +#### Parameters + +##### path + +`string` + +##### callback + +[`FileWatcherCallback`](../type-aliases/FileWatcherCallback.md) + +##### pollingInterval? + +`number` + +##### options? + +[`WatchOptions`](WatchOptions.md) + +#### Returns + +[`FileWatcher`](FileWatcher.md) diff --git a/docs/api_docs/namespaces/ts/interfaces/WatchOfConfigFile.md b/docs/api_docs/namespaces/ts/interfaces/WatchOfConfigFile.md new file mode 100644 index 0000000000000000000000000000000000000000..834986379aba8d6fe4f0300be778f73dbd2ed4fb --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/WatchOfConfigFile.md @@ -0,0 +1,55 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / WatchOfConfigFile + +# Interface: WatchOfConfigFile\ + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5897 + +Creates the watch what generates program using the config file + +## Extends + +- [`Watch`](Watch.md)\<`T`\> + +## Type Parameters + +• **T** + +## Methods + +### close() + +> **close**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5892 + +Closes the watch + +#### Returns + +`void` + +#### Inherited from + +[`Watch`](Watch.md).[`close`](Watch.md#close) + +*** + +### getProgram() + +> **getProgram**(): `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5890 + +Synchronize with host and get updated program + +#### Returns + +`T` + +#### Inherited from + +[`Watch`](Watch.md).[`getProgram`](Watch.md#getprogram) diff --git a/docs/api_docs/namespaces/ts/interfaces/WatchOfFilesAndCompilerOptions.md b/docs/api_docs/namespaces/ts/interfaces/WatchOfFilesAndCompilerOptions.md new file mode 100644 index 0000000000000000000000000000000000000000..86a3d9076adbcfae7ff1bc36df8335c5ee3ccb50 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/WatchOfFilesAndCompilerOptions.md @@ -0,0 +1,75 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / WatchOfFilesAndCompilerOptions + +# Interface: WatchOfFilesAndCompilerOptions\ + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5902 + +Creates the watch that generates program using the root files and compiler options + +## Extends + +- [`Watch`](Watch.md)\<`T`\> + +## Type Parameters + +• **T** + +## Methods + +### close() + +> **close**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5892 + +Closes the watch + +#### Returns + +`void` + +#### Inherited from + +[`Watch`](Watch.md).[`close`](Watch.md#close) + +*** + +### getProgram() + +> **getProgram**(): `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5890 + +Synchronize with host and get updated program + +#### Returns + +`T` + +#### Inherited from + +[`Watch`](Watch.md).[`getProgram`](Watch.md#getprogram) + +*** + +### updateRootFileNames() + +> **updateRootFileNames**(`fileNames`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5904 + +Updates the root files in the program, only if this is not config file compilation + +#### Parameters + +##### fileNames + +`string`[] + +#### Returns + +`void` diff --git a/docs/api_docs/namespaces/ts/interfaces/WatchOptions.md b/docs/api_docs/namespaces/ts/interfaces/WatchOptions.md new file mode 100644 index 0000000000000000000000000000000000000000..e374b948c475747e1484f326b3d6e3e90a12bdc7 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/WatchOptions.md @@ -0,0 +1,61 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / WatchOptions + +# Interface: WatchOptions + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3225 + +## Indexable + +\[`option`: `string`\]: [`CompilerOptionsValue`](../type-aliases/CompilerOptionsValue.md) + +## Properties + +### excludeDirectories? + +> `optional` **excludeDirectories**: `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3230 + +*** + +### excludeFiles? + +> `optional` **excludeFiles**: `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3231 + +*** + +### fallbackPolling? + +> `optional` **fallbackPolling**: [`PollingWatchKind`](../enumerations/PollingWatchKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3228 + +*** + +### synchronousWatchDirectory? + +> `optional` **synchronousWatchDirectory**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3229 + +*** + +### watchDirectory? + +> `optional` **watchDirectory**: [`WatchDirectoryKind`](../enumerations/WatchDirectoryKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3227 + +*** + +### watchFile? + +> `optional` **watchFile**: [`WatchFileKind`](../enumerations/WatchFileKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3226 diff --git a/docs/api_docs/namespaces/ts/interfaces/WhileStatement.md b/docs/api_docs/namespaces/ts/interfaces/WhileStatement.md new file mode 100644 index 0000000000000000000000000000000000000000..9628bbf9a4d4cbb6ccfe181de75c955b7abcbdc6 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/WhileStatement.md @@ -0,0 +1,509 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / WhileStatement + +# Interface: WhileStatement + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1520 + +## Extends + +- [`IterationStatement`](IterationStatement.md) + +## Properties + +### \_statementBrand + +> **\_statementBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1471 + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`_statementBrand`](IterationStatement.md#_statementbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`decorators`](IterationStatement.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`end`](IterationStatement.md#end) + +*** + +### expression + +> `readonly` **expression**: [`Expression`](Expression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1522 + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`flags`](IterationStatement.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`WhileStatement`](../enumerations/SyntaxKind.md#whilestatement) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1521 + +#### Overrides + +[`IterationStatement`](IterationStatement.md).[`kind`](IterationStatement.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`locals`](IterationStatement.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`modifiers`](IterationStatement.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`parent`](IterationStatement.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`pos`](IterationStatement.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`skipCheck`](IterationStatement.md#skipcheck) + +*** + +### statement + +> `readonly` **statement**: [`Statement`](Statement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1514 + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`statement`](IterationStatement.md#statement) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`symbol`](IterationStatement.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`forEachChild`](IterationStatement.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getChildAt`](IterationStatement.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getChildCount`](IterationStatement.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getChildren`](IterationStatement.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getEnd`](IterationStatement.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getFirstToken`](IterationStatement.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getFullStart`](IterationStatement.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getFullText`](IterationStatement.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getFullWidth`](IterationStatement.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getLastToken`](IterationStatement.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getLeadingTriviaWidth`](IterationStatement.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getSourceFile`](IterationStatement.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getStart`](IterationStatement.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getText`](IterationStatement.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`IterationStatement`](IterationStatement.md).[`getWidth`](IterationStatement.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/WithStatement.md b/docs/api_docs/namespaces/ts/interfaces/WithStatement.md new file mode 100644 index 0000000000000000000000000000000000000000..36c7a6c6fbe2c2e926a5016a786cf0794fc5a900 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/WithStatement.md @@ -0,0 +1,505 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / WithStatement + +# Interface: WithStatement + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1556 + +## Extends + +- [`Statement`](Statement.md) + +## Properties + +### \_statementBrand + +> **\_statementBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1471 + +#### Inherited from + +[`Statement`](Statement.md).[`_statementBrand`](Statement.md#_statementbrand) + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Statement`](Statement.md).[`decorators`](Statement.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Statement`](Statement.md).[`end`](Statement.md#end) + +*** + +### expression + +> `readonly` **expression**: [`Expression`](Expression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1558 + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Statement`](Statement.md).[`flags`](Statement.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`WithStatement`](../enumerations/SyntaxKind.md#withstatement) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1557 + +#### Overrides + +[`Statement`](Statement.md).[`kind`](Statement.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Statement`](Statement.md).[`locals`](Statement.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Statement`](Statement.md).[`modifiers`](Statement.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`Statement`](Statement.md).[`parent`](Statement.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Statement`](Statement.md).[`pos`](Statement.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Statement`](Statement.md).[`skipCheck`](Statement.md#skipcheck) + +*** + +### statement + +> `readonly` **statement**: [`Statement`](Statement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1559 + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Statement`](Statement.md).[`symbol`](Statement.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Statement`](Statement.md).[`forEachChild`](Statement.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getChildAt`](Statement.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getChildCount`](Statement.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Statement`](Statement.md).[`getChildren`](Statement.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getEnd`](Statement.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getFirstToken`](Statement.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getFullStart`](Statement.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Statement`](Statement.md).[`getFullText`](Statement.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getFullWidth`](Statement.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getLastToken`](Statement.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getLeadingTriviaWidth`](Statement.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Statement`](Statement.md).[`getSourceFile`](Statement.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getStart`](Statement.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Statement`](Statement.md).[`getText`](Statement.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Statement`](Statement.md).[`getWidth`](Statement.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/interfaces/WriteFileCallbackData.md b/docs/api_docs/namespaces/ts/interfaces/WriteFileCallbackData.md new file mode 100644 index 0000000000000000000000000000000000000000..83643d2ee79d45ab190f47a455a6b7fdc6580c75 --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/WriteFileCallbackData.md @@ -0,0 +1,9 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / WriteFileCallbackData + +# Interface: WriteFileCallbackData + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2255 diff --git a/docs/api_docs/namespaces/ts/interfaces/YieldExpression.md b/docs/api_docs/namespaces/ts/interfaces/YieldExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..3fb8e673a46649ad4ff6334140f50b0de8cc40af --- /dev/null +++ b/docs/api_docs/namespaces/ts/interfaces/YieldExpression.md @@ -0,0 +1,505 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / YieldExpression + +# Interface: YieldExpression + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1129 + +## Extends + +- [`Expression`](Expression.md) + +## Properties + +### \_expressionBrand + +> **\_expressionBrand**: `any` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1056 + +#### Inherited from + +[`Expression`](Expression.md).[`_expressionBrand`](Expression.md#_expressionbrand) + +*** + +### asteriskToken? + +> `readonly` `optional` **asteriskToken**: [`AsteriskToken`](../type-aliases/AsteriskToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1131 + +*** + +### ~~decorators?~~ + +> `readonly` `optional` **decorators**: `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8375 + +#### Deprecated + +`decorators` has been removed from `Node` and merged with `modifiers` on the `Node` subtypes that support them. +Use `ts.canHaveDecorators()` to test whether a `Node` can have decorators. +Use `ts.getDecorators()` to get the decorators of a `Node`. + +For example: +```ts +const decorators = ts.canHaveDecorators(node) ? ts.getDecorators(node) : undefined; +``` + +#### Inherited from + +[`Expression`](Expression.md).[`decorators`](Expression.md#decorators) + +*** + +### end + +> `readonly` **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:103 + +#### Inherited from + +[`Expression`](Expression.md).[`end`](Expression.md#end) + +*** + +### expression? + +> `readonly` `optional` **expression**: [`Expression`](Expression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1132 + +*** + +### flags + +> `readonly` **flags**: [`NodeFlags`](../enumerations/NodeFlags.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:599 + +#### Inherited from + +[`Expression`](Expression.md).[`flags`](Expression.md#flags) + +*** + +### kind + +> `readonly` **kind**: [`YieldExpression`](../enumerations/SyntaxKind.md#yieldexpression) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1130 + +#### Overrides + +[`Expression`](Expression.md).[`kind`](Expression.md#kind) + +*** + +### locals? + +> `optional` **locals**: [`SymbolTable`](../type-aliases/SymbolTable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:602 + +#### Inherited from + +[`Expression`](Expression.md).[`locals`](Expression.md#locals) + +*** + +### ~~modifiers?~~ + +> `readonly` `optional` **modifiers**: [`NodeArray`](NodeArray.md)\<[`ModifierLike`](../type-aliases/ModifierLike.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8386 + +#### Deprecated + +`modifiers` has been removed from `Node` and moved to the `Node` subtypes that support them. +Use `ts.canHaveModifiers()` to test whether a `Node` can have modifiers. +Use `ts.getModifiers()` to get the modifiers of a `Node`. + +For example: +```ts +const modifiers = ts.canHaveModifiers(node) ? ts.getModifiers(node) : undefined; +``` + +#### Inherited from + +[`Expression`](Expression.md).[`modifiers`](Expression.md#modifiers) + +*** + +### parent + +> `readonly` **parent**: [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:600 + +#### Inherited from + +[`Expression`](Expression.md).[`parent`](Expression.md#parent) + +*** + +### pos + +> `readonly` **pos**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:102 + +#### Inherited from + +[`Expression`](Expression.md).[`pos`](Expression.md#pos) + +*** + +### skipCheck? + +> `optional` **skipCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:603 + +#### Inherited from + +[`Expression`](Expression.md).[`skipCheck`](Expression.md#skipcheck) + +*** + +### symbol + +> **symbol**: [`Symbol`](Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:601 + +#### Inherited from + +[`Expression`](Expression.md).[`symbol`](Expression.md#symbol) + +## Methods + +### forEachChild() + +> **forEachChild**\<`T`\>(`cbNode`, `cbNodeArray`?): `undefined` \| `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6102 + +#### Type Parameters + +• **T** + +#### Parameters + +##### cbNode + +(`node`) => `undefined` \| `T` + +##### cbNodeArray? + +(`nodes`) => `undefined` \| `T` + +#### Returns + +`undefined` \| `T` + +#### Inherited from + +[`Expression`](Expression.md).[`forEachChild`](Expression.md#foreachchild) + +*** + +### getChildAt() + +> **getChildAt**(`index`, `sourceFile`?): [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6090 + +#### Parameters + +##### index + +`number` + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md) + +#### Inherited from + +[`Expression`](Expression.md).[`getChildAt`](Expression.md#getchildat) + +*** + +### getChildCount() + +> **getChildCount**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6089 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getChildCount`](Expression.md#getchildcount) + +*** + +### getChildren() + +> **getChildren**(`sourceFile`?): [`Node`](Node.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6091 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +[`Node`](Node.md)[] + +#### Inherited from + +[`Expression`](Expression.md).[`getChildren`](Expression.md#getchildren) + +*** + +### getEnd() + +> **getEnd**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6094 + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getEnd`](Expression.md#getend) + +*** + +### getFirstToken() + +> **getFirstToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6100 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Expression`](Expression.md).[`getFirstToken`](Expression.md#getfirsttoken) + +*** + +### getFullStart() + +> **getFullStart**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6093 + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getFullStart`](Expression.md#getfullstart) + +*** + +### getFullText() + +> **getFullText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6098 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Expression`](Expression.md).[`getFullText`](Expression.md#getfulltext) + +*** + +### getFullWidth() + +> **getFullWidth**(): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6096 + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getFullWidth`](Expression.md#getfullwidth) + +*** + +### getLastToken() + +> **getLastToken**(`sourceFile`?): `undefined` \| [`Node`](Node.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6101 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`undefined` \| [`Node`](Node.md) + +#### Inherited from + +[`Expression`](Expression.md).[`getLastToken`](Expression.md#getlasttoken) + +*** + +### getLeadingTriviaWidth() + +> **getLeadingTriviaWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6097 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getLeadingTriviaWidth`](Expression.md#getleadingtriviawidth) + +*** + +### getSourceFile() + +> **getSourceFile**(): [`SourceFile`](SourceFile.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6088 + +#### Returns + +[`SourceFile`](SourceFile.md) + +#### Inherited from + +[`Expression`](Expression.md).[`getSourceFile`](Expression.md#getsourcefile) + +*** + +### getStart() + +> **getStart**(`sourceFile`?, `includeJsDocComment`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6092 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +##### includeJsDocComment? + +`boolean` + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getStart`](Expression.md#getstart) + +*** + +### getText() + +> **getText**(`sourceFile`?): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6099 + +#### Parameters + +##### sourceFile? + +[`SourceFile`](SourceFile.md) + +#### Returns + +`string` + +#### Inherited from + +[`Expression`](Expression.md).[`getText`](Expression.md#gettext) + +*** + +### getWidth() + +> **getWidth**(`sourceFile`?): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6095 + +#### Parameters + +##### sourceFile? + +[`SourceFileLike`](SourceFileLike.md) + +#### Returns + +`number` + +#### Inherited from + +[`Expression`](Expression.md).[`getWidth`](Expression.md#getwidth) diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/README.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/README.md new file mode 100644 index 0000000000000000000000000000000000000000..a1be9f1991b114cbead8241de334505885297e5c --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/README.md @@ -0,0 +1,36 @@ +[**ArkAnalyzer**](../../../../README.md) + +*** + +[ArkAnalyzer](../../../../globals.md) / [ts](../../README.md) / ArkTSLinter\_1\_0 + +# ArkTSLinter\_1\_0 + +## Namespaces + +- [Autofixer](namespaces/Autofixer/README.md) +- [Common](namespaces/Common/README.md) +- [DiagnosticCheckerNamespace](namespaces/DiagnosticCheckerNamespace/README.md) +- [LibraryTypeCallDiagnosticCheckerNamespace](namespaces/LibraryTypeCallDiagnosticCheckerNamespace/README.md) +- [Problems](namespaces/Problems/README.md) +- [Utils](namespaces/Utils/README.md) + +## Classes + +- [LinterConfig](classes/LinterConfig.md) +- [TSCCompiledProgram](classes/TSCCompiledProgram.md) +- [TypeScriptLinter](classes/TypeScriptLinter.md) + +## Interfaces + +- [ProblemInfo](interfaces/ProblemInfo.md) + +## Variables + +- [cookBookMsg](variables/cookBookMsg.md) +- [cookBookTag](variables/cookBookTag.md) + +## Functions + +- [runArkTSLinter](functions/runArkTSLinter.md) +- [translateDiag](functions/translateDiag.md) diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/classes/LinterConfig.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/classes/LinterConfig.md new file mode 100644 index 0000000000000000000000000000000000000000..2dbd9e8903a49050c2cc93c111d74b1891d2d523 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/classes/LinterConfig.md @@ -0,0 +1,63 @@ +[**ArkAnalyzer**](../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../globals.md) / [ts](../../../README.md) / [ArkTSLinter\_1\_0](../README.md) / LinterConfig + +# Class: LinterConfig + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8897 + +## Constructors + +### new LinterConfig() + +> **new LinterConfig**(): [`LinterConfig`](LinterConfig.md) + +#### Returns + +[`LinterConfig`](LinterConfig.md) + +## Properties + +### incrementOnlyTokens + +> `static` **incrementOnlyTokens**: [`ESMap`](../../../interfaces/ESMap.md)\<[`SyntaxKind`](../../../enumerations/SyntaxKind.md), [`FaultID`](../namespaces/Problems/enumerations/FaultID.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8902 + +*** + +### nodeDesc + +> `static` **nodeDesc**: `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8898 + +*** + +### terminalTokens + +> `static` **terminalTokens**: [`Set`](../../../interfaces/Set.md)\<[`SyntaxKind`](../../../enumerations/SyntaxKind.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8901 + +*** + +### tsSyntaxKindNames + +> `static` **tsSyntaxKindNames**: `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8899 + +## Methods + +### initStatic() + +> `static` **initStatic**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8900 + +#### Returns + +`void` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/classes/TSCCompiledProgram.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/classes/TSCCompiledProgram.md new file mode 100644 index 0000000000000000000000000000000000000000..1ebe2e28f032c4389fb61e8343b5f975abaa419a --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/classes/TSCCompiledProgram.md @@ -0,0 +1,81 @@ +[**ArkAnalyzer**](../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../globals.md) / [ts](../../../README.md) / [ArkTSLinter\_1\_0](../README.md) / TSCCompiledProgram + +# Class: TSCCompiledProgram + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9044 + +## Constructors + +### new TSCCompiledProgram() + +> **new TSCCompiledProgram**(`program`): [`TSCCompiledProgram`](TSCCompiledProgram.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9046 + +#### Parameters + +##### program + +[`BuilderProgram`](../../../interfaces/BuilderProgram.md) + +#### Returns + +[`TSCCompiledProgram`](TSCCompiledProgram.md) + +## Methods + +### doAllGetDiagnostics() + +> **doAllGetDiagnostics**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9050 + +#### Returns + +`void` + +*** + +### getBuilderProgram() + +> **getBuilderProgram**(): [`BuilderProgram`](../../../interfaces/BuilderProgram.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9048 + +#### Returns + +[`BuilderProgram`](../../../interfaces/BuilderProgram.md) + +*** + +### getProgram() + +> **getProgram**(): [`Program`](../../../interfaces/Program.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9047 + +#### Returns + +[`Program`](../../../interfaces/Program.md) + +*** + +### getStrictDiagnostics() + +> **getStrictDiagnostics**(`fileName`): [`Diagnostic`](../../../interfaces/Diagnostic.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9049 + +#### Parameters + +##### fileName + +`string` + +#### Returns + +[`Diagnostic`](../../../interfaces/Diagnostic.md)[] diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/classes/TypeScriptLinter.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/classes/TypeScriptLinter.md new file mode 100644 index 0000000000000000000000000000000000000000..76e92f2badf335ef529aa54810e7f1d052beafee --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/classes/TypeScriptLinter.md @@ -0,0 +1,307 @@ +[**ArkAnalyzer**](../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../globals.md) / [ts](../../../README.md) / [ArkTSLinter\_1\_0](../README.md) / TypeScriptLinter + +# Class: TypeScriptLinter + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8924 + +## Constructors + +### new TypeScriptLinter() + +> **new TypeScriptLinter**(`sourceFile`, `tsProgram`, `tscStrictDiagnostics`?): [`TypeScriptLinter`](TypeScriptLinter.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8950 + +#### Parameters + +##### sourceFile + +[`SourceFile`](../../../interfaces/SourceFile.md) + +##### tsProgram + +[`Program`](../../../interfaces/Program.md) + +##### tscStrictDiagnostics? + +[`Map`](../../../interfaces/Map.md)\<[`Diagnostic`](../../../interfaces/Diagnostic.md)[]\> + +#### Returns + +[`TypeScriptLinter`](TypeScriptLinter.md) + +## Properties + +### currentErrorLine + +> **currentErrorLine**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8945 + +*** + +### currentWarningLine + +> **currentWarningLine**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8946 + +*** + +### handlersMap + +> `readonly` **handlersMap**: [`ESMap`](../../../interfaces/ESMap.md)\<[`SyntaxKind`](../../../enumerations/SyntaxKind.md), (`node`) => `void`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8952 + +*** + +### libraryTypeCallDiagnosticChecker + +> **libraryTypeCallDiagnosticChecker**: [`LibraryTypeCallDiagnosticChecker`](../namespaces/LibraryTypeCallDiagnosticCheckerNamespace/classes/LibraryTypeCallDiagnosticChecker.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8948 + +*** + +### skipArkTSStaticBlocksCheck + +> **skipArkTSStaticBlocksCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8949 + +*** + +### staticBlocks + +> **staticBlocks**: [`Set`](../../../interfaces/Set.md)\<`string`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8947 + +*** + +### errorLineNumbersString + +> `static` **errorLineNumbersString**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8936 + +*** + +### filteredDiagnosticMessages + +> `static` **filteredDiagnosticMessages**: [`DiagnosticMessageChain`](../../../interfaces/DiagnosticMessageChain.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8941 + +*** + +### ideMode + +> `static` **ideMode**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8927 + +*** + +### lineCounters + +> `static` **lineCounters**: `number`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8934 + +*** + +### lintEtsOnly + +> `static` **lintEtsOnly**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8931 + +*** + +### logTscErrors + +> `static` **logTscErrors**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8929 + +*** + +### nodeCounters + +> `static` **nodeCounters**: `number`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8933 + +*** + +### problemsInfos + +> `static` **problemsInfos**: [`ProblemInfo`](../interfaces/ProblemInfo.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8940 + +*** + +### reportDiagnostics + +> `static` **reportDiagnostics**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8939 + +*** + +### strictMode + +> `static` **strictMode**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8928 + +*** + +### totalErrorLines + +> `static` **totalErrorLines**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8935 + +*** + +### totalVisitedNodes + +> `static` **totalVisitedNodes**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8932 + +*** + +### totalWarningLines + +> `static` **totalWarningLines**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8937 + +*** + +### tsTypeChecker + +> `static` **tsTypeChecker**: [`TypeChecker`](../../../interfaces/TypeChecker.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8944 + +*** + +### warningLineNumbersString + +> `static` **warningLineNumbersString**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8938 + +*** + +### warningsAsErrors + +> `static` **warningsAsErrors**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8930 + +## Methods + +### incrementCounters() + +> **incrementCounters**(`node`, `faultId`, `autofixable`?, `autofix`?): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8953 + +#### Parameters + +##### node + +[`Node`](../../../interfaces/Node.md) | [`CommentRange`](../../../interfaces/CommentRange.md) + +##### faultId + +`number` + +##### autofixable? + +`boolean` + +##### autofix? + +[`Autofix`](../namespaces/Autofixer/interfaces/Autofix.md)[] + +#### Returns + +`void` + +*** + +### lint() + +> **lint**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9038 + +#### Returns + +`void` + +*** + +### visitTSNode() + +> **visitTSNode**(`node`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8954 + +#### Parameters + +##### node + +[`Node`](../../../interfaces/Node.md) + +#### Returns + +`void` + +*** + +### clearTsTypeChecker() + +> `static` **clearTsTypeChecker**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8951 + +#### Returns + +`void` + +*** + +### initGlobals() + +> `static` **initGlobals**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8942 + +#### Returns + +`void` + +*** + +### initStatic() + +> `static` **initStatic**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8943 + +#### Returns + +`void` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/functions/runArkTSLinter.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/functions/runArkTSLinter.md new file mode 100644 index 0000000000000000000000000000000000000000..ac78632283d2a5c8e75c4a6fda9ca11444cd0e1c --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/functions/runArkTSLinter.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../globals.md) / [ts](../../../README.md) / [ArkTSLinter\_1\_0](../README.md) / runArkTSLinter + +# Function: runArkTSLinter() + +> **runArkTSLinter**(`tsBuilderProgram`, `srcFile`?, `buildInfoWriteFile`?, `arkTSVersion`?): [`Diagnostic`](../../../interfaces/Diagnostic.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9057 + +## Parameters + +### tsBuilderProgram + +[`BuilderProgram`](../../../interfaces/BuilderProgram.md) + +### srcFile? + +[`SourceFile`](../../../interfaces/SourceFile.md) + +### buildInfoWriteFile? + +[`WriteFileCallback`](../../../type-aliases/WriteFileCallback.md) + +### arkTSVersion? + +`string` + +## Returns + +[`Diagnostic`](../../../interfaces/Diagnostic.md)[] diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/functions/translateDiag.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/functions/translateDiag.md new file mode 100644 index 0000000000000000000000000000000000000000..f503f94eec7dace5128d1fa675ceb26355ad1580 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/functions/translateDiag.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../globals.md) / [ts](../../../README.md) / [ArkTSLinter\_1\_0](../README.md) / translateDiag + +# Function: translateDiag() + +> **translateDiag**(`srcFile`, `problemInfo`): [`Diagnostic`](../../../interfaces/Diagnostic.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9056 + +## Parameters + +### srcFile + +[`SourceFile`](../../../interfaces/SourceFile.md) + +### problemInfo + +[`ProblemInfo`](../interfaces/ProblemInfo.md) + +## Returns + +[`Diagnostic`](../../../interfaces/Diagnostic.md) diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/interfaces/ProblemInfo.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/interfaces/ProblemInfo.md new file mode 100644 index 0000000000000000000000000000000000000000..802b578191f72f1b379fbbe785ee25cc5d2f2281 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/interfaces/ProblemInfo.md @@ -0,0 +1,105 @@ +[**ArkAnalyzer**](../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../globals.md) / [ts](../../../README.md) / [ArkTSLinter\_1\_0](../README.md) / ProblemInfo + +# Interface: ProblemInfo + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8910 + +## Properties + +### autofix? + +> `optional` **autofix**: [`Autofix`](../namespaces/Autofixer/interfaces/Autofix.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8922 + +*** + +### autofixable + +> **autofixable**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8921 + +*** + +### column + +> **column**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8912 + +*** + +### end + +> **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8914 + +*** + +### line + +> **line**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8911 + +*** + +### problem + +> **problem**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8917 + +*** + +### rule + +> **rule**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8919 + +*** + +### ruleTag + +> **ruleTag**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8920 + +*** + +### severity + +> **severity**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8916 + +*** + +### start + +> **start**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8913 + +*** + +### suggest + +> **suggest**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8918 + +*** + +### type + +> **type**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8915 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Autofixer/README.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Autofixer/README.md new file mode 100644 index 0000000000000000000000000000000000000000..98937a95af5a1d0382192c38786cc76381c8791e --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Autofixer/README.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../globals.md) / [ts](../../../../README.md) / [ArkTSLinter\_1\_0](../../README.md) / Autofixer + +# Autofixer + +## Interfaces + +- [Autofix](interfaces/Autofix.md) + +## Variables + +- [AUTOFIX\_ALL](variables/AUTOFIX_ALL.md) +- [autofixInfo](variables/autofixInfo.md) + +## Functions + +- [fixCtorParameterProperties](functions/fixCtorParameterProperties.md) +- [fixFunctionExpression](functions/fixFunctionExpression.md) +- [fixLiteralAsPropertyName](functions/fixLiteralAsPropertyName.md) +- [fixPropertyAccessByIndex](functions/fixPropertyAccessByIndex.md) +- [fixReturnType](functions/fixReturnType.md) +- [shouldAutofix](functions/shouldAutofix.md) diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Autofixer/functions/fixCtorParameterProperties.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Autofixer/functions/fixCtorParameterProperties.md new file mode 100644 index 0000000000000000000000000000000000000000..ea54f570b9904a6610c88a625f8c82f93d65dbee --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Autofixer/functions/fixCtorParameterProperties.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Autofixer](../README.md) / fixCtorParameterProperties + +# Function: fixCtorParameterProperties() + +> **fixCtorParameterProperties**(`ctorDecl`, `paramTypes`): `undefined` \| [`Autofix`](../interfaces/Autofix.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8890 + +## Parameters + +### ctorDecl + +[`ConstructorDeclaration`](../../../../../interfaces/ConstructorDeclaration.md) + +### paramTypes + +[`TypeNode`](../../../../../interfaces/TypeNode.md)[] + +## Returns + +`undefined` \| [`Autofix`](../interfaces/Autofix.md)[] diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Autofixer/functions/fixFunctionExpression.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Autofixer/functions/fixFunctionExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..336ce7e87324cf77e940b04ba5a3e6a1c0996818 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Autofixer/functions/fixFunctionExpression.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Autofixer](../README.md) / fixFunctionExpression + +# Function: fixFunctionExpression() + +> **fixFunctionExpression**(`funcExpr`, `params`?, `retType`?): [`Autofix`](../interfaces/Autofix.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8888 + +## Parameters + +### funcExpr + +[`FunctionExpression`](../../../../../interfaces/FunctionExpression.md) + +### params? + +[`NodeArray`](../../../../../interfaces/NodeArray.md)\<[`ParameterDeclaration`](../../../../../interfaces/ParameterDeclaration.md)\> + +### retType? + +[`TypeNode`](../../../../../interfaces/TypeNode.md) + +## Returns + +[`Autofix`](../interfaces/Autofix.md) diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Autofixer/functions/fixLiteralAsPropertyName.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Autofixer/functions/fixLiteralAsPropertyName.md new file mode 100644 index 0000000000000000000000000000000000000000..c8797cead84aeae0dbeb3714ace039d0ad1b3cb4 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Autofixer/functions/fixLiteralAsPropertyName.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Autofixer](../README.md) / fixLiteralAsPropertyName + +# Function: fixLiteralAsPropertyName() + +> **fixLiteralAsPropertyName**(`node`): `undefined` \| [`Autofix`](../interfaces/Autofix.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8886 + +## Parameters + +### node + +[`Node`](../../../../../interfaces/Node.md) + +## Returns + +`undefined` \| [`Autofix`](../interfaces/Autofix.md)[] diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Autofixer/functions/fixPropertyAccessByIndex.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Autofixer/functions/fixPropertyAccessByIndex.md new file mode 100644 index 0000000000000000000000000000000000000000..038063dd1aafcbe5d1fb4d9bd370a19972e99d9f --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Autofixer/functions/fixPropertyAccessByIndex.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Autofixer](../README.md) / fixPropertyAccessByIndex + +# Function: fixPropertyAccessByIndex() + +> **fixPropertyAccessByIndex**(`node`): `undefined` \| [`Autofix`](../interfaces/Autofix.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8887 + +## Parameters + +### node + +[`Node`](../../../../../interfaces/Node.md) + +## Returns + +`undefined` \| [`Autofix`](../interfaces/Autofix.md)[] diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Autofixer/functions/fixReturnType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Autofixer/functions/fixReturnType.md new file mode 100644 index 0000000000000000000000000000000000000000..a40ff55fdada6ab472e21c7e2b81116abcf6de0d --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Autofixer/functions/fixReturnType.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Autofixer](../README.md) / fixReturnType + +# Function: fixReturnType() + +> **fixReturnType**(`funcLikeDecl`, `typeNode`): [`Autofix`](../interfaces/Autofix.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8889 + +## Parameters + +### funcLikeDecl + +[`FunctionLikeDeclaration`](../../../../../type-aliases/FunctionLikeDeclaration.md) + +### typeNode + +[`TypeNode`](../../../../../interfaces/TypeNode.md) + +## Returns + +[`Autofix`](../interfaces/Autofix.md) diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Autofixer/functions/shouldAutofix.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Autofixer/functions/shouldAutofix.md new file mode 100644 index 0000000000000000000000000000000000000000..3f28130356c7d022ffece7696a7c7995b7a746b1 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Autofixer/functions/shouldAutofix.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Autofixer](../README.md) / shouldAutofix + +# Function: shouldAutofix() + +> **shouldAutofix**(`node`, `faultID`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8880 + +## Parameters + +### node + +[`Node`](../../../../../interfaces/Node.md) + +### faultID + +[`FaultID`](../../Problems/enumerations/FaultID.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Autofixer/interfaces/Autofix.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Autofixer/interfaces/Autofix.md new file mode 100644 index 0000000000000000000000000000000000000000..9eeae5617a38c9af25eda88c78e3b9bc5327dc90 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Autofixer/interfaces/Autofix.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Autofixer](../README.md) / Autofix + +# Interface: Autofix + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8881 + +## Properties + +### end + +> **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8884 + +*** + +### replacementText + +> **replacementText**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8882 + +*** + +### start + +> **start**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8883 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Autofixer/variables/AUTOFIX_ALL.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Autofixer/variables/AUTOFIX_ALL.md new file mode 100644 index 0000000000000000000000000000000000000000..f0cd89503acdcfb61cdd596d4725fde99f8fe990 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Autofixer/variables/AUTOFIX_ALL.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Autofixer](../README.md) / AUTOFIX\_ALL + +# Variable: AUTOFIX\_ALL + +> `const` **AUTOFIX\_ALL**: [`AutofixInfo`](../../Common/interfaces/AutofixInfo.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8878 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Autofixer/variables/autofixInfo.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Autofixer/variables/autofixInfo.md new file mode 100644 index 0000000000000000000000000000000000000000..b8a745aea3ee61e1471d4d557f49921c9b817e57 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Autofixer/variables/autofixInfo.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Autofixer](../README.md) / autofixInfo + +# Variable: autofixInfo + +> `const` **autofixInfo**: [`AutofixInfo`](../../Common/interfaces/AutofixInfo.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8879 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Common/README.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Common/README.md new file mode 100644 index 0000000000000000000000000000000000000000..c013c40760d540ba0541f9c47dd1f10c0d154cc8 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Common/README.md @@ -0,0 +1,13 @@ +[**ArkAnalyzer**](../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../globals.md) / [ts](../../../../README.md) / [ArkTSLinter\_1\_0](../../README.md) / Common + +# Common + +## Interfaces + +- [AutofixInfo](interfaces/AutofixInfo.md) +- [CommandLineOptions](interfaces/CommandLineOptions.md) +- [LintOptions](interfaces/LintOptions.md) diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Common/interfaces/AutofixInfo.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Common/interfaces/AutofixInfo.md new file mode 100644 index 0000000000000000000000000000000000000000..45628b85138010d7be91f7dcfc70daff853881a7 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Common/interfaces/AutofixInfo.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Common](../README.md) / AutofixInfo + +# Interface: AutofixInfo + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8568 + +## Properties + +### end + +> **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8571 + +*** + +### problemID + +> **problemID**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8569 + +*** + +### start + +> **start**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8570 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Common/interfaces/CommandLineOptions.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Common/interfaces/CommandLineOptions.md new file mode 100644 index 0000000000000000000000000000000000000000..94a858320490b0602a96fa90ceb8481481b9c405 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Common/interfaces/CommandLineOptions.md @@ -0,0 +1,65 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Common](../README.md) / CommandLineOptions + +# Interface: CommandLineOptions + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8573 + +## Properties + +### autofixInfo? + +> `optional` **autofixInfo**: [`AutofixInfo`](AutofixInfo.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8580 + +*** + +### ideMode? + +> `optional` **ideMode**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8575 + +*** + +### inputFiles + +> **inputFiles**: `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8579 + +*** + +### logTscErrors? + +> `optional` **logTscErrors**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8576 + +*** + +### parsedConfigFile? + +> `optional` **parsedConfigFile**: [`ParsedCommandLine`](../../../../../interfaces/ParsedCommandLine.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8578 + +*** + +### strictMode? + +> `optional` **strictMode**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8574 + +*** + +### warningsAsErrors + +> **warningsAsErrors**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8577 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Common/interfaces/LintOptions.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Common/interfaces/LintOptions.md new file mode 100644 index 0000000000000000000000000000000000000000..af330038d442d367d85503510d6fdb0a77559554 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Common/interfaces/LintOptions.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Common](../README.md) / LintOptions + +# Interface: LintOptions + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8582 + +## Indexable + +\[`key`: `string`\]: `any` + +## Properties + +### cmdOptions + +> **cmdOptions**: [`CommandLineOptions`](CommandLineOptions.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8583 + +*** + +### tsProgram? + +> `optional` **tsProgram**: [`Program`](../../../../../interfaces/Program.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8584 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/DiagnosticCheckerNamespace/README.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/DiagnosticCheckerNamespace/README.md new file mode 100644 index 0000000000000000000000000000000000000000..a58a446658a2cc6968d2e86154b5e4897dbf2f6f --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/DiagnosticCheckerNamespace/README.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../globals.md) / [ts](../../../../README.md) / [ArkTSLinter\_1\_0](../../README.md) / DiagnosticCheckerNamespace + +# DiagnosticCheckerNamespace + +## Interfaces + +- [DiagnosticChecker](interfaces/DiagnosticChecker.md) diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/DiagnosticCheckerNamespace/interfaces/DiagnosticChecker.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/DiagnosticCheckerNamespace/interfaces/DiagnosticChecker.md new file mode 100644 index 0000000000000000000000000000000000000000..225dd4b6f4d64e793e258a5c1a76442b4c04e4ce --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/DiagnosticCheckerNamespace/interfaces/DiagnosticChecker.md @@ -0,0 +1,27 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [DiagnosticCheckerNamespace](../README.md) / DiagnosticChecker + +# Interface: DiagnosticChecker + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8599 + +## Methods + +### checkDiagnosticMessage() + +> **checkDiagnosticMessage**(`msgText`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8600 + +#### Parameters + +##### msgText + +`string` | [`DiagnosticMessageChain`](../../../../../interfaces/DiagnosticMessageChain.md) + +#### Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/README.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/README.md new file mode 100644 index 0000000000000000000000000000000000000000..f6ffd6e2863ba85c86e3a1e8b88902cd3561d98b --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/README.md @@ -0,0 +1,22 @@ +[**ArkAnalyzer**](../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../globals.md) / [ts](../../../../README.md) / [ArkTSLinter\_1\_0](../../README.md) / LibraryTypeCallDiagnosticCheckerNamespace + +# LibraryTypeCallDiagnosticCheckerNamespace + +## Classes + +- [LibraryTypeCallDiagnosticChecker](classes/LibraryTypeCallDiagnosticChecker.md) + +## Variables + +- [ARGUMENT\_OF\_TYPE\_0\_IS\_NOT\_ASSIGNABLE\_TO\_PARAMETER\_OF\_TYPE\_1\_ERROR\_CODE](variables/ARGUMENT_OF_TYPE_0_IS_NOT_ASSIGNABLE_TO_PARAMETER_OF_TYPE_1_ERROR_CODE.md) +- [ARGUMENT\_OF\_TYPE\_NULL\_IS\_NOT\_ASSIGNABLE\_TO\_PARAMETER\_OF\_TYPE\_1\_RE](variables/ARGUMENT_OF_TYPE_NULL_IS_NOT_ASSIGNABLE_TO_PARAMETER_OF_TYPE_1_RE.md) +- [ARGUMENT\_OF\_TYPE\_UNDEFINED\_IS\_NOT\_ASSIGNABLE\_TO\_PARAMETER\_OF\_TYPE\_1\_RE](variables/ARGUMENT_OF_TYPE_UNDEFINED_IS_NOT_ASSIGNABLE_TO_PARAMETER_OF_TYPE_1_RE.md) +- [NO\_OVERLOAD\_MATCHES\_THIS\_CALL\_ERROR\_CODE](variables/NO_OVERLOAD_MATCHES_THIS_CALL_ERROR_CODE.md) +- [TYPE\_0\_IS\_NOT\_ASSIGNABLE\_TO\_TYPE\_1\_ERROR\_CODE](variables/TYPE_0_IS_NOT_ASSIGNABLE_TO_TYPE_1_ERROR_CODE.md) +- [TYPE\_NULL\_IS\_NOT\_ASSIGNABLE\_TO\_TYPE\_1\_RE](variables/TYPE_NULL_IS_NOT_ASSIGNABLE_TO_TYPE_1_RE.md) +- [TYPE\_UNDEFINED\_IS\_NOT\_ASSIGNABLE\_TO\_TYPE\_1\_RE](variables/TYPE_UNDEFINED_IS_NOT_ASSIGNABLE_TO_TYPE_1_RE.md) +- [TYPE\_UNKNOWN\_IS\_NOT\_ASSIGNABLE\_TO\_TYPE\_1\_RE](variables/TYPE_UNKNOWN_IS_NOT_ASSIGNABLE_TO_TYPE_1_RE.md) diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/classes/LibraryTypeCallDiagnosticChecker.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/classes/LibraryTypeCallDiagnosticChecker.md new file mode 100644 index 0000000000000000000000000000000000000000..6bf00ec791dffc962b5a06f659019c4732147103 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/classes/LibraryTypeCallDiagnosticChecker.md @@ -0,0 +1,153 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [LibraryTypeCallDiagnosticCheckerNamespace](../README.md) / LibraryTypeCallDiagnosticChecker + +# Class: LibraryTypeCallDiagnosticChecker + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8617 + +## Implements + +- [`DiagnosticChecker`](../../DiagnosticCheckerNamespace/interfaces/DiagnosticChecker.md) + +## Constructors + +### new LibraryTypeCallDiagnosticChecker() + +> **new LibraryTypeCallDiagnosticChecker**(`filteredDiagnosticMessages`): [`LibraryTypeCallDiagnosticChecker`](LibraryTypeCallDiagnosticChecker.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8621 + +#### Parameters + +##### filteredDiagnosticMessages + +[`DiagnosticMessageChain`](../../../../../interfaces/DiagnosticMessageChain.md)[] + +#### Returns + +[`LibraryTypeCallDiagnosticChecker`](LibraryTypeCallDiagnosticChecker.md) + +## Properties + +### diagnosticMessages + +> **diagnosticMessages**: `undefined` \| [`DiagnosticMessageChain`](../../../../../interfaces/DiagnosticMessageChain.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8619 + +*** + +### filteredDiagnosticMessages + +> **filteredDiagnosticMessages**: [`DiagnosticMessageChain`](../../../../../interfaces/DiagnosticMessageChain.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8620 + +*** + +### inLibCall + +> **inLibCall**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8618 + +## Methods + +### checkDiagnosticMessage() + +> **checkDiagnosticMessage**(`msgText`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8626 + +#### Parameters + +##### msgText + +`string` | [`DiagnosticMessageChain`](../../../../../interfaces/DiagnosticMessageChain.md) + +#### Returns + +`boolean` + +#### Implementation of + +[`DiagnosticChecker`](../../DiagnosticCheckerNamespace/interfaces/DiagnosticChecker.md).[`checkDiagnosticMessage`](../../DiagnosticCheckerNamespace/interfaces/DiagnosticChecker.md#checkdiagnosticmessage) + +*** + +### checkFilteredDiagnosticMessages() + +> **checkFilteredDiagnosticMessages**(`msgText`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8625 + +#### Parameters + +##### msgText + +`string` | [`DiagnosticMessageChain`](../../../../../interfaces/DiagnosticMessageChain.md) + +#### Returns + +`boolean` + +*** + +### checkMessageChain() + +> **checkMessageChain**(`chain`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8624 + +#### Parameters + +##### chain + +[`DiagnosticMessageChain`](../../../../../interfaces/DiagnosticMessageChain.md) + +#### Returns + +`boolean` + +*** + +### checkMessageText() + +> **checkMessageText**(`msg`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8623 + +#### Parameters + +##### msg + +`string` + +#### Returns + +`boolean` + +*** + +### configure() + +> **configure**(`inLibCall`, `diagnosticMessages`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8622 + +#### Parameters + +##### inLibCall + +`boolean` + +##### diagnosticMessages + +[`DiagnosticMessageChain`](../../../../../interfaces/DiagnosticMessageChain.md)[] + +#### Returns + +`void` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/variables/ARGUMENT_OF_TYPE_0_IS_NOT_ASSIGNABLE_TO_PARAMETER_OF_TYPE_1_ERROR_CODE.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/variables/ARGUMENT_OF_TYPE_0_IS_NOT_ASSIGNABLE_TO_PARAMETER_OF_TYPE_1_ERROR_CODE.md new file mode 100644 index 0000000000000000000000000000000000000000..635007956ac8fa218f75b94aaed46f6646f382de --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/variables/ARGUMENT_OF_TYPE_0_IS_NOT_ASSIGNABLE_TO_PARAMETER_OF_TYPE_1_ERROR_CODE.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [LibraryTypeCallDiagnosticCheckerNamespace](../README.md) / ARGUMENT\_OF\_TYPE\_0\_IS\_NOT\_ASSIGNABLE\_TO\_PARAMETER\_OF\_TYPE\_1\_ERROR\_CODE + +# Variable: ARGUMENT\_OF\_TYPE\_0\_IS\_NOT\_ASSIGNABLE\_TO\_PARAMETER\_OF\_TYPE\_1\_ERROR\_CODE + +> `const` **ARGUMENT\_OF\_TYPE\_0\_IS\_NOT\_ASSIGNABLE\_TO\_PARAMETER\_OF\_TYPE\_1\_ERROR\_CODE**: `2345` = `2345` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8613 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/variables/ARGUMENT_OF_TYPE_NULL_IS_NOT_ASSIGNABLE_TO_PARAMETER_OF_TYPE_1_RE.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/variables/ARGUMENT_OF_TYPE_NULL_IS_NOT_ASSIGNABLE_TO_PARAMETER_OF_TYPE_1_RE.md new file mode 100644 index 0000000000000000000000000000000000000000..485c3e3c6eabc567d33f8c5dbe449431b448b853 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/variables/ARGUMENT_OF_TYPE_NULL_IS_NOT_ASSIGNABLE_TO_PARAMETER_OF_TYPE_1_RE.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [LibraryTypeCallDiagnosticCheckerNamespace](../README.md) / ARGUMENT\_OF\_TYPE\_NULL\_IS\_NOT\_ASSIGNABLE\_TO\_PARAMETER\_OF\_TYPE\_1\_RE + +# Variable: ARGUMENT\_OF\_TYPE\_NULL\_IS\_NOT\_ASSIGNABLE\_TO\_PARAMETER\_OF\_TYPE\_1\_RE + +> `const` **ARGUMENT\_OF\_TYPE\_NULL\_IS\_NOT\_ASSIGNABLE\_TO\_PARAMETER\_OF\_TYPE\_1\_RE**: `RegExp` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8614 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/variables/ARGUMENT_OF_TYPE_UNDEFINED_IS_NOT_ASSIGNABLE_TO_PARAMETER_OF_TYPE_1_RE.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/variables/ARGUMENT_OF_TYPE_UNDEFINED_IS_NOT_ASSIGNABLE_TO_PARAMETER_OF_TYPE_1_RE.md new file mode 100644 index 0000000000000000000000000000000000000000..d366412c43f8ad0ac169f6d1f3f591f77f38fd35 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/variables/ARGUMENT_OF_TYPE_UNDEFINED_IS_NOT_ASSIGNABLE_TO_PARAMETER_OF_TYPE_1_RE.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [LibraryTypeCallDiagnosticCheckerNamespace](../README.md) / ARGUMENT\_OF\_TYPE\_UNDEFINED\_IS\_NOT\_ASSIGNABLE\_TO\_PARAMETER\_OF\_TYPE\_1\_RE + +# Variable: ARGUMENT\_OF\_TYPE\_UNDEFINED\_IS\_NOT\_ASSIGNABLE\_TO\_PARAMETER\_OF\_TYPE\_1\_RE + +> `const` **ARGUMENT\_OF\_TYPE\_UNDEFINED\_IS\_NOT\_ASSIGNABLE\_TO\_PARAMETER\_OF\_TYPE\_1\_RE**: `RegExp` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8615 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/variables/NO_OVERLOAD_MATCHES_THIS_CALL_ERROR_CODE.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/variables/NO_OVERLOAD_MATCHES_THIS_CALL_ERROR_CODE.md new file mode 100644 index 0000000000000000000000000000000000000000..4c56fa4fec6404a6ec4cb348a760df063e0926c1 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/variables/NO_OVERLOAD_MATCHES_THIS_CALL_ERROR_CODE.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [LibraryTypeCallDiagnosticCheckerNamespace](../README.md) / NO\_OVERLOAD\_MATCHES\_THIS\_CALL\_ERROR\_CODE + +# Variable: NO\_OVERLOAD\_MATCHES\_THIS\_CALL\_ERROR\_CODE + +> `const` **NO\_OVERLOAD\_MATCHES\_THIS\_CALL\_ERROR\_CODE**: `2769` = `2769` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8616 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/variables/TYPE_0_IS_NOT_ASSIGNABLE_TO_TYPE_1_ERROR_CODE.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/variables/TYPE_0_IS_NOT_ASSIGNABLE_TO_TYPE_1_ERROR_CODE.md new file mode 100644 index 0000000000000000000000000000000000000000..318ccda91df203887ed38ab28f4157677990ce9b --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/variables/TYPE_0_IS_NOT_ASSIGNABLE_TO_TYPE_1_ERROR_CODE.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [LibraryTypeCallDiagnosticCheckerNamespace](../README.md) / TYPE\_0\_IS\_NOT\_ASSIGNABLE\_TO\_TYPE\_1\_ERROR\_CODE + +# Variable: TYPE\_0\_IS\_NOT\_ASSIGNABLE\_TO\_TYPE\_1\_ERROR\_CODE + +> `const` **TYPE\_0\_IS\_NOT\_ASSIGNABLE\_TO\_TYPE\_1\_ERROR\_CODE**: `2322` = `2322` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8609 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/variables/TYPE_NULL_IS_NOT_ASSIGNABLE_TO_TYPE_1_RE.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/variables/TYPE_NULL_IS_NOT_ASSIGNABLE_TO_TYPE_1_RE.md new file mode 100644 index 0000000000000000000000000000000000000000..f1851fb1bbab03e56c27b22a68ca3058fd5c8893 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/variables/TYPE_NULL_IS_NOT_ASSIGNABLE_TO_TYPE_1_RE.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [LibraryTypeCallDiagnosticCheckerNamespace](../README.md) / TYPE\_NULL\_IS\_NOT\_ASSIGNABLE\_TO\_TYPE\_1\_RE + +# Variable: TYPE\_NULL\_IS\_NOT\_ASSIGNABLE\_TO\_TYPE\_1\_RE + +> `const` **TYPE\_NULL\_IS\_NOT\_ASSIGNABLE\_TO\_TYPE\_1\_RE**: `RegExp` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8611 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/variables/TYPE_UNDEFINED_IS_NOT_ASSIGNABLE_TO_TYPE_1_RE.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/variables/TYPE_UNDEFINED_IS_NOT_ASSIGNABLE_TO_TYPE_1_RE.md new file mode 100644 index 0000000000000000000000000000000000000000..137f4590871586b20630da500dd3c787fdacbaff --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/variables/TYPE_UNDEFINED_IS_NOT_ASSIGNABLE_TO_TYPE_1_RE.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [LibraryTypeCallDiagnosticCheckerNamespace](../README.md) / TYPE\_UNDEFINED\_IS\_NOT\_ASSIGNABLE\_TO\_TYPE\_1\_RE + +# Variable: TYPE\_UNDEFINED\_IS\_NOT\_ASSIGNABLE\_TO\_TYPE\_1\_RE + +> `const` **TYPE\_UNDEFINED\_IS\_NOT\_ASSIGNABLE\_TO\_TYPE\_1\_RE**: `RegExp` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8612 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/variables/TYPE_UNKNOWN_IS_NOT_ASSIGNABLE_TO_TYPE_1_RE.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/variables/TYPE_UNKNOWN_IS_NOT_ASSIGNABLE_TO_TYPE_1_RE.md new file mode 100644 index 0000000000000000000000000000000000000000..412161541fd39d11c13126b0c2217b9efbbc6441 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/variables/TYPE_UNKNOWN_IS_NOT_ASSIGNABLE_TO_TYPE_1_RE.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [LibraryTypeCallDiagnosticCheckerNamespace](../README.md) / TYPE\_UNKNOWN\_IS\_NOT\_ASSIGNABLE\_TO\_TYPE\_1\_RE + +# Variable: TYPE\_UNKNOWN\_IS\_NOT\_ASSIGNABLE\_TO\_TYPE\_1\_RE + +> `const` **TYPE\_UNKNOWN\_IS\_NOT\_ASSIGNABLE\_TO\_TYPE\_1\_RE**: `RegExp` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8610 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Problems/README.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Problems/README.md new file mode 100644 index 0000000000000000000000000000000000000000..43a8063f9fc0bc9b67ad0742d4ab1733e06e8624 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Problems/README.md @@ -0,0 +1,19 @@ +[**ArkAnalyzer**](../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../globals.md) / [ts](../../../../README.md) / [ArkTSLinter\_1\_0](../../README.md) / Problems + +# Problems + +## Enumerations + +- [FaultID](enumerations/FaultID.md) + +## Classes + +- [FaultAttributs](classes/FaultAttributs.md) + +## Variables + +- [faultsAttrs](variables/faultsAttrs.md) diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Problems/classes/FaultAttributs.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Problems/classes/FaultAttributs.md new file mode 100644 index 0000000000000000000000000000000000000000..1850dfa5fd4cbc3c4c619770fd6b1afe5b19ba85 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Problems/classes/FaultAttributs.md @@ -0,0 +1,43 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Problems](../README.md) / FaultAttributs + +# Class: FaultAttributs + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8864 + +## Constructors + +### new FaultAttributs() + +> **new FaultAttributs**(): [`FaultAttributs`](FaultAttributs.md) + +#### Returns + +[`FaultAttributs`](FaultAttributs.md) + +## Properties + +### cookBookRef + +> **cookBookRef**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8867 + +*** + +### migratable? + +> `optional` **migratable**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8865 + +*** + +### warning? + +> `optional` **warning**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8866 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Problems/enumerations/FaultID.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Problems/enumerations/FaultID.md new file mode 100644 index 0000000000000000000000000000000000000000..035d9729ad9b00c50353576e72954d2709fd631e --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Problems/enumerations/FaultID.md @@ -0,0 +1,689 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Problems](../README.md) / FaultID + +# Enumeration: FaultID + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8777 + +## Enumeration Members + +### AnyType + +> **AnyType**: `0` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8778 + +*** + +### ArrayLiteralNoContextType + +> **ArrayLiteralNoContextType**: `3` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8781 + +*** + +### CallSignature + +> **CallSignature**: `39` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8817 + +*** + +### CatchWithUnsupportedType + +> **CatchWithUnsupportedType**: `32` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8810 + +*** + +### ClassAsObject + +> **ClassAsObject**: `46` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8824 + +*** + +### ClassExpression + +> **ClassExpression**: `28` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8806 + +*** + +### CommaOperator + +> **CommaOperator**: `25` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8803 + +*** + +### ComputedPropertyName + +> **ComputedPropertyName**: `4` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8782 + +*** + +### ConditionalType + +> **ConditionalType**: `43` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8821 + +*** + +### ConstAssertion + +> **ConstAssertion**: `75` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8853 + +*** + +### ConstructorFuncs + +> **ConstructorFuncs**: `38` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8816 + +*** + +### ConstructorIface + +> **ConstructorIface**: `37` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8815 + +*** + +### ConstructorType + +> **ConstructorType**: `36` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8814 + +*** + +### DeclWithDuplicateName + +> **DeclWithDuplicateName**: `34` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8812 + +*** + +### DefaultImport + +> **DefaultImport**: `59` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8837 + +*** + +### DefiniteAssignment + +> **DefiniteAssignment**: `69` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8847 + +*** + +### DeleteOperator + +> **DeleteOperator**: `33` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8811 + +*** + +### DestructuringAssignment + +> **DestructuringAssignment**: `29` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8807 + +*** + +### DestructuringDeclaration + +> **DestructuringDeclaration**: `30` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8808 + +*** + +### DestructuringParameter + +> **DestructuringParameter**: `9` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8787 + +*** + +### EnumMemberNonConstInit + +> **EnumMemberNonConstInit**: `52` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8830 + +*** + +### EnumMerging + +> **EnumMerging**: `12` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8790 + +*** + +### ErrorSuppression + +> **ErrorSuppression**: `79` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8857 + +*** + +### EsObjectType + +> **EsObjectType**: `83` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8861 + +*** + +### ExportAssignment + +> **ExportAssignment**: `60` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8838 + +*** + +### ForInStatement + +> **ForInStatement**: `19` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8797 + +*** + +### FunctionApplyBindCall + +> **FunctionApplyBindCall**: `74` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8852 + +*** + +### FunctionContainsThis + +> **FunctionContainsThis**: `49` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8827 + +*** + +### FunctionExpression + +> **FunctionExpression**: `22` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8800 + +*** + +### GeneratorFunction + +> **GeneratorFunction**: `48` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8826 + +*** + +### GenericCallNoTypeArgs + +> **GenericCallNoTypeArgs**: `62` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8840 + +*** + +### GlobalThis + +> **GlobalThis**: `71` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8849 + +*** + +### ImplementsClass + +> **ImplementsClass**: `53` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8831 + +*** + +### ImportAfterStatement + +> **ImportAfterStatement**: `82` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8860 + +*** + +### ImportAssertion + +> **ImportAssertion**: `76` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8854 + +*** + +### ImportAssignment + +> **ImportAssignment**: `61` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8839 + +*** + +### ImportFromPath + +> **ImportFromPath**: `21` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8799 + +*** + +### IndexedAccessType + +> **IndexedAccessType**: `17` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8795 + +*** + +### IndexMember + +> **IndexMember**: `14` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8792 + +*** + +### InOperator + +> **InOperator**: `20` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8798 + +*** + +### InstanceofUnsupported + +> **InstanceofUnsupported**: `64` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8842 + +*** + +### IntefaceExtendDifProps + +> **IntefaceExtendDifProps**: `57` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8835 + +*** + +### InterfaceExtendsClass + +> **InterfaceExtendsClass**: `13` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8791 + +*** + +### InterfaceMerging + +> **InterfaceMerging**: `11` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8789 + +*** + +### IntersectionType + +> **IntersectionType**: `23` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8801 + +*** + +### IsOperator + +> **IsOperator**: `8` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8786 + +*** + +### JsxElement + +> **JsxElement**: `51` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8829 + +*** + +### LambdaWithTypeParameters + +> **LambdaWithTypeParameters**: `27` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8805 + +*** + +### LAST\_ID + +> **LAST\_ID**: `84` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8862 + +*** + +### LimitedReturnTypeInference + +> **LimitedReturnTypeInference**: `26` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8804 + +*** + +### LimitedStdLibApi + +> **LimitedStdLibApi**: `78` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8856 + +*** + +### LiteralAsPropertyName + +> **LiteralAsPropertyName**: `5` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8783 + +*** + +### LocalFunction + +> **LocalFunction**: `42` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8820 + +*** + +### MappedType + +> **MappedType**: `44` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8822 + +*** + +### MultipleStaticBlocks + +> **MultipleStaticBlocks**: `55` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8833 + +*** + +### NamespaceAsObject + +> **NamespaceAsObject**: `45` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8823 + +*** + +### NewTarget + +> **NewTarget**: `68` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8846 + +*** + +### NonDeclarationInNamespace + +> **NonDeclarationInNamespace**: `47` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8825 + +*** + +### NoUndefinedPropAccess + +> **NoUndefinedPropAccess**: `54` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8832 + +*** + +### ObjectLiteralNoContextType + +> **ObjectLiteralNoContextType**: `2` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8780 + +*** + +### ObjectTypeLiteral + +> **ObjectTypeLiteral**: `24` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8802 + +*** + +### ParameterProperties + +> **ParameterProperties**: `63` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8841 + +*** + +### PrivateIdentifier + +> **PrivateIdentifier**: `41` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8819 + +*** + +### PropertyAccessByIndex + +> **PropertyAccessByIndex**: `50` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8828 + +*** + +### PropertyDeclOnFunction + +> **PropertyDeclOnFunction**: `73` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8851 + +*** + +### Prototype + +> **Prototype**: `70` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8848 + +*** + +### RegexLiteral + +> **RegexLiteral**: `7` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8785 + +*** + +### ShorthandAmbientModuleDecl + +> **ShorthandAmbientModuleDecl**: `65` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8843 + +*** + +### SpreadOperator + +> **SpreadOperator**: `77` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8855 + +*** + +### StrictDiagnostic + +> **StrictDiagnostic**: `80` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8858 + +*** + +### StructuralIdentity + +> **StructuralIdentity**: `58` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8836 + +*** + +### SymbolType + +> **SymbolType**: `1` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8779 + +*** + +### ThisType + +> **ThisType**: `56` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8834 + +*** + +### ThrowStatement + +> **ThrowStatement**: `16` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8794 + +*** + +### TypeAssertion + +> **TypeAssertion**: `40` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8818 + +*** + +### TypeQuery + +> **TypeQuery**: `6` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8784 + +*** + +### UMDModuleDefinition + +> **UMDModuleDefinition**: `67` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8845 + +*** + +### UnaryArithmNotNumber + +> **UnaryArithmNotNumber**: `35` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8813 + +*** + +### UnknownType + +> **UnknownType**: `18` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8796 + +*** + +### UnsupportedDecorators + +> **UnsupportedDecorators**: `81` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8859 + +*** + +### UtilityType + +> **UtilityType**: `72` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8850 + +*** + +### VarDeclaration + +> **VarDeclaration**: `31` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8809 + +*** + +### WildcardsInModuleName + +> **WildcardsInModuleName**: `66` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8844 + +*** + +### WithStatement + +> **WithStatement**: `15` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8793 + +*** + +### YieldExpression + +> **YieldExpression**: `10` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8788 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Problems/variables/faultsAttrs.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Problems/variables/faultsAttrs.md new file mode 100644 index 0000000000000000000000000000000000000000..571e1b4978b5b9edfc3c7f10f3ca510c646d4e92 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Problems/variables/faultsAttrs.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Problems](../README.md) / faultsAttrs + +# Variable: faultsAttrs + +> `const` **faultsAttrs**: [`FaultAttributs`](../classes/FaultAttributs.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8869 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/README.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/README.md new file mode 100644 index 0000000000000000000000000000000000000000..e7cc23a8a6bed7dddcea78219202f2597a619999 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/README.md @@ -0,0 +1,143 @@ +[**ArkAnalyzer**](../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../globals.md) / [ts](../../../../README.md) / [ArkTSLinter\_1\_0](../../README.md) / Utils + +# Utils + +## Enumerations + +- [CheckType](enumerations/CheckType.md) +- [ProblemSeverity](enumerations/ProblemSeverity.md) + +## Variables + +- [ALLOWED\_STD\_SYMBOL\_API](variables/ALLOWED_STD_SYMBOL_API.md) +- [ARKTS\_IGNORE\_DIRS](variables/ARKTS_IGNORE_DIRS.md) +- [ARKTS\_IGNORE\_FILES](variables/ARKTS_IGNORE_FILES.md) +- [ARKUI\_DECORATORS](variables/ARKUI_DECORATORS.md) +- [ES\_OBJECT](variables/ES_OBJECT.md) +- [FUNCTION\_HAS\_NO\_RETURN\_ERROR\_CODE](variables/FUNCTION_HAS_NO_RETURN_ERROR_CODE.md) +- [LIMITED\_STANDARD\_UTILITY\_TYPES](variables/LIMITED_STANDARD_UTILITY_TYPES.md) +- [LIMITED\_STD\_GLOBAL\_FUNC](variables/LIMITED_STD_GLOBAL_FUNC.md) +- [LIMITED\_STD\_OBJECT\_API](variables/LIMITED_STD_OBJECT_API.md) +- [LIMITED\_STD\_PROXYHANDLER\_API](variables/LIMITED_STD_PROXYHANDLER_API.md) +- [LIMITED\_STD\_REFLECT\_API](variables/LIMITED_STD_REFLECT_API.md) +- [NON\_INITIALIZABLE\_PROPERTY\_ClASS\_DECORATORS](variables/NON_INITIALIZABLE_PROPERTY_ClASS_DECORATORS.md) +- [NON\_INITIALIZABLE\_PROPERTY\_DECORATORS](variables/NON_INITIALIZABLE_PROPERTY_DECORATORS.md) +- [NON\_RETURN\_FUNCTION\_DECORATORS](variables/NON_RETURN_FUNCTION_DECORATORS.md) +- [PROPERTY\_HAS\_NO\_INITIALIZER\_ERROR\_CODE](variables/PROPERTY_HAS_NO_INITIALIZER_ERROR_CODE.md) +- [STANDARD\_LIBRARIES](variables/STANDARD_LIBRARIES.md) +- [TYPED\_ARRAYS](variables/TYPED_ARRAYS.md) + +## Functions + +- [clearTrueSymbolAtLocationCache](functions/clearTrueSymbolAtLocationCache.md) +- [clearTypeChecker](functions/clearTypeChecker.md) +- [decodeAutofixInfo](functions/decodeAutofixInfo.md) +- [encodeProblemInfo](functions/encodeProblemInfo.md) +- [entityNameToString](functions/entityNameToString.md) +- [findParentIf](functions/findParentIf.md) +- [followIfAliased](functions/followIfAliased.md) +- [getAccessModifier](functions/getAccessModifier.md) +- [getDeclaration](functions/getDeclaration.md) +- [getEndPos](functions/getEndPos.md) +- [getModifier](functions/getModifier.md) +- [getParentSymbolName](functions/getParentSymbolName.md) +- [getScriptKind](functions/getScriptKind.md) +- [getStartPos](functions/getStartPos.md) +- [getSymbolDeclarationTypeNode](functions/getSymbolDeclarationTypeNode.md) +- [getSymbolOfCallExpression](functions/getSymbolOfCallExpression.md) +- [getVariableDeclarationTypeNode](functions/getVariableDeclarationTypeNode.md) +- [hasAccessModifier](functions/hasAccessModifier.md) +- [hasEsObjectType](functions/hasEsObjectType.md) +- [hasLibraryType](functions/hasLibraryType.md) +- [hasMethods](functions/hasMethods.md) +- [hasModifier](functions/hasModifier.md) +- [hasPredecessor](functions/hasPredecessor.md) +- [isAnonymousType](functions/isAnonymousType.md) +- [isAnyType](functions/isAnyType.md) +- [isAssignmentOperator](functions/isAssignmentOperator.md) +- [isBooleanType](functions/isBooleanType.md) +- [isCallToFunctionWithOmittedReturnType](functions/isCallToFunctionWithOmittedReturnType.md) +- [isCompileTimeExpression](functions/isCompileTimeExpression.md) +- [isConst](functions/isConst.md) +- [isDefaultImport](functions/isDefaultImport.md) +- [isDerivedFrom](functions/isDerivedFrom.md) +- [isDestructuringAssignmentLHS](functions/isDestructuringAssignmentLHS.md) +- [isDynamicLiteralInitializer](functions/isDynamicLiteralInitializer.md) +- [isDynamicType](functions/isDynamicType.md) +- [isEnumMemberType](functions/isEnumMemberType.md) +- [isEnumType](functions/isEnumType.md) +- [isEsObjectPossiblyAllowed](functions/isEsObjectPossiblyAllowed.md) +- [isEsObjectSymbol](functions/isEsObjectSymbol.md) +- [isEsObjectType](functions/isEsObjectType.md) +- [isExpressionAssignableToType](functions/isExpressionAssignableToType.md) +- [isFunctionOrMethod](functions/isFunctionOrMethod.md) +- [isFunctionSymbol](functions/isFunctionSymbol.md) +- [isGenericArrayType](functions/isGenericArrayType.md) +- [isGlobalSymbol](functions/isGlobalSymbol.md) +- [isInsideBlock](functions/isInsideBlock.md) +- [isIntegerConstantValue](functions/isIntegerConstantValue.md) +- [isInterfaceType](functions/isInterfaceType.md) +- [isIntrinsicObjectType](functions/isIntrinsicObjectType.md) +- [isLibrarySymbol](functions/isLibrarySymbol.md) +- [isLibraryType](functions/isLibraryType.md) +- [isLiteralType](functions/isLiteralType.md) +- [isMethodAssignment](functions/isMethodAssignment.md) +- [isNullType](functions/isNullType.md) +- [isNumberConstantValue](functions/isNumberConstantValue.md) +- [isNumberLikeType](functions/isNumberLikeType.md) +- [isNumberType](functions/isNumberType.md) +- [isObjectLiteralType](functions/isObjectLiteralType.md) +- [isObjectType](functions/isObjectType.md) +- [isPrimitiveEnumMemberType](functions/isPrimitiveEnumMemberType.md) +- [isPrimitiveEnumType](functions/isPrimitiveEnumType.md) +- [isPrimitiveType](functions/isPrimitiveType.md) +- [isPrototypeSymbol](functions/isPrototypeSymbol.md) +- [isReferenceType](functions/isReferenceType.md) +- [isStdLibrarySymbol](functions/isStdLibrarySymbol.md) +- [isStdLibraryType](functions/isStdLibraryType.md) +- [isStdPartialType](functions/isStdPartialType.md) +- [isStdReadonlyType](functions/isStdReadonlyType.md) +- [isStdRecordType](functions/isStdRecordType.md) +- [isStdRequiredType](functions/isStdRequiredType.md) +- [isStdSymbol](functions/isStdSymbol.md) +- [isStringConstantValue](functions/isStringConstantValue.md) +- [isStringLikeType](functions/isStringLikeType.md) +- [isStringType](functions/isStringType.md) +- [isStruct](functions/isStruct.md) +- [isStructDeclaration](functions/isStructDeclaration.md) +- [isStructDeclarationKind](functions/isStructDeclarationKind.md) +- [isStructObjectInitializer](functions/isStructObjectInitializer.md) +- [isSupportedType](functions/isSupportedType.md) +- [isSymbolAPI](functions/isSymbolAPI.md) +- [isSymbolIterator](functions/isSymbolIterator.md) +- [isThisOrSuperExpr](functions/isThisOrSuperExpr.md) +- [isType](functions/isType.md) +- [isTypedArray](functions/isTypedArray.md) +- [isTypeDeclSyntaxKind](functions/isTypeDeclSyntaxKind.md) +- [isTypeReference](functions/isTypeReference.md) +- [isTypeSymbol](functions/isTypeSymbol.md) +- [isUnknownType](functions/isUnknownType.md) +- [isUnsupportedType](functions/isUnsupportedType.md) +- [isUnsupportedUnionType](functions/isUnsupportedUnionType.md) +- [isValidEnumMemberInit](functions/isValidEnumMemberInit.md) +- [isValueAssignableToESObject](functions/isValueAssignableToESObject.md) +- [logTscDiagnostic](functions/logTscDiagnostic.md) +- [needToDeduceStructuralIdentity](functions/needToDeduceStructuralIdentity.md) +- [pathContainsDirectory](functions/pathContainsDirectory.md) +- [processParentTypes](functions/processParentTypes.md) +- [processParentTypesCheck](functions/processParentTypesCheck.md) +- [relatedByInheritanceOrIdentical](functions/relatedByInheritanceOrIdentical.md) +- [setTestMode](functions/setTestMode.md) +- [setTypeChecker](functions/setTypeChecker.md) +- [symbolHasDuplicateName](functions/symbolHasDuplicateName.md) +- [symbolHasEsObjectType](functions/symbolHasEsObjectType.md) +- [trueSymbolAtLocation](functions/trueSymbolAtLocation.md) +- [typeIsRecursive](functions/typeIsRecursive.md) +- [unwrapParenthesized](functions/unwrapParenthesized.md) +- [unwrapParenthesizedType](functions/unwrapParenthesizedType.md) +- [validateFields](functions/validateFields.md) +- [validateObjectLiteralType](functions/validateObjectLiteralType.md) diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/enumerations/CheckType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/enumerations/CheckType.md new file mode 100644 index 0000000000000000000000000000000000000000..471c39f18342cb8df1c064000a9ef12b715ce83e --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/enumerations/CheckType.md @@ -0,0 +1,49 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / CheckType + +# Enumeration: CheckType + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8719 + +## Enumeration Members + +### Array + +> **Array**: `0` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8720 + +*** + +### Error + +> **Error**: `"Error"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8724 + +*** + +### Map + +> **Map**: `"Map"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8723 + +*** + +### Set + +> **Set**: `"Set"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8722 + +*** + +### String + +> **String**: `"String"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8721 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/enumerations/ProblemSeverity.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/enumerations/ProblemSeverity.md new file mode 100644 index 0000000000000000000000000000000000000000..4298573c1a96a4f13a5d676667793e294ec0a03b --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/enumerations/ProblemSeverity.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / ProblemSeverity + +# Enumeration: ProblemSeverity + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8640 + +## Enumeration Members + +### ERROR + +> **ERROR**: `2` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8642 + +*** + +### WARNING + +> **WARNING**: `1` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8641 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/clearTrueSymbolAtLocationCache.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/clearTrueSymbolAtLocationCache.md new file mode 100644 index 0000000000000000000000000000000000000000..59882581adb9e21e3bcb2d3fefbd836ffb2c5b5e --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/clearTrueSymbolAtLocationCache.md @@ -0,0 +1,15 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / clearTrueSymbolAtLocationCache + +# Function: clearTrueSymbolAtLocationCache() + +> **clearTrueSymbolAtLocationCache**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8672 + +## Returns + +`void` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/clearTypeChecker.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/clearTypeChecker.md new file mode 100644 index 0000000000000000000000000000000000000000..b86d915ca2bea2911634ff53508353d6766f8c58 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/clearTypeChecker.md @@ -0,0 +1,15 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / clearTypeChecker + +# Function: clearTypeChecker() + +> **clearTypeChecker**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8647 + +## Returns + +`void` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/decodeAutofixInfo.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/decodeAutofixInfo.md new file mode 100644 index 0000000000000000000000000000000000000000..2ae2b9be06f29ed62b581d521b1caf104645ce9e --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/decodeAutofixInfo.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / decodeAutofixInfo + +# Function: decodeAutofixInfo() + +> **decodeAutofixInfo**(`info`): [`AutofixInfo`](../../Common/interfaces/AutofixInfo.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8707 + +## Parameters + +### info + +`string` + +## Returns + +[`AutofixInfo`](../../Common/interfaces/AutofixInfo.md) diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/encodeProblemInfo.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/encodeProblemInfo.md new file mode 100644 index 0000000000000000000000000000000000000000..29527dec5968b967565b55080de81c7f9a111060 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/encodeProblemInfo.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / encodeProblemInfo + +# Function: encodeProblemInfo() + +> **encodeProblemInfo**(`problem`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8706 + +## Parameters + +### problem + +[`ProblemInfo`](../../../interfaces/ProblemInfo.md) + +## Returns + +`string` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/entityNameToString.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/entityNameToString.md new file mode 100644 index 0000000000000000000000000000000000000000..1da0915890664b59dc0548e58732df3883d7531b --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/entityNameToString.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / entityNameToString + +# Function: entityNameToString() + +> **entityNameToString**(`name`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8654 + +## Parameters + +### name + +[`EntityName`](../../../../../type-aliases/EntityName.md) + +## Returns + +`string` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/findParentIf.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/findParentIf.md new file mode 100644 index 0000000000000000000000000000000000000000..997f65caff6f8baed6e6e3838e9938d98f382dea --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/findParentIf.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / findParentIf + +# Function: findParentIf() + +> **findParentIf**(`asExpr`): `null` \| [`IfStatement`](../../../../../interfaces/IfStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8662 + +## Parameters + +### asExpr + +[`AsExpression`](../../../../../interfaces/AsExpression.md) + +## Returns + +`null` \| [`IfStatement`](../../../../../interfaces/IfStatement.md) diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/followIfAliased.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/followIfAliased.md new file mode 100644 index 0000000000000000000000000000000000000000..24b5fb0de1a7f01c9b076d628ad9a873f7581cfa --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/followIfAliased.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / followIfAliased + +# Function: followIfAliased() + +> **followIfAliased**(`sym`): [`Symbol`](../../../../../interfaces/Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8670 + +## Parameters + +### sym + +[`Symbol`](../../../../../interfaces/Symbol.md) + +## Returns + +[`Symbol`](../../../../../interfaces/Symbol.md) diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/getAccessModifier.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/getAccessModifier.md new file mode 100644 index 0000000000000000000000000000000000000000..7fe889704dd1351ea385871fce44339d7d007c63 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/getAccessModifier.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / getAccessModifier + +# Function: getAccessModifier() + +> **getAccessModifier**(`modifiers`): `undefined` \| [`Modifier`](../../../../../type-aliases/Modifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8744 + +## Parameters + +### modifiers + +`undefined` | readonly [`Modifier`](../../../../../type-aliases/Modifier.md)[] + +## Returns + +`undefined` \| [`Modifier`](../../../../../type-aliases/Modifier.md) diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/getDeclaration.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/getDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..0ea0d73b77e579dbbe9e868834810ad623195364 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/getDeclaration.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / getDeclaration + +# Function: getDeclaration() + +> **getDeclaration**(`tsSymbol`): `undefined` \| [`Declaration`](../../../../../interfaces/Declaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8692 + +## Parameters + +### tsSymbol + +`undefined` | [`Symbol`](../../../../../interfaces/Symbol.md) + +## Returns + +`undefined` \| [`Declaration`](../../../../../interfaces/Declaration.md) diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/getEndPos.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/getEndPos.md new file mode 100644 index 0000000000000000000000000000000000000000..544a7eecd961caaa537f26d8ce23f3aaeaf8bb24 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/getEndPos.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / getEndPos + +# Function: getEndPos() + +> **getEndPos**(`nodeOrComment`): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8650 + +## Parameters + +### nodeOrComment + +[`Node`](../../../../../interfaces/Node.md) | [`CommentRange`](../../../../../interfaces/CommentRange.md) + +## Returns + +`number` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/getModifier.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/getModifier.md new file mode 100644 index 0000000000000000000000000000000000000000..0a680d9a60cc50afe60fd9e8adb0be91bcb4db0d --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/getModifier.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / getModifier + +# Function: getModifier() + +> **getModifier**(`modifiers`, `modifierKind`): `undefined` \| [`Modifier`](../../../../../type-aliases/Modifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8743 + +## Parameters + +### modifiers + +`undefined` | readonly [`Modifier`](../../../../../type-aliases/Modifier.md)[] + +### modifierKind + +[`SyntaxKind`](../../../../../enumerations/SyntaxKind.md) + +## Returns + +`undefined` \| [`Modifier`](../../../../../type-aliases/Modifier.md) diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/getParentSymbolName.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/getParentSymbolName.md new file mode 100644 index 0000000000000000000000000000000000000000..3b9a4abdc5d9c473282273ae002d9ef07b64ea47 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/getParentSymbolName.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / getParentSymbolName + +# Function: getParentSymbolName() + +> **getParentSymbolName**(`symbol`): `undefined` \| `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8736 + +## Parameters + +### symbol + +[`Symbol`](../../../../../interfaces/Symbol.md) + +## Returns + +`undefined` \| `string` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/getScriptKind.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/getScriptKind.md new file mode 100644 index 0000000000000000000000000000000000000000..8dbdeba65648afc7a01ac68c3b7e009f6ebb3cb0 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/getScriptKind.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / getScriptKind + +# Function: getScriptKind() + +> **getScriptKind**(`srcFile`): [`ScriptKind`](../../../../../enumerations/ScriptKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8753 + +## Parameters + +### srcFile + +[`SourceFile`](../../../../../interfaces/SourceFile.md) + +## Returns + +[`ScriptKind`](../../../../../enumerations/ScriptKind.md) diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/getStartPos.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/getStartPos.md new file mode 100644 index 0000000000000000000000000000000000000000..5d97c5cb3921b43e9bbf9406f6568395ecd38b23 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/getStartPos.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / getStartPos + +# Function: getStartPos() + +> **getStartPos**(`nodeOrComment`): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8649 + +## Parameters + +### nodeOrComment + +[`Node`](../../../../../interfaces/Node.md) | [`CommentRange`](../../../../../interfaces/CommentRange.md) + +## Returns + +`number` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/getSymbolDeclarationTypeNode.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/getSymbolDeclarationTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..9af8a90b8c9cf8ad8e1c728d133527b34baf166d --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/getSymbolDeclarationTypeNode.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / getSymbolDeclarationTypeNode + +# Function: getSymbolDeclarationTypeNode() + +> **getSymbolDeclarationTypeNode**(`sym`): `undefined` \| [`TypeNode`](../../../../../interfaces/TypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8764 + +## Parameters + +### sym + +[`Symbol`](../../../../../interfaces/Symbol.md) + +## Returns + +`undefined` \| [`TypeNode`](../../../../../interfaces/TypeNode.md) diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/getSymbolOfCallExpression.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/getSymbolOfCallExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..b3d379e1babb0edd122595dc6c2338f469bcedff --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/getSymbolOfCallExpression.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / getSymbolOfCallExpression + +# Function: getSymbolOfCallExpression() + +> **getSymbolOfCallExpression**(`callExpr`): `undefined` \| [`Symbol`](../../../../../interfaces/Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8769 + +## Parameters + +### callExpr + +[`CallExpression`](../../../../../interfaces/CallExpression.md) + +## Returns + +`undefined` \| [`Symbol`](../../../../../interfaces/Symbol.md) diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/getVariableDeclarationTypeNode.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/getVariableDeclarationTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..dbe31ebbddbda581e8f1adbc04609f6bb6d199a8 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/getVariableDeclarationTypeNode.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / getVariableDeclarationTypeNode + +# Function: getVariableDeclarationTypeNode() + +> **getVariableDeclarationTypeNode**(`node`): `undefined` \| [`TypeNode`](../../../../../interfaces/TypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8763 + +## Parameters + +### node + +[`Node`](../../../../../interfaces/Node.md) + +## Returns + +`undefined` \| [`TypeNode`](../../../../../interfaces/TypeNode.md) diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/hasAccessModifier.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/hasAccessModifier.md new file mode 100644 index 0000000000000000000000000000000000000000..3d412cc26f14a3aba17857244a057981fb422f83 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/hasAccessModifier.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / hasAccessModifier + +# Function: hasAccessModifier() + +> **hasAccessModifier**(`decl`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8742 + +## Parameters + +### decl + +[`Declaration`](../../../../../interfaces/Declaration.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/hasEsObjectType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/hasEsObjectType.md new file mode 100644 index 0000000000000000000000000000000000000000..df88f3c206e263aebab2978eec0b848a37c678e2 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/hasEsObjectType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / hasEsObjectType + +# Function: hasEsObjectType() + +> **hasEsObjectType**(`node`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8765 + +## Parameters + +### node + +[`Node`](../../../../../interfaces/Node.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/hasLibraryType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/hasLibraryType.md new file mode 100644 index 0000000000000000000000000000000000000000..ad8220a5902dd07f0860415fdfb6c17d8184eb45 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/hasLibraryType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / hasLibraryType + +# Function: hasLibraryType() + +> **hasLibraryType**(`node`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8750 + +## Parameters + +### node + +[`Node`](../../../../../interfaces/Node.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/hasMethods.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/hasMethods.md new file mode 100644 index 0000000000000000000000000000000000000000..84c08298e0a5f6316978f7bd8a2acfd8e201107b --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/hasMethods.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / hasMethods + +# Function: hasMethods() + +> **hasMethods**(`type`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8713 + +## Parameters + +### type + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/hasModifier.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/hasModifier.md new file mode 100644 index 0000000000000000000000000000000000000000..6d7317543186cd06059a50672f166fb8ad583375 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/hasModifier.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / hasModifier + +# Function: hasModifier() + +> **hasModifier**(`tsModifiers`, `tsModifierKind`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8668 + +## Parameters + +### tsModifiers + +`undefined` | readonly [`Modifier`](../../../../../type-aliases/Modifier.md)[] + +### tsModifierKind + +`number` + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/hasPredecessor.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/hasPredecessor.md new file mode 100644 index 0000000000000000000000000000000000000000..62ab54c1bef51cf01b172fd5293817c806b784dc --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/hasPredecessor.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / hasPredecessor + +# Function: hasPredecessor() + +> **hasPredecessor**(`node`, `predicate`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8701 + +## Parameters + +### node + +[`Node`](../../../../../interfaces/Node.md) + +### predicate + +(`node`) => `boolean` + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isAnonymousType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isAnonymousType.md new file mode 100644 index 0000000000000000000000000000000000000000..19053d258d1c2bb02894632e1bfab9da3a2610ff --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isAnonymousType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isAnonymousType + +# Function: isAnonymousType() + +> **isAnonymousType**(`type`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8768 + +## Parameters + +### type + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isAnyType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isAnyType.md new file mode 100644 index 0000000000000000000000000000000000000000..8c4df503b5d19b9a5194b9150e56130ddc389242 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isAnyType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isAnyType + +# Function: isAnyType() + +> **isAnyType**(`tsType`): `tsType is TypeReference` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8686 + +## Parameters + +### tsType + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`tsType is TypeReference` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isAssignmentOperator.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isAssignmentOperator.md new file mode 100644 index 0000000000000000000000000000000000000000..dee56262640209f7defbb016419220f74285b31c --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isAssignmentOperator.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isAssignmentOperator + +# Function: isAssignmentOperator() + +> **isAssignmentOperator**(`tsBinOp`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8651 + +## Parameters + +### tsBinOp + +[`BinaryOperatorToken`](../../../../../type-aliases/BinaryOperatorToken.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isBooleanType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isBooleanType.md new file mode 100644 index 0000000000000000000000000000000000000000..c310b332303d866cb10c96fd21bc1b3dddcbf87f --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isBooleanType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isBooleanType + +# Function: isBooleanType() + +> **isBooleanType**(`tsType`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8656 + +## Parameters + +### tsType + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isCallToFunctionWithOmittedReturnType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isCallToFunctionWithOmittedReturnType.md new file mode 100644 index 0000000000000000000000000000000000000000..e6d25307cbb0e7aba9b98bc072b1a5baf99ec1f7 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isCallToFunctionWithOmittedReturnType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isCallToFunctionWithOmittedReturnType + +# Function: isCallToFunctionWithOmittedReturnType() + +> **isCallToFunctionWithOmittedReturnType**(`tsExpr`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8708 + +## Parameters + +### tsExpr + +[`Expression`](../../../../../interfaces/Expression.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isCompileTimeExpression.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isCompileTimeExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..43182fbdb2052f12518e393a75dd3d26ce9f33e0 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isCompileTimeExpression.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isCompileTimeExpression + +# Function: isCompileTimeExpression() + +> **isCompileTimeExpression**(`tsExpr`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8694 + +## Parameters + +### tsExpr + +[`Expression`](../../../../../interfaces/Expression.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isConst.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isConst.md new file mode 100644 index 0000000000000000000000000000000000000000..a47ed9aa739294f84c55dc25816f4090e08cfe8c --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isConst.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isConst + +# Function: isConst() + +> **isConst**(`tsNode`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8695 + +## Parameters + +### tsNode + +[`Node`](../../../../../interfaces/Node.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isDefaultImport.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isDefaultImport.md new file mode 100644 index 0000000000000000000000000000000000000000..a3f69af7a4c172af81d4bdab1119943452d56de8 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isDefaultImport.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isDefaultImport + +# Function: isDefaultImport() + +> **isDefaultImport**(`importSpec`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8741 + +## Parameters + +### importSpec + +[`ImportSpecifier`](../../../../../interfaces/ImportSpecifier.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isDerivedFrom.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isDerivedFrom.md new file mode 100644 index 0000000000000000000000000000000000000000..ad24b3ad4d10f35ad4a3093843be65cf31207a58 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isDerivedFrom.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isDerivedFrom + +# Function: isDerivedFrom() + +> **isDerivedFrom**(`tsType`, `checkType`): `tsType is TypeReference` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8679 + +## Parameters + +### tsType + +[`Type`](../../../../../interfaces/Type.md) + +### checkType + +[`CheckType`](../enumerations/CheckType.md) + +## Returns + +`tsType is TypeReference` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isDestructuringAssignmentLHS.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isDestructuringAssignmentLHS.md new file mode 100644 index 0000000000000000000000000000000000000000..55149ff3bfb21ba93a8c1e1fe0751e90278ff312 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isDestructuringAssignmentLHS.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isDestructuringAssignmentLHS + +# Function: isDestructuringAssignmentLHS() + +> **isDestructuringAssignmentLHS**(`tsExpr`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8663 + +## Parameters + +### tsExpr + +[`ObjectLiteralExpression`](../../../../../interfaces/ObjectLiteralExpression.md) | [`ArrayLiteralExpression`](../../../../../interfaces/ArrayLiteralExpression.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isDynamicLiteralInitializer.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isDynamicLiteralInitializer.md new file mode 100644 index 0000000000000000000000000000000000000000..8db08d4edf67012049fb64ba59eb651d93c080d6 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isDynamicLiteralInitializer.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isDynamicLiteralInitializer + +# Function: isDynamicLiteralInitializer() + +> **isDynamicLiteralInitializer**(`expr`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8758 + +## Parameters + +### expr + +[`Expression`](../../../../../interfaces/Expression.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isDynamicType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isDynamicType.md new file mode 100644 index 0000000000000000000000000000000000000000..cf8eb62baf6b972c0f3c77e83985a307e44f3ad7 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isDynamicType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isDynamicType + +# Function: isDynamicType() + +> **isDynamicType**(`type`): `undefined` \| `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8757 + +## Parameters + +### type + +`undefined` | [`Type`](../../../../../interfaces/Type.md) + +## Returns + +`undefined` \| `boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isEnumMemberType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isEnumMemberType.md new file mode 100644 index 0000000000000000000000000000000000000000..d5ca19c6b46400f1410feaf28f2730fafeb2777d --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isEnumMemberType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isEnumMemberType + +# Function: isEnumMemberType() + +> **isEnumMemberType**(`tsType`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8665 + +## Parameters + +### tsType + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isEnumType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isEnumType.md new file mode 100644 index 0000000000000000000000000000000000000000..d15d31ad921747213218b8e0b1fb927cf57f8d60 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isEnumType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isEnumType + +# Function: isEnumType() + +> **isEnumType**(`tsType`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8664 + +## Parameters + +### tsType + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isEsObjectPossiblyAllowed.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isEsObjectPossiblyAllowed.md new file mode 100644 index 0000000000000000000000000000000000000000..863c70adad4ae7509ee6d9ad6268c2c09dd67086 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isEsObjectPossiblyAllowed.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isEsObjectPossiblyAllowed + +# Function: isEsObjectPossiblyAllowed() + +> **isEsObjectPossiblyAllowed**(`typeRef`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8761 + +## Parameters + +### typeRef + +[`TypeReferenceNode`](../../../../../interfaces/TypeReferenceNode.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isEsObjectSymbol.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isEsObjectSymbol.md new file mode 100644 index 0000000000000000000000000000000000000000..e9efe01918f91d44e0396bc597fbaeaa5ceb1448 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isEsObjectSymbol.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isEsObjectSymbol + +# Function: isEsObjectSymbol() + +> **isEsObjectSymbol**(`sym`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8767 + +## Parameters + +### sym + +[`Symbol`](../../../../../interfaces/Symbol.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isEsObjectType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isEsObjectType.md new file mode 100644 index 0000000000000000000000000000000000000000..054fbfc09e6fcf71a31bc6a57e68ee5c104ff2f5 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isEsObjectType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isEsObjectType + +# Function: isEsObjectType() + +> **isEsObjectType**(`typeNode`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8759 + +## Parameters + +### typeNode + +[`TypeNode`](../../../../../interfaces/TypeNode.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isExpressionAssignableToType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isExpressionAssignableToType.md new file mode 100644 index 0000000000000000000000000000000000000000..635cef7974d467cd0f19f4901267260eea87efa9 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isExpressionAssignableToType.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isExpressionAssignableToType + +# Function: isExpressionAssignableToType() + +> **isExpressionAssignableToType**(`lhsType`, `rhsExpr`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8714 + +## Parameters + +### lhsType + +`undefined` | [`Type`](../../../../../interfaces/Type.md) + +### rhsExpr + +[`Expression`](../../../../../interfaces/Expression.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isFunctionOrMethod.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isFunctionOrMethod.md new file mode 100644 index 0000000000000000000000000000000000000000..855d351367537f281d108302ee412b8e0e2a779b --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isFunctionOrMethod.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isFunctionOrMethod + +# Function: isFunctionOrMethod() + +> **isFunctionOrMethod**(`tsSymbol`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8690 + +## Parameters + +### tsSymbol + +`undefined` | [`Symbol`](../../../../../interfaces/Symbol.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isFunctionSymbol.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isFunctionSymbol.md new file mode 100644 index 0000000000000000000000000000000000000000..d9aaceef8a221ef163bf2f84fe67012fc9ad5857 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isFunctionSymbol.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isFunctionSymbol + +# Function: isFunctionSymbol() + +> **isFunctionSymbol**(`symbol`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8684 + +## Parameters + +### symbol + +`undefined` | [`Symbol`](../../../../../interfaces/Symbol.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isGenericArrayType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isGenericArrayType.md new file mode 100644 index 0000000000000000000000000000000000000000..54fa7f2bd960599971ce01935e12994a03bbb222 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isGenericArrayType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isGenericArrayType + +# Function: isGenericArrayType() + +> **isGenericArrayType**(`tsType`): `tsType is TypeReference` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8678 + +## Parameters + +### tsType + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`tsType is TypeReference` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isGlobalSymbol.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isGlobalSymbol.md new file mode 100644 index 0000000000000000000000000000000000000000..bb7dce3e7297764f169f870dd5c799cd4ae802f2 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isGlobalSymbol.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isGlobalSymbol + +# Function: isGlobalSymbol() + +> **isGlobalSymbol**(`symbol`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8737 + +## Parameters + +### symbol + +[`Symbol`](../../../../../interfaces/Symbol.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isInsideBlock.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isInsideBlock.md new file mode 100644 index 0000000000000000000000000000000000000000..901d1da98e36ee91e8dfb62416ab9a77fd960403 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isInsideBlock.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isInsideBlock + +# Function: isInsideBlock() + +> **isInsideBlock**(`node`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8760 + +## Parameters + +### node + +[`Node`](../../../../../interfaces/Node.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isIntegerConstantValue.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isIntegerConstantValue.md new file mode 100644 index 0000000000000000000000000000000000000000..bc9448a796f66774168db7ded89f6eaf46b49a89 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isIntegerConstantValue.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isIntegerConstantValue + +# Function: isIntegerConstantValue() + +> **isIntegerConstantValue**(`tsExpr`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8697 + +## Parameters + +### tsExpr + +[`EnumMember`](../../../../../interfaces/EnumMember.md) | [`NumericLiteral`](../../../../../interfaces/NumericLiteral.md) | [`PropertyAccessExpression`](../../../../../interfaces/PropertyAccessExpression.md) | [`ElementAccessExpression`](../../../../../interfaces/ElementAccessExpression.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isInterfaceType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isInterfaceType.md new file mode 100644 index 0000000000000000000000000000000000000000..d5a112422c911ffe7ba9acd50ed859b4c456c609 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isInterfaceType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isInterfaceType + +# Function: isInterfaceType() + +> **isInterfaceType**(`tsType`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8685 + +## Parameters + +### tsType + +`undefined` | [`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isIntrinsicObjectType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isIntrinsicObjectType.md new file mode 100644 index 0000000000000000000000000000000000000000..e0d11247aa363d5c790610eeb97c4846215d5f56 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isIntrinsicObjectType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isIntrinsicObjectType + +# Function: isIntrinsicObjectType() + +> **isIntrinsicObjectType**(`type`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8756 + +## Parameters + +### type + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isLibrarySymbol.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isLibrarySymbol.md new file mode 100644 index 0000000000000000000000000000000000000000..ba4a510734300f8aeea2eb597a1a4a4af047591a --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isLibrarySymbol.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isLibrarySymbol + +# Function: isLibrarySymbol() + +> **isLibrarySymbol**(`sym`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8751 + +## Parameters + +### sym + +`undefined` | [`Symbol`](../../../../../interfaces/Symbol.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isLibraryType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isLibraryType.md new file mode 100644 index 0000000000000000000000000000000000000000..57c04c581c9bb4fca406fa59719fe665701d8bbb --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isLibraryType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isLibraryType + +# Function: isLibraryType() + +> **isLibraryType**(`type`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8749 + +## Parameters + +### type + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isLiteralType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isLiteralType.md new file mode 100644 index 0000000000000000000000000000000000000000..5dc33b7c5ba6bd00eb3f0639322e326f1e084b1a --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isLiteralType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isLiteralType + +# Function: isLiteralType() + +> **isLiteralType**(`type`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8715 + +## Parameters + +### type + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isMethodAssignment.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isMethodAssignment.md new file mode 100644 index 0000000000000000000000000000000000000000..233bd071404cb2731e0262f1b649e03714e628f1 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isMethodAssignment.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isMethodAssignment + +# Function: isMethodAssignment() + +> **isMethodAssignment**(`tsSymbol`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8691 + +## Parameters + +### tsSymbol + +`undefined` | [`Symbol`](../../../../../interfaces/Symbol.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isNullType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isNullType.md new file mode 100644 index 0000000000000000000000000000000000000000..894fe0778598fca8ed9dee12625235cc49a09cfb --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isNullType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isNullType + +# Function: isNullType() + +> **isNullType**(`tsTypeNode`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8681 + +## Parameters + +### tsTypeNode + +[`TypeNode`](../../../../../interfaces/TypeNode.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isNumberConstantValue.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isNumberConstantValue.md new file mode 100644 index 0000000000000000000000000000000000000000..0a673625b66169a7ac4cc49fb79f40b1eeb005a0 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isNumberConstantValue.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isNumberConstantValue + +# Function: isNumberConstantValue() + +> **isNumberConstantValue**(`tsExpr`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8696 + +## Parameters + +### tsExpr + +[`EnumMember`](../../../../../interfaces/EnumMember.md) | [`NumericLiteral`](../../../../../interfaces/NumericLiteral.md) | [`PropertyAccessExpression`](../../../../../interfaces/PropertyAccessExpression.md) | [`ElementAccessExpression`](../../../../../interfaces/ElementAccessExpression.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isNumberLikeType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isNumberLikeType.md new file mode 100644 index 0000000000000000000000000000000000000000..c42b1332b45857086ea2d9d8ff7a838a64e9ce2c --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isNumberLikeType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isNumberLikeType + +# Function: isNumberLikeType() + +> **isNumberLikeType**(`tsType`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8667 + +## Parameters + +### tsType + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isNumberType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isNumberType.md new file mode 100644 index 0000000000000000000000000000000000000000..4da77bf3a724da2e1e71345202d4f488f7498f2a --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isNumberType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isNumberType + +# Function: isNumberType() + +> **isNumberType**(`tsType`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8655 + +## Parameters + +### tsType + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isObjectLiteralType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isObjectLiteralType.md new file mode 100644 index 0000000000000000000000000000000000000000..54972933535e5dcf2f2575d58fbae125159e2ef4 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isObjectLiteralType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isObjectLiteralType + +# Function: isObjectLiteralType() + +> **isObjectLiteralType**(`tsType`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8666 + +## Parameters + +### tsType + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isObjectType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isObjectType.md new file mode 100644 index 0000000000000000000000000000000000000000..0ea33096032db5928b5922f58c3ccf0d36287ef6 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isObjectType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isObjectType + +# Function: isObjectType() + +> **isObjectType**(`tsType`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8704 + +## Parameters + +### tsType + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isPrimitiveEnumMemberType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isPrimitiveEnumMemberType.md new file mode 100644 index 0000000000000000000000000000000000000000..c38fca76f2785edbafb0b0fdf0891c823dccc7d3 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isPrimitiveEnumMemberType.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isPrimitiveEnumMemberType + +# Function: isPrimitiveEnumMemberType() + +> **isPrimitiveEnumMemberType**(`type`, `primitiveType`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8660 + +## Parameters + +### type + +[`Type`](../../../../../interfaces/Type.md) + +### primitiveType + +[`TypeFlags`](../../../../../enumerations/TypeFlags.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isPrimitiveEnumType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isPrimitiveEnumType.md new file mode 100644 index 0000000000000000000000000000000000000000..043faa2e5f7ec4c4d6a5a280429208525d522906 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isPrimitiveEnumType.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isPrimitiveEnumType + +# Function: isPrimitiveEnumType() + +> **isPrimitiveEnumType**(`type`, `primitiveType`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8659 + +## Parameters + +### type + +[`Type`](../../../../../interfaces/Type.md) + +### primitiveType + +[`TypeFlags`](../../../../../enumerations/TypeFlags.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isPrimitiveType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isPrimitiveType.md new file mode 100644 index 0000000000000000000000000000000000000000..7821bc77e3f4dcf0f00d7286b7c0292c9a498441 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isPrimitiveType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isPrimitiveType + +# Function: isPrimitiveType() + +> **isPrimitiveType**(`type`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8676 + +## Parameters + +### type + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isPrototypeSymbol.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isPrototypeSymbol.md new file mode 100644 index 0000000000000000000000000000000000000000..553a4803e7523a6697cbc9ccc5d8326db365f132 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isPrototypeSymbol.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isPrototypeSymbol + +# Function: isPrototypeSymbol() + +> **isPrototypeSymbol**(`symbol`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8683 + +## Parameters + +### symbol + +`undefined` | [`Symbol`](../../../../../interfaces/Symbol.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isReferenceType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isReferenceType.md new file mode 100644 index 0000000000000000000000000000000000000000..89ec6306fdf85d8d5c4318c8ac8ad16052c5091f --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isReferenceType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isReferenceType + +# Function: isReferenceType() + +> **isReferenceType**(`tsType`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8675 + +## Parameters + +### tsType + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isStdLibrarySymbol.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isStdLibrarySymbol.md new file mode 100644 index 0000000000000000000000000000000000000000..6435eed046c8a7e35c28499f4f2c605b51c9fb57 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isStdLibrarySymbol.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isStdLibrarySymbol + +# Function: isStdLibrarySymbol() + +> **isStdLibrarySymbol**(`sym`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8755 + +## Parameters + +### sym + +`undefined` | [`Symbol`](../../../../../interfaces/Symbol.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isStdLibraryType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isStdLibraryType.md new file mode 100644 index 0000000000000000000000000000000000000000..c870c06e4778d3a44c9fb3ce109077c8a845dc16 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isStdLibraryType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isStdLibraryType + +# Function: isStdLibraryType() + +> **isStdLibraryType**(`type`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8754 + +## Parameters + +### type + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isStdPartialType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isStdPartialType.md new file mode 100644 index 0000000000000000000000000000000000000000..902b3cd3aa579d07280b38d1edf8d33c882f8122 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isStdPartialType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isStdPartialType + +# Function: isStdPartialType() + +> **isStdPartialType**(`type`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8746 + +## Parameters + +### type + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isStdReadonlyType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isStdReadonlyType.md new file mode 100644 index 0000000000000000000000000000000000000000..6b25b7984dfc912c60f6c0bd2d0e35fa2e710d24 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isStdReadonlyType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isStdReadonlyType + +# Function: isStdReadonlyType() + +> **isStdReadonlyType**(`type`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8748 + +## Parameters + +### type + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isStdRecordType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isStdRecordType.md new file mode 100644 index 0000000000000000000000000000000000000000..a0946cd9eb88ddfa7cbbf7f727de37ec7aa4a427 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isStdRecordType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isStdRecordType + +# Function: isStdRecordType() + +> **isStdRecordType**(`type`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8745 + +## Parameters + +### type + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isStdRequiredType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isStdRequiredType.md new file mode 100644 index 0000000000000000000000000000000000000000..c12448a7dd701362e01c770eb83846f664dd8fce --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isStdRequiredType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isStdRequiredType + +# Function: isStdRequiredType() + +> **isStdRequiredType**(`type`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8747 + +## Parameters + +### type + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isStdSymbol.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isStdSymbol.md new file mode 100644 index 0000000000000000000000000000000000000000..2992827176fc65bdb9aafb46d59150eeccf7b699 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isStdSymbol.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isStdSymbol + +# Function: isStdSymbol() + +> **isStdSymbol**(`symbol`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8739 + +## Parameters + +### symbol + +[`Symbol`](../../../../../interfaces/Symbol.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isStringConstantValue.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isStringConstantValue.md new file mode 100644 index 0000000000000000000000000000000000000000..a4baaa419c63184ec988c905f565ee7c4a07f598 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isStringConstantValue.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isStringConstantValue + +# Function: isStringConstantValue() + +> **isStringConstantValue**(`tsExpr`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8698 + +## Parameters + +### tsExpr + +[`EnumMember`](../../../../../interfaces/EnumMember.md) | [`PropertyAccessExpression`](../../../../../interfaces/PropertyAccessExpression.md) | [`ElementAccessExpression`](../../../../../interfaces/ElementAccessExpression.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isStringLikeType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isStringLikeType.md new file mode 100644 index 0000000000000000000000000000000000000000..74c5d8b2809a2c7ac671adba2763062e59229e1b --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isStringLikeType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isStringLikeType + +# Function: isStringLikeType() + +> **isStringLikeType**(`tsType`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8657 + +## Parameters + +### tsType + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isStringType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isStringType.md new file mode 100644 index 0000000000000000000000000000000000000000..afaf3c79ea5da8399389133408df9b3ce704d46a --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isStringType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isStringType + +# Function: isStringType() + +> **isStringType**(`type`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8658 + +## Parameters + +### type + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isStruct.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isStruct.md new file mode 100644 index 0000000000000000000000000000000000000000..bb318639bc62bffe91f92b75e7646c2830a895d1 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isStruct.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isStruct + +# Function: isStruct() + +> **isStruct**(`symbol`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8718 + +## Parameters + +### symbol + +[`Symbol`](../../../../../interfaces/Symbol.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isStructDeclaration.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isStructDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..323bbfff791280758288c2b87a90c27b0c0ba35c --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isStructDeclaration.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isStructDeclaration + +# Function: isStructDeclaration() + +> **isStructDeclaration**(`node`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8711 + +## Parameters + +### node + +[`Node`](../../../../../interfaces/Node.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isStructDeclarationKind.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isStructDeclarationKind.md new file mode 100644 index 0000000000000000000000000000000000000000..456f2ab17f7e835cdb70a35e7ceb582c55e87f1b --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isStructDeclarationKind.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isStructDeclarationKind + +# Function: isStructDeclarationKind() + +> **isStructDeclarationKind**(`kind`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8710 + +## Parameters + +### kind + +[`SyntaxKind`](../../../../../enumerations/SyntaxKind.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isStructObjectInitializer.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isStructObjectInitializer.md new file mode 100644 index 0000000000000000000000000000000000000000..a393fa92869e643a8002886b9bc1ef0569d91b23 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isStructObjectInitializer.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isStructObjectInitializer + +# Function: isStructObjectInitializer() + +> **isStructObjectInitializer**(`objectLiteral`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8712 + +## Parameters + +### objectLiteral + +[`ObjectLiteralExpression`](../../../../../interfaces/ObjectLiteralExpression.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isSupportedType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isSupportedType.md new file mode 100644 index 0000000000000000000000000000000000000000..3bda273c020b57be5a7f48db9e8d95a6f942891d --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isSupportedType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isSupportedType + +# Function: isSupportedType() + +> **isSupportedType**(`typeNode`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8717 + +## Parameters + +### typeNode + +[`TypeNode`](../../../../../interfaces/TypeNode.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isSymbolAPI.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isSymbolAPI.md new file mode 100644 index 0000000000000000000000000000000000000000..86ee3643bfc984f39908cd2f52b61a7dd3c4aec2 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isSymbolAPI.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isSymbolAPI + +# Function: isSymbolAPI() + +> **isSymbolAPI**(`symbol`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8738 + +## Parameters + +### symbol + +[`Symbol`](../../../../../interfaces/Symbol.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isSymbolIterator.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isSymbolIterator.md new file mode 100644 index 0000000000000000000000000000000000000000..e84e89fbda2250e2da5cae3e6d31e81085bb2e8a --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isSymbolIterator.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isSymbolIterator + +# Function: isSymbolIterator() + +> **isSymbolIterator**(`symbol`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8740 + +## Parameters + +### symbol + +[`Symbol`](../../../../../interfaces/Symbol.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isThisOrSuperExpr.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isThisOrSuperExpr.md new file mode 100644 index 0000000000000000000000000000000000000000..ae3092356846211b487fe8d4e773dcdeb7307228 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isThisOrSuperExpr.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isThisOrSuperExpr + +# Function: isThisOrSuperExpr() + +> **isThisOrSuperExpr**(`tsExpr`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8682 + +## Parameters + +### tsExpr + +[`Expression`](../../../../../interfaces/Expression.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isType.md new file mode 100644 index 0000000000000000000000000000000000000000..ba42af8f73ddcddbb3370b15f3dfe65220022b04 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isType.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isType + +# Function: isType() + +> **isType**(`tsType`, `checkType`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8653 + +## Parameters + +### tsType + +`undefined` | [`TypeNode`](../../../../../interfaces/TypeNode.md) + +### checkType + +`string` + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isTypeDeclSyntaxKind.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isTypeDeclSyntaxKind.md new file mode 100644 index 0000000000000000000000000000000000000000..fbd2d96bd2962515e34993dcabaf9d999124e3e9 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isTypeDeclSyntaxKind.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isTypeDeclSyntaxKind + +# Function: isTypeDeclSyntaxKind() + +> **isTypeDeclSyntaxKind**(`kind`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8673 + +## Parameters + +### kind + +[`SyntaxKind`](../../../../../enumerations/SyntaxKind.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isTypeReference.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isTypeReference.md new file mode 100644 index 0000000000000000000000000000000000000000..bab7944ea3be9d059002f03afd8c889cfeec9d14 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isTypeReference.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isTypeReference + +# Function: isTypeReference() + +> **isTypeReference**(`tsType`): `tsType is TypeReference` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8680 + +## Parameters + +### tsType + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`tsType is TypeReference` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isTypeSymbol.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isTypeSymbol.md new file mode 100644 index 0000000000000000000000000000000000000000..5785581bf1a214744829292d0ba935a01a946f2b --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isTypeSymbol.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isTypeSymbol + +# Function: isTypeSymbol() + +> **isTypeSymbol**(`symbol`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8677 + +## Parameters + +### symbol + +`undefined` | [`Symbol`](../../../../../interfaces/Symbol.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isTypedArray.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isTypedArray.md new file mode 100644 index 0000000000000000000000000000000000000000..ae2efdcd1cedca794243e9b850c27daf4be1d5e2 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isTypedArray.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isTypedArray + +# Function: isTypedArray() + +> **isTypedArray**(`tsType`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8652 + +## Parameters + +### tsType + +`undefined` | [`TypeNode`](../../../../../interfaces/TypeNode.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isUnknownType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isUnknownType.md new file mode 100644 index 0000000000000000000000000000000000000000..349b8b5b55b8e9bb75b5877f4ea35cfa82089f5a --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isUnknownType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isUnknownType + +# Function: isUnknownType() + +> **isUnknownType**(`tsType`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8687 + +## Parameters + +### tsType + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isUnsupportedType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isUnsupportedType.md new file mode 100644 index 0000000000000000000000000000000000000000..91b9a7e88e8df0fb086228d1177047d10b102267 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isUnsupportedType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isUnsupportedType + +# Function: isUnsupportedType() + +> **isUnsupportedType**(`tsType`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8688 + +## Parameters + +### tsType + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isUnsupportedUnionType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isUnsupportedUnionType.md new file mode 100644 index 0000000000000000000000000000000000000000..9490fe9e99637e32101f5d3fae8647e3f018b8e5 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isUnsupportedUnionType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isUnsupportedUnionType + +# Function: isUnsupportedUnionType() + +> **isUnsupportedUnionType**(`tsType`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8689 + +## Parameters + +### tsType + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isValidEnumMemberInit.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isValidEnumMemberInit.md new file mode 100644 index 0000000000000000000000000000000000000000..b12871f8801e0cf3659d90083fa01c0a9f6b60d4 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isValidEnumMemberInit.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isValidEnumMemberInit + +# Function: isValidEnumMemberInit() + +> **isValidEnumMemberInit**(`tsExpr`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8693 + +## Parameters + +### tsExpr + +[`Expression`](../../../../../interfaces/Expression.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isValueAssignableToESObject.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isValueAssignableToESObject.md new file mode 100644 index 0000000000000000000000000000000000000000..2b0428f3dade0d82e23ac385ebef0d5284187299 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/isValueAssignableToESObject.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / isValueAssignableToESObject + +# Function: isValueAssignableToESObject() + +> **isValueAssignableToESObject**(`node`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8762 + +## Parameters + +### node + +[`Node`](../../../../../interfaces/Node.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/logTscDiagnostic.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/logTscDiagnostic.md new file mode 100644 index 0000000000000000000000000000000000000000..6f0d0b78892aeff4aa6df4470ce31a74a580fcc2 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/logTscDiagnostic.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / logTscDiagnostic + +# Function: logTscDiagnostic() + +> **logTscDiagnostic**(`diagnostics`, `log`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8705 + +## Parameters + +### diagnostics + +readonly [`Diagnostic`](../../../../../interfaces/Diagnostic.md)[] + +### log + +(`message`, ...`args`) => `void` + +## Returns + +`void` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/needToDeduceStructuralIdentity.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/needToDeduceStructuralIdentity.md new file mode 100644 index 0000000000000000000000000000000000000000..9b5b42078fc3e1e54baba965a3d0cd7e56de6660 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/needToDeduceStructuralIdentity.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / needToDeduceStructuralIdentity + +# Function: needToDeduceStructuralIdentity() + +> **needToDeduceStructuralIdentity**(`typeFrom`, `typeTo`, `allowPromotion`?): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8700 + +## Parameters + +### typeFrom + +[`Type`](../../../../../interfaces/Type.md) + +### typeTo + +[`Type`](../../../../../interfaces/Type.md) + +### allowPromotion? + +`boolean` + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/pathContainsDirectory.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/pathContainsDirectory.md new file mode 100644 index 0000000000000000000000000000000000000000..5b9da3374acbfa9bb1e67e1fba7806222ef05387 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/pathContainsDirectory.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / pathContainsDirectory + +# Function: pathContainsDirectory() + +> **pathContainsDirectory**(`targetPath`, `dir`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8752 + +## Parameters + +### targetPath + +`string` + +### dir + +`string` + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/processParentTypes.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/processParentTypes.md new file mode 100644 index 0000000000000000000000000000000000000000..ea7dcf95867504de02b23e10c1122d84de48aecd --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/processParentTypes.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / processParentTypes + +# Function: processParentTypes() + +> **processParentTypes**(`parentTypes`, `typeB`, `processInterfaces`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8702 + +## Parameters + +### parentTypes + +[`NodeArray`](../../../../../interfaces/NodeArray.md)\<[`ExpressionWithTypeArguments`](../../../../../interfaces/ExpressionWithTypeArguments.md)\> + +### typeB + +[`Type`](../../../../../interfaces/Type.md) + +### processInterfaces + +`boolean` + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/processParentTypesCheck.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/processParentTypesCheck.md new file mode 100644 index 0000000000000000000000000000000000000000..1445ffaca751425fd85c5ea43e81d2c29f6b486a --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/processParentTypesCheck.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / processParentTypesCheck + +# Function: processParentTypesCheck() + +> **processParentTypesCheck**(`parentTypes`, `checkType`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8703 + +## Parameters + +### parentTypes + +[`NodeArray`](../../../../../interfaces/NodeArray.md)\<[`ExpressionWithTypeArguments`](../../../../../interfaces/ExpressionWithTypeArguments.md)\> + +### checkType + +[`CheckType`](../enumerations/CheckType.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/relatedByInheritanceOrIdentical.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/relatedByInheritanceOrIdentical.md new file mode 100644 index 0000000000000000000000000000000000000000..a9f2a83f068a9ffef43d3962d6a0ab9f2ac58dc4 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/relatedByInheritanceOrIdentical.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / relatedByInheritanceOrIdentical + +# Function: relatedByInheritanceOrIdentical() + +> **relatedByInheritanceOrIdentical**(`typeA`, `typeB`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8699 + +## Parameters + +### typeA + +[`Type`](../../../../../interfaces/Type.md) + +### typeB + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/setTestMode.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/setTestMode.md new file mode 100644 index 0000000000000000000000000000000000000000..9a9aefe2267cd7bd2c090329c48f92915071b205 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/setTestMode.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / setTestMode + +# Function: setTestMode() + +> **setTestMode**(`tsTestMode`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8648 + +## Parameters + +### tsTestMode + +`boolean` + +## Returns + +`void` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/setTypeChecker.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/setTypeChecker.md new file mode 100644 index 0000000000000000000000000000000000000000..356696d9ef38c07d63b8f2fd3ae68b59cc59a908 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/setTypeChecker.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / setTypeChecker + +# Function: setTypeChecker() + +> **setTypeChecker**(`tsTypeChecker`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8646 + +## Parameters + +### tsTypeChecker + +[`TypeChecker`](../../../../../interfaces/TypeChecker.md) + +## Returns + +`void` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/symbolHasDuplicateName.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/symbolHasDuplicateName.md new file mode 100644 index 0000000000000000000000000000000000000000..977d374b89c71be04d2ad0811d27b36d71c79bde --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/symbolHasDuplicateName.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / symbolHasDuplicateName + +# Function: symbolHasDuplicateName() + +> **symbolHasDuplicateName**(`symbol`, `tsDeclKind`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8674 + +## Parameters + +### symbol + +[`Symbol`](../../../../../interfaces/Symbol.md) + +### tsDeclKind + +[`SyntaxKind`](../../../../../enumerations/SyntaxKind.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/symbolHasEsObjectType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/symbolHasEsObjectType.md new file mode 100644 index 0000000000000000000000000000000000000000..c8804a2c0aaa73387c20c58f3a14a9ba4be0f988 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/symbolHasEsObjectType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / symbolHasEsObjectType + +# Function: symbolHasEsObjectType() + +> **symbolHasEsObjectType**(`sym`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8766 + +## Parameters + +### sym + +[`Symbol`](../../../../../interfaces/Symbol.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/trueSymbolAtLocation.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/trueSymbolAtLocation.md new file mode 100644 index 0000000000000000000000000000000000000000..8718b75dd8fd5ed7f1a1339621139fb89174d153 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/trueSymbolAtLocation.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / trueSymbolAtLocation + +# Function: trueSymbolAtLocation() + +> **trueSymbolAtLocation**(`node`): `undefined` \| [`Symbol`](../../../../../interfaces/Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8671 + +## Parameters + +### node + +[`Node`](../../../../../interfaces/Node.md) + +## Returns + +`undefined` \| [`Symbol`](../../../../../interfaces/Symbol.md) diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/typeIsRecursive.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/typeIsRecursive.md new file mode 100644 index 0000000000000000000000000000000000000000..18bb739dbe84cc58108dde5dadc404a76a5de393 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/typeIsRecursive.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / typeIsRecursive + +# Function: typeIsRecursive() + +> **typeIsRecursive**(`topType`, `type`?): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8770 + +## Parameters + +### topType + +[`Type`](../../../../../interfaces/Type.md) + +### type? + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/unwrapParenthesized.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/unwrapParenthesized.md new file mode 100644 index 0000000000000000000000000000000000000000..5db7ba8d55b2c498194178ed765941b8918cc348 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/unwrapParenthesized.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / unwrapParenthesized + +# Function: unwrapParenthesized() + +> **unwrapParenthesized**(`tsExpr`): [`Expression`](../../../../../interfaces/Expression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8669 + +## Parameters + +### tsExpr + +[`Expression`](../../../../../interfaces/Expression.md) + +## Returns + +[`Expression`](../../../../../interfaces/Expression.md) diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/unwrapParenthesizedType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/unwrapParenthesizedType.md new file mode 100644 index 0000000000000000000000000000000000000000..ba8673efe803a11b6734d70e0ec76bcb8c81fdda --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/unwrapParenthesizedType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / unwrapParenthesizedType + +# Function: unwrapParenthesizedType() + +> **unwrapParenthesizedType**(`tsType`): [`TypeNode`](../../../../../interfaces/TypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8661 + +## Parameters + +### tsType + +[`TypeNode`](../../../../../interfaces/TypeNode.md) + +## Returns + +[`TypeNode`](../../../../../interfaces/TypeNode.md) diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/validateFields.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/validateFields.md new file mode 100644 index 0000000000000000000000000000000000000000..3ad8058ebe5ab3c4aa1d9d07db287e0beccc16f9 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/validateFields.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / validateFields + +# Function: validateFields() + +> **validateFields**(`type`, `objectLiteral`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8716 + +## Parameters + +### type + +[`Type`](../../../../../interfaces/Type.md) + +### objectLiteral + +[`ObjectLiteralExpression`](../../../../../interfaces/ObjectLiteralExpression.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/validateObjectLiteralType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/validateObjectLiteralType.md new file mode 100644 index 0000000000000000000000000000000000000000..e5b1b6afce704993f91af5efa076a0b21ee4a040 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/functions/validateObjectLiteralType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / validateObjectLiteralType + +# Function: validateObjectLiteralType() + +> **validateObjectLiteralType**(`type`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8709 + +## Parameters + +### type + +`undefined` | [`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/variables/ALLOWED_STD_SYMBOL_API.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/variables/ALLOWED_STD_SYMBOL_API.md new file mode 100644 index 0000000000000000000000000000000000000000..648263691f19fbbdef46a9fab0ff605eefccee8b --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/variables/ALLOWED_STD_SYMBOL_API.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / ALLOWED\_STD\_SYMBOL\_API + +# Variable: ALLOWED\_STD\_SYMBOL\_API + +> `const` **ALLOWED\_STD\_SYMBOL\_API**: `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8639 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/variables/ARKTS_IGNORE_DIRS.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/variables/ARKTS_IGNORE_DIRS.md new file mode 100644 index 0000000000000000000000000000000000000000..c616882e24d219b47a699a0d99c1b6ee742273e8 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/variables/ARKTS_IGNORE_DIRS.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / ARKTS\_IGNORE\_DIRS + +# Variable: ARKTS\_IGNORE\_DIRS + +> `const` **ARKTS\_IGNORE\_DIRS**: `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8644 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/variables/ARKTS_IGNORE_FILES.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/variables/ARKTS_IGNORE_FILES.md new file mode 100644 index 0000000000000000000000000000000000000000..769d3d880c5b4cb995374abecb4d887c5c2070ae --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/variables/ARKTS_IGNORE_FILES.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / ARKTS\_IGNORE\_FILES + +# Variable: ARKTS\_IGNORE\_FILES + +> `const` **ARKTS\_IGNORE\_FILES**: `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8645 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/variables/ARKUI_DECORATORS.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/variables/ARKUI_DECORATORS.md new file mode 100644 index 0000000000000000000000000000000000000000..c7194a2966f6da6e062fcc88d4c67620bda571c3 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/variables/ARKUI_DECORATORS.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / ARKUI\_DECORATORS + +# Variable: ARKUI\_DECORATORS + +> `const` **ARKUI\_DECORATORS**: `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8731 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/variables/ES_OBJECT.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/variables/ES_OBJECT.md new file mode 100644 index 0000000000000000000000000000000000000000..202047aa7cd4db1e82b390fa4915e5c86471e422 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/variables/ES_OBJECT.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / ES\_OBJECT + +# Variable: ES\_OBJECT + +> `const` **ES\_OBJECT**: `"ESObject"` = `"ESObject"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8726 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/variables/FUNCTION_HAS_NO_RETURN_ERROR_CODE.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/variables/FUNCTION_HAS_NO_RETURN_ERROR_CODE.md new file mode 100644 index 0000000000000000000000000000000000000000..90b437e49e655df1537f412cd188cd9daad576d3 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/variables/FUNCTION_HAS_NO_RETURN_ERROR_CODE.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / FUNCTION\_HAS\_NO\_RETURN\_ERROR\_CODE + +# Variable: FUNCTION\_HAS\_NO\_RETURN\_ERROR\_CODE + +> `const` **FUNCTION\_HAS\_NO\_RETURN\_ERROR\_CODE**: `2366` = `2366` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8732 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/variables/LIMITED_STANDARD_UTILITY_TYPES.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/variables/LIMITED_STANDARD_UTILITY_TYPES.md new file mode 100644 index 0000000000000000000000000000000000000000..df60f58a30e20b180fb86d9977b11951b433d2e0 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/variables/LIMITED_STANDARD_UTILITY_TYPES.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / LIMITED\_STANDARD\_UTILITY\_TYPES + +# Variable: LIMITED\_STANDARD\_UTILITY\_TYPES + +> `const` **LIMITED\_STANDARD\_UTILITY\_TYPES**: `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8638 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/variables/LIMITED_STD_GLOBAL_FUNC.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/variables/LIMITED_STD_GLOBAL_FUNC.md new file mode 100644 index 0000000000000000000000000000000000000000..566cd50741afb15ef262614a7a1c995b5fa72c13 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/variables/LIMITED_STD_GLOBAL_FUNC.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / LIMITED\_STD\_GLOBAL\_FUNC + +# Variable: LIMITED\_STD\_GLOBAL\_FUNC + +> `const` **LIMITED\_STD\_GLOBAL\_FUNC**: `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8727 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/variables/LIMITED_STD_OBJECT_API.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/variables/LIMITED_STD_OBJECT_API.md new file mode 100644 index 0000000000000000000000000000000000000000..d15deb32dc01496928f3a0497ebca50f19dc6ca8 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/variables/LIMITED_STD_OBJECT_API.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / LIMITED\_STD\_OBJECT\_API + +# Variable: LIMITED\_STD\_OBJECT\_API + +> `const` **LIMITED\_STD\_OBJECT\_API**: `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8728 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/variables/LIMITED_STD_PROXYHANDLER_API.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/variables/LIMITED_STD_PROXYHANDLER_API.md new file mode 100644 index 0000000000000000000000000000000000000000..ee30d470fffec90f7fc960231c37e3be226e53d2 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/variables/LIMITED_STD_PROXYHANDLER_API.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / LIMITED\_STD\_PROXYHANDLER\_API + +# Variable: LIMITED\_STD\_PROXYHANDLER\_API + +> `const` **LIMITED\_STD\_PROXYHANDLER\_API**: `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8730 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/variables/LIMITED_STD_REFLECT_API.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/variables/LIMITED_STD_REFLECT_API.md new file mode 100644 index 0000000000000000000000000000000000000000..f708cf979fbebd5474b4c7edc665f127c5758135 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/variables/LIMITED_STD_REFLECT_API.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / LIMITED\_STD\_REFLECT\_API + +# Variable: LIMITED\_STD\_REFLECT\_API + +> `const` **LIMITED\_STD\_REFLECT\_API**: `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8729 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/variables/NON_INITIALIZABLE_PROPERTY_ClASS_DECORATORS.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/variables/NON_INITIALIZABLE_PROPERTY_ClASS_DECORATORS.md new file mode 100644 index 0000000000000000000000000000000000000000..aaabae5f6a74042f8965334ae71d64cb71bca270 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/variables/NON_INITIALIZABLE_PROPERTY_ClASS_DECORATORS.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / NON\_INITIALIZABLE\_PROPERTY\_ClASS\_DECORATORS + +# Variable: NON\_INITIALIZABLE\_PROPERTY\_ClASS\_DECORATORS + +> `const` **NON\_INITIALIZABLE\_PROPERTY\_ClASS\_DECORATORS**: `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8637 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/variables/NON_INITIALIZABLE_PROPERTY_DECORATORS.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/variables/NON_INITIALIZABLE_PROPERTY_DECORATORS.md new file mode 100644 index 0000000000000000000000000000000000000000..14718e38995b68bc6ebb0858576810a864d9880c --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/variables/NON_INITIALIZABLE_PROPERTY_DECORATORS.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / NON\_INITIALIZABLE\_PROPERTY\_DECORATORS + +# Variable: NON\_INITIALIZABLE\_PROPERTY\_DECORATORS + +> `const` **NON\_INITIALIZABLE\_PROPERTY\_DECORATORS**: `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8636 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/variables/NON_RETURN_FUNCTION_DECORATORS.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/variables/NON_RETURN_FUNCTION_DECORATORS.md new file mode 100644 index 0000000000000000000000000000000000000000..23a89cf00cae31b6f0c488696de8f0f7ad519a62 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/variables/NON_RETURN_FUNCTION_DECORATORS.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / NON\_RETURN\_FUNCTION\_DECORATORS + +# Variable: NON\_RETURN\_FUNCTION\_DECORATORS + +> `const` **NON\_RETURN\_FUNCTION\_DECORATORS**: `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8733 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/variables/PROPERTY_HAS_NO_INITIALIZER_ERROR_CODE.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/variables/PROPERTY_HAS_NO_INITIALIZER_ERROR_CODE.md new file mode 100644 index 0000000000000000000000000000000000000000..2fb1f2d494aa9eebb38374c27f685c13b8e2f39f --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/variables/PROPERTY_HAS_NO_INITIALIZER_ERROR_CODE.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / PROPERTY\_HAS\_NO\_INITIALIZER\_ERROR\_CODE + +# Variable: PROPERTY\_HAS\_NO\_INITIALIZER\_ERROR\_CODE + +> `const` **PROPERTY\_HAS\_NO\_INITIALIZER\_ERROR\_CODE**: `2564` = `2564` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8635 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/variables/STANDARD_LIBRARIES.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/variables/STANDARD_LIBRARIES.md new file mode 100644 index 0000000000000000000000000000000000000000..d1a95cf0edb21f06f1e6ba3e95ff449be1e9d9af --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/variables/STANDARD_LIBRARIES.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / STANDARD\_LIBRARIES + +# Variable: STANDARD\_LIBRARIES + +> `const` **STANDARD\_LIBRARIES**: `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8734 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/variables/TYPED_ARRAYS.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/variables/TYPED_ARRAYS.md new file mode 100644 index 0000000000000000000000000000000000000000..2824cbadb355384901f759ddd06d4402dc1cfba4 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/namespaces/Utils/variables/TYPED_ARRAYS.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_0](../../../README.md) / [Utils](../README.md) / TYPED\_ARRAYS + +# Variable: TYPED\_ARRAYS + +> `const` **TYPED\_ARRAYS**: `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8735 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/variables/cookBookMsg.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/variables/cookBookMsg.md new file mode 100644 index 0000000000000000000000000000000000000000..a14460ef51d826f9d97564eede0166744929329a --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/variables/cookBookMsg.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../globals.md) / [ts](../../../README.md) / [ArkTSLinter\_1\_0](../README.md) / cookBookMsg + +# Variable: cookBookMsg + +> `const` **cookBookMsg**: `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8592 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/variables/cookBookTag.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/variables/cookBookTag.md new file mode 100644 index 0000000000000000000000000000000000000000..ec52d60462d56f9f17e9090687447b15c45be524 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_0/variables/cookBookTag.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../globals.md) / [ts](../../../README.md) / [ArkTSLinter\_1\_0](../README.md) / cookBookTag + +# Variable: cookBookTag + +> `const` **cookBookTag**: `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:8593 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/README.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/README.md new file mode 100644 index 0000000000000000000000000000000000000000..91baa0dcc887dce37f0c9686b665e4db26cbb168 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/README.md @@ -0,0 +1,43 @@ +[**ArkAnalyzer**](../../../../README.md) + +*** + +[ArkAnalyzer](../../../../globals.md) / [ts](../../README.md) / ArkTSLinter\_1\_1 + +# ArkTSLinter\_1\_1 + +## Namespaces + +- [Autofixer](namespaces/Autofixer/README.md) +- [Common](namespaces/Common/README.md) +- [DiagnosticCheckerNamespace](namespaces/DiagnosticCheckerNamespace/README.md) +- [LibraryTypeCallDiagnosticCheckerNamespace](namespaces/LibraryTypeCallDiagnosticCheckerNamespace/README.md) +- [Problems](namespaces/Problems/README.md) +- [Utils](namespaces/Utils/README.md) + +## Classes + +- [InteropTypescriptLinter](classes/InteropTypescriptLinter.md) +- [LinterConfig](classes/LinterConfig.md) +- [TSCCompiledProgram](classes/TSCCompiledProgram.md) +- [TypeScriptLinter](classes/TypeScriptLinter.md) + +## Interfaces + +- [KitInfo](interfaces/KitInfo.md) +- [KitSymbol](interfaces/KitSymbol.md) +- [ProblemInfo](interfaces/ProblemInfo.md) + +## Type Aliases + +- [KitSymbols](type-aliases/KitSymbols.md) + +## Variables + +- [cookBookMsg](variables/cookBookMsg.md) +- [cookBookTag](variables/cookBookTag.md) + +## Functions + +- [runArkTSLinter](functions/runArkTSLinter.md) +- [translateDiag](functions/translateDiag.md) diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/classes/InteropTypescriptLinter.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/classes/InteropTypescriptLinter.md new file mode 100644 index 0000000000000000000000000000000000000000..c04a113a99a5c393c5579bfcf9d84f18cea047fa --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/classes/InteropTypescriptLinter.md @@ -0,0 +1,241 @@ +[**ArkAnalyzer**](../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../globals.md) / [ts](../../../README.md) / [ArkTSLinter\_1\_1](../README.md) / InteropTypescriptLinter + +# Class: InteropTypescriptLinter + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9701 + +## Constructors + +### new InteropTypescriptLinter() + +> **new InteropTypescriptLinter**(`sourceFile`, `tsProgram`, `isInSdk`): [`InteropTypescriptLinter`](InteropTypescriptLinter.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9726 + +#### Parameters + +##### sourceFile + +[`SourceFile`](../../../interfaces/SourceFile.md) + +##### tsProgram + +[`Program`](../../../interfaces/Program.md) + +##### isInSdk + +`boolean` + +#### Returns + +[`InteropTypescriptLinter`](InteropTypescriptLinter.md) + +## Properties + +### currentErrorLine + +> **currentErrorLine**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9724 + +*** + +### currentWarningLine + +> **currentWarningLine**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9725 + +*** + +### handlersMap + +> `readonly` **handlersMap**: [`ESMap`](../../../interfaces/ESMap.md)\<[`SyntaxKind`](../../../enumerations/SyntaxKind.md), (`node`) => `void`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9728 + +*** + +### errorLineNumbersString + +> `static` **errorLineNumbersString**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9709 + +*** + +### etsLoaderPath? + +> `static` `optional` **etsLoaderPath**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9717 + +*** + +### kitInfos + +> `static` **kitInfos**: [`Map`](../../../interfaces/Map.md)\<[`KitInfo`](../interfaces/KitInfo.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9718 + +*** + +### lineCounters + +> `static` **lineCounters**: `number`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9707 + +*** + +### nodeCounters + +> `static` **nodeCounters**: `number`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9706 + +*** + +### problemsInfos + +> `static` **problemsInfos**: [`ProblemInfo`](../interfaces/ProblemInfo.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9713 + +*** + +### reportDiagnostics + +> `static` **reportDiagnostics**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9712 + +*** + +### strictMode + +> `static` **strictMode**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9704 + +*** + +### totalErrorLines + +> `static` **totalErrorLines**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9708 + +*** + +### totalVisitedNodes + +> `static` **totalVisitedNodes**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9705 + +*** + +### totalWarningLines + +> `static` **totalWarningLines**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9710 + +*** + +### tsTypeChecker + +> `static` **tsTypeChecker**: [`TypeChecker`](../../../interfaces/TypeChecker.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9716 + +*** + +### warningLineNumbersString + +> `static` **warningLineNumbersString**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9711 + +## Methods + +### incrementCounters() + +> **incrementCounters**(`node`, `faultId`, `autofixable`?, `autofix`?): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9729 + +#### Parameters + +##### node + +[`Node`](../../../interfaces/Node.md) | [`CommentRange`](../../../interfaces/CommentRange.md) + +##### faultId + +`number` + +##### autofixable? + +`boolean` + +##### autofix? + +[`Autofix`](../namespaces/Autofixer/interfaces/Autofix.md)[] + +#### Returns + +`void` + +*** + +### lint() + +> **lint**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9749 + +#### Returns + +`void` + +*** + +### clearTsTypeChecker() + +> `static` **clearTsTypeChecker**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9727 + +#### Returns + +`void` + +*** + +### initGlobals() + +> `static` **initGlobals**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9714 + +#### Returns + +`void` + +*** + +### initStatic() + +> `static` **initStatic**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9715 + +#### Returns + +`void` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/classes/LinterConfig.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/classes/LinterConfig.md new file mode 100644 index 0000000000000000000000000000000000000000..90046995435d1d503a5bfec6711274598b36414b --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/classes/LinterConfig.md @@ -0,0 +1,63 @@ +[**ArkAnalyzer**](../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../globals.md) / [ts](../../../README.md) / [ArkTSLinter\_1\_1](../README.md) / LinterConfig + +# Class: LinterConfig + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9503 + +## Constructors + +### new LinterConfig() + +> **new LinterConfig**(): [`LinterConfig`](LinterConfig.md) + +#### Returns + +[`LinterConfig`](LinterConfig.md) + +## Properties + +### incrementOnlyTokens + +> `static` **incrementOnlyTokens**: [`ESMap`](../../../interfaces/ESMap.md)\<[`SyntaxKind`](../../../enumerations/SyntaxKind.md), [`FaultID`](../namespaces/Problems/enumerations/FaultID.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9508 + +*** + +### nodeDesc + +> `static` **nodeDesc**: `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9504 + +*** + +### terminalTokens + +> `static` **terminalTokens**: [`Set`](../../../interfaces/Set.md)\<[`SyntaxKind`](../../../enumerations/SyntaxKind.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9507 + +*** + +### tsSyntaxKindNames + +> `static` **tsSyntaxKindNames**: `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9505 + +## Methods + +### initStatic() + +> `static` **initStatic**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9506 + +#### Returns + +`void` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/classes/TSCCompiledProgram.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/classes/TSCCompiledProgram.md new file mode 100644 index 0000000000000000000000000000000000000000..d85b3b1fff625ad6aa1dfc1626bc7753491747be --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/classes/TSCCompiledProgram.md @@ -0,0 +1,81 @@ +[**ArkAnalyzer**](../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../globals.md) / [ts](../../../README.md) / [ArkTSLinter\_1\_1](../README.md) / TSCCompiledProgram + +# Class: TSCCompiledProgram + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9755 + +## Constructors + +### new TSCCompiledProgram() + +> **new TSCCompiledProgram**(`program`): [`TSCCompiledProgram`](TSCCompiledProgram.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9757 + +#### Parameters + +##### program + +[`BuilderProgram`](../../../interfaces/BuilderProgram.md) + +#### Returns + +[`TSCCompiledProgram`](TSCCompiledProgram.md) + +## Methods + +### doAllGetDiagnostics() + +> **doAllGetDiagnostics**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9761 + +#### Returns + +`void` + +*** + +### getBuilderProgram() + +> **getBuilderProgram**(): [`BuilderProgram`](../../../interfaces/BuilderProgram.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9759 + +#### Returns + +[`BuilderProgram`](../../../interfaces/BuilderProgram.md) + +*** + +### getProgram() + +> **getProgram**(): [`Program`](../../../interfaces/Program.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9758 + +#### Returns + +[`Program`](../../../interfaces/Program.md) + +*** + +### getStrictDiagnostics() + +> **getStrictDiagnostics**(`fileName`): [`Diagnostic`](../../../interfaces/Diagnostic.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9760 + +#### Parameters + +##### fileName + +`string` + +#### Returns + +[`Diagnostic`](../../../interfaces/Diagnostic.md)[] diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/classes/TypeScriptLinter.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/classes/TypeScriptLinter.md new file mode 100644 index 0000000000000000000000000000000000000000..7aabfa916dbaa5afc3b9bd4a412d121893fde834 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/classes/TypeScriptLinter.md @@ -0,0 +1,331 @@ +[**ArkAnalyzer**](../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../globals.md) / [ts](../../../README.md) / [ArkTSLinter\_1\_1](../README.md) / TypeScriptLinter + +# Class: TypeScriptLinter + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9530 + +## Constructors + +### new TypeScriptLinter() + +> **new TypeScriptLinter**(`sourceFile`, `tsProgram`, `tscStrictDiagnostics`?): [`TypeScriptLinter`](TypeScriptLinter.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9562 + +#### Parameters + +##### sourceFile + +[`SourceFile`](../../../interfaces/SourceFile.md) + +##### tsProgram + +[`Program`](../../../interfaces/Program.md) + +##### tscStrictDiagnostics? + +[`Map`](../../../interfaces/Map.md)\<[`Diagnostic`](../../../interfaces/Diagnostic.md)[]\> + +#### Returns + +[`TypeScriptLinter`](TypeScriptLinter.md) + +## Properties + +### currentErrorLine + +> **currentErrorLine**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9554 + +*** + +### currentWarningLine + +> **currentWarningLine**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9555 + +*** + +### handlersMap + +> `readonly` **handlersMap**: [`ESMap`](../../../interfaces/ESMap.md)\<[`SyntaxKind`](../../../enumerations/SyntaxKind.md), (`node`) => `void`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9564 + +*** + +### libraryTypeCallDiagnosticChecker + +> **libraryTypeCallDiagnosticChecker**: [`LibraryTypeCallDiagnosticChecker`](../namespaces/LibraryTypeCallDiagnosticCheckerNamespace/classes/LibraryTypeCallDiagnosticChecker.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9557 + +*** + +### skipArkTSStaticBlocksCheck + +> **skipArkTSStaticBlocksCheck**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9558 + +*** + +### staticBlocks + +> **staticBlocks**: [`Set`](../../../interfaces/Set.md)\<`string`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9556 + +*** + +### errorLineNumbersString + +> `static` **errorLineNumbersString**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9542 + +*** + +### filteredDiagnosticMessages + +> `static` **filteredDiagnosticMessages**: [`DiagnosticMessageChain`](../../../interfaces/DiagnosticMessageChain.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9547 + +*** + +### ideMode + +> `static` **ideMode**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9533 + +*** + +### lineCounters + +> `static` **lineCounters**: `number`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9540 + +*** + +### lintEtsOnly + +> `static` **lintEtsOnly**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9537 + +*** + +### logTscErrors + +> `static` **logTscErrors**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9535 + +*** + +### nodeCounters + +> `static` **nodeCounters**: `number`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9539 + +*** + +### problemsInfos + +> `static` **problemsInfos**: [`ProblemInfo`](../interfaces/ProblemInfo.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9546 + +*** + +### reportDiagnostics + +> `static` **reportDiagnostics**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9545 + +*** + +### sharedModulesCache + +> `static` **sharedModulesCache**: [`ESMap`](../../../interfaces/ESMap.md)\<`string`, `boolean`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9548 + +*** + +### strictDiagnosticCache + +> `static` **strictDiagnosticCache**: [`Set`](../../../interfaces/Set.md)\<[`Diagnostic`](../../../interfaces/Diagnostic.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9549 + +*** + +### strictMode + +> `static` **strictMode**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9534 + +*** + +### totalErrorLines + +> `static` **totalErrorLines**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9541 + +*** + +### totalVisitedNodes + +> `static` **totalVisitedNodes**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9538 + +*** + +### totalWarningLines + +> `static` **totalWarningLines**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9543 + +*** + +### tsTypeChecker + +> `static` **tsTypeChecker**: [`TypeChecker`](../../../interfaces/TypeChecker.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9553 + +*** + +### unknowDiagnosticCache + +> `static` **unknowDiagnosticCache**: [`Set`](../../../interfaces/Set.md)\<[`Diagnostic`](../../../interfaces/Diagnostic.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9550 + +*** + +### warningLineNumbersString + +> `static` **warningLineNumbersString**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9544 + +*** + +### warningsAsErrors + +> `static` **warningsAsErrors**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9536 + +## Methods + +### incrementCounters() + +> **incrementCounters**(`node`, `faultId`, `autofixable`?, `autofix`?): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9565 + +#### Parameters + +##### node + +[`Node`](../../../interfaces/Node.md) | [`CommentRange`](../../../interfaces/CommentRange.md) + +##### faultId + +`number` + +##### autofixable? + +`boolean` + +##### autofix? + +[`Autofix`](../namespaces/Autofixer/interfaces/Autofix.md)[] + +#### Returns + +`void` + +*** + +### isFileExportSendableDecl() + +> **isFileExportSendableDecl**(`decl`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9616 + +#### Parameters + +##### decl + +[`Declaration`](../../../interfaces/Declaration.md) + +#### Returns + +`boolean` + +*** + +### lint() + +> **lint**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9675 + +#### Returns + +`void` + +*** + +### clearTsTypeChecker() + +> `static` **clearTsTypeChecker**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9563 + +#### Returns + +`void` + +*** + +### initGlobals() + +> `static` **initGlobals**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9551 + +#### Returns + +`void` + +*** + +### initStatic() + +> `static` **initStatic**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9552 + +#### Returns + +`void` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/functions/runArkTSLinter.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/functions/runArkTSLinter.md new file mode 100644 index 0000000000000000000000000000000000000000..7bb8d4f7db415189286ea8cdf9ad31e4915d6b66 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/functions/runArkTSLinter.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../globals.md) / [ts](../../../README.md) / [ArkTSLinter\_1\_1](../README.md) / runArkTSLinter + +# Function: runArkTSLinter() + +> **runArkTSLinter**(`tsBuilderProgram`, `srcFile`?, `buildInfoWriteFile`?, `arkTSVersion`?): [`Diagnostic`](../../../interfaces/Diagnostic.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9768 + +## Parameters + +### tsBuilderProgram + +[`BuilderProgram`](../../../interfaces/BuilderProgram.md) + +### srcFile? + +[`SourceFile`](../../../interfaces/SourceFile.md) + +### buildInfoWriteFile? + +[`WriteFileCallback`](../../../type-aliases/WriteFileCallback.md) + +### arkTSVersion? + +`string` + +## Returns + +[`Diagnostic`](../../../interfaces/Diagnostic.md)[] diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/functions/translateDiag.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/functions/translateDiag.md new file mode 100644 index 0000000000000000000000000000000000000000..f7a4be4e6aba7cf8e9885682b2697abc1f2b65e6 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/functions/translateDiag.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../globals.md) / [ts](../../../README.md) / [ArkTSLinter\_1\_1](../README.md) / translateDiag + +# Function: translateDiag() + +> **translateDiag**(`srcFile`, `problemInfo`): [`Diagnostic`](../../../interfaces/Diagnostic.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9767 + +## Parameters + +### srcFile + +[`SourceFile`](../../../interfaces/SourceFile.md) + +### problemInfo + +[`ProblemInfo`](../interfaces/ProblemInfo.md) + +## Returns + +[`Diagnostic`](../../../interfaces/Diagnostic.md) diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/interfaces/KitInfo.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/interfaces/KitInfo.md new file mode 100644 index 0000000000000000000000000000000000000000..1162b4e91dd5d169e7158477d1218c2868c973ae --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/interfaces/KitInfo.md @@ -0,0 +1,17 @@ +[**ArkAnalyzer**](../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../globals.md) / [ts](../../../README.md) / [ArkTSLinter\_1\_1](../README.md) / KitInfo + +# Interface: KitInfo + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9698 + +## Properties + +### symbols? + +> `optional` **symbols**: [`KitSymbols`](../type-aliases/KitSymbols.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9699 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/interfaces/KitSymbol.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/interfaces/KitSymbol.md new file mode 100644 index 0000000000000000000000000000000000000000..e90b995c8e6743f3b8a2e95999c3ea87df6f1a22 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/interfaces/KitSymbol.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../globals.md) / [ts](../../../README.md) / [ArkTSLinter\_1\_1](../README.md) / KitSymbol + +# Interface: KitSymbol + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9693 + +## Properties + +### bindings + +> **bindings**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9695 + +*** + +### source + +> **source**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9694 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/interfaces/ProblemInfo.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/interfaces/ProblemInfo.md new file mode 100644 index 0000000000000000000000000000000000000000..2712849934e799e9a813e47ca586ab8526106227 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/interfaces/ProblemInfo.md @@ -0,0 +1,105 @@ +[**ArkAnalyzer**](../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../globals.md) / [ts](../../../README.md) / [ArkTSLinter\_1\_1](../README.md) / ProblemInfo + +# Interface: ProblemInfo + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9516 + +## Properties + +### autofix? + +> `optional` **autofix**: [`Autofix`](../namespaces/Autofixer/interfaces/Autofix.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9528 + +*** + +### autofixable + +> **autofixable**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9527 + +*** + +### column + +> **column**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9518 + +*** + +### end + +> **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9520 + +*** + +### line + +> **line**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9517 + +*** + +### problem + +> **problem**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9523 + +*** + +### rule + +> **rule**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9525 + +*** + +### ruleTag + +> **ruleTag**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9526 + +*** + +### severity + +> **severity**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9522 + +*** + +### start + +> **start**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9519 + +*** + +### suggest + +> **suggest**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9524 + +*** + +### type + +> **type**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9521 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Autofixer/README.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Autofixer/README.md new file mode 100644 index 0000000000000000000000000000000000000000..cc47846244de5b4ef6787efd9ab3e7516747e1c7 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Autofixer/README.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../globals.md) / [ts](../../../../README.md) / [ArkTSLinter\_1\_1](../../README.md) / Autofixer + +# Autofixer + +## Interfaces + +- [Autofix](interfaces/Autofix.md) + +## Variables + +- [AUTOFIX\_ALL](variables/AUTOFIX_ALL.md) +- [autofixInfo](variables/autofixInfo.md) + +## Functions + +- [fixCtorParameterProperties](functions/fixCtorParameterProperties.md) +- [fixFunctionExpression](functions/fixFunctionExpression.md) +- [fixLiteralAsPropertyName](functions/fixLiteralAsPropertyName.md) +- [fixPropertyAccessByIndex](functions/fixPropertyAccessByIndex.md) +- [fixReturnType](functions/fixReturnType.md) +- [shouldAutofix](functions/shouldAutofix.md) diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Autofixer/functions/fixCtorParameterProperties.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Autofixer/functions/fixCtorParameterProperties.md new file mode 100644 index 0000000000000000000000000000000000000000..b72a5c975a2ab9dd48f7296803893ee6ae3c0b44 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Autofixer/functions/fixCtorParameterProperties.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Autofixer](../README.md) / fixCtorParameterProperties + +# Function: fixCtorParameterProperties() + +> **fixCtorParameterProperties**(`ctorDecl`, `paramTypes`): `undefined` \| [`Autofix`](../interfaces/Autofix.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9496 + +## Parameters + +### ctorDecl + +[`ConstructorDeclaration`](../../../../../interfaces/ConstructorDeclaration.md) + +### paramTypes + +[`TypeNode`](../../../../../interfaces/TypeNode.md)[] + +## Returns + +`undefined` \| [`Autofix`](../interfaces/Autofix.md)[] diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Autofixer/functions/fixFunctionExpression.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Autofixer/functions/fixFunctionExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..2f430bcc1986af301e7042b4a6a1a39772735457 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Autofixer/functions/fixFunctionExpression.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Autofixer](../README.md) / fixFunctionExpression + +# Function: fixFunctionExpression() + +> **fixFunctionExpression**(`funcExpr`, `params`?, `retType`?): [`Autofix`](../interfaces/Autofix.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9494 + +## Parameters + +### funcExpr + +[`FunctionExpression`](../../../../../interfaces/FunctionExpression.md) + +### params? + +[`NodeArray`](../../../../../interfaces/NodeArray.md)\<[`ParameterDeclaration`](../../../../../interfaces/ParameterDeclaration.md)\> + +### retType? + +[`TypeNode`](../../../../../interfaces/TypeNode.md) + +## Returns + +[`Autofix`](../interfaces/Autofix.md) diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Autofixer/functions/fixLiteralAsPropertyName.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Autofixer/functions/fixLiteralAsPropertyName.md new file mode 100644 index 0000000000000000000000000000000000000000..9a643bf0da828985ed3a7930b9a933afb610ead0 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Autofixer/functions/fixLiteralAsPropertyName.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Autofixer](../README.md) / fixLiteralAsPropertyName + +# Function: fixLiteralAsPropertyName() + +> **fixLiteralAsPropertyName**(`node`): `undefined` \| [`Autofix`](../interfaces/Autofix.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9492 + +## Parameters + +### node + +[`Node`](../../../../../interfaces/Node.md) + +## Returns + +`undefined` \| [`Autofix`](../interfaces/Autofix.md)[] diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Autofixer/functions/fixPropertyAccessByIndex.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Autofixer/functions/fixPropertyAccessByIndex.md new file mode 100644 index 0000000000000000000000000000000000000000..9a9799832673a0532d8fa9868318fad04e2854ba --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Autofixer/functions/fixPropertyAccessByIndex.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Autofixer](../README.md) / fixPropertyAccessByIndex + +# Function: fixPropertyAccessByIndex() + +> **fixPropertyAccessByIndex**(`node`): `undefined` \| [`Autofix`](../interfaces/Autofix.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9493 + +## Parameters + +### node + +[`Node`](../../../../../interfaces/Node.md) + +## Returns + +`undefined` \| [`Autofix`](../interfaces/Autofix.md)[] diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Autofixer/functions/fixReturnType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Autofixer/functions/fixReturnType.md new file mode 100644 index 0000000000000000000000000000000000000000..0f32da62366c7f147b82291d6179dbca0e260027 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Autofixer/functions/fixReturnType.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Autofixer](../README.md) / fixReturnType + +# Function: fixReturnType() + +> **fixReturnType**(`funcLikeDecl`, `typeNode`): [`Autofix`](../interfaces/Autofix.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9495 + +## Parameters + +### funcLikeDecl + +[`FunctionLikeDeclaration`](../../../../../type-aliases/FunctionLikeDeclaration.md) + +### typeNode + +[`TypeNode`](../../../../../interfaces/TypeNode.md) + +## Returns + +[`Autofix`](../interfaces/Autofix.md) diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Autofixer/functions/shouldAutofix.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Autofixer/functions/shouldAutofix.md new file mode 100644 index 0000000000000000000000000000000000000000..379d646d72b5a858af254106e40b773c21eaa971 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Autofixer/functions/shouldAutofix.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Autofixer](../README.md) / shouldAutofix + +# Function: shouldAutofix() + +> **shouldAutofix**(`node`, `faultID`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9486 + +## Parameters + +### node + +[`Node`](../../../../../interfaces/Node.md) + +### faultID + +[`FaultID`](../../Problems/enumerations/FaultID.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Autofixer/interfaces/Autofix.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Autofixer/interfaces/Autofix.md new file mode 100644 index 0000000000000000000000000000000000000000..e28afbb5491f8e583ad52a4844b7cf7b2b7553d5 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Autofixer/interfaces/Autofix.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Autofixer](../README.md) / Autofix + +# Interface: Autofix + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9487 + +## Properties + +### end + +> **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9490 + +*** + +### replacementText + +> **replacementText**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9488 + +*** + +### start + +> **start**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9489 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Autofixer/variables/AUTOFIX_ALL.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Autofixer/variables/AUTOFIX_ALL.md new file mode 100644 index 0000000000000000000000000000000000000000..10b7b5fb627672fcd7c34dea0304f90223bdb2bc --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Autofixer/variables/AUTOFIX_ALL.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Autofixer](../README.md) / AUTOFIX\_ALL + +# Variable: AUTOFIX\_ALL + +> `const` **AUTOFIX\_ALL**: [`AutofixInfo`](../../Common/interfaces/AutofixInfo.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9484 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Autofixer/variables/autofixInfo.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Autofixer/variables/autofixInfo.md new file mode 100644 index 0000000000000000000000000000000000000000..c7d7b3fe89175d7df694f82442008fda81db032d --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Autofixer/variables/autofixInfo.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Autofixer](../README.md) / autofixInfo + +# Variable: autofixInfo + +> `const` **autofixInfo**: [`AutofixInfo`](../../Common/interfaces/AutofixInfo.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9485 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Common/README.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Common/README.md new file mode 100644 index 0000000000000000000000000000000000000000..3359f516ce06a0e18b6617fc1f988f50551ace8d --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Common/README.md @@ -0,0 +1,17 @@ +[**ArkAnalyzer**](../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../globals.md) / [ts](../../../../README.md) / [ArkTSLinter\_1\_1](../../README.md) / Common + +# Common + +## Enumerations + +- [ProblemSeverity](enumerations/ProblemSeverity.md) + +## Interfaces + +- [AutofixInfo](interfaces/AutofixInfo.md) +- [CommandLineOptions](interfaces/CommandLineOptions.md) +- [LintOptions](interfaces/LintOptions.md) diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Common/enumerations/ProblemSeverity.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Common/enumerations/ProblemSeverity.md new file mode 100644 index 0000000000000000000000000000000000000000..41d654cc7d967ea2f174b10396ed96407d142c4b --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Common/enumerations/ProblemSeverity.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Common](../README.md) / ProblemSeverity + +# Enumeration: ProblemSeverity + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9082 + +## Enumeration Members + +### ERROR + +> **ERROR**: `2` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9084 + +*** + +### WARNING + +> **WARNING**: `1` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9083 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Common/interfaces/AutofixInfo.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Common/interfaces/AutofixInfo.md new file mode 100644 index 0000000000000000000000000000000000000000..c5613c0ff50b7cc504ff8346a09c17d447a29e27 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Common/interfaces/AutofixInfo.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Common](../README.md) / AutofixInfo + +# Interface: AutofixInfo + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9063 + +## Properties + +### end + +> **end**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9066 + +*** + +### problemID + +> **problemID**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9064 + +*** + +### start + +> **start**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9065 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Common/interfaces/CommandLineOptions.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Common/interfaces/CommandLineOptions.md new file mode 100644 index 0000000000000000000000000000000000000000..78d4bde5c00dc4bbed0fa4dc9ca434c944029052 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Common/interfaces/CommandLineOptions.md @@ -0,0 +1,65 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Common](../README.md) / CommandLineOptions + +# Interface: CommandLineOptions + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9068 + +## Properties + +### autofixInfo? + +> `optional` **autofixInfo**: [`AutofixInfo`](AutofixInfo.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9075 + +*** + +### ideMode? + +> `optional` **ideMode**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9070 + +*** + +### inputFiles + +> **inputFiles**: `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9074 + +*** + +### logTscErrors? + +> `optional` **logTscErrors**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9071 + +*** + +### parsedConfigFile? + +> `optional` **parsedConfigFile**: [`ParsedCommandLine`](../../../../../interfaces/ParsedCommandLine.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9073 + +*** + +### strictMode? + +> `optional` **strictMode**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9069 + +*** + +### warningsAsErrors + +> **warningsAsErrors**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9072 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Common/interfaces/LintOptions.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Common/interfaces/LintOptions.md new file mode 100644 index 0000000000000000000000000000000000000000..836d1af4443cd3a5b183e9fd43f076b8d9967038 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Common/interfaces/LintOptions.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Common](../README.md) / LintOptions + +# Interface: LintOptions + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9077 + +## Indexable + +\[`key`: `string`\]: `any` + +## Properties + +### cmdOptions + +> **cmdOptions**: [`CommandLineOptions`](CommandLineOptions.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9078 + +*** + +### tsProgram? + +> `optional` **tsProgram**: [`Program`](../../../../../interfaces/Program.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9079 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/DiagnosticCheckerNamespace/README.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/DiagnosticCheckerNamespace/README.md new file mode 100644 index 0000000000000000000000000000000000000000..29ee40ad0c1a528350d5c6c870ca8306fdbc86df --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/DiagnosticCheckerNamespace/README.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../globals.md) / [ts](../../../../README.md) / [ArkTSLinter\_1\_1](../../README.md) / DiagnosticCheckerNamespace + +# DiagnosticCheckerNamespace + +## Interfaces + +- [DiagnosticChecker](interfaces/DiagnosticChecker.md) diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/DiagnosticCheckerNamespace/interfaces/DiagnosticChecker.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/DiagnosticCheckerNamespace/interfaces/DiagnosticChecker.md new file mode 100644 index 0000000000000000000000000000000000000000..84cf0c89a99b29f665c2416f691f4f1dfeaf7114 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/DiagnosticCheckerNamespace/interfaces/DiagnosticChecker.md @@ -0,0 +1,27 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [DiagnosticCheckerNamespace](../README.md) / DiagnosticChecker + +# Interface: DiagnosticChecker + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9098 + +## Methods + +### checkDiagnosticMessage() + +> **checkDiagnosticMessage**(`msgText`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9099 + +#### Parameters + +##### msgText + +`string` | [`DiagnosticMessageChain`](../../../../../interfaces/DiagnosticMessageChain.md) + +#### Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/README.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/README.md new file mode 100644 index 0000000000000000000000000000000000000000..975731e7357c680358167a8cd094306077c9bd04 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/README.md @@ -0,0 +1,30 @@ +[**ArkAnalyzer**](../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../globals.md) / [ts](../../../../README.md) / [ArkTSLinter\_1\_1](../../README.md) / LibraryTypeCallDiagnosticCheckerNamespace + +# LibraryTypeCallDiagnosticCheckerNamespace + +## Enumerations + +- [ErrorType](enumerations/ErrorType.md) + +## Classes + +- [LibraryTypeCallDiagnosticChecker](classes/LibraryTypeCallDiagnosticChecker.md) + +## Variables + +- [ARGUMENT\_OF\_TYPE](variables/ARGUMENT_OF_TYPE.md) +- [ARGUMENT\_OF\_TYPE\_0\_IS\_NOT\_ASSIGNABLE\_TO\_PARAMETER\_OF\_TYPE\_1\_ERROR\_CODE](variables/ARGUMENT_OF_TYPE_0_IS_NOT_ASSIGNABLE_TO_PARAMETER_OF_TYPE_1_ERROR_CODE.md) +- [ARGUMENT\_OF\_TYPE\_NULL\_IS\_NOT\_ASSIGNABLE\_TO\_PARAMETER\_OF\_TYPE\_1\_RE](variables/ARGUMENT_OF_TYPE_NULL_IS_NOT_ASSIGNABLE_TO_PARAMETER_OF_TYPE_1_RE.md) +- [ARGUMENT\_OF\_TYPE\_UNDEFINED\_IS\_NOT\_ASSIGNABLE\_TO\_PARAMETER\_OF\_TYPE\_1\_RE](variables/ARGUMENT_OF_TYPE_UNDEFINED_IS_NOT_ASSIGNABLE_TO_PARAMETER_OF_TYPE_1_RE.md) +- [IS\_NOT\_ASSIGNABLE\_TO\_PARAMETER\_OF\_TYPE](variables/IS_NOT_ASSIGNABLE_TO_PARAMETER_OF_TYPE.md) +- [IS\_NOT\_ASSIGNABLE\_TO\_TYPE](variables/IS_NOT_ASSIGNABLE_TO_TYPE.md) +- [NO\_OVERLOAD\_MATCHES\_THIS\_CALL\_ERROR\_CODE](variables/NO_OVERLOAD_MATCHES_THIS_CALL_ERROR_CODE.md) +- [TYPE](variables/TYPE.md) +- [TYPE\_0\_IS\_NOT\_ASSIGNABLE\_TO\_TYPE\_1\_ERROR\_CODE](variables/TYPE_0_IS_NOT_ASSIGNABLE_TO_TYPE_1_ERROR_CODE.md) +- [TYPE\_NULL\_IS\_NOT\_ASSIGNABLE\_TO\_TYPE\_1\_RE](variables/TYPE_NULL_IS_NOT_ASSIGNABLE_TO_TYPE_1_RE.md) +- [TYPE\_UNDEFINED\_IS\_NOT\_ASSIGNABLE\_TO\_TYPE\_1\_RE](variables/TYPE_UNDEFINED_IS_NOT_ASSIGNABLE_TO_TYPE_1_RE.md) +- [TYPE\_UNKNOWN\_IS\_NOT\_ASSIGNABLE\_TO\_TYPE\_1\_RE](variables/TYPE_UNKNOWN_IS_NOT_ASSIGNABLE_TO_TYPE_1_RE.md) diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/classes/LibraryTypeCallDiagnosticChecker.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/classes/LibraryTypeCallDiagnosticChecker.md new file mode 100644 index 0000000000000000000000000000000000000000..b57aed1fd11feeed7dca691bba9e04daf2e11c0c --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/classes/LibraryTypeCallDiagnosticChecker.md @@ -0,0 +1,197 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [LibraryTypeCallDiagnosticCheckerNamespace](../README.md) / LibraryTypeCallDiagnosticChecker + +# Class: LibraryTypeCallDiagnosticChecker + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9126 + +## Implements + +- [`DiagnosticChecker`](../../DiagnosticCheckerNamespace/interfaces/DiagnosticChecker.md) + +## Constructors + +### new LibraryTypeCallDiagnosticChecker() + +> **new LibraryTypeCallDiagnosticChecker**(`filteredDiagnosticMessages`): [`LibraryTypeCallDiagnosticChecker`](LibraryTypeCallDiagnosticChecker.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9130 + +#### Parameters + +##### filteredDiagnosticMessages + +[`DiagnosticMessageChain`](../../../../../interfaces/DiagnosticMessageChain.md)[] + +#### Returns + +[`LibraryTypeCallDiagnosticChecker`](LibraryTypeCallDiagnosticChecker.md) + +## Properties + +### diagnosticMessages + +> **diagnosticMessages**: `undefined` \| [`DiagnosticMessageChain`](../../../../../interfaces/DiagnosticMessageChain.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9128 + +*** + +### filteredDiagnosticMessages + +> **filteredDiagnosticMessages**: [`DiagnosticMessageChain`](../../../../../interfaces/DiagnosticMessageChain.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9129 + +*** + +### inLibCall + +> **inLibCall**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9127 + +## Methods + +### checkDiagnosticMessage() + +> **checkDiagnosticMessage**(`msgText`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9135 + +#### Parameters + +##### msgText + +`string` | [`DiagnosticMessageChain`](../../../../../interfaces/DiagnosticMessageChain.md) + +#### Returns + +`boolean` + +#### Implementation of + +[`DiagnosticChecker`](../../DiagnosticCheckerNamespace/interfaces/DiagnosticChecker.md).[`checkDiagnosticMessage`](../../DiagnosticCheckerNamespace/interfaces/DiagnosticChecker.md#checkdiagnosticmessage) + +*** + +### checkFilteredDiagnosticMessages() + +> **checkFilteredDiagnosticMessages**(`msgText`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9134 + +#### Parameters + +##### msgText + +`string` | [`DiagnosticMessageChain`](../../../../../interfaces/DiagnosticMessageChain.md) + +#### Returns + +`boolean` + +*** + +### checkMessageText() + +> **checkMessageText**(`msg`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9132 + +#### Parameters + +##### msg + +`string` + +#### Returns + +`boolean` + +*** + +### configure() + +> **configure**(`inLibCall`, `diagnosticMessages`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9131 + +#### Parameters + +##### inLibCall + +`boolean` + +##### diagnosticMessages + +[`DiagnosticMessageChain`](../../../../../interfaces/DiagnosticMessageChain.md)[] + +#### Returns + +`void` + +*** + +### checkMessageChain() + +> `static` **checkMessageChain**(`chain`, `inLibCall`): [`ErrorType`](../enumerations/ErrorType.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9133 + +#### Parameters + +##### chain + +[`DiagnosticMessageChain`](../../../../../interfaces/DiagnosticMessageChain.md) + +##### inLibCall + +`boolean` + +#### Returns + +[`ErrorType`](../enumerations/ErrorType.md) + +*** + +### collectDiagnosticMessage() + +> `static` **collectDiagnosticMessage**(`diagnosticMessageChain`, `textSet`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9137 + +#### Parameters + +##### diagnosticMessageChain + +[`DiagnosticMessageChain`](../../../../../interfaces/DiagnosticMessageChain.md) + +##### textSet + +[`Set`](../../../../../interfaces/Set.md)\<`string`\> + +#### Returns + +`void` + +*** + +### rebuildTscDiagnostics() + +> `static` **rebuildTscDiagnostics**(`tscStrictDiagnostics`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9136 + +#### Parameters + +##### tscStrictDiagnostics + +[`Map`](../../../../../interfaces/Map.md)\<[`Diagnostic`](../../../../../interfaces/Diagnostic.md)[]\> + +#### Returns + +`void` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/enumerations/ErrorType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/enumerations/ErrorType.md new file mode 100644 index 0000000000000000000000000000000000000000..2fc1aab40af353e37b9014ac937da01d34c0cea5 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/enumerations/ErrorType.md @@ -0,0 +1,41 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [LibraryTypeCallDiagnosticCheckerNamespace](../README.md) / ErrorType + +# Enumeration: ErrorType + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9120 + +## Enumeration Members + +### NO\_ERROR + +> **NO\_ERROR**: `0` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9121 + +*** + +### NULL + +> **NULL**: `2` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9123 + +*** + +### UNDEFINED + +> **UNDEFINED**: `3` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9124 + +*** + +### UNKNOW + +> **UNKNOW**: `1` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9122 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/variables/ARGUMENT_OF_TYPE.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/variables/ARGUMENT_OF_TYPE.md new file mode 100644 index 0000000000000000000000000000000000000000..69062625cba614814a92a1417207d2f807e91c7e --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/variables/ARGUMENT_OF_TYPE.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [LibraryTypeCallDiagnosticCheckerNamespace](../README.md) / ARGUMENT\_OF\_TYPE + +# Variable: ARGUMENT\_OF\_TYPE + +> `const` **ARGUMENT\_OF\_TYPE**: `"Argument of type"` = `"Argument of type"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9118 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/variables/ARGUMENT_OF_TYPE_0_IS_NOT_ASSIGNABLE_TO_PARAMETER_OF_TYPE_1_ERROR_CODE.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/variables/ARGUMENT_OF_TYPE_0_IS_NOT_ASSIGNABLE_TO_PARAMETER_OF_TYPE_1_ERROR_CODE.md new file mode 100644 index 0000000000000000000000000000000000000000..c4075199e21a4f65f04bb65e43cacad7ab85c9bb --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/variables/ARGUMENT_OF_TYPE_0_IS_NOT_ASSIGNABLE_TO_PARAMETER_OF_TYPE_1_ERROR_CODE.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [LibraryTypeCallDiagnosticCheckerNamespace](../README.md) / ARGUMENT\_OF\_TYPE\_0\_IS\_NOT\_ASSIGNABLE\_TO\_PARAMETER\_OF\_TYPE\_1\_ERROR\_CODE + +# Variable: ARGUMENT\_OF\_TYPE\_0\_IS\_NOT\_ASSIGNABLE\_TO\_PARAMETER\_OF\_TYPE\_1\_ERROR\_CODE + +> `const` **ARGUMENT\_OF\_TYPE\_0\_IS\_NOT\_ASSIGNABLE\_TO\_PARAMETER\_OF\_TYPE\_1\_ERROR\_CODE**: `2345` = `2345` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9112 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/variables/ARGUMENT_OF_TYPE_NULL_IS_NOT_ASSIGNABLE_TO_PARAMETER_OF_TYPE_1_RE.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/variables/ARGUMENT_OF_TYPE_NULL_IS_NOT_ASSIGNABLE_TO_PARAMETER_OF_TYPE_1_RE.md new file mode 100644 index 0000000000000000000000000000000000000000..4ef43bc393e21452602f3554a0a3cadaa982ceee --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/variables/ARGUMENT_OF_TYPE_NULL_IS_NOT_ASSIGNABLE_TO_PARAMETER_OF_TYPE_1_RE.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [LibraryTypeCallDiagnosticCheckerNamespace](../README.md) / ARGUMENT\_OF\_TYPE\_NULL\_IS\_NOT\_ASSIGNABLE\_TO\_PARAMETER\_OF\_TYPE\_1\_RE + +# Variable: ARGUMENT\_OF\_TYPE\_NULL\_IS\_NOT\_ASSIGNABLE\_TO\_PARAMETER\_OF\_TYPE\_1\_RE + +> `const` **ARGUMENT\_OF\_TYPE\_NULL\_IS\_NOT\_ASSIGNABLE\_TO\_PARAMETER\_OF\_TYPE\_1\_RE**: `RegExp` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9113 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/variables/ARGUMENT_OF_TYPE_UNDEFINED_IS_NOT_ASSIGNABLE_TO_PARAMETER_OF_TYPE_1_RE.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/variables/ARGUMENT_OF_TYPE_UNDEFINED_IS_NOT_ASSIGNABLE_TO_PARAMETER_OF_TYPE_1_RE.md new file mode 100644 index 0000000000000000000000000000000000000000..a806975629c33a2c83dfaf66f14b777fbcad300c --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/variables/ARGUMENT_OF_TYPE_UNDEFINED_IS_NOT_ASSIGNABLE_TO_PARAMETER_OF_TYPE_1_RE.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [LibraryTypeCallDiagnosticCheckerNamespace](../README.md) / ARGUMENT\_OF\_TYPE\_UNDEFINED\_IS\_NOT\_ASSIGNABLE\_TO\_PARAMETER\_OF\_TYPE\_1\_RE + +# Variable: ARGUMENT\_OF\_TYPE\_UNDEFINED\_IS\_NOT\_ASSIGNABLE\_TO\_PARAMETER\_OF\_TYPE\_1\_RE + +> `const` **ARGUMENT\_OF\_TYPE\_UNDEFINED\_IS\_NOT\_ASSIGNABLE\_TO\_PARAMETER\_OF\_TYPE\_1\_RE**: `RegExp` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9114 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/variables/IS_NOT_ASSIGNABLE_TO_PARAMETER_OF_TYPE.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/variables/IS_NOT_ASSIGNABLE_TO_PARAMETER_OF_TYPE.md new file mode 100644 index 0000000000000000000000000000000000000000..472f9e6150909a99e8865473dd6811de685983f1 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/variables/IS_NOT_ASSIGNABLE_TO_PARAMETER_OF_TYPE.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [LibraryTypeCallDiagnosticCheckerNamespace](../README.md) / IS\_NOT\_ASSIGNABLE\_TO\_PARAMETER\_OF\_TYPE + +# Variable: IS\_NOT\_ASSIGNABLE\_TO\_PARAMETER\_OF\_TYPE + +> `const` **IS\_NOT\_ASSIGNABLE\_TO\_PARAMETER\_OF\_TYPE**: `"is not assignable to parameter of type"` = `"is not assignable to parameter of type"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9119 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/variables/IS_NOT_ASSIGNABLE_TO_TYPE.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/variables/IS_NOT_ASSIGNABLE_TO_TYPE.md new file mode 100644 index 0000000000000000000000000000000000000000..e27fb24fb04f4543fb464f1acae9014f8021bb2c --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/variables/IS_NOT_ASSIGNABLE_TO_TYPE.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [LibraryTypeCallDiagnosticCheckerNamespace](../README.md) / IS\_NOT\_ASSIGNABLE\_TO\_TYPE + +# Variable: IS\_NOT\_ASSIGNABLE\_TO\_TYPE + +> `const` **IS\_NOT\_ASSIGNABLE\_TO\_TYPE**: `"is not assignable to type"` = `"is not assignable to type"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9117 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/variables/NO_OVERLOAD_MATCHES_THIS_CALL_ERROR_CODE.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/variables/NO_OVERLOAD_MATCHES_THIS_CALL_ERROR_CODE.md new file mode 100644 index 0000000000000000000000000000000000000000..93d220f70136838b045038494454530937d40048 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/variables/NO_OVERLOAD_MATCHES_THIS_CALL_ERROR_CODE.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [LibraryTypeCallDiagnosticCheckerNamespace](../README.md) / NO\_OVERLOAD\_MATCHES\_THIS\_CALL\_ERROR\_CODE + +# Variable: NO\_OVERLOAD\_MATCHES\_THIS\_CALL\_ERROR\_CODE + +> `const` **NO\_OVERLOAD\_MATCHES\_THIS\_CALL\_ERROR\_CODE**: `2769` = `2769` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9115 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/variables/TYPE.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/variables/TYPE.md new file mode 100644 index 0000000000000000000000000000000000000000..87869a6a522192b4b3b8e09fcb1d844cdf7feaf6 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/variables/TYPE.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [LibraryTypeCallDiagnosticCheckerNamespace](../README.md) / TYPE + +# Variable: TYPE + +> `const` **TYPE**: `"Type"` = `"Type"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9116 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/variables/TYPE_0_IS_NOT_ASSIGNABLE_TO_TYPE_1_ERROR_CODE.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/variables/TYPE_0_IS_NOT_ASSIGNABLE_TO_TYPE_1_ERROR_CODE.md new file mode 100644 index 0000000000000000000000000000000000000000..34a3a0a6d3bb6e7b5e8dd9cdc322737b4e31c388 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/variables/TYPE_0_IS_NOT_ASSIGNABLE_TO_TYPE_1_ERROR_CODE.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [LibraryTypeCallDiagnosticCheckerNamespace](../README.md) / TYPE\_0\_IS\_NOT\_ASSIGNABLE\_TO\_TYPE\_1\_ERROR\_CODE + +# Variable: TYPE\_0\_IS\_NOT\_ASSIGNABLE\_TO\_TYPE\_1\_ERROR\_CODE + +> `const` **TYPE\_0\_IS\_NOT\_ASSIGNABLE\_TO\_TYPE\_1\_ERROR\_CODE**: `2322` = `2322` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9108 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/variables/TYPE_NULL_IS_NOT_ASSIGNABLE_TO_TYPE_1_RE.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/variables/TYPE_NULL_IS_NOT_ASSIGNABLE_TO_TYPE_1_RE.md new file mode 100644 index 0000000000000000000000000000000000000000..d2d511631855f1cd80c292b674fe1a71cec14ed6 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/variables/TYPE_NULL_IS_NOT_ASSIGNABLE_TO_TYPE_1_RE.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [LibraryTypeCallDiagnosticCheckerNamespace](../README.md) / TYPE\_NULL\_IS\_NOT\_ASSIGNABLE\_TO\_TYPE\_1\_RE + +# Variable: TYPE\_NULL\_IS\_NOT\_ASSIGNABLE\_TO\_TYPE\_1\_RE + +> `const` **TYPE\_NULL\_IS\_NOT\_ASSIGNABLE\_TO\_TYPE\_1\_RE**: `RegExp` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9110 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/variables/TYPE_UNDEFINED_IS_NOT_ASSIGNABLE_TO_TYPE_1_RE.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/variables/TYPE_UNDEFINED_IS_NOT_ASSIGNABLE_TO_TYPE_1_RE.md new file mode 100644 index 0000000000000000000000000000000000000000..476cdcb8c9efbe9a3a4609b14d2f3b50b3b7eb0c --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/variables/TYPE_UNDEFINED_IS_NOT_ASSIGNABLE_TO_TYPE_1_RE.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [LibraryTypeCallDiagnosticCheckerNamespace](../README.md) / TYPE\_UNDEFINED\_IS\_NOT\_ASSIGNABLE\_TO\_TYPE\_1\_RE + +# Variable: TYPE\_UNDEFINED\_IS\_NOT\_ASSIGNABLE\_TO\_TYPE\_1\_RE + +> `const` **TYPE\_UNDEFINED\_IS\_NOT\_ASSIGNABLE\_TO\_TYPE\_1\_RE**: `RegExp` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9111 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/variables/TYPE_UNKNOWN_IS_NOT_ASSIGNABLE_TO_TYPE_1_RE.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/variables/TYPE_UNKNOWN_IS_NOT_ASSIGNABLE_TO_TYPE_1_RE.md new file mode 100644 index 0000000000000000000000000000000000000000..fbc8ebd2cb77adab47798c588814651b23463fb1 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/LibraryTypeCallDiagnosticCheckerNamespace/variables/TYPE_UNKNOWN_IS_NOT_ASSIGNABLE_TO_TYPE_1_RE.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [LibraryTypeCallDiagnosticCheckerNamespace](../README.md) / TYPE\_UNKNOWN\_IS\_NOT\_ASSIGNABLE\_TO\_TYPE\_1\_RE + +# Variable: TYPE\_UNKNOWN\_IS\_NOT\_ASSIGNABLE\_TO\_TYPE\_1\_RE + +> `const` **TYPE\_UNKNOWN\_IS\_NOT\_ASSIGNABLE\_TO\_TYPE\_1\_RE**: `RegExp` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9109 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Problems/README.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Problems/README.md new file mode 100644 index 0000000000000000000000000000000000000000..e30d160c2dc44cab4816058a10d9618b0e9f4b8e --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Problems/README.md @@ -0,0 +1,19 @@ +[**ArkAnalyzer**](../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../globals.md) / [ts](../../../../README.md) / [ArkTSLinter\_1\_1](../../README.md) / Problems + +# Problems + +## Enumerations + +- [FaultID](enumerations/FaultID.md) + +## Classes + +- [FaultAttributes](classes/FaultAttributes.md) + +## Variables + +- [faultsAttrs](variables/faultsAttrs.md) diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Problems/classes/FaultAttributes.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Problems/classes/FaultAttributes.md new file mode 100644 index 0000000000000000000000000000000000000000..8738ccbc47a756f7f6bda8ae45c3b6d280d2650b --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Problems/classes/FaultAttributes.md @@ -0,0 +1,59 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Problems](../README.md) / FaultAttributes + +# Class: FaultAttributes + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9260 + +## Constructors + +### new FaultAttributes() + +> **new FaultAttributes**(`cookBookRef`, `migratable`?, `severity`?): [`FaultAttributes`](FaultAttributes.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9264 + +#### Parameters + +##### cookBookRef + +`number` + +##### migratable? + +`boolean` + +##### severity? + +[`ProblemSeverity`](../../Common/enumerations/ProblemSeverity.md) + +#### Returns + +[`FaultAttributes`](FaultAttributes.md) + +## Properties + +### cookBookRef + +> **cookBookRef**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9261 + +*** + +### migratable + +> **migratable**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9262 + +*** + +### severity + +> **severity**: [`ProblemSeverity`](../../Common/enumerations/ProblemSeverity.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9263 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Problems/enumerations/FaultID.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Problems/enumerations/FaultID.md new file mode 100644 index 0000000000000000000000000000000000000000..7a7987c301e8f192f2684c641990362707a87551 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Problems/enumerations/FaultID.md @@ -0,0 +1,905 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Problems](../README.md) / FaultID + +# Enumeration: FaultID + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9146 + +## Enumeration Members + +### AnyType + +> **AnyType**: `0` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9147 + +*** + +### ArrayLiteralNoContextType + +> **ArrayLiteralNoContextType**: `3` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9150 + +*** + +### CallSignature + +> **CallSignature**: `36` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9183 + +*** + +### CatchWithUnsupportedType + +> **CatchWithUnsupportedType**: `29` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9176 + +*** + +### ClassAsObject + +> **ClassAsObject**: `43` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9190 + +*** + +### ClassExpression + +> **ClassExpression**: `25` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9172 + +*** + +### CommaOperator + +> **CommaOperator**: `23` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9170 + +*** + +### ComputedPropertyName + +> **ComputedPropertyName**: `4` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9151 + +*** + +### ConditionalType + +> **ConditionalType**: `40` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9187 + +*** + +### ConstAssertion + +> **ConstAssertion**: `72` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9219 + +*** + +### ConstructorFuncs + +> **ConstructorFuncs**: `35` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9182 + +*** + +### ConstructorIface + +> **ConstructorIface**: `34` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9181 + +*** + +### ConstructorType + +> **ConstructorType**: `33` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9180 + +*** + +### DeclWithDuplicateName + +> **DeclWithDuplicateName**: `31` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9178 + +*** + +### DefiniteAssignment + +> **DefiniteAssignment**: `65` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9212 + +*** + +### DeleteOperator + +> **DeleteOperator**: `30` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9177 + +*** + +### DestructuringAssignment + +> **DestructuringAssignment**: `26` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9173 + +*** + +### DestructuringDeclaration + +> **DestructuringDeclaration**: `27` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9174 + +*** + +### DestructuringParameter + +> **DestructuringParameter**: `8` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9155 + +*** + +### EnumMemberNonConstInit + +> **EnumMemberNonConstInit**: `49` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9196 + +*** + +### EnumMerging + +> **EnumMerging**: `11` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9158 + +*** + +### ErrorSuppression + +> **ErrorSuppression**: `76` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9223 + +*** + +### EsObjectType + +> **EsObjectType**: `79` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9226 + +*** + +### ExportAssignment + +> **ExportAssignment**: `56` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9203 + +*** + +### ForInStatement + +> **ForInStatement**: `18` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9165 + +*** + +### FunctionApplyCall + +> **FunctionApplyCall**: `70` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9217 + +*** + +### FunctionBind + +> **FunctionBind**: `71` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9218 + +*** + +### FunctionContainsThis + +> **FunctionContainsThis**: `46` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9193 + +*** + +### FunctionExpression + +> **FunctionExpression**: `20` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9167 + +*** + +### GeneratorFunction + +> **GeneratorFunction**: `45` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9192 + +*** + +### GenericCallNoTypeArgs + +> **GenericCallNoTypeArgs**: `58` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9205 + +*** + +### GlobalThis + +> **GlobalThis**: `67` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9214 + +*** + +### ImplementsClass + +> **ImplementsClass**: `50` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9197 + +*** + +### ImportAfterStatement + +> **ImportAfterStatement**: `78` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9225 + +*** + +### ImportAssertion + +> **ImportAssertion**: `73` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9220 + +*** + +### ImportAssignment + +> **ImportAssignment**: `57` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9204 + +*** + +### IndexedAccessType + +> **IndexedAccessType**: `16` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9163 + +*** + +### IndexMember + +> **IndexMember**: `13` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9160 + +*** + +### InOperator + +> **InOperator**: `19` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9166 + +*** + +### InstanceofUnsupported + +> **InstanceofUnsupported**: `60` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9207 + +*** + +### IntefaceExtendDifProps + +> **IntefaceExtendDifProps**: `54` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9201 + +*** + +### InterfaceExtendsClass + +> **InterfaceExtendsClass**: `12` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9159 + +*** + +### InterfaceMerging + +> **InterfaceMerging**: `10` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9157 + +*** + +### IntersectionType + +> **IntersectionType**: `21` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9168 + +*** + +### IsOperator + +> **IsOperator**: `7` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9154 + +*** + +### JsxElement + +> **JsxElement**: `48` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9195 + +*** + +### LAST\_ID + +> **LAST\_ID**: `111` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9258 + +*** + +### LimitedReturnTypeInference + +> **LimitedReturnTypeInference**: `24` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9171 + +*** + +### LimitedStdLibApi + +> **LimitedStdLibApi**: `75` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9222 + +*** + +### LiteralAsPropertyName + +> **LiteralAsPropertyName**: `5` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9152 + +*** + +### LocalFunction + +> **LocalFunction**: `39` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9186 + +*** + +### MappedType + +> **MappedType**: `41` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9188 + +*** + +### MethodReassignment + +> **MethodReassignment**: `51` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9198 + +*** + +### MultipleStaticBlocks + +> **MultipleStaticBlocks**: `52` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9199 + +*** + +### NamespaceAsObject + +> **NamespaceAsObject**: `42` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9189 + +*** + +### NewTarget + +> **NewTarget**: `64` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9211 + +*** + +### NoNamespaceImportEtsToTs + +> **NoNamespaceImportEtsToTs**: `96` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9243 + +*** + +### NonDeclarationInNamespace + +> **NonDeclarationInNamespace**: `44` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9191 + +*** + +### NoSideEffectImportEtsToTs + +> **NoSideEffectImportEtsToTs**: `97` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9244 + +*** + +### NoTsImportEts + +> **NoTsImportEts**: `92` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9239 + +*** + +### NoTsReExportEts + +> **NoTsReExportEts**: `95` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9242 + +*** + +### ObjectLiteralNoContextType + +> **ObjectLiteralNoContextType**: `2` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9149 + +*** + +### ObjectTypeLiteral + +> **ObjectTypeLiteral**: `22` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9169 + +*** + +### ParameterProperties + +> **ParameterProperties**: `59` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9206 + +*** + +### PrivateIdentifier + +> **PrivateIdentifier**: `38` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9185 + +*** + +### PropertyAccessByIndex + +> **PropertyAccessByIndex**: `47` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9194 + +*** + +### PropertyDeclOnFunction + +> **PropertyDeclOnFunction**: `69` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9216 + +*** + +### Prototype + +> **Prototype**: `66` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9213 + +*** + +### SendableAsExpr + +> **SendableAsExpr**: `88` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9235 + +*** + +### SendableBetaCompatible + +> **SendableBetaCompatible**: `110` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9257 + +*** + +### SendableCapturedVars + +> **SendableCapturedVars**: `84` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9231 + +*** + +### SendableClassDecorator + +> **SendableClassDecorator**: `85` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9232 + +*** + +### SendableClassInheritance + +> **SendableClassInheritance**: `80` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9227 + +*** + +### SendableClosureExport + +> **SendableClosureExport**: `108` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9255 + +*** + +### SendableComputedPropName + +> **SendableComputedPropName**: `87` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9234 + +*** + +### SendableDecoratorLimited + +> **SendableDecoratorLimited**: `107` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9254 + +*** + +### SendableDefiniteAssignment + +> **SendableDefiniteAssignment**: `82` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9229 + +*** + +### SendableExplicitFieldType + +> **SendableExplicitFieldType**: `98` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9245 + +*** + +### SendableFunctionAsExpr + +> **SendableFunctionAsExpr**: `106` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9253 + +*** + +### SendableFunctionAssignment + +> **SendableFunctionAssignment**: `103` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9250 + +*** + +### SendableFunctionDecorator + +> **SendableFunctionDecorator**: `100` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9247 + +*** + +### SendableFunctionImportedVariables + +> **SendableFunctionImportedVariables**: `99` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9246 + +*** + +### SendableFunctionOverloadDecorator + +> **SendableFunctionOverloadDecorator**: `104` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9251 + +*** + +### SendableFunctionProperty + +> **SendableFunctionProperty**: `105` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9252 + +*** + +### SendableGenericTypes + +> **SendableGenericTypes**: `83` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9230 + +*** + +### SendableObjectInitialization + +> **SendableObjectInitialization**: `86` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9233 + +*** + +### SendablePropType + +> **SendablePropType**: `81` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9228 + +*** + +### SendableTypeAliasDeclaration + +> **SendableTypeAliasDeclaration**: `102` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9249 + +*** + +### SendableTypeAliasDecorator + +> **SendableTypeAliasDecorator**: `101` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9248 + +*** + +### SendableTypeExported + +> **SendableTypeExported**: `94` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9241 + +*** + +### SendableTypeInheritance + +> **SendableTypeInheritance**: `93` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9240 + +*** + +### SharedModuleExports + +> **SharedModuleExports**: `90` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9237 + +*** + +### SharedModuleExportsWarning + +> **SharedModuleExportsWarning**: `109` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9256 + +*** + +### SharedModuleNoWildcardExport + +> **SharedModuleNoWildcardExport**: `91` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9238 + +*** + +### SharedNoSideEffectImport + +> **SharedNoSideEffectImport**: `89` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9236 + +*** + +### ShorthandAmbientModuleDecl + +> **ShorthandAmbientModuleDecl**: `61` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9208 + +*** + +### SpreadOperator + +> **SpreadOperator**: `74` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9221 + +*** + +### StrictDiagnostic + +> **StrictDiagnostic**: `77` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9224 + +*** + +### StructuralIdentity + +> **StructuralIdentity**: `55` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9202 + +*** + +### SymbolType + +> **SymbolType**: `1` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9148 + +*** + +### ThisType + +> **ThisType**: `53` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9200 + +*** + +### ThrowStatement + +> **ThrowStatement**: `15` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9162 + +*** + +### TypeAssertion + +> **TypeAssertion**: `37` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9184 + +*** + +### TypeQuery + +> **TypeQuery**: `6` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9153 + +*** + +### UMDModuleDefinition + +> **UMDModuleDefinition**: `63` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9210 + +*** + +### UnaryArithmNotNumber + +> **UnaryArithmNotNumber**: `32` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9179 + +*** + +### UnknownType + +> **UnknownType**: `17` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9164 + +*** + +### UtilityType + +> **UtilityType**: `68` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9215 + +*** + +### VarDeclaration + +> **VarDeclaration**: `28` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9175 + +*** + +### WildcardsInModuleName + +> **WildcardsInModuleName**: `62` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9209 + +*** + +### WithStatement + +> **WithStatement**: `14` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9161 + +*** + +### YieldExpression + +> **YieldExpression**: `9` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9156 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Problems/variables/faultsAttrs.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Problems/variables/faultsAttrs.md new file mode 100644 index 0000000000000000000000000000000000000000..d27bfbc3e2f705d59a889cec409337ef954cd2f9 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Problems/variables/faultsAttrs.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Problems](../README.md) / faultsAttrs + +# Variable: faultsAttrs + +> `const` **faultsAttrs**: [`FaultAttributes`](../classes/FaultAttributes.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9266 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/README.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/README.md new file mode 100644 index 0000000000000000000000000000000000000000..158c54af086513fb81cd9b0eb83ef508fbefe509 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/README.md @@ -0,0 +1,218 @@ +[**ArkAnalyzer**](../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../globals.md) / [ts](../../../../README.md) / [ArkTSLinter\_1\_1](../../README.md) / Utils + +# Utils + +## Type Aliases + +- [CheckType](type-aliases/CheckType.md) + +## Variables + +- [ALLOWED\_STD\_SYMBOL\_API](variables/ALLOWED_STD_SYMBOL_API.md) +- [ARKTS\_COLLECTIONS\_D\_ETS](variables/ARKTS_COLLECTIONS_D_ETS.md) +- [ARKTS\_IGNORE\_DIRS](variables/ARKTS_IGNORE_DIRS.md) +- [ARKTS\_IGNORE\_FILES](variables/ARKTS_IGNORE_FILES.md) +- [ARKTS\_LANG\_D\_ETS](variables/ARKTS_LANG_D_ETS.md) +- [COLLECTIONS\_NAMESPACE](variables/COLLECTIONS_NAMESPACE.md) +- [D\_TS](variables/D_TS.md) +- [ES\_OBJECT](variables/ES_OBJECT.md) +- [FUNCTION\_HAS\_NO\_RETURN\_ERROR\_CODE](variables/FUNCTION_HAS_NO_RETURN_ERROR_CODE.md) +- [ISENDABLE\_TYPE](variables/ISENDABLE_TYPE.md) +- [LANG\_NAMESPACE](variables/LANG_NAMESPACE.md) +- [LIMITED\_STANDARD\_UTILITY\_TYPES](variables/LIMITED_STANDARD_UTILITY_TYPES.md) +- [LIMITED\_STD\_GLOBAL\_FUNC](variables/LIMITED_STD_GLOBAL_FUNC.md) +- [LIMITED\_STD\_OBJECT\_API](variables/LIMITED_STD_OBJECT_API.md) +- [LIMITED\_STD\_PROXYHANDLER\_API](variables/LIMITED_STD_PROXYHANDLER_API.md) +- [LIMITED\_STD\_REFLECT\_API](variables/LIMITED_STD_REFLECT_API.md) +- [NON\_INITIALIZABLE\_PROPERTY\_CLASS\_DECORATORS](variables/NON_INITIALIZABLE_PROPERTY_CLASS_DECORATORS.md) +- [NON\_INITIALIZABLE\_PROPERTY\_DECORATORS](variables/NON_INITIALIZABLE_PROPERTY_DECORATORS.md) +- [NON\_RETURN\_FUNCTION\_DECORATORS](variables/NON_RETURN_FUNCTION_DECORATORS.md) +- [PROPERTY\_HAS\_NO\_INITIALIZER\_ERROR\_CODE](variables/PROPERTY_HAS_NO_INITIALIZER_ERROR_CODE.md) +- [SENDABLE\_CLOSURE\_DECLS](variables/SENDABLE_CLOSURE_DECLS.md) +- [SENDABLE\_DECORATOR](variables/SENDABLE_DECORATOR.md) +- [SENDABLE\_DECORATOR\_NODES](variables/SENDABLE_DECORATOR_NODES.md) +- [SENDABLE\_INTERFACE](variables/SENDABLE_INTERFACE.md) +- [STANDARD\_LIBRARIES](variables/STANDARD_LIBRARIES.md) +- [TYPED\_ARRAYS](variables/TYPED_ARRAYS.md) +- [USE\_SHARED](variables/USE_SHARED.md) + +## Functions + +- [checkTypeSet](functions/checkTypeSet.md) +- [clearTrueSymbolAtLocationCache](functions/clearTrueSymbolAtLocationCache.md) +- [clearTypeChecker](functions/clearTypeChecker.md) +- [decodeAutofixInfo](functions/decodeAutofixInfo.md) +- [encodeProblemInfo](functions/encodeProblemInfo.md) +- [entityNameToString](functions/entityNameToString.md) +- [findParentIf](functions/findParentIf.md) +- [followIfAliased](functions/followIfAliased.md) +- [getAccessModifier](functions/getAccessModifier.md) +- [getCatchWithUnsupportedTypeHighlightRange](functions/getCatchWithUnsupportedTypeHighlightRange.md) +- [getClassExpressionHighlightRange](functions/getClassExpressionHighlightRange.md) +- [getConstAssertionHighlightRange](functions/getConstAssertionHighlightRange.md) +- [getDeclaration](functions/getDeclaration.md) +- [getDeclarationNode](functions/getDeclarationNode.md) +- [getDeclWithDuplicateNameHighlightRange](functions/getDeclWithDuplicateNameHighlightRange.md) +- [getDecoratorName](functions/getDecoratorName.md) +- [getDecoratorsIfInSendableClass](functions/getDecoratorsIfInSendableClass.md) +- [getDeleteOperatorHighlightRange](functions/getDeleteOperatorHighlightRange.md) +- [getEndPos](functions/getEndPos.md) +- [getForInStatementHighlightRange](functions/getForInStatementHighlightRange.md) +- [getFunctionApplyCallHighlightRange](functions/getFunctionApplyCallHighlightRange.md) +- [getHighlightRange](functions/getHighlightRange.md) +- [getInstanceofUnsupportedHighlightRange](functions/getInstanceofUnsupportedHighlightRange.md) +- [getKeywordHighlightRange](functions/getKeywordHighlightRange.md) +- [getLimitedReturnTypeInferenceHighlightRange](functions/getLimitedReturnTypeInferenceHighlightRange.md) +- [getLocalFunctionHighlightRange](functions/getLocalFunctionHighlightRange.md) +- [getModifier](functions/getModifier.md) +- [getMultipleStaticBlocksHighlightRange](functions/getMultipleStaticBlocksHighlightRange.md) +- [getNonNullableType](functions/getNonNullableType.md) +- [getNonSendableDecorators](functions/getNonSendableDecorators.md) +- [getObjectLiteralNoContextTypeHighlightRange](functions/getObjectLiteralNoContextTypeHighlightRange.md) +- [getParentSymbolName](functions/getParentSymbolName.md) +- [getScriptKind](functions/getScriptKind.md) +- [getSendableDecorator](functions/getSendableDecorator.md) +- [getSendableDefiniteAssignmentHighlightRange](functions/getSendableDefiniteAssignmentHighlightRange.md) +- [getStartPos](functions/getStartPos.md) +- [getSymbolDeclarationTypeNode](functions/getSymbolDeclarationTypeNode.md) +- [getSymbolOfCallExpression](functions/getSymbolOfCallExpression.md) +- [getTypeOrTypeConstraintAtLocation](functions/getTypeOrTypeConstraintAtLocation.md) +- [getTypeQueryHighlightRange](functions/getTypeQueryHighlightRange.md) +- [getVarDeclarationHighlightRange](functions/getVarDeclarationHighlightRange.md) +- [getVariableDeclarationTypeNode](functions/getVariableDeclarationTypeNode.md) +- [getWithStatementHighlightRange](functions/getWithStatementHighlightRange.md) +- [hasAccessModifier](functions/hasAccessModifier.md) +- [hasEsObjectType](functions/hasEsObjectType.md) +- [hasLibraryType](functions/hasLibraryType.md) +- [hasMethods](functions/hasMethods.md) +- [hasModifier](functions/hasModifier.md) +- [hasPredecessor](functions/hasPredecessor.md) +- [hasSendableDecorator](functions/hasSendableDecorator.md) +- [hasSendableDecoratorFunctionOverload](functions/hasSendableDecoratorFunctionOverload.md) +- [hasSendableTypeAlias](functions/hasSendableTypeAlias.md) +- [isAllowedIndexSignature](functions/isAllowedIndexSignature.md) +- [isAnonymous](functions/isAnonymous.md) +- [isAnonymousType](functions/isAnonymousType.md) +- [isAnyType](functions/isAnyType.md) +- [isArkTSCollectionsArrayLikeType](functions/isArkTSCollectionsArrayLikeType.md) +- [isArkTSCollectionsClassOrInterfaceDeclaration](functions/isArkTSCollectionsClassOrInterfaceDeclaration.md) +- [isArray](functions/isArray.md) +- [isAssignmentOperator](functions/isAssignmentOperator.md) +- [isBooleanLikeType](functions/isBooleanLikeType.md) +- [isCallToFunctionWithOmittedReturnType](functions/isCallToFunctionWithOmittedReturnType.md) +- [isCompileTimeExpression](functions/isCompileTimeExpression.md) +- [isConst](functions/isConst.md) +- [isConstEnum](functions/isConstEnum.md) +- [isDefaultImport](functions/isDefaultImport.md) +- [isDestructuringAssignmentLHS](functions/isDestructuringAssignmentLHS.md) +- [isDynamicLiteralInitializer](functions/isDynamicLiteralInitializer.md) +- [isDynamicType](functions/isDynamicType.md) +- [isEnum](functions/isEnum.md) +- [isEnumMemberType](functions/isEnumMemberType.md) +- [isEnumStringLiteral](functions/isEnumStringLiteral.md) +- [isEnumType](functions/isEnumType.md) +- [isEsObjectPossiblyAllowed](functions/isEsObjectPossiblyAllowed.md) +- [isEsObjectSymbol](functions/isEsObjectSymbol.md) +- [isEsObjectType](functions/isEsObjectType.md) +- [isFunctionOrMethod](functions/isFunctionOrMethod.md) +- [isFunctionSymbol](functions/isFunctionSymbol.md) +- [isGenericArrayType](functions/isGenericArrayType.md) +- [isGlobalSymbol](functions/isGlobalSymbol.md) +- [isInImportWhiteList](functions/isInImportWhiteList.md) +- [isInsideBlock](functions/isInsideBlock.md) +- [isIntegerConstantValue](functions/isIntegerConstantValue.md) +- [isInterfaceType](functions/isInterfaceType.md) +- [isIntrinsicObjectType](functions/isIntrinsicObjectType.md) +- [isISendableInterface](functions/isISendableInterface.md) +- [isLibrarySymbol](functions/isLibrarySymbol.md) +- [isLibraryType](functions/isLibraryType.md) +- [isLiteralType](functions/isLiteralType.md) +- [isMethodAssignment](functions/isMethodAssignment.md) +- [isNonSendableFunctionTypeAlias](functions/isNonSendableFunctionTypeAlias.md) +- [isNullType](functions/isNullType.md) +- [isNumberConstantValue](functions/isNumberConstantValue.md) +- [isNumberLikeType](functions/isNumberLikeType.md) +- [isObject](functions/isObject.md) +- [isObjectLiteralAssignable](functions/isObjectLiteralAssignable.md) +- [isObjectLiteralType](functions/isObjectLiteralType.md) +- [isObjectType](functions/isObjectType.md) +- [isOrDerivedFrom](functions/isOrDerivedFrom.md) +- [isPrimitiveEnumMemberType](functions/isPrimitiveEnumMemberType.md) +- [isPrimitiveLiteralType](functions/isPrimitiveLiteralType.md) +- [isPrimitiveType](functions/isPrimitiveType.md) +- [isPrototypeSymbol](functions/isPrototypeSymbol.md) +- [isPurePrimitiveLiteralType](functions/isPurePrimitiveLiteralType.md) +- [isReadonlyArrayType](functions/isReadonlyArrayType.md) +- [isReferenceType](functions/isReferenceType.md) +- [isSendableClassOrInterface](functions/isSendableClassOrInterface.md) +- [isSendableClassOrInterfaceEntity](functions/isSendableClassOrInterfaceEntity.md) +- [isSendableFunction](functions/isSendableFunction.md) +- [isSendableType](functions/isSendableType.md) +- [isSendableTypeAlias](functions/isSendableTypeAlias.md) +- [isSendableTypeNode](functions/isSendableTypeNode.md) +- [isSendableUnionType](functions/isSendableUnionType.md) +- [isShareableEntity](functions/isShareableEntity.md) +- [isShareableType](functions/isShareableType.md) +- [isSharedModule](functions/isSharedModule.md) +- [isStdBigIntType](functions/isStdBigIntType.md) +- [isStdBooleanType](functions/isStdBooleanType.md) +- [isStdErrorType](functions/isStdErrorType.md) +- [isStdLibrarySymbol](functions/isStdLibrarySymbol.md) +- [isStdLibraryType](functions/isStdLibraryType.md) +- [isStdMapType](functions/isStdMapType.md) +- [isStdNumberType](functions/isStdNumberType.md) +- [isStdPartialType](functions/isStdPartialType.md) +- [isStdReadonlyType](functions/isStdReadonlyType.md) +- [isStdRecordType](functions/isStdRecordType.md) +- [isStdRequiredType](functions/isStdRequiredType.md) +- [isStdSymbol](functions/isStdSymbol.md) +- [isStringConstantValue](functions/isStringConstantValue.md) +- [isStringLikeType](functions/isStringLikeType.md) +- [isStringType](functions/isStringType.md) +- [isStruct](functions/isStruct.md) +- [isStructDeclaration](functions/isStructDeclaration.md) +- [isStructDeclarationKind](functions/isStructDeclarationKind.md) +- [isStructObjectInitializer](functions/isStructObjectInitializer.md) +- [isSupportedType](functions/isSupportedType.md) +- [isSymbolAPI](functions/isSymbolAPI.md) +- [isSymbolIterator](functions/isSymbolIterator.md) +- [isSymbolIteratorExpression](functions/isSymbolIteratorExpression.md) +- [isThisOrSuperExpr](functions/isThisOrSuperExpr.md) +- [isTuple](functions/isTuple.md) +- [isType](functions/isType.md) +- [isTypedArray](functions/isTypedArray.md) +- [isTypeDeclSyntaxKind](functions/isTypeDeclSyntaxKind.md) +- [isTypeReference](functions/isTypeReference.md) +- [isTypeSymbol](functions/isTypeSymbol.md) +- [isUnknownType](functions/isUnknownType.md) +- [isUnsupportedType](functions/isUnsupportedType.md) +- [isUnsupportedUnionType](functions/isUnsupportedUnionType.md) +- [isValidComputedPropertyName](functions/isValidComputedPropertyName.md) +- [isValidEnumMemberInit](functions/isValidEnumMemberInit.md) +- [isValueAssignableToESObject](functions/isValueAssignableToESObject.md) +- [isWrongSendableFunctionAssignment](functions/isWrongSendableFunctionAssignment.md) +- [logTscDiagnostic](functions/logTscDiagnostic.md) +- [needStrictMatchType](functions/needStrictMatchType.md) +- [needToDeduceStructuralIdentity](functions/needToDeduceStructuralIdentity.md) +- [pathContainsDirectory](functions/pathContainsDirectory.md) +- [processParentTypes](functions/processParentTypes.md) +- [reduceReference](functions/reduceReference.md) +- [relatedByInheritanceOrIdentical](functions/relatedByInheritanceOrIdentical.md) +- [searchFileExportDecl](functions/searchFileExportDecl.md) +- [setTestMode](functions/setTestMode.md) +- [setTypeChecker](functions/setTypeChecker.md) +- [symbolHasDuplicateName](functions/symbolHasDuplicateName.md) +- [symbolHasEsObjectType](functions/symbolHasEsObjectType.md) +- [trueSymbolAtLocation](functions/trueSymbolAtLocation.md) +- [typeContainsNonSendableClassOrInterface](functions/typeContainsNonSendableClassOrInterface.md) +- [typeContainsSendableClassOrInterface](functions/typeContainsSendableClassOrInterface.md) +- [typeIsRecursive](functions/typeIsRecursive.md) +- [unwrapParenthesized](functions/unwrapParenthesized.md) +- [unwrapParenthesizedType](functions/unwrapParenthesizedType.md) +- [unwrapParenthesizedTypeNode](functions/unwrapParenthesizedTypeNode.md) +- [validateFields](functions/validateFields.md) +- [validateObjectLiteralType](functions/validateObjectLiteralType.md) diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/checkTypeSet.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/checkTypeSet.md new file mode 100644 index 0000000000000000000000000000000000000000..f8ff6fcec699cae29beda33bda181ecc56ebc3c8 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/checkTypeSet.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / checkTypeSet + +# Function: checkTypeSet() + +> **checkTypeSet**(`typeSet`, `predicate`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9383 + +## Parameters + +### typeSet + +[`Type`](../../../../../interfaces/Type.md) + +### predicate + +[`CheckType`](../type-aliases/CheckType.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/clearTrueSymbolAtLocationCache.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/clearTrueSymbolAtLocationCache.md new file mode 100644 index 0000000000000000000000000000000000000000..805fa21f449a2618f7c710844fe29ddae3b918bc --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/clearTrueSymbolAtLocationCache.md @@ -0,0 +1,15 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / clearTrueSymbolAtLocationCache + +# Function: clearTrueSymbolAtLocationCache() + +> **clearTrueSymbolAtLocationCache**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9334 + +## Returns + +`void` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/clearTypeChecker.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/clearTypeChecker.md new file mode 100644 index 0000000000000000000000000000000000000000..c650fbd091972434e583d0282d530a40e48a324c --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/clearTypeChecker.md @@ -0,0 +1,15 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / clearTypeChecker + +# Function: clearTypeChecker() + +> **clearTypeChecker**(): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9293 + +## Returns + +`void` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/decodeAutofixInfo.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/decodeAutofixInfo.md new file mode 100644 index 0000000000000000000000000000000000000000..aacc46e4ea23ac6c8bcd1fd802bba35484b2520a --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/decodeAutofixInfo.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / decodeAutofixInfo + +# Function: decodeAutofixInfo() + +> **decodeAutofixInfo**(`info`): [`AutofixInfo`](../../Common/interfaces/AutofixInfo.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9376 + +## Parameters + +### info + +`string` + +## Returns + +[`AutofixInfo`](../../Common/interfaces/AutofixInfo.md) diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/encodeProblemInfo.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/encodeProblemInfo.md new file mode 100644 index 0000000000000000000000000000000000000000..f5d6ed529a1790320c86e0927fe09c49c5402ffa --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/encodeProblemInfo.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / encodeProblemInfo + +# Function: encodeProblemInfo() + +> **encodeProblemInfo**(`problem`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9375 + +## Parameters + +### problem + +[`ProblemInfo`](../../../interfaces/ProblemInfo.md) + +## Returns + +`string` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/entityNameToString.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/entityNameToString.md new file mode 100644 index 0000000000000000000000000000000000000000..93962bf1c7c4a6661c4c9b05335767841fd513a4 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/entityNameToString.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / entityNameToString + +# Function: entityNameToString() + +> **entityNameToString**(`name`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9317 + +## Parameters + +### name + +[`EntityName`](../../../../../type-aliases/EntityName.md) + +## Returns + +`string` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/findParentIf.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/findParentIf.md new file mode 100644 index 0000000000000000000000000000000000000000..4347f9d67893fe12e8233ca05652b6497a52cf55 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/findParentIf.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / findParentIf + +# Function: findParentIf() + +> **findParentIf**(`asExpr`): `null` \| [`IfStatement`](../../../../../interfaces/IfStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9324 + +## Parameters + +### asExpr + +[`AsExpression`](../../../../../interfaces/AsExpression.md) + +## Returns + +`null` \| [`IfStatement`](../../../../../interfaces/IfStatement.md) diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/followIfAliased.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/followIfAliased.md new file mode 100644 index 0000000000000000000000000000000000000000..42a859aa901eb6ee86bfea8a41838586b49d2d7c --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/followIfAliased.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / followIfAliased + +# Function: followIfAliased() + +> **followIfAliased**(`sym`): [`Symbol`](../../../../../interfaces/Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9332 + +## Parameters + +### sym + +[`Symbol`](../../../../../interfaces/Symbol.md) + +## Returns + +[`Symbol`](../../../../../interfaces/Symbol.md) diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getAccessModifier.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getAccessModifier.md new file mode 100644 index 0000000000000000000000000000000000000000..8d69a99dcb9a9d87c7ba3f6bc714940226cee143 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getAccessModifier.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / getAccessModifier + +# Function: getAccessModifier() + +> **getAccessModifier**(`modifiers`): `undefined` \| [`Modifier`](../../../../../type-aliases/Modifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9409 + +## Parameters + +### modifiers + +`undefined` | readonly [`Modifier`](../../../../../type-aliases/Modifier.md)[] + +## Returns + +`undefined` \| [`Modifier`](../../../../../type-aliases/Modifier.md) diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getCatchWithUnsupportedTypeHighlightRange.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getCatchWithUnsupportedTypeHighlightRange.md new file mode 100644 index 0000000000000000000000000000000000000000..91042ae2f44f34f50929ab06033dbeea1b0eca20 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getCatchWithUnsupportedTypeHighlightRange.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / getCatchWithUnsupportedTypeHighlightRange + +# Function: getCatchWithUnsupportedTypeHighlightRange() + +> **getCatchWithUnsupportedTypeHighlightRange**(`nodeOrComment`): `undefined` \| \[`number`, `number`\] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9299 + +## Parameters + +### nodeOrComment + +[`Node`](../../../../../interfaces/Node.md) | [`CommentRange`](../../../../../interfaces/CommentRange.md) + +## Returns + +`undefined` \| \[`number`, `number`\] diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getClassExpressionHighlightRange.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getClassExpressionHighlightRange.md new file mode 100644 index 0000000000000000000000000000000000000000..796c10bf92a1a0a3137927a407c03c81bf341e5d --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getClassExpressionHighlightRange.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / getClassExpressionHighlightRange + +# Function: getClassExpressionHighlightRange() + +> **getClassExpressionHighlightRange**(`nodeOrComment`): `undefined` \| \[`number`, `number`\] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9311 + +## Parameters + +### nodeOrComment + +[`Node`](../../../../../interfaces/Node.md) | [`CommentRange`](../../../../../interfaces/CommentRange.md) + +## Returns + +`undefined` \| \[`number`, `number`\] diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getConstAssertionHighlightRange.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getConstAssertionHighlightRange.md new file mode 100644 index 0000000000000000000000000000000000000000..5492513231f794e150bc982325c91db721f818ca --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getConstAssertionHighlightRange.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / getConstAssertionHighlightRange + +# Function: getConstAssertionHighlightRange() + +> **getConstAssertionHighlightRange**(`nodeOrComment`): `undefined` \| \[`number`, `number`\] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9305 + +## Parameters + +### nodeOrComment + +[`Node`](../../../../../interfaces/Node.md) | [`CommentRange`](../../../../../interfaces/CommentRange.md) + +## Returns + +`undefined` \| \[`number`, `number`\] diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getDeclWithDuplicateNameHighlightRange.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getDeclWithDuplicateNameHighlightRange.md new file mode 100644 index 0000000000000000000000000000000000000000..271d7e93c0a64783cb0ffd81a279c3bde819ccca --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getDeclWithDuplicateNameHighlightRange.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / getDeclWithDuplicateNameHighlightRange + +# Function: getDeclWithDuplicateNameHighlightRange() + +> **getDeclWithDuplicateNameHighlightRange**(`nodeOrComment`): `undefined` \| \[`number`, `number`\] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9309 + +## Parameters + +### nodeOrComment + +[`Node`](../../../../../interfaces/Node.md) | [`CommentRange`](../../../../../interfaces/CommentRange.md) + +## Returns + +`undefined` \| \[`number`, `number`\] diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getDeclaration.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..5e77fa0f7d669c0e1f1c246d37033149fdf98e15 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getDeclaration.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / getDeclaration + +# Function: getDeclaration() + +> **getDeclaration**(`tsSymbol`): `undefined` \| [`Declaration`](../../../../../interfaces/Declaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9360 + +## Parameters + +### tsSymbol + +`undefined` | [`Symbol`](../../../../../interfaces/Symbol.md) + +## Returns + +`undefined` \| [`Declaration`](../../../../../interfaces/Declaration.md) diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getDeclarationNode.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getDeclarationNode.md new file mode 100644 index 0000000000000000000000000000000000000000..3f781fbc109f40633ea8833081b7be0bcc28088c --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getDeclarationNode.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / getDeclarationNode + +# Function: getDeclarationNode() + +> **getDeclarationNode**(`node`): `undefined` \| [`Declaration`](../../../../../interfaces/Declaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9465 + +## Parameters + +### node + +[`Node`](../../../../../interfaces/Node.md) + +## Returns + +`undefined` \| [`Declaration`](../../../../../interfaces/Declaration.md) diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getDecoratorName.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getDecoratorName.md new file mode 100644 index 0000000000000000000000000000000000000000..eda2abd8d1efc0f6ff7151dda91649f87440c5e5 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getDecoratorName.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / getDecoratorName + +# Function: getDecoratorName() + +> **getDecoratorName**(`decorator`): `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9449 + +## Parameters + +### decorator + +[`Decorator`](../../../../../interfaces/Decorator.md) + +## Returns + +`string` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getDecoratorsIfInSendableClass.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getDecoratorsIfInSendableClass.md new file mode 100644 index 0000000000000000000000000000000000000000..c4fc93a71acf9e12a1b67e9456dba300fac95b23 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getDecoratorsIfInSendableClass.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / getDecoratorsIfInSendableClass + +# Function: getDecoratorsIfInSendableClass() + +> **getDecoratorsIfInSendableClass**(`declaration`): `undefined` \| readonly [`Decorator`](../../../../../interfaces/Decorator.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9462 + +## Parameters + +### declaration + +[`HasDecorators`](../../../../../type-aliases/HasDecorators.md) + +## Returns + +`undefined` \| readonly [`Decorator`](../../../../../interfaces/Decorator.md)[] diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getDeleteOperatorHighlightRange.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getDeleteOperatorHighlightRange.md new file mode 100644 index 0000000000000000000000000000000000000000..8c1ce3b174a581bddae965f40e68f5c5948acf12 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getDeleteOperatorHighlightRange.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / getDeleteOperatorHighlightRange + +# Function: getDeleteOperatorHighlightRange() + +> **getDeleteOperatorHighlightRange**(`nodeOrComment`): `undefined` \| \[`number`, `number`\] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9302 + +## Parameters + +### nodeOrComment + +[`Node`](../../../../../interfaces/Node.md) | [`CommentRange`](../../../../../interfaces/CommentRange.md) + +## Returns + +`undefined` \| \[`number`, `number`\] diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getEndPos.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getEndPos.md new file mode 100644 index 0000000000000000000000000000000000000000..a50e124f93ec74452ee244e1243703863ad89783 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getEndPos.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / getEndPos + +# Function: getEndPos() + +> **getEndPos**(`nodeOrComment`): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9296 + +## Parameters + +### nodeOrComment + +[`Node`](../../../../../interfaces/Node.md) | [`CommentRange`](../../../../../interfaces/CommentRange.md) + +## Returns + +`number` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getForInStatementHighlightRange.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getForInStatementHighlightRange.md new file mode 100644 index 0000000000000000000000000000000000000000..94638fdee19704aa8ebfc16a9efca3c4e446bdaf --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getForInStatementHighlightRange.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / getForInStatementHighlightRange + +# Function: getForInStatementHighlightRange() + +> **getForInStatementHighlightRange**(`nodeOrComment`): `undefined` \| \[`number`, `number`\] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9300 + +## Parameters + +### nodeOrComment + +[`Node`](../../../../../interfaces/Node.md) | [`CommentRange`](../../../../../interfaces/CommentRange.md) + +## Returns + +`undefined` \| \[`number`, `number`\] diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getFunctionApplyCallHighlightRange.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getFunctionApplyCallHighlightRange.md new file mode 100644 index 0000000000000000000000000000000000000000..fce65b3845ee61fe9bd956495765f27541823371 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getFunctionApplyCallHighlightRange.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / getFunctionApplyCallHighlightRange + +# Function: getFunctionApplyCallHighlightRange() + +> **getFunctionApplyCallHighlightRange**(`nodeOrComment`): `undefined` \| \[`number`, `number`\] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9308 + +## Parameters + +### nodeOrComment + +[`Node`](../../../../../interfaces/Node.md) | [`CommentRange`](../../../../../interfaces/CommentRange.md) + +## Returns + +`undefined` \| \[`number`, `number`\] diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getHighlightRange.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getHighlightRange.md new file mode 100644 index 0000000000000000000000000000000000000000..93dd22a1f66fffab22da71846fa118e2e39509ea --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getHighlightRange.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / getHighlightRange + +# Function: getHighlightRange() + +> **getHighlightRange**(`nodeOrComment`, `faultId`): \[`number`, `number`\] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9297 + +## Parameters + +### nodeOrComment + +[`Node`](../../../../../interfaces/Node.md) | [`CommentRange`](../../../../../interfaces/CommentRange.md) + +### faultId + +`number` + +## Returns + +\[`number`, `number`\] diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getInstanceofUnsupportedHighlightRange.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getInstanceofUnsupportedHighlightRange.md new file mode 100644 index 0000000000000000000000000000000000000000..3de59cf5a01fa41eb7a9c65dc8a43bea3c6ba5b7 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getInstanceofUnsupportedHighlightRange.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / getInstanceofUnsupportedHighlightRange + +# Function: getInstanceofUnsupportedHighlightRange() + +> **getInstanceofUnsupportedHighlightRange**(`nodeOrComment`): `undefined` \| \[`number`, `number`\] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9304 + +## Parameters + +### nodeOrComment + +[`Node`](../../../../../interfaces/Node.md) | [`CommentRange`](../../../../../interfaces/CommentRange.md) + +## Returns + +`undefined` \| \[`number`, `number`\] diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getKeywordHighlightRange.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getKeywordHighlightRange.md new file mode 100644 index 0000000000000000000000000000000000000000..7d1326c8941303350f4071b830178ab4f5ae5d80 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getKeywordHighlightRange.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / getKeywordHighlightRange + +# Function: getKeywordHighlightRange() + +> **getKeywordHighlightRange**(`nodeOrComment`, `keyword`): \[`number`, `number`\] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9314 + +## Parameters + +### nodeOrComment + +[`Node`](../../../../../interfaces/Node.md) | [`CommentRange`](../../../../../interfaces/CommentRange.md) + +### keyword + +`string` + +## Returns + +\[`number`, `number`\] diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getLimitedReturnTypeInferenceHighlightRange.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getLimitedReturnTypeInferenceHighlightRange.md new file mode 100644 index 0000000000000000000000000000000000000000..0eaf13aa97c81b35e58027199f744340efe57eac --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getLimitedReturnTypeInferenceHighlightRange.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / getLimitedReturnTypeInferenceHighlightRange + +# Function: getLimitedReturnTypeInferenceHighlightRange() + +> **getLimitedReturnTypeInferenceHighlightRange**(`nodeOrComment`): `undefined` \| \[`number`, `number`\] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9306 + +## Parameters + +### nodeOrComment + +[`Node`](../../../../../interfaces/Node.md) | [`CommentRange`](../../../../../interfaces/CommentRange.md) + +## Returns + +`undefined` \| \[`number`, `number`\] diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getLocalFunctionHighlightRange.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getLocalFunctionHighlightRange.md new file mode 100644 index 0000000000000000000000000000000000000000..a677369ca6976411a1604cff7f67513ca2e1fec8 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getLocalFunctionHighlightRange.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / getLocalFunctionHighlightRange + +# Function: getLocalFunctionHighlightRange() + +> **getLocalFunctionHighlightRange**(`nodeOrComment`): `undefined` \| \[`number`, `number`\] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9307 + +## Parameters + +### nodeOrComment + +[`Node`](../../../../../interfaces/Node.md) | [`CommentRange`](../../../../../interfaces/CommentRange.md) + +## Returns + +`undefined` \| \[`number`, `number`\] diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getModifier.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getModifier.md new file mode 100644 index 0000000000000000000000000000000000000000..7ff84a15f4e1d4e961adb5bc4ab6873e963d5eda --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getModifier.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / getModifier + +# Function: getModifier() + +> **getModifier**(`modifiers`, `modifierKind`): `undefined` \| [`Modifier`](../../../../../type-aliases/Modifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9408 + +## Parameters + +### modifiers + +`undefined` | readonly [`Modifier`](../../../../../type-aliases/Modifier.md)[] + +### modifierKind + +[`SyntaxKind`](../../../../../enumerations/SyntaxKind.md) + +## Returns + +`undefined` \| [`Modifier`](../../../../../type-aliases/Modifier.md) diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getMultipleStaticBlocksHighlightRange.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getMultipleStaticBlocksHighlightRange.md new file mode 100644 index 0000000000000000000000000000000000000000..e30026d52831593c418ae13da270d60cffa6f0c7 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getMultipleStaticBlocksHighlightRange.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / getMultipleStaticBlocksHighlightRange + +# Function: getMultipleStaticBlocksHighlightRange() + +> **getMultipleStaticBlocksHighlightRange**(`nodeOrComment`): `undefined` \| \[`number`, `number`\] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9312 + +## Parameters + +### nodeOrComment + +[`Node`](../../../../../interfaces/Node.md) | [`CommentRange`](../../../../../interfaces/CommentRange.md) + +## Returns + +`undefined` \| \[`number`, `number`\] diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getNonNullableType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getNonNullableType.md new file mode 100644 index 0000000000000000000000000000000000000000..957772e9097d71dfd1e06685daea77b0ff746633 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getNonNullableType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / getNonNullableType + +# Function: getNonNullableType() + +> **getNonNullableType**(`t`): [`Type`](../../../../../interfaces/Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9384 + +## Parameters + +### t + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +[`Type`](../../../../../interfaces/Type.md) diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getNonSendableDecorators.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getNonSendableDecorators.md new file mode 100644 index 0000000000000000000000000000000000000000..50d6d4b9f1bb72fcb5e72ba9cbc6accf2153baaa --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getNonSendableDecorators.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / getNonSendableDecorators + +# Function: getNonSendableDecorators() + +> **getNonSendableDecorators**(`decl`): `undefined` \| [`Decorator`](../../../../../interfaces/Decorator.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9460 + +## Parameters + +### decl + +[`ClassDeclaration`](../../../../../interfaces/ClassDeclaration.md) | [`TypeAliasDeclaration`](../../../../../interfaces/TypeAliasDeclaration.md) | [`FunctionDeclaration`](../../../../../interfaces/FunctionDeclaration.md) + +## Returns + +`undefined` \| [`Decorator`](../../../../../interfaces/Decorator.md)[] diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getObjectLiteralNoContextTypeHighlightRange.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getObjectLiteralNoContextTypeHighlightRange.md new file mode 100644 index 0000000000000000000000000000000000000000..f888574371b396f580ecf85efe4b0a4e4e6f48c2 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getObjectLiteralNoContextTypeHighlightRange.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / getObjectLiteralNoContextTypeHighlightRange + +# Function: getObjectLiteralNoContextTypeHighlightRange() + +> **getObjectLiteralNoContextTypeHighlightRange**(`nodeOrComment`): `undefined` \| \[`number`, `number`\] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9310 + +## Parameters + +### nodeOrComment + +[`Node`](../../../../../interfaces/Node.md) | [`CommentRange`](../../../../../interfaces/CommentRange.md) + +## Returns + +`undefined` \| \[`number`, `number`\] diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getParentSymbolName.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getParentSymbolName.md new file mode 100644 index 0000000000000000000000000000000000000000..88a1624cdac02e6677c5e6d209ea50980df9c243 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getParentSymbolName.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / getParentSymbolName + +# Function: getParentSymbolName() + +> **getParentSymbolName**(`symbol`): `undefined` \| `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9400 + +## Parameters + +### symbol + +[`Symbol`](../../../../../interfaces/Symbol.md) + +## Returns + +`undefined` \| `string` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getScriptKind.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getScriptKind.md new file mode 100644 index 0000000000000000000000000000000000000000..fc9b71df54dc83854be80c9dfe021277ab23a3c0 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getScriptKind.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / getScriptKind + +# Function: getScriptKind() + +> **getScriptKind**(`srcFile`): [`ScriptKind`](../../../../../enumerations/ScriptKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9420 + +## Parameters + +### srcFile + +[`SourceFile`](../../../../../interfaces/SourceFile.md) + +## Returns + +[`ScriptKind`](../../../../../enumerations/ScriptKind.md) diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getSendableDecorator.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getSendableDecorator.md new file mode 100644 index 0000000000000000000000000000000000000000..1491569da69b8eec193472a5f887d088254acbc5 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getSendableDecorator.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / getSendableDecorator + +# Function: getSendableDecorator() + +> **getSendableDecorator**(`decl`): `undefined` \| [`Decorator`](../../../../../interfaces/Decorator.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9461 + +## Parameters + +### decl + +[`ClassDeclaration`](../../../../../interfaces/ClassDeclaration.md) | [`TypeAliasDeclaration`](../../../../../interfaces/TypeAliasDeclaration.md) | [`FunctionDeclaration`](../../../../../interfaces/FunctionDeclaration.md) + +## Returns + +`undefined` \| [`Decorator`](../../../../../interfaces/Decorator.md) diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getSendableDefiniteAssignmentHighlightRange.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getSendableDefiniteAssignmentHighlightRange.md new file mode 100644 index 0000000000000000000000000000000000000000..f08e43daff0e9231812e29370fcf6d9785918f45 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getSendableDefiniteAssignmentHighlightRange.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / getSendableDefiniteAssignmentHighlightRange + +# Function: getSendableDefiniteAssignmentHighlightRange() + +> **getSendableDefiniteAssignmentHighlightRange**(`nodeOrComment`): `undefined` \| \[`number`, `number`\] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9313 + +## Parameters + +### nodeOrComment + +[`Node`](../../../../../interfaces/Node.md) | [`CommentRange`](../../../../../interfaces/CommentRange.md) + +## Returns + +`undefined` \| \[`number`, `number`\] diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getStartPos.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getStartPos.md new file mode 100644 index 0000000000000000000000000000000000000000..6cf68ba3b2131c8f3ac8533e04f8310c1af6cf35 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getStartPos.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / getStartPos + +# Function: getStartPos() + +> **getStartPos**(`nodeOrComment`): `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9295 + +## Parameters + +### nodeOrComment + +[`Node`](../../../../../interfaces/Node.md) | [`CommentRange`](../../../../../interfaces/CommentRange.md) + +## Returns + +`number` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getSymbolDeclarationTypeNode.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getSymbolDeclarationTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..d74e7ea5bc8b2c90e587529ce6e1a06fc9295e57 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getSymbolDeclarationTypeNode.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / getSymbolDeclarationTypeNode + +# Function: getSymbolDeclarationTypeNode() + +> **getSymbolDeclarationTypeNode**(`sym`): `undefined` \| [`TypeNode`](../../../../../interfaces/TypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9433 + +## Parameters + +### sym + +[`Symbol`](../../../../../interfaces/Symbol.md) + +## Returns + +`undefined` \| [`TypeNode`](../../../../../interfaces/TypeNode.md) diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getSymbolOfCallExpression.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getSymbolOfCallExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..8187d6a3c7ea7c21d94159991ccc26728807de3b --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getSymbolOfCallExpression.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / getSymbolOfCallExpression + +# Function: getSymbolOfCallExpression() + +> **getSymbolOfCallExpression**(`callExpr`): `undefined` \| [`Symbol`](../../../../../interfaces/Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9438 + +## Parameters + +### callExpr + +[`CallExpression`](../../../../../interfaces/CallExpression.md) + +## Returns + +`undefined` \| [`Symbol`](../../../../../interfaces/Symbol.md) diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getTypeOrTypeConstraintAtLocation.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getTypeOrTypeConstraintAtLocation.md new file mode 100644 index 0000000000000000000000000000000000000000..4b2988e13e5a7ef69fb0291fd8049c149e360b81 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getTypeOrTypeConstraintAtLocation.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / getTypeOrTypeConstraintAtLocation + +# Function: getTypeOrTypeConstraintAtLocation() + +> **getTypeOrTypeConstraintAtLocation**(`expr`): [`Type`](../../../../../interfaces/Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9440 + +## Parameters + +### expr + +[`Expression`](../../../../../interfaces/Expression.md) + +## Returns + +[`Type`](../../../../../interfaces/Type.md) diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getTypeQueryHighlightRange.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getTypeQueryHighlightRange.md new file mode 100644 index 0000000000000000000000000000000000000000..264da19c291cd0a11795bf046aa8be4c217c5fb5 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getTypeQueryHighlightRange.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / getTypeQueryHighlightRange + +# Function: getTypeQueryHighlightRange() + +> **getTypeQueryHighlightRange**(`nodeOrComment`): `undefined` \| \[`number`, `number`\] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9303 + +## Parameters + +### nodeOrComment + +[`Node`](../../../../../interfaces/Node.md) | [`CommentRange`](../../../../../interfaces/CommentRange.md) + +## Returns + +`undefined` \| \[`number`, `number`\] diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getVarDeclarationHighlightRange.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getVarDeclarationHighlightRange.md new file mode 100644 index 0000000000000000000000000000000000000000..0216e1a794570eccdf8cd038c0ca5b2fb4b1033d --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getVarDeclarationHighlightRange.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / getVarDeclarationHighlightRange + +# Function: getVarDeclarationHighlightRange() + +> **getVarDeclarationHighlightRange**(`nodeOrComment`): `undefined` \| \[`number`, `number`\] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9298 + +## Parameters + +### nodeOrComment + +[`Node`](../../../../../interfaces/Node.md) | [`CommentRange`](../../../../../interfaces/CommentRange.md) + +## Returns + +`undefined` \| \[`number`, `number`\] diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getVariableDeclarationTypeNode.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getVariableDeclarationTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..a67db9d59400a9947e3a179ebb1940624fa90704 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getVariableDeclarationTypeNode.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / getVariableDeclarationTypeNode + +# Function: getVariableDeclarationTypeNode() + +> **getVariableDeclarationTypeNode**(`node`): `undefined` \| [`TypeNode`](../../../../../interfaces/TypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9432 + +## Parameters + +### node + +[`Node`](../../../../../interfaces/Node.md) + +## Returns + +`undefined` \| [`TypeNode`](../../../../../interfaces/TypeNode.md) diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getWithStatementHighlightRange.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getWithStatementHighlightRange.md new file mode 100644 index 0000000000000000000000000000000000000000..28c29119b71917b5deab345982ed098c227de03a --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/getWithStatementHighlightRange.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / getWithStatementHighlightRange + +# Function: getWithStatementHighlightRange() + +> **getWithStatementHighlightRange**(`nodeOrComment`): `undefined` \| \[`number`, `number`\] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9301 + +## Parameters + +### nodeOrComment + +[`Node`](../../../../../interfaces/Node.md) | [`CommentRange`](../../../../../interfaces/CommentRange.md) + +## Returns + +`undefined` \| \[`number`, `number`\] diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/hasAccessModifier.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/hasAccessModifier.md new file mode 100644 index 0000000000000000000000000000000000000000..44b6e294a6692903f17f18a15336fce37178a952 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/hasAccessModifier.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / hasAccessModifier + +# Function: hasAccessModifier() + +> **hasAccessModifier**(`decl`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9407 + +## Parameters + +### decl + +[`Declaration`](../../../../../interfaces/Declaration.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/hasEsObjectType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/hasEsObjectType.md new file mode 100644 index 0000000000000000000000000000000000000000..896fa800bedbacc047fa73b0173e7e7fd7333cf3 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/hasEsObjectType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / hasEsObjectType + +# Function: hasEsObjectType() + +> **hasEsObjectType**(`node`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9434 + +## Parameters + +### node + +[`Node`](../../../../../interfaces/Node.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/hasLibraryType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/hasLibraryType.md new file mode 100644 index 0000000000000000000000000000000000000000..57a4d140cf6b9a72dae8fa1168c69c44ca85d9c1 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/hasLibraryType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / hasLibraryType + +# Function: hasLibraryType() + +> **hasLibraryType**(`node`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9417 + +## Parameters + +### node + +[`Node`](../../../../../interfaces/Node.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/hasMethods.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/hasMethods.md new file mode 100644 index 0000000000000000000000000000000000000000..b3ad14ad9df4a40ede7dd2e54d4f2991d9241bf9 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/hasMethods.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / hasMethods + +# Function: hasMethods() + +> **hasMethods**(`type`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9382 + +## Parameters + +### type + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/hasModifier.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/hasModifier.md new file mode 100644 index 0000000000000000000000000000000000000000..591cf92f839b56c80278a66f8d8fc0d0d13b3fdb --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/hasModifier.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / hasModifier + +# Function: hasModifier() + +> **hasModifier**(`tsModifiers`, `tsModifierKind`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9330 + +## Parameters + +### tsModifiers + +`undefined` | readonly [`Modifier`](../../../../../type-aliases/Modifier.md)[] + +### tsModifierKind + +`number` + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/hasPredecessor.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/hasPredecessor.md new file mode 100644 index 0000000000000000000000000000000000000000..0a0936b04fa5217c27fffca3f518eb4dcb901d4d --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/hasPredecessor.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / hasPredecessor + +# Function: hasPredecessor() + +> **hasPredecessor**(`node`, `predicate`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9371 + +## Parameters + +### node + +[`Node`](../../../../../interfaces/Node.md) + +### predicate + +(`node`) => `boolean` + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/hasSendableDecorator.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/hasSendableDecorator.md new file mode 100644 index 0000000000000000000000000000000000000000..951317234bbba9fb92418dc1a0560da93df55319 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/hasSendableDecorator.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / hasSendableDecorator + +# Function: hasSendableDecorator() + +> **hasSendableDecorator**(`decl`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9459 + +## Parameters + +### decl + +[`ClassDeclaration`](../../../../../interfaces/ClassDeclaration.md) | [`TypeAliasDeclaration`](../../../../../interfaces/TypeAliasDeclaration.md) | [`FunctionDeclaration`](../../../../../interfaces/FunctionDeclaration.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/hasSendableDecoratorFunctionOverload.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/hasSendableDecoratorFunctionOverload.md new file mode 100644 index 0000000000000000000000000000000000000000..7a08e9e2501ab4abbaaeb8b7723dc18df4105e3e --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/hasSendableDecoratorFunctionOverload.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / hasSendableDecoratorFunctionOverload + +# Function: hasSendableDecoratorFunctionOverload() + +> **hasSendableDecoratorFunctionOverload**(`decl`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9469 + +## Parameters + +### decl + +[`FunctionDeclaration`](../../../../../interfaces/FunctionDeclaration.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/hasSendableTypeAlias.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/hasSendableTypeAlias.md new file mode 100644 index 0000000000000000000000000000000000000000..448bd8c253b3753e9feba534f3a37f7e03bcf0c5 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/hasSendableTypeAlias.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / hasSendableTypeAlias + +# Function: hasSendableTypeAlias() + +> **hasSendableTypeAlias**(`type`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9472 + +## Parameters + +### type + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isAllowedIndexSignature.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isAllowedIndexSignature.md new file mode 100644 index 0000000000000000000000000000000000000000..e549f774354357eddb84efe7b4c249697cad0e1b --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isAllowedIndexSignature.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isAllowedIndexSignature + +# Function: isAllowedIndexSignature() + +> **isAllowedIndexSignature**(`node`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9446 + +## Parameters + +### node + +[`IndexSignatureDeclaration`](../../../../../interfaces/IndexSignatureDeclaration.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isAnonymous.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isAnonymous.md new file mode 100644 index 0000000000000000000000000000000000000000..c8540f85b16b143cc3ec614cf4f644e3c87a8b20 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isAnonymous.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isAnonymous + +# Function: isAnonymous() + +> **isAnonymous**(`type`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9426 + +## Parameters + +### type + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isAnonymousType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isAnonymousType.md new file mode 100644 index 0000000000000000000000000000000000000000..38a7aefabb861dedb59298eb98bcc4f90baa901e --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isAnonymousType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isAnonymousType + +# Function: isAnonymousType() + +> **isAnonymousType**(`type`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9437 + +## Parameters + +### type + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isAnyType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isAnyType.md new file mode 100644 index 0000000000000000000000000000000000000000..f4ec6cdd34c9a1afe5fdf1f6c9f023fb0671205c --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isAnyType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isAnyType + +# Function: isAnyType() + +> **isAnyType**(`tsType`): `tsType is TypeReference` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9354 + +## Parameters + +### tsType + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`tsType is TypeReference` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isArkTSCollectionsArrayLikeType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isArkTSCollectionsArrayLikeType.md new file mode 100644 index 0000000000000000000000000000000000000000..23881d6294d0f4044c2ad9526d036424e0e10b11 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isArkTSCollectionsArrayLikeType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isArkTSCollectionsArrayLikeType + +# Function: isArkTSCollectionsArrayLikeType() + +> **isArkTSCollectionsArrayLikeType**(`type`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9447 + +## Parameters + +### type + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isArkTSCollectionsClassOrInterfaceDeclaration.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isArkTSCollectionsClassOrInterfaceDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..4f38dc11e60e7f5dcecc4a0be5487964f2d603fe --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isArkTSCollectionsClassOrInterfaceDeclaration.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isArkTSCollectionsClassOrInterfaceDeclaration + +# Function: isArkTSCollectionsClassOrInterfaceDeclaration() + +> **isArkTSCollectionsClassOrInterfaceDeclaration**(`decl`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9448 + +## Parameters + +### decl + +[`Node`](../../../../../interfaces/Node.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isArray.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isArray.md new file mode 100644 index 0000000000000000000000000000000000000000..cd4cf31d6eac428d23e8fe68faa3f3209b9e2c74 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isArray.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isArray + +# Function: isArray() + +> **isArray**(`tsType`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9345 + +## Parameters + +### tsType + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isAssignmentOperator.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isAssignmentOperator.md new file mode 100644 index 0000000000000000000000000000000000000000..1f63e6f8a516991465a384cb8d2026ecd13043ac --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isAssignmentOperator.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isAssignmentOperator + +# Function: isAssignmentOperator() + +> **isAssignmentOperator**(`tsBinOp`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9315 + +## Parameters + +### tsBinOp + +[`BinaryOperatorToken`](../../../../../type-aliases/BinaryOperatorToken.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isBooleanLikeType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isBooleanLikeType.md new file mode 100644 index 0000000000000000000000000000000000000000..eaa3705a32b835e2741994895a2df0ead06372ea --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isBooleanLikeType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isBooleanLikeType + +# Function: isBooleanLikeType() + +> **isBooleanLikeType**(`tsType`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9319 + +## Parameters + +### tsType + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isCallToFunctionWithOmittedReturnType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isCallToFunctionWithOmittedReturnType.md new file mode 100644 index 0000000000000000000000000000000000000000..cf074e092cde578269747dd971e2de8d64cd2758 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isCallToFunctionWithOmittedReturnType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isCallToFunctionWithOmittedReturnType + +# Function: isCallToFunctionWithOmittedReturnType() + +> **isCallToFunctionWithOmittedReturnType**(`tsExpr`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9377 + +## Parameters + +### tsExpr + +[`Expression`](../../../../../interfaces/Expression.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isCompileTimeExpression.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isCompileTimeExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..c10959d20e039b4287b4981b1dd8e8080f447b51 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isCompileTimeExpression.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isCompileTimeExpression + +# Function: isCompileTimeExpression() + +> **isCompileTimeExpression**(`tsExpr`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9362 + +## Parameters + +### tsExpr + +[`Expression`](../../../../../interfaces/Expression.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isConst.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isConst.md new file mode 100644 index 0000000000000000000000000000000000000000..06f9016da4c6c94907c1f197db5101fc69ec64e3 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isConst.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isConst + +# Function: isConst() + +> **isConst**(`tsNode`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9363 + +## Parameters + +### tsNode + +[`Node`](../../../../../interfaces/Node.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isConstEnum.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isConstEnum.md new file mode 100644 index 0000000000000000000000000000000000000000..c50a31b55e2d3015215a359e05e36bc2998c2bc7 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isConstEnum.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isConstEnum + +# Function: isConstEnum() + +> **isConstEnum**(`sym`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9457 + +## Parameters + +### sym + +`undefined` | [`Symbol`](../../../../../interfaces/Symbol.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isDefaultImport.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isDefaultImport.md new file mode 100644 index 0000000000000000000000000000000000000000..c0de98422123f0cee7e0f97dafdaff15a63673c5 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isDefaultImport.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isDefaultImport + +# Function: isDefaultImport() + +> **isDefaultImport**(`importSpec`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9406 + +## Parameters + +### importSpec + +[`ImportSpecifier`](../../../../../interfaces/ImportSpecifier.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isDestructuringAssignmentLHS.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isDestructuringAssignmentLHS.md new file mode 100644 index 0000000000000000000000000000000000000000..1f62dc4bef312557ea4e79493be473e33ccf2131 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isDestructuringAssignmentLHS.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isDestructuringAssignmentLHS + +# Function: isDestructuringAssignmentLHS() + +> **isDestructuringAssignmentLHS**(`tsExpr`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9325 + +## Parameters + +### tsExpr + +[`ObjectLiteralExpression`](../../../../../interfaces/ObjectLiteralExpression.md) | [`ArrayLiteralExpression`](../../../../../interfaces/ArrayLiteralExpression.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isDynamicLiteralInitializer.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isDynamicLiteralInitializer.md new file mode 100644 index 0000000000000000000000000000000000000000..545e3d1a489be63fe21697fbde46970790978013 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isDynamicLiteralInitializer.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isDynamicLiteralInitializer + +# Function: isDynamicLiteralInitializer() + +> **isDynamicLiteralInitializer**(`expr`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9427 + +## Parameters + +### expr + +[`Expression`](../../../../../interfaces/Expression.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isDynamicType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isDynamicType.md new file mode 100644 index 0000000000000000000000000000000000000000..fc06382279405e378728280e78051b3cc0228631 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isDynamicType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isDynamicType + +# Function: isDynamicType() + +> **isDynamicType**(`type`): `undefined` \| `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9424 + +## Parameters + +### type + +`undefined` | [`Type`](../../../../../interfaces/Type.md) + +## Returns + +`undefined` \| `boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isEnum.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isEnum.md new file mode 100644 index 0000000000000000000000000000000000000000..841af7da986714d408fb5f17ff53e6a906e88f36 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isEnum.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isEnum + +# Function: isEnum() + +> **isEnum**(`tsSymbol`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9327 + +## Parameters + +### tsSymbol + +[`Symbol`](../../../../../interfaces/Symbol.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isEnumMemberType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isEnumMemberType.md new file mode 100644 index 0000000000000000000000000000000000000000..94118ebe6479dbd230ce7af2162028aefcd51f3f --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isEnumMemberType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isEnumMemberType + +# Function: isEnumMemberType() + +> **isEnumMemberType**(`tsType`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9328 + +## Parameters + +### tsType + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isEnumStringLiteral.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isEnumStringLiteral.md new file mode 100644 index 0000000000000000000000000000000000000000..8b3a357c78e4dd8e6b6d6d176cd4032eef8fc004 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isEnumStringLiteral.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isEnumStringLiteral + +# Function: isEnumStringLiteral() + +> **isEnumStringLiteral**(`expr`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9444 + +## Parameters + +### expr + +[`Expression`](../../../../../interfaces/Expression.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isEnumType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isEnumType.md new file mode 100644 index 0000000000000000000000000000000000000000..bcce9a4977605418178b7c35943789f45f13647a --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isEnumType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isEnumType + +# Function: isEnumType() + +> **isEnumType**(`tsType`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9326 + +## Parameters + +### tsType + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isEsObjectPossiblyAllowed.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isEsObjectPossiblyAllowed.md new file mode 100644 index 0000000000000000000000000000000000000000..508a2834a7b8f3dd1f2e562922e85ebd593ed25c --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isEsObjectPossiblyAllowed.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isEsObjectPossiblyAllowed + +# Function: isEsObjectPossiblyAllowed() + +> **isEsObjectPossiblyAllowed**(`typeRef`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9430 + +## Parameters + +### typeRef + +[`TypeReferenceNode`](../../../../../interfaces/TypeReferenceNode.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isEsObjectSymbol.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isEsObjectSymbol.md new file mode 100644 index 0000000000000000000000000000000000000000..fb5dbe41c3be8849131298acc3e3c1a6f0605058 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isEsObjectSymbol.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isEsObjectSymbol + +# Function: isEsObjectSymbol() + +> **isEsObjectSymbol**(`sym`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9436 + +## Parameters + +### sym + +[`Symbol`](../../../../../interfaces/Symbol.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isEsObjectType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isEsObjectType.md new file mode 100644 index 0000000000000000000000000000000000000000..49985bfa180aa4dc97bd9956ba582aaea1bede89 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isEsObjectType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isEsObjectType + +# Function: isEsObjectType() + +> **isEsObjectType**(`typeNode`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9428 + +## Parameters + +### typeNode + +`undefined` | [`TypeNode`](../../../../../interfaces/TypeNode.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isFunctionOrMethod.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isFunctionOrMethod.md new file mode 100644 index 0000000000000000000000000000000000000000..8988473a0728457ee60ea9247b373d29cf70ab7f --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isFunctionOrMethod.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isFunctionOrMethod + +# Function: isFunctionOrMethod() + +> **isFunctionOrMethod**(`tsSymbol`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9358 + +## Parameters + +### tsSymbol + +`undefined` | [`Symbol`](../../../../../interfaces/Symbol.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isFunctionSymbol.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isFunctionSymbol.md new file mode 100644 index 0000000000000000000000000000000000000000..60d9302aa0387690f4105f1f8dfe315081c4f6ec --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isFunctionSymbol.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isFunctionSymbol + +# Function: isFunctionSymbol() + +> **isFunctionSymbol**(`symbol`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9352 + +## Parameters + +### symbol + +`undefined` | [`Symbol`](../../../../../interfaces/Symbol.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isGenericArrayType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isGenericArrayType.md new file mode 100644 index 0000000000000000000000000000000000000000..a66baebbf604a9ffca8a60fd4460f5996fbe50e6 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isGenericArrayType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isGenericArrayType + +# Function: isGenericArrayType() + +> **isGenericArrayType**(`tsType`): `tsType is TypeReference` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9342 + +## Parameters + +### tsType + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`tsType is TypeReference` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isGlobalSymbol.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isGlobalSymbol.md new file mode 100644 index 0000000000000000000000000000000000000000..bc1abe8d81e2f187a15f402ffe294131d5574966 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isGlobalSymbol.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isGlobalSymbol + +# Function: isGlobalSymbol() + +> **isGlobalSymbol**(`symbol`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9401 + +## Parameters + +### symbol + +[`Symbol`](../../../../../interfaces/Symbol.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isISendableInterface.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isISendableInterface.md new file mode 100644 index 0000000000000000000000000000000000000000..3d8a179e744f727a7a81c62bcb69a2ab12d4b096 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isISendableInterface.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isISendableInterface + +# Function: isISendableInterface() + +> **isISendableInterface**(`type`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9463 + +## Parameters + +### type + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isInImportWhiteList.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isInImportWhiteList.md new file mode 100644 index 0000000000000000000000000000000000000000..898c5f57bc09be379740812d5dc75dee6a5178c4 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isInImportWhiteList.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isInImportWhiteList + +# Function: isInImportWhiteList() + +> **isInImportWhiteList**(`resolvedModule`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9468 + +## Parameters + +### resolvedModule + +[`ResolvedModuleFull`](../../../../../interfaces/ResolvedModuleFull.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isInsideBlock.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isInsideBlock.md new file mode 100644 index 0000000000000000000000000000000000000000..65f41c3a474032af8109ff542b7a744064f2b9f7 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isInsideBlock.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isInsideBlock + +# Function: isInsideBlock() + +> **isInsideBlock**(`node`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9429 + +## Parameters + +### node + +[`Node`](../../../../../interfaces/Node.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isIntegerConstantValue.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isIntegerConstantValue.md new file mode 100644 index 0000000000000000000000000000000000000000..67ea928b0dfb110f3e79314dc61ecfc8206b1650 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isIntegerConstantValue.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isIntegerConstantValue + +# Function: isIntegerConstantValue() + +> **isIntegerConstantValue**(`tsExpr`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9365 + +## Parameters + +### tsExpr + +[`EnumMember`](../../../../../interfaces/EnumMember.md) | [`NumericLiteral`](../../../../../interfaces/NumericLiteral.md) | [`PropertyAccessExpression`](../../../../../interfaces/PropertyAccessExpression.md) | [`ElementAccessExpression`](../../../../../interfaces/ElementAccessExpression.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isInterfaceType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isInterfaceType.md new file mode 100644 index 0000000000000000000000000000000000000000..30ffe1bf7532552b52b76df27b33c11759b1eedf --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isInterfaceType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isInterfaceType + +# Function: isInterfaceType() + +> **isInterfaceType**(`tsType`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9353 + +## Parameters + +### tsType + +`undefined` | [`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isIntrinsicObjectType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isIntrinsicObjectType.md new file mode 100644 index 0000000000000000000000000000000000000000..21b487e50e419b338635a951ca5f660137a1063f --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isIntrinsicObjectType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isIntrinsicObjectType + +# Function: isIntrinsicObjectType() + +> **isIntrinsicObjectType**(`type`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9423 + +## Parameters + +### type + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isLibrarySymbol.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isLibrarySymbol.md new file mode 100644 index 0000000000000000000000000000000000000000..553282711a7abc47cbd900c29858473f2dbd726a --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isLibrarySymbol.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isLibrarySymbol + +# Function: isLibrarySymbol() + +> **isLibrarySymbol**(`sym`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9418 + +## Parameters + +### sym + +`undefined` | [`Symbol`](../../../../../interfaces/Symbol.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isLibraryType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isLibraryType.md new file mode 100644 index 0000000000000000000000000000000000000000..55b33a01309b6e641b36add6ddcdceab95b9ffcb --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isLibraryType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isLibraryType + +# Function: isLibraryType() + +> **isLibraryType**(`type`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9416 + +## Parameters + +### type + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isLiteralType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isLiteralType.md new file mode 100644 index 0000000000000000000000000000000000000000..89172adf5f980675ce4665e6180b1c881c51b6b0 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isLiteralType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isLiteralType + +# Function: isLiteralType() + +> **isLiteralType**(`type`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9386 + +## Parameters + +### type + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isMethodAssignment.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isMethodAssignment.md new file mode 100644 index 0000000000000000000000000000000000000000..acc15fbed846a2b8f4b491c2bb98a25ae8058ff2 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isMethodAssignment.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isMethodAssignment + +# Function: isMethodAssignment() + +> **isMethodAssignment**(`tsSymbol`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9359 + +## Parameters + +### tsSymbol + +`undefined` | [`Symbol`](../../../../../interfaces/Symbol.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isNonSendableFunctionTypeAlias.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isNonSendableFunctionTypeAlias.md new file mode 100644 index 0000000000000000000000000000000000000000..25e5be8bc8d2f3f6a9b407870ce448bf4198f99c --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isNonSendableFunctionTypeAlias.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isNonSendableFunctionTypeAlias + +# Function: isNonSendableFunctionTypeAlias() + +> **isNonSendableFunctionTypeAlias**(`type`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9473 + +## Parameters + +### type + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isNullType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isNullType.md new file mode 100644 index 0000000000000000000000000000000000000000..286e5ca925d1ca5f5eda2a2fb5daa7cace57669c --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isNullType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isNullType + +# Function: isNullType() + +> **isNullType**(`tsTypeNode`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9349 + +## Parameters + +### tsTypeNode + +[`TypeNode`](../../../../../interfaces/TypeNode.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isNumberConstantValue.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isNumberConstantValue.md new file mode 100644 index 0000000000000000000000000000000000000000..c8e7b7eb9a194128a7d9f62dad8f919b0a562b43 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isNumberConstantValue.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isNumberConstantValue + +# Function: isNumberConstantValue() + +> **isNumberConstantValue**(`tsExpr`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9364 + +## Parameters + +### tsExpr + +[`EnumMember`](../../../../../interfaces/EnumMember.md) | [`NumericLiteral`](../../../../../interfaces/NumericLiteral.md) | [`PropertyAccessExpression`](../../../../../interfaces/PropertyAccessExpression.md) | [`ElementAccessExpression`](../../../../../interfaces/ElementAccessExpression.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isNumberLikeType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isNumberLikeType.md new file mode 100644 index 0000000000000000000000000000000000000000..7763f62a4ce059f502fe5cdd80891bc9c09d72b0 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isNumberLikeType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isNumberLikeType + +# Function: isNumberLikeType() + +> **isNumberLikeType**(`tsType`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9318 + +## Parameters + +### tsType + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isObject.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isObject.md new file mode 100644 index 0000000000000000000000000000000000000000..b3420369bf1e9b8c4b86929c94f1643a4e07970d --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isObject.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isObject + +# Function: isObject() + +> **isObject**(`tsType`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9373 + +## Parameters + +### tsType + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isObjectLiteralAssignable.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isObjectLiteralAssignable.md new file mode 100644 index 0000000000000000000000000000000000000000..a55dde65590936e027393c30d8a2a7b93e97e7fa --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isObjectLiteralAssignable.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isObjectLiteralAssignable + +# Function: isObjectLiteralAssignable() + +> **isObjectLiteralAssignable**(`lhsType`, `rhsExpr`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9385 + +## Parameters + +### lhsType + +`undefined` | [`Type`](../../../../../interfaces/Type.md) + +### rhsExpr + +[`ObjectLiteralExpression`](../../../../../interfaces/ObjectLiteralExpression.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isObjectLiteralType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isObjectLiteralType.md new file mode 100644 index 0000000000000000000000000000000000000000..a7fc716da087f0f74e2d0daecf0e18766286cbcc --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isObjectLiteralType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isObjectLiteralType + +# Function: isObjectLiteralType() + +> **isObjectLiteralType**(`tsType`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9329 + +## Parameters + +### tsType + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isObjectType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isObjectType.md new file mode 100644 index 0000000000000000000000000000000000000000..700f3c5c855dfa92fd140f18bd7cf30d1683d0fa --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isObjectType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isObjectType + +# Function: isObjectType() + +> **isObjectType**(`type`): `type is ObjectType` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9425 + +## Parameters + +### type + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`type is ObjectType` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isOrDerivedFrom.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isOrDerivedFrom.md new file mode 100644 index 0000000000000000000000000000000000000000..d1ba905b8e74ac6d94d6c553904e8180b729e062 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isOrDerivedFrom.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isOrDerivedFrom + +# Function: isOrDerivedFrom() + +> **isOrDerivedFrom**(`tsType`, `checkType`, `checkedBaseTypes`?): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9347 + +## Parameters + +### tsType + +[`Type`](../../../../../interfaces/Type.md) + +### checkType + +[`CheckType`](../type-aliases/CheckType.md) + +### checkedBaseTypes? + +[`Set`](../../../../../interfaces/Set.md)\<[`Type`](../../../../../interfaces/Type.md)\> + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isPrimitiveEnumMemberType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isPrimitiveEnumMemberType.md new file mode 100644 index 0000000000000000000000000000000000000000..dd22a2235132b31ebf92bb617ac94c7a5b32e044 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isPrimitiveEnumMemberType.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isPrimitiveEnumMemberType + +# Function: isPrimitiveEnumMemberType() + +> **isPrimitiveEnumMemberType**(`type`, `primitiveType`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9322 + +## Parameters + +### type + +[`Type`](../../../../../interfaces/Type.md) + +### primitiveType + +[`TypeFlags`](../../../../../enumerations/TypeFlags.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isPrimitiveLiteralType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isPrimitiveLiteralType.md new file mode 100644 index 0000000000000000000000000000000000000000..452ef50e735d094c36cbbafd3bba00b58b87e969 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isPrimitiveLiteralType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isPrimitiveLiteralType + +# Function: isPrimitiveLiteralType() + +> **isPrimitiveLiteralType**(`type`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9339 + +## Parameters + +### type + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isPrimitiveType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isPrimitiveType.md new file mode 100644 index 0000000000000000000000000000000000000000..dd344cd767078dbdbf71839b1c668e2a68144ce8 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isPrimitiveType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isPrimitiveType + +# Function: isPrimitiveType() + +> **isPrimitiveType**(`type`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9338 + +## Parameters + +### type + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isPrototypeSymbol.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isPrototypeSymbol.md new file mode 100644 index 0000000000000000000000000000000000000000..8c2aedc95dccc00d2c6eebd1e6886b476bea2106 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isPrototypeSymbol.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isPrototypeSymbol + +# Function: isPrototypeSymbol() + +> **isPrototypeSymbol**(`symbol`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9351 + +## Parameters + +### symbol + +`undefined` | [`Symbol`](../../../../../interfaces/Symbol.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isPurePrimitiveLiteralType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isPurePrimitiveLiteralType.md new file mode 100644 index 0000000000000000000000000000000000000000..89946367e2196ce70b6920d5c6e5b3fd16d4c5fb --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isPurePrimitiveLiteralType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isPurePrimitiveLiteralType + +# Function: isPurePrimitiveLiteralType() + +> **isPurePrimitiveLiteralType**(`type`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9340 + +## Parameters + +### type + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isReadonlyArrayType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isReadonlyArrayType.md new file mode 100644 index 0000000000000000000000000000000000000000..0b4f81f93c0ffd9bb09683d33e1423cc9d4c261e --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isReadonlyArrayType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isReadonlyArrayType + +# Function: isReadonlyArrayType() + +> **isReadonlyArrayType**(`tsType`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9343 + +## Parameters + +### tsType + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isReferenceType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isReferenceType.md new file mode 100644 index 0000000000000000000000000000000000000000..066652af0f589f15d047f325779fe59785ba49b1 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isReferenceType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isReferenceType + +# Function: isReferenceType() + +> **isReferenceType**(`tsType`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9337 + +## Parameters + +### tsType + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isSendableClassOrInterface.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isSendableClassOrInterface.md new file mode 100644 index 0000000000000000000000000000000000000000..33ddfc6b95a609ed54a6a9f2f0ab501356a185e9 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isSendableClassOrInterface.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isSendableClassOrInterface + +# Function: isSendableClassOrInterface() + +> **isSendableClassOrInterface**(`type`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9454 + +## Parameters + +### type + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isSendableClassOrInterfaceEntity.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isSendableClassOrInterfaceEntity.md new file mode 100644 index 0000000000000000000000000000000000000000..e94366039b977d64b59629433eccd3d8733583bb --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isSendableClassOrInterfaceEntity.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isSendableClassOrInterfaceEntity + +# Function: isSendableClassOrInterfaceEntity() + +> **isSendableClassOrInterfaceEntity**(`node`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9467 + +## Parameters + +### node + +[`Node`](../../../../../interfaces/Node.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isSendableFunction.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isSendableFunction.md new file mode 100644 index 0000000000000000000000000000000000000000..23d66638fb8a94451e079271e8a10c14b5805bce --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isSendableFunction.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isSendableFunction + +# Function: isSendableFunction() + +> **isSendableFunction**(`type`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9470 + +## Parameters + +### type + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isSendableType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isSendableType.md new file mode 100644 index 0000000000000000000000000000000000000000..cf700394f454dbe7f6f24a8046c8ad8701d3c2bf --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isSendableType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isSendableType + +# Function: isSendableType() + +> **isSendableType**(`type`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9452 + +## Parameters + +### type + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isSendableTypeAlias.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isSendableTypeAlias.md new file mode 100644 index 0000000000000000000000000000000000000000..9be6e89d7c26e778b1b0ae558f469a116f1c3be0 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isSendableTypeAlias.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isSendableTypeAlias + +# Function: isSendableTypeAlias() + +> **isSendableTypeAlias**(`type`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9471 + +## Parameters + +### type + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isSendableTypeNode.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isSendableTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..492f973a2bb3c022c215b49202020174f9c4fab5 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isSendableTypeNode.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isSendableTypeNode + +# Function: isSendableTypeNode() + +> **isSendableTypeNode**(`typeNode`, `isShared`?): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9451 + +## Parameters + +### typeNode + +[`TypeNode`](../../../../../interfaces/TypeNode.md) + +### isShared? + +`boolean` + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isSendableUnionType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isSendableUnionType.md new file mode 100644 index 0000000000000000000000000000000000000000..18ae9d1ae82e32b906d30dc3e2617dc115d5c267 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isSendableUnionType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isSendableUnionType + +# Function: isSendableUnionType() + +> **isSendableUnionType**(`type`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9458 + +## Parameters + +### type + +[`UnionType`](../../../../../interfaces/UnionType.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isShareableEntity.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isShareableEntity.md new file mode 100644 index 0000000000000000000000000000000000000000..e15c2d6ef494c0cc1b37c90a4e952c01528b5d08 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isShareableEntity.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isShareableEntity + +# Function: isShareableEntity() + +> **isShareableEntity**(`node`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9466 + +## Parameters + +### node + +[`Node`](../../../../../interfaces/Node.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isShareableType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isShareableType.md new file mode 100644 index 0000000000000000000000000000000000000000..6dd5870205017eca8795401335dbc550dbf5cc59 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isShareableType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isShareableType + +# Function: isShareableType() + +> **isShareableType**(`tsType`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9453 + +## Parameters + +### tsType + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isSharedModule.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isSharedModule.md new file mode 100644 index 0000000000000000000000000000000000000000..05c4d30fc566d1a479e1bbfd6e47f17dc1525225 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isSharedModule.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isSharedModule + +# Function: isSharedModule() + +> **isSharedModule**(`sourceFile`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9464 + +## Parameters + +### sourceFile + +[`SourceFile`](../../../../../interfaces/SourceFile.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isStdBigIntType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isStdBigIntType.md new file mode 100644 index 0000000000000000000000000000000000000000..57a77fd33554f6a9fa0390bffe8e518a9eb43e74 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isStdBigIntType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isStdBigIntType + +# Function: isStdBigIntType() + +> **isStdBigIntType**(`type`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9441 + +## Parameters + +### type + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isStdBooleanType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isStdBooleanType.md new file mode 100644 index 0000000000000000000000000000000000000000..f1e088aa335f6027b9ec3991f58e4c1eca715096 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isStdBooleanType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isStdBooleanType + +# Function: isStdBooleanType() + +> **isStdBooleanType**(`type`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9443 + +## Parameters + +### type + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isStdErrorType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isStdErrorType.md new file mode 100644 index 0000000000000000000000000000000000000000..5d0d3a976fb1cb7876e77f463d66c7cdf9c2a32d --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isStdErrorType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isStdErrorType + +# Function: isStdErrorType() + +> **isStdErrorType**(`type`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9412 + +## Parameters + +### type + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isStdLibrarySymbol.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isStdLibrarySymbol.md new file mode 100644 index 0000000000000000000000000000000000000000..afc456978d4b558cc2a0a8140d596de88d707c45 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isStdLibrarySymbol.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isStdLibrarySymbol + +# Function: isStdLibrarySymbol() + +> **isStdLibrarySymbol**(`sym`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9422 + +## Parameters + +### sym + +`undefined` | [`Symbol`](../../../../../interfaces/Symbol.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isStdLibraryType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isStdLibraryType.md new file mode 100644 index 0000000000000000000000000000000000000000..a77bd21a2a56e9aaadb45f888f202d88997b3d46 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isStdLibraryType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isStdLibraryType + +# Function: isStdLibraryType() + +> **isStdLibraryType**(`type`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9421 + +## Parameters + +### type + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isStdMapType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isStdMapType.md new file mode 100644 index 0000000000000000000000000000000000000000..b35600af445bde718fd75ed6020e4eaed590947f --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isStdMapType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isStdMapType + +# Function: isStdMapType() + +> **isStdMapType**(`type`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9411 + +## Parameters + +### type + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isStdNumberType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isStdNumberType.md new file mode 100644 index 0000000000000000000000000000000000000000..5e6af167fa763993ba0a199bd05f0094b1dfb8fb --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isStdNumberType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isStdNumberType + +# Function: isStdNumberType() + +> **isStdNumberType**(`type`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9442 + +## Parameters + +### type + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isStdPartialType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isStdPartialType.md new file mode 100644 index 0000000000000000000000000000000000000000..074f5e70429641085ede10610d39b7046664b54b --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isStdPartialType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isStdPartialType + +# Function: isStdPartialType() + +> **isStdPartialType**(`type`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9413 + +## Parameters + +### type + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isStdReadonlyType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isStdReadonlyType.md new file mode 100644 index 0000000000000000000000000000000000000000..0d7c72e062002e4863357ab1cd519c6b95497d6e --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isStdReadonlyType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isStdReadonlyType + +# Function: isStdReadonlyType() + +> **isStdReadonlyType**(`type`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9415 + +## Parameters + +### type + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isStdRecordType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isStdRecordType.md new file mode 100644 index 0000000000000000000000000000000000000000..20334ecaab95fb22fcfce56120b4b43d948e9590 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isStdRecordType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isStdRecordType + +# Function: isStdRecordType() + +> **isStdRecordType**(`type`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9410 + +## Parameters + +### type + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isStdRequiredType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isStdRequiredType.md new file mode 100644 index 0000000000000000000000000000000000000000..1ed4e7decadbd7a74b70a110bba147af0de2afcb --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isStdRequiredType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isStdRequiredType + +# Function: isStdRequiredType() + +> **isStdRequiredType**(`type`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9414 + +## Parameters + +### type + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isStdSymbol.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isStdSymbol.md new file mode 100644 index 0000000000000000000000000000000000000000..f40265bdcb21fa95f7b338b6712f6c9d88037182 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isStdSymbol.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isStdSymbol + +# Function: isStdSymbol() + +> **isStdSymbol**(`symbol`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9403 + +## Parameters + +### symbol + +[`Symbol`](../../../../../interfaces/Symbol.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isStringConstantValue.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isStringConstantValue.md new file mode 100644 index 0000000000000000000000000000000000000000..3c6ea92191895682bff2b1e086c4b19b2c7fab4b --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isStringConstantValue.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isStringConstantValue + +# Function: isStringConstantValue() + +> **isStringConstantValue**(`tsExpr`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9366 + +## Parameters + +### tsExpr + +[`EnumMember`](../../../../../interfaces/EnumMember.md) | [`PropertyAccessExpression`](../../../../../interfaces/PropertyAccessExpression.md) | [`ElementAccessExpression`](../../../../../interfaces/ElementAccessExpression.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isStringLikeType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isStringLikeType.md new file mode 100644 index 0000000000000000000000000000000000000000..a76a29c8440658f6eb7c51f536e2ec5e7fa99633 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isStringLikeType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isStringLikeType + +# Function: isStringLikeType() + +> **isStringLikeType**(`tsType`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9320 + +## Parameters + +### tsType + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isStringType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isStringType.md new file mode 100644 index 0000000000000000000000000000000000000000..6bbad3fd137a776273cfb93648fd7df39c6a4a7a --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isStringType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isStringType + +# Function: isStringType() + +> **isStringType**(`tsType`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9321 + +## Parameters + +### tsType + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isStruct.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isStruct.md new file mode 100644 index 0000000000000000000000000000000000000000..f33b87f974587d37a787e764b18f076c261ccc1c --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isStruct.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isStruct + +# Function: isStruct() + +> **isStruct**(`symbol`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9389 + +## Parameters + +### symbol + +[`Symbol`](../../../../../interfaces/Symbol.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isStructDeclaration.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isStructDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..91499e6c2a2ad67dc8d7cc95ac119ca689dffd34 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isStructDeclaration.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isStructDeclaration + +# Function: isStructDeclaration() + +> **isStructDeclaration**(`node`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9380 + +## Parameters + +### node + +[`Node`](../../../../../interfaces/Node.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isStructDeclarationKind.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isStructDeclarationKind.md new file mode 100644 index 0000000000000000000000000000000000000000..1853fbb5d982c958f2fdfc49aa065a7ce1da191c --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isStructDeclarationKind.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isStructDeclarationKind + +# Function: isStructDeclarationKind() + +> **isStructDeclarationKind**(`kind`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9379 + +## Parameters + +### kind + +[`SyntaxKind`](../../../../../enumerations/SyntaxKind.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isStructObjectInitializer.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isStructObjectInitializer.md new file mode 100644 index 0000000000000000000000000000000000000000..b1edfaadde833ef99e6d2e8b77b059f72b2d7ef8 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isStructObjectInitializer.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isStructObjectInitializer + +# Function: isStructObjectInitializer() + +> **isStructObjectInitializer**(`objectLiteral`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9381 + +## Parameters + +### objectLiteral + +[`ObjectLiteralExpression`](../../../../../interfaces/ObjectLiteralExpression.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isSupportedType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isSupportedType.md new file mode 100644 index 0000000000000000000000000000000000000000..0e6345c68d3197dc07b5f63e664206a34d23bb79 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isSupportedType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isSupportedType + +# Function: isSupportedType() + +> **isSupportedType**(`typeNode`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9388 + +## Parameters + +### typeNode + +[`TypeNode`](../../../../../interfaces/TypeNode.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isSymbolAPI.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isSymbolAPI.md new file mode 100644 index 0000000000000000000000000000000000000000..6940b13a1d96788a58dbb885ffb49ca878bffe65 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isSymbolAPI.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isSymbolAPI + +# Function: isSymbolAPI() + +> **isSymbolAPI**(`symbol`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9402 + +## Parameters + +### symbol + +[`Symbol`](../../../../../interfaces/Symbol.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isSymbolIterator.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isSymbolIterator.md new file mode 100644 index 0000000000000000000000000000000000000000..05b2032a41d645fff40da90a7a1580b55280e0fc --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isSymbolIterator.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isSymbolIterator + +# Function: isSymbolIterator() + +> **isSymbolIterator**(`symbol`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9404 + +## Parameters + +### symbol + +[`Symbol`](../../../../../interfaces/Symbol.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isSymbolIteratorExpression.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isSymbolIteratorExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..d08122dbee3215a83d6770a57eac8db8a5bd96df --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isSymbolIteratorExpression.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isSymbolIteratorExpression + +# Function: isSymbolIteratorExpression() + +> **isSymbolIteratorExpression**(`expr`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9405 + +## Parameters + +### expr + +[`Expression`](../../../../../interfaces/Expression.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isThisOrSuperExpr.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isThisOrSuperExpr.md new file mode 100644 index 0000000000000000000000000000000000000000..4d12ba7b36c6b1582aad965ffa08a286c17017b2 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isThisOrSuperExpr.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isThisOrSuperExpr + +# Function: isThisOrSuperExpr() + +> **isThisOrSuperExpr**(`tsExpr`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9350 + +## Parameters + +### tsExpr + +[`Expression`](../../../../../interfaces/Expression.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isTuple.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isTuple.md new file mode 100644 index 0000000000000000000000000000000000000000..0c4eaa4b56e2aead9f30e8faf79cb1d4e18b4cbd --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isTuple.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isTuple + +# Function: isTuple() + +> **isTuple**(`tsType`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9346 + +## Parameters + +### tsType + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isType.md new file mode 100644 index 0000000000000000000000000000000000000000..5b4b76dd7253a76e6d63b78c2a17d300e479ab8c --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isType.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isType + +# Function: isType() + +> **isType**(`tsType`, `checkType`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9316 + +## Parameters + +### tsType + +`undefined` | [`TypeNode`](../../../../../interfaces/TypeNode.md) + +### checkType + +`string` + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isTypeDeclSyntaxKind.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isTypeDeclSyntaxKind.md new file mode 100644 index 0000000000000000000000000000000000000000..ba091b66c1a541ee00f8e9b42ecdf65354bc2a41 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isTypeDeclSyntaxKind.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isTypeDeclSyntaxKind + +# Function: isTypeDeclSyntaxKind() + +> **isTypeDeclSyntaxKind**(`kind`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9335 + +## Parameters + +### kind + +[`SyntaxKind`](../../../../../enumerations/SyntaxKind.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isTypeReference.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isTypeReference.md new file mode 100644 index 0000000000000000000000000000000000000000..2a5879addfc61de395d65ead2c077e2d0155ab0a --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isTypeReference.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isTypeReference + +# Function: isTypeReference() + +> **isTypeReference**(`tsType`): `tsType is TypeReference` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9348 + +## Parameters + +### tsType + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`tsType is TypeReference` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isTypeSymbol.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isTypeSymbol.md new file mode 100644 index 0000000000000000000000000000000000000000..ddfc9ed4a510ae5a3e9ec14ec7be838272f3df23 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isTypeSymbol.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isTypeSymbol + +# Function: isTypeSymbol() + +> **isTypeSymbol**(`symbol`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9341 + +## Parameters + +### symbol + +`undefined` | [`Symbol`](../../../../../interfaces/Symbol.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isTypedArray.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isTypedArray.md new file mode 100644 index 0000000000000000000000000000000000000000..8d39c5506eb10f76106e3d800575765542d9bebd --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isTypedArray.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isTypedArray + +# Function: isTypedArray() + +> **isTypedArray**(`tsType`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9344 + +## Parameters + +### tsType + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isUnknownType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isUnknownType.md new file mode 100644 index 0000000000000000000000000000000000000000..907870a897514721e9c8da8d04016d1f78316599 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isUnknownType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isUnknownType + +# Function: isUnknownType() + +> **isUnknownType**(`tsType`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9355 + +## Parameters + +### tsType + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isUnsupportedType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isUnsupportedType.md new file mode 100644 index 0000000000000000000000000000000000000000..45063363950f0d1fb9a0f7f01c277cb855c60221 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isUnsupportedType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isUnsupportedType + +# Function: isUnsupportedType() + +> **isUnsupportedType**(`tsType`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9356 + +## Parameters + +### tsType + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isUnsupportedUnionType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isUnsupportedUnionType.md new file mode 100644 index 0000000000000000000000000000000000000000..bda5a359d85436dff250a01afbb36b8d0f02e2b7 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isUnsupportedUnionType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isUnsupportedUnionType + +# Function: isUnsupportedUnionType() + +> **isUnsupportedUnionType**(`tsType`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9357 + +## Parameters + +### tsType + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isValidComputedPropertyName.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isValidComputedPropertyName.md new file mode 100644 index 0000000000000000000000000000000000000000..84f709fecde7c9b39b6df2e57ff44a28cac3bbc2 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isValidComputedPropertyName.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isValidComputedPropertyName + +# Function: isValidComputedPropertyName() + +> **isValidComputedPropertyName**(`computedProperty`, `isRecordObjectInitializer`?): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9445 + +## Parameters + +### computedProperty + +[`ComputedPropertyName`](../../../../../interfaces/ComputedPropertyName.md) + +### isRecordObjectInitializer? + +`boolean` + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isValidEnumMemberInit.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isValidEnumMemberInit.md new file mode 100644 index 0000000000000000000000000000000000000000..8296cc555411ce5df07a8455d3f9f727cb793edf --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isValidEnumMemberInit.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isValidEnumMemberInit + +# Function: isValidEnumMemberInit() + +> **isValidEnumMemberInit**(`tsExpr`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9361 + +## Parameters + +### tsExpr + +[`Expression`](../../../../../interfaces/Expression.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isValueAssignableToESObject.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isValueAssignableToESObject.md new file mode 100644 index 0000000000000000000000000000000000000000..db5d8abc3935954f7cbd340c4e5d62c94e930a36 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isValueAssignableToESObject.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isValueAssignableToESObject + +# Function: isValueAssignableToESObject() + +> **isValueAssignableToESObject**(`node`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9431 + +## Parameters + +### node + +[`Node`](../../../../../interfaces/Node.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isWrongSendableFunctionAssignment.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isWrongSendableFunctionAssignment.md new file mode 100644 index 0000000000000000000000000000000000000000..e10a7ebb827d0714276da7e0f2dad7c64b7b3594 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/isWrongSendableFunctionAssignment.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / isWrongSendableFunctionAssignment + +# Function: isWrongSendableFunctionAssignment() + +> **isWrongSendableFunctionAssignment**(`lhsType`, `rhsType`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9474 + +## Parameters + +### lhsType + +[`Type`](../../../../../interfaces/Type.md) + +### rhsType + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/logTscDiagnostic.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/logTscDiagnostic.md new file mode 100644 index 0000000000000000000000000000000000000000..8d5280194e02a762819ec4a6ddc39365c6d0539c --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/logTscDiagnostic.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / logTscDiagnostic + +# Function: logTscDiagnostic() + +> **logTscDiagnostic**(`diagnostics`, `log`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9374 + +## Parameters + +### diagnostics + +readonly [`Diagnostic`](../../../../../interfaces/Diagnostic.md)[] + +### log + +(`message`, ...`args`) => `void` + +## Returns + +`void` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/needStrictMatchType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/needStrictMatchType.md new file mode 100644 index 0000000000000000000000000000000000000000..59fcac8029d9ed9d55d69a341bd0e608b3f20db0 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/needStrictMatchType.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / needStrictMatchType + +# Function: needStrictMatchType() + +> **needStrictMatchType**(`lhsType`, `rhsType`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9370 + +## Parameters + +### lhsType + +[`Type`](../../../../../interfaces/Type.md) + +### rhsType + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/needToDeduceStructuralIdentity.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/needToDeduceStructuralIdentity.md new file mode 100644 index 0000000000000000000000000000000000000000..f3cb8da56c4f26d449f59cd86971aa85fede5312 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/needToDeduceStructuralIdentity.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / needToDeduceStructuralIdentity + +# Function: needToDeduceStructuralIdentity() + +> **needToDeduceStructuralIdentity**(`lhsType`, `rhsType`, `rhsExpr`, `isStrict`?): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9369 + +## Parameters + +### lhsType + +[`Type`](../../../../../interfaces/Type.md) + +### rhsType + +[`Type`](../../../../../interfaces/Type.md) + +### rhsExpr + +[`Expression`](../../../../../interfaces/Expression.md) + +### isStrict? + +`boolean` + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/pathContainsDirectory.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/pathContainsDirectory.md new file mode 100644 index 0000000000000000000000000000000000000000..8d4dfe930acb88a0d47cf9e1e9df974bb66cd817 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/pathContainsDirectory.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / pathContainsDirectory + +# Function: pathContainsDirectory() + +> **pathContainsDirectory**(`targetPath`, `dir`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9419 + +## Parameters + +### targetPath + +`string` + +### dir + +`string` + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/processParentTypes.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/processParentTypes.md new file mode 100644 index 0000000000000000000000000000000000000000..021a2b59bc8f8c7a64b3b5eb31aa7c427ffc2cac --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/processParentTypes.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / processParentTypes + +# Function: processParentTypes() + +> **processParentTypes**(`parentTypes`, `typeB`, `processInterfaces`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9372 + +## Parameters + +### parentTypes + +[`NodeArray`](../../../../../interfaces/NodeArray.md)\<[`ExpressionWithTypeArguments`](../../../../../interfaces/ExpressionWithTypeArguments.md)\> + +### typeB + +[`Type`](../../../../../interfaces/Type.md) + +### processInterfaces + +`boolean` + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/reduceReference.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/reduceReference.md new file mode 100644 index 0000000000000000000000000000000000000000..16c7161690a6ccaa17f560491c67973548a3bf1b --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/reduceReference.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / reduceReference + +# Function: reduceReference() + +> **reduceReference**(`t`): [`Type`](../../../../../interfaces/Type.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9368 + +## Parameters + +### t + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +[`Type`](../../../../../interfaces/Type.md) diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/relatedByInheritanceOrIdentical.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/relatedByInheritanceOrIdentical.md new file mode 100644 index 0000000000000000000000000000000000000000..9bd9d4f7c22fd08a5567eb4cf1b8bec787d0dfc4 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/relatedByInheritanceOrIdentical.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / relatedByInheritanceOrIdentical + +# Function: relatedByInheritanceOrIdentical() + +> **relatedByInheritanceOrIdentical**(`typeA`, `typeB`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9367 + +## Parameters + +### typeA + +[`Type`](../../../../../interfaces/Type.md) + +### typeB + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/searchFileExportDecl.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/searchFileExportDecl.md new file mode 100644 index 0000000000000000000000000000000000000000..3a731e3dcce210d9c2b3ff730b13d9a1da29f120 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/searchFileExportDecl.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / searchFileExportDecl + +# Function: searchFileExportDecl() + +> **searchFileExportDecl**(`sourceFile`, `targetDecls`?): [`Set`](../../../../../interfaces/Set.md)\<[`Node`](../../../../../interfaces/Node.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9475 + +## Parameters + +### sourceFile + +[`SourceFile`](../../../../../interfaces/SourceFile.md) + +### targetDecls? + +[`SyntaxKind`](../../../../../enumerations/SyntaxKind.md)[] + +## Returns + +[`Set`](../../../../../interfaces/Set.md)\<[`Node`](../../../../../interfaces/Node.md)\> diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/setTestMode.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/setTestMode.md new file mode 100644 index 0000000000000000000000000000000000000000..367cefbd82045769235e38047a7a8a3c85ac549b --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/setTestMode.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / setTestMode + +# Function: setTestMode() + +> **setTestMode**(`tsTestMode`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9294 + +## Parameters + +### tsTestMode + +`boolean` + +## Returns + +`void` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/setTypeChecker.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/setTypeChecker.md new file mode 100644 index 0000000000000000000000000000000000000000..f605af5c28afeb36396f0ccb9b6556db627478fd --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/setTypeChecker.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / setTypeChecker + +# Function: setTypeChecker() + +> **setTypeChecker**(`tsTypeChecker`): `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9292 + +## Parameters + +### tsTypeChecker + +[`TypeChecker`](../../../../../interfaces/TypeChecker.md) + +## Returns + +`void` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/symbolHasDuplicateName.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/symbolHasDuplicateName.md new file mode 100644 index 0000000000000000000000000000000000000000..4d1cbd40ceb1701fda487d0564d09c642d704ab8 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/symbolHasDuplicateName.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / symbolHasDuplicateName + +# Function: symbolHasDuplicateName() + +> **symbolHasDuplicateName**(`symbol`, `tsDeclKind`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9336 + +## Parameters + +### symbol + +[`Symbol`](../../../../../interfaces/Symbol.md) + +### tsDeclKind + +[`SyntaxKind`](../../../../../enumerations/SyntaxKind.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/symbolHasEsObjectType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/symbolHasEsObjectType.md new file mode 100644 index 0000000000000000000000000000000000000000..51ba718f0abcf9622be9b2783ac945d0900417f9 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/symbolHasEsObjectType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / symbolHasEsObjectType + +# Function: symbolHasEsObjectType() + +> **symbolHasEsObjectType**(`sym`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9435 + +## Parameters + +### sym + +[`Symbol`](../../../../../interfaces/Symbol.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/trueSymbolAtLocation.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/trueSymbolAtLocation.md new file mode 100644 index 0000000000000000000000000000000000000000..72f0e13087ffd55f0520bd7401eb0d58a0f140b2 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/trueSymbolAtLocation.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / trueSymbolAtLocation + +# Function: trueSymbolAtLocation() + +> **trueSymbolAtLocation**(`node`): `undefined` \| [`Symbol`](../../../../../interfaces/Symbol.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9333 + +## Parameters + +### node + +[`Node`](../../../../../interfaces/Node.md) + +## Returns + +`undefined` \| [`Symbol`](../../../../../interfaces/Symbol.md) diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/typeContainsNonSendableClassOrInterface.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/typeContainsNonSendableClassOrInterface.md new file mode 100644 index 0000000000000000000000000000000000000000..65a26b26daa709987987c9477cdb047d504955ee --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/typeContainsNonSendableClassOrInterface.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / typeContainsNonSendableClassOrInterface + +# Function: typeContainsNonSendableClassOrInterface() + +> **typeContainsNonSendableClassOrInterface**(`type`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9456 + +## Parameters + +### type + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/typeContainsSendableClassOrInterface.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/typeContainsSendableClassOrInterface.md new file mode 100644 index 0000000000000000000000000000000000000000..81cfbff06b7df1abc797586c094c1bd08e3fdef1 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/typeContainsSendableClassOrInterface.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / typeContainsSendableClassOrInterface + +# Function: typeContainsSendableClassOrInterface() + +> **typeContainsSendableClassOrInterface**(`type`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9455 + +## Parameters + +### type + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/typeIsRecursive.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/typeIsRecursive.md new file mode 100644 index 0000000000000000000000000000000000000000..8daa3d97027ae9ae4e8a8f8949ef4cfdec4a1ff6 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/typeIsRecursive.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / typeIsRecursive + +# Function: typeIsRecursive() + +> **typeIsRecursive**(`topType`, `type`?): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9439 + +## Parameters + +### topType + +[`Type`](../../../../../interfaces/Type.md) + +### type? + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/unwrapParenthesized.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/unwrapParenthesized.md new file mode 100644 index 0000000000000000000000000000000000000000..69376164b243a6d4f05fdb57831179af753c65c2 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/unwrapParenthesized.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / unwrapParenthesized + +# Function: unwrapParenthesized() + +> **unwrapParenthesized**(`tsExpr`): [`Expression`](../../../../../interfaces/Expression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9331 + +## Parameters + +### tsExpr + +[`Expression`](../../../../../interfaces/Expression.md) + +## Returns + +[`Expression`](../../../../../interfaces/Expression.md) diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/unwrapParenthesizedType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/unwrapParenthesizedType.md new file mode 100644 index 0000000000000000000000000000000000000000..33ab62b014a76f5d101ea59fba24449a1debd49c --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/unwrapParenthesizedType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / unwrapParenthesizedType + +# Function: unwrapParenthesizedType() + +> **unwrapParenthesizedType**(`tsType`): [`TypeNode`](../../../../../interfaces/TypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9323 + +## Parameters + +### tsType + +[`TypeNode`](../../../../../interfaces/TypeNode.md) + +## Returns + +[`TypeNode`](../../../../../interfaces/TypeNode.md) diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/unwrapParenthesizedTypeNode.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/unwrapParenthesizedTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..f4d0e387764353890515536dc86daae9ad73216c --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/unwrapParenthesizedTypeNode.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / unwrapParenthesizedTypeNode + +# Function: unwrapParenthesizedTypeNode() + +> **unwrapParenthesizedTypeNode**(`typeNode`): [`TypeNode`](../../../../../interfaces/TypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9450 + +## Parameters + +### typeNode + +[`TypeNode`](../../../../../interfaces/TypeNode.md) + +## Returns + +[`TypeNode`](../../../../../interfaces/TypeNode.md) diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/validateFields.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/validateFields.md new file mode 100644 index 0000000000000000000000000000000000000000..7782619be4a278e0726107743ba109448970177d --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/validateFields.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / validateFields + +# Function: validateFields() + +> **validateFields**(`objectType`, `objectLiteral`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9387 + +## Parameters + +### objectType + +[`Type`](../../../../../interfaces/Type.md) + +### objectLiteral + +[`ObjectLiteralExpression`](../../../../../interfaces/ObjectLiteralExpression.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/validateObjectLiteralType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/validateObjectLiteralType.md new file mode 100644 index 0000000000000000000000000000000000000000..12da52cad323093e4fa3d14ea0ce80e5a5f03703 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/functions/validateObjectLiteralType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / validateObjectLiteralType + +# Function: validateObjectLiteralType() + +> **validateObjectLiteralType**(`type`): `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9378 + +## Parameters + +### type + +`undefined` | [`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/type-aliases/CheckType.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/type-aliases/CheckType.md new file mode 100644 index 0000000000000000000000000000000000000000..eaa72c225bd1a8e4ba247e697959fad6b63f54aa --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/type-aliases/CheckType.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / CheckType + +# Type Alias: CheckType() + +> **CheckType**: (`t`) => `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9390 + +## Parameters + +### t + +[`Type`](../../../../../interfaces/Type.md) + +## Returns + +`boolean` diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/ALLOWED_STD_SYMBOL_API.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/ALLOWED_STD_SYMBOL_API.md new file mode 100644 index 0000000000000000000000000000000000000000..bcaa119ef3696acc6a17fd0c110268504bbb67c0 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/ALLOWED_STD_SYMBOL_API.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / ALLOWED\_STD\_SYMBOL\_API + +# Variable: ALLOWED\_STD\_SYMBOL\_API + +> `const` **ALLOWED\_STD\_SYMBOL\_API**: `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9278 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/ARKTS_COLLECTIONS_D_ETS.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/ARKTS_COLLECTIONS_D_ETS.md new file mode 100644 index 0000000000000000000000000000000000000000..9eb00adf365301bcd4ebe6f79e799db4cedac543 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/ARKTS_COLLECTIONS_D_ETS.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / ARKTS\_COLLECTIONS\_D\_ETS + +# Variable: ARKTS\_COLLECTIONS\_D\_ETS + +> `const` **ARKTS\_COLLECTIONS\_D\_ETS**: `"@arkts.collections.d.ets"` = `"@arkts.collections.d.ets"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9285 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/ARKTS_IGNORE_DIRS.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/ARKTS_IGNORE_DIRS.md new file mode 100644 index 0000000000000000000000000000000000000000..cd7dfacc503bfbaf0dd993e45d92530a4fd84c97 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/ARKTS_IGNORE_DIRS.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / ARKTS\_IGNORE\_DIRS + +# Variable: ARKTS\_IGNORE\_DIRS + +> `const` **ARKTS\_IGNORE\_DIRS**: `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9279 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/ARKTS_IGNORE_FILES.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/ARKTS_IGNORE_FILES.md new file mode 100644 index 0000000000000000000000000000000000000000..b4addb4d770120ea43131bf01c344517c3eb3cd4 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/ARKTS_IGNORE_FILES.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / ARKTS\_IGNORE\_FILES + +# Variable: ARKTS\_IGNORE\_FILES + +> `const` **ARKTS\_IGNORE\_FILES**: `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9280 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/ARKTS_LANG_D_ETS.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/ARKTS_LANG_D_ETS.md new file mode 100644 index 0000000000000000000000000000000000000000..9d607449d54ba6eeb8e1134f0668a07a598a9c6f --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/ARKTS_LANG_D_ETS.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / ARKTS\_LANG\_D\_ETS + +# Variable: ARKTS\_LANG\_D\_ETS + +> `const` **ARKTS\_LANG\_D\_ETS**: `"@arkts.lang.d.ets"` = `"@arkts.lang.d.ets"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9287 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/COLLECTIONS_NAMESPACE.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/COLLECTIONS_NAMESPACE.md new file mode 100644 index 0000000000000000000000000000000000000000..fb7fa61a9c556a6a07c7b94c25406f0f3e7dadc6 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/COLLECTIONS_NAMESPACE.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / COLLECTIONS\_NAMESPACE + +# Variable: COLLECTIONS\_NAMESPACE + +> `const` **COLLECTIONS\_NAMESPACE**: `"collections"` = `"collections"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9286 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/D_TS.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/D_TS.md new file mode 100644 index 0000000000000000000000000000000000000000..ea6296a3d7a4fa5f2e5f5b9a8fc0e5288dc92b95 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/D_TS.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / D\_TS + +# Variable: D\_TS + +> `const` **D\_TS**: `".d.ts"` = `".d.ts"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9291 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/ES_OBJECT.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/ES_OBJECT.md new file mode 100644 index 0000000000000000000000000000000000000000..5bebe23b3425d85074e480e9038b971d8665c70f --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/ES_OBJECT.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / ES\_OBJECT + +# Variable: ES\_OBJECT + +> `const` **ES\_OBJECT**: `"ESObject"` = `"ESObject"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9391 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/FUNCTION_HAS_NO_RETURN_ERROR_CODE.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/FUNCTION_HAS_NO_RETURN_ERROR_CODE.md new file mode 100644 index 0000000000000000000000000000000000000000..e3646e20953338d21b956f90ea8a9afac2ba6355 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/FUNCTION_HAS_NO_RETURN_ERROR_CODE.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / FUNCTION\_HAS\_NO\_RETURN\_ERROR\_CODE + +# Variable: FUNCTION\_HAS\_NO\_RETURN\_ERROR\_CODE + +> `const` **FUNCTION\_HAS\_NO\_RETURN\_ERROR\_CODE**: `2366` = `2366` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9396 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/ISENDABLE_TYPE.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/ISENDABLE_TYPE.md new file mode 100644 index 0000000000000000000000000000000000000000..54016640b68d2f01f0fc4e2666281e46db062af1 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/ISENDABLE_TYPE.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / ISENDABLE\_TYPE + +# Variable: ISENDABLE\_TYPE + +> `const` **ISENDABLE\_TYPE**: `"ISendable"` = `"ISendable"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9289 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/LANG_NAMESPACE.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/LANG_NAMESPACE.md new file mode 100644 index 0000000000000000000000000000000000000000..cc78ec52040add4098b3ba53fe0c5ae5d72326a3 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/LANG_NAMESPACE.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / LANG\_NAMESPACE + +# Variable: LANG\_NAMESPACE + +> `const` **LANG\_NAMESPACE**: `"lang"` = `"lang"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9288 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/LIMITED_STANDARD_UTILITY_TYPES.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/LIMITED_STANDARD_UTILITY_TYPES.md new file mode 100644 index 0000000000000000000000000000000000000000..7d553ce8e591b12f5ab7821c4343952b928d0ddd --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/LIMITED_STANDARD_UTILITY_TYPES.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / LIMITED\_STANDARD\_UTILITY\_TYPES + +# Variable: LIMITED\_STANDARD\_UTILITY\_TYPES + +> `const` **LIMITED\_STANDARD\_UTILITY\_TYPES**: `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9277 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/LIMITED_STD_GLOBAL_FUNC.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/LIMITED_STD_GLOBAL_FUNC.md new file mode 100644 index 0000000000000000000000000000000000000000..6f55b254e5f55f8c22c3ec96fc707b48c887eb77 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/LIMITED_STD_GLOBAL_FUNC.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / LIMITED\_STD\_GLOBAL\_FUNC + +# Variable: LIMITED\_STD\_GLOBAL\_FUNC + +> `const` **LIMITED\_STD\_GLOBAL\_FUNC**: `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9392 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/LIMITED_STD_OBJECT_API.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/LIMITED_STD_OBJECT_API.md new file mode 100644 index 0000000000000000000000000000000000000000..6f56c1eedee85c0bfb5d6c19917b8ef1431aa205 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/LIMITED_STD_OBJECT_API.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / LIMITED\_STD\_OBJECT\_API + +# Variable: LIMITED\_STD\_OBJECT\_API + +> `const` **LIMITED\_STD\_OBJECT\_API**: `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9393 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/LIMITED_STD_PROXYHANDLER_API.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/LIMITED_STD_PROXYHANDLER_API.md new file mode 100644 index 0000000000000000000000000000000000000000..9b999c7accf1820da69b0d405ef2eb5006ceab7d --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/LIMITED_STD_PROXYHANDLER_API.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / LIMITED\_STD\_PROXYHANDLER\_API + +# Variable: LIMITED\_STD\_PROXYHANDLER\_API + +> `const` **LIMITED\_STD\_PROXYHANDLER\_API**: `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9395 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/LIMITED_STD_REFLECT_API.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/LIMITED_STD_REFLECT_API.md new file mode 100644 index 0000000000000000000000000000000000000000..fadab244193f64db834c61b1ea0378915d6188bf --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/LIMITED_STD_REFLECT_API.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / LIMITED\_STD\_REFLECT\_API + +# Variable: LIMITED\_STD\_REFLECT\_API + +> `const` **LIMITED\_STD\_REFLECT\_API**: `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9394 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/NON_INITIALIZABLE_PROPERTY_CLASS_DECORATORS.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/NON_INITIALIZABLE_PROPERTY_CLASS_DECORATORS.md new file mode 100644 index 0000000000000000000000000000000000000000..cb1333e98c4a586333a3e6e7e72b0f56256fffb9 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/NON_INITIALIZABLE_PROPERTY_CLASS_DECORATORS.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / NON\_INITIALIZABLE\_PROPERTY\_CLASS\_DECORATORS + +# Variable: NON\_INITIALIZABLE\_PROPERTY\_CLASS\_DECORATORS + +> `const` **NON\_INITIALIZABLE\_PROPERTY\_CLASS\_DECORATORS**: `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9276 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/NON_INITIALIZABLE_PROPERTY_DECORATORS.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/NON_INITIALIZABLE_PROPERTY_DECORATORS.md new file mode 100644 index 0000000000000000000000000000000000000000..eb45997585d2d2d772e864fff42b1379b7021144 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/NON_INITIALIZABLE_PROPERTY_DECORATORS.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / NON\_INITIALIZABLE\_PROPERTY\_DECORATORS + +# Variable: NON\_INITIALIZABLE\_PROPERTY\_DECORATORS + +> `const` **NON\_INITIALIZABLE\_PROPERTY\_DECORATORS**: `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9275 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/NON_RETURN_FUNCTION_DECORATORS.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/NON_RETURN_FUNCTION_DECORATORS.md new file mode 100644 index 0000000000000000000000000000000000000000..ca4c067fa078cd3538e19e964b236c96ab0e7180 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/NON_RETURN_FUNCTION_DECORATORS.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / NON\_RETURN\_FUNCTION\_DECORATORS + +# Variable: NON\_RETURN\_FUNCTION\_DECORATORS + +> `const` **NON\_RETURN\_FUNCTION\_DECORATORS**: `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9397 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/PROPERTY_HAS_NO_INITIALIZER_ERROR_CODE.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/PROPERTY_HAS_NO_INITIALIZER_ERROR_CODE.md new file mode 100644 index 0000000000000000000000000000000000000000..5bab202ea127fe259972a76e0de067fa9f66cbcd --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/PROPERTY_HAS_NO_INITIALIZER_ERROR_CODE.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / PROPERTY\_HAS\_NO\_INITIALIZER\_ERROR\_CODE + +# Variable: PROPERTY\_HAS\_NO\_INITIALIZER\_ERROR\_CODE + +> `const` **PROPERTY\_HAS\_NO\_INITIALIZER\_ERROR\_CODE**: `2564` = `2564` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9274 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/SENDABLE_CLOSURE_DECLS.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/SENDABLE_CLOSURE_DECLS.md new file mode 100644 index 0000000000000000000000000000000000000000..4f1622faa5f9b54c604a559452356df3d1518334 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/SENDABLE_CLOSURE_DECLS.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / SENDABLE\_CLOSURE\_DECLS + +# Variable: SENDABLE\_CLOSURE\_DECLS + +> `const` **SENDABLE\_CLOSURE\_DECLS**: [`SyntaxKind`](../../../../../enumerations/SyntaxKind.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9284 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/SENDABLE_DECORATOR.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/SENDABLE_DECORATOR.md new file mode 100644 index 0000000000000000000000000000000000000000..32ca9da674e0230253da296911fa100df5598acf --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/SENDABLE_DECORATOR.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / SENDABLE\_DECORATOR + +# Variable: SENDABLE\_DECORATOR + +> `const` **SENDABLE\_DECORATOR**: `"Sendable"` = `"Sendable"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9281 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/SENDABLE_DECORATOR_NODES.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/SENDABLE_DECORATOR_NODES.md new file mode 100644 index 0000000000000000000000000000000000000000..e8cd993787f73dac297e32d0b0e859e6ef535770 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/SENDABLE_DECORATOR_NODES.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / SENDABLE\_DECORATOR\_NODES + +# Variable: SENDABLE\_DECORATOR\_NODES + +> `const` **SENDABLE\_DECORATOR\_NODES**: [`SyntaxKind`](../../../../../enumerations/SyntaxKind.md)[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9283 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/SENDABLE_INTERFACE.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/SENDABLE_INTERFACE.md new file mode 100644 index 0000000000000000000000000000000000000000..205dff71b2ada3bb03eff3170a0fba0f14c796d6 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/SENDABLE_INTERFACE.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / SENDABLE\_INTERFACE + +# Variable: SENDABLE\_INTERFACE + +> `const` **SENDABLE\_INTERFACE**: `"ISendable"` = `"ISendable"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9282 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/STANDARD_LIBRARIES.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/STANDARD_LIBRARIES.md new file mode 100644 index 0000000000000000000000000000000000000000..6b9fa14740298fcd13d6b359056a2974216d386d --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/STANDARD_LIBRARIES.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / STANDARD\_LIBRARIES + +# Variable: STANDARD\_LIBRARIES + +> `const` **STANDARD\_LIBRARIES**: `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9398 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/TYPED_ARRAYS.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/TYPED_ARRAYS.md new file mode 100644 index 0000000000000000000000000000000000000000..1f143228f83e2c648a57f6d6e9c88163aee04eff --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/TYPED_ARRAYS.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / TYPED\_ARRAYS + +# Variable: TYPED\_ARRAYS + +> `const` **TYPED\_ARRAYS**: `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9399 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/USE_SHARED.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/USE_SHARED.md new file mode 100644 index 0000000000000000000000000000000000000000..8c4b01f09acbe0441b33d9a6a75c0af5039b72a0 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/namespaces/Utils/variables/USE_SHARED.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../../../globals.md) / [ts](../../../../../README.md) / [ArkTSLinter\_1\_1](../../../README.md) / [Utils](../README.md) / USE\_SHARED + +# Variable: USE\_SHARED + +> `const` **USE\_SHARED**: `"use shared"` = `"use shared"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9290 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/type-aliases/KitSymbols.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/type-aliases/KitSymbols.md new file mode 100644 index 0000000000000000000000000000000000000000..20be9ad056ff41a2c0d9da12a08cefa9a6a27652 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/type-aliases/KitSymbols.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../globals.md) / [ts](../../../README.md) / [ArkTSLinter\_1\_1](../README.md) / KitSymbols + +# Type Alias: KitSymbols + +> **KitSymbols**: `Record`\<`string`, [`KitSymbol`](../interfaces/KitSymbol.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9697 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/variables/cookBookMsg.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/variables/cookBookMsg.md new file mode 100644 index 0000000000000000000000000000000000000000..1709ca2ff3165173c727f3aae18b8c369d84a81e --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/variables/cookBookMsg.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../globals.md) / [ts](../../../README.md) / [ArkTSLinter\_1\_1](../README.md) / cookBookMsg + +# Variable: cookBookMsg + +> `const` **cookBookMsg**: `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9091 diff --git a/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/variables/cookBookTag.md b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/variables/cookBookTag.md new file mode 100644 index 0000000000000000000000000000000000000000..62ec9a0a3bcfe71190fcdb52af57c80001c7ab3d --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ArkTSLinter_1_1/variables/cookBookTag.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../globals.md) / [ts](../../../README.md) / [ArkTSLinter\_1\_1](../README.md) / cookBookTag + +# Variable: cookBookTag + +> `const` **cookBookTag**: `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:9092 diff --git a/docs/api_docs/namespaces/ts/namespaces/ScriptSnapshot/README.md b/docs/api_docs/namespaces/ts/namespaces/ScriptSnapshot/README.md new file mode 100644 index 0000000000000000000000000000000000000000..2e28f6f3f306d322909c2ac128a35590d13c4d2a --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ScriptSnapshot/README.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../README.md) + +*** + +[ArkAnalyzer](../../../../globals.md) / [ts](../../README.md) / ScriptSnapshot + +# ScriptSnapshot + +## Functions + +- [fromString](functions/fromString.md) diff --git a/docs/api_docs/namespaces/ts/namespaces/ScriptSnapshot/functions/fromString.md b/docs/api_docs/namespaces/ts/namespaces/ScriptSnapshot/functions/fromString.md new file mode 100644 index 0000000000000000000000000000000000000000..e1ea4026803ec07f5b46a6e955a46f12f36e26db --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/ScriptSnapshot/functions/fromString.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../globals.md) / [ts](../../../README.md) / [ScriptSnapshot](../README.md) / fromString + +# Function: fromString() + +> **fromString**(`text`): [`IScriptSnapshot`](../../../interfaces/IScriptSnapshot.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6191 + +## Parameters + +### text + +`string` + +## Returns + +[`IScriptSnapshot`](../../../interfaces/IScriptSnapshot.md) diff --git a/docs/api_docs/namespaces/ts/namespaces/server/README.md b/docs/api_docs/namespaces/ts/namespaces/server/README.md new file mode 100644 index 0000000000000000000000000000000000000000..e870b22c757242b3d89b0e12aec8603422946a56 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/server/README.md @@ -0,0 +1,34 @@ +[**ArkAnalyzer**](../../../../README.md) + +*** + +[ArkAnalyzer](../../../../globals.md) / [ts](../../README.md) / server + +# server + +## Interfaces + +- [BeginInstallTypes](interfaces/BeginInstallTypes.md) +- [CloseProject](interfaces/CloseProject.md) +- [DiscoverTypings](interfaces/DiscoverTypings.md) +- [EndInstallTypes](interfaces/EndInstallTypes.md) +- [InitializationFailedResponse](interfaces/InitializationFailedResponse.md) +- [InstallPackageRequest](interfaces/InstallPackageRequest.md) +- [InstallTypes](interfaces/InstallTypes.md) +- [InvalidateCachedTypings](interfaces/InvalidateCachedTypings.md) +- [PackageInstalledResponse](interfaces/PackageInstalledResponse.md) +- [ProjectResponse](interfaces/ProjectResponse.md) +- [SetTypings](interfaces/SetTypings.md) +- [TypesRegistryRequest](interfaces/TypesRegistryRequest.md) +- [TypingInstallerRequestWithProjectName](interfaces/TypingInstallerRequestWithProjectName.md) +- [TypingInstallerResponse](interfaces/TypingInstallerResponse.md) + +## Type Aliases + +- [ActionInvalidate](type-aliases/ActionInvalidate.md) +- [ActionPackageInstalled](type-aliases/ActionPackageInstalled.md) +- [ActionSet](type-aliases/ActionSet.md) +- [EventBeginInstallTypes](type-aliases/EventBeginInstallTypes.md) +- [EventEndInstallTypes](type-aliases/EventEndInstallTypes.md) +- [EventInitializationFailed](type-aliases/EventInitializationFailed.md) +- [EventTypesRegistry](type-aliases/EventTypesRegistry.md) diff --git a/docs/api_docs/namespaces/ts/namespaces/server/interfaces/BeginInstallTypes.md b/docs/api_docs/namespaces/ts/namespaces/server/interfaces/BeginInstallTypes.md new file mode 100644 index 0000000000000000000000000000000000000000..2e4223efd2e2a9c45b1781d15fe5e0b78a098bf6 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/server/interfaces/BeginInstallTypes.md @@ -0,0 +1,73 @@ +[**ArkAnalyzer**](../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../globals.md) / [ts](../../../README.md) / [server](../README.md) / BeginInstallTypes + +# Interface: BeginInstallTypes + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6071 + +## Extends + +- [`InstallTypes`](InstallTypes.md) + +## Properties + +### eventId + +> `readonly` **eventId**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6067 + +#### Inherited from + +[`InstallTypes`](InstallTypes.md).[`eventId`](InstallTypes.md#eventid) + +*** + +### kind + +> `readonly` **kind**: `"event::beginInstallTypes"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6072 + +#### Overrides + +[`InstallTypes`](InstallTypes.md).[`kind`](InstallTypes.md#kind) + +*** + +### packagesToInstall + +> `readonly` **packagesToInstall**: readonly `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6069 + +#### Inherited from + +[`InstallTypes`](InstallTypes.md).[`packagesToInstall`](InstallTypes.md#packagestoinstall) + +*** + +### projectName + +> `readonly` **projectName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6060 + +#### Inherited from + +[`InstallTypes`](InstallTypes.md).[`projectName`](InstallTypes.md#projectname) + +*** + +### typingsInstallerVersion + +> `readonly` **typingsInstallerVersion**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6068 + +#### Inherited from + +[`InstallTypes`](InstallTypes.md).[`typingsInstallerVersion`](InstallTypes.md#typingsinstallerversion) diff --git a/docs/api_docs/namespaces/ts/namespaces/server/interfaces/CloseProject.md b/docs/api_docs/namespaces/ts/namespaces/server/interfaces/CloseProject.md new file mode 100644 index 0000000000000000000000000000000000000000..09a7c107be91101985b975324b3a390133117b19 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/server/interfaces/CloseProject.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../globals.md) / [ts](../../../README.md) / [server](../README.md) / CloseProject + +# Interface: CloseProject + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6037 + +## Extends + +- [`TypingInstallerRequestWithProjectName`](TypingInstallerRequestWithProjectName.md) + +## Properties + +### kind + +> `readonly` **kind**: `"closeProject"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6038 + +*** + +### projectName + +> `readonly` **projectName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6025 + +#### Inherited from + +[`TypingInstallerRequestWithProjectName`](TypingInstallerRequestWithProjectName.md).[`projectName`](TypingInstallerRequestWithProjectName.md#projectname) diff --git a/docs/api_docs/namespaces/ts/namespaces/server/interfaces/DiscoverTypings.md b/docs/api_docs/namespaces/ts/namespaces/server/interfaces/DiscoverTypings.md new file mode 100644 index 0000000000000000000000000000000000000000..36aa6006b99e6a4a9eebae8d26d6fb97fbc35790 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/server/interfaces/DiscoverTypings.md @@ -0,0 +1,89 @@ +[**ArkAnalyzer**](../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../globals.md) / [ts](../../../README.md) / [server](../README.md) / DiscoverTypings + +# Interface: DiscoverTypings + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6027 + +## Extends + +- [`TypingInstallerRequestWithProjectName`](TypingInstallerRequestWithProjectName.md) + +## Properties + +### cachePath? + +> `readonly` `optional` **cachePath**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6034 + +*** + +### compilerOptions + +> `readonly` **compilerOptions**: [`CompilerOptions`](../../../interfaces/CompilerOptions.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6030 + +*** + +### fileNames + +> `readonly` **fileNames**: `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6028 + +*** + +### kind + +> `readonly` **kind**: `"discover"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6035 + +*** + +### projectName + +> `readonly` **projectName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6025 + +#### Inherited from + +[`TypingInstallerRequestWithProjectName`](TypingInstallerRequestWithProjectName.md).[`projectName`](TypingInstallerRequestWithProjectName.md#projectname) + +*** + +### projectRootPath + +> `readonly` **projectRootPath**: [`Path`](../../../type-aliases/Path.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6029 + +*** + +### typeAcquisition + +> `readonly` **typeAcquisition**: [`TypeAcquisition`](../../../interfaces/TypeAcquisition.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6032 + +*** + +### unresolvedImports + +> `readonly` **unresolvedImports**: [`SortedReadonlyArray`](../../../interfaces/SortedReadonlyArray.md)\<`string`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6033 + +*** + +### watchOptions? + +> `readonly` `optional` **watchOptions**: [`WatchOptions`](../../../interfaces/WatchOptions.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6031 diff --git a/docs/api_docs/namespaces/ts/namespaces/server/interfaces/EndInstallTypes.md b/docs/api_docs/namespaces/ts/namespaces/server/interfaces/EndInstallTypes.md new file mode 100644 index 0000000000000000000000000000000000000000..a9bdb799a95779948e8bad13bb92155bbc15fb68 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/server/interfaces/EndInstallTypes.md @@ -0,0 +1,81 @@ +[**ArkAnalyzer**](../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../globals.md) / [ts](../../../README.md) / [server](../README.md) / EndInstallTypes + +# Interface: EndInstallTypes + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6074 + +## Extends + +- [`InstallTypes`](InstallTypes.md) + +## Properties + +### eventId + +> `readonly` **eventId**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6067 + +#### Inherited from + +[`InstallTypes`](InstallTypes.md).[`eventId`](InstallTypes.md#eventid) + +*** + +### installSuccess + +> `readonly` **installSuccess**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6076 + +*** + +### kind + +> `readonly` **kind**: `"event::endInstallTypes"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6075 + +#### Overrides + +[`InstallTypes`](InstallTypes.md).[`kind`](InstallTypes.md#kind) + +*** + +### packagesToInstall + +> `readonly` **packagesToInstall**: readonly `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6069 + +#### Inherited from + +[`InstallTypes`](InstallTypes.md).[`packagesToInstall`](InstallTypes.md#packagestoinstall) + +*** + +### projectName + +> `readonly` **projectName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6060 + +#### Inherited from + +[`InstallTypes`](InstallTypes.md).[`projectName`](InstallTypes.md#projectname) + +*** + +### typingsInstallerVersion + +> `readonly` **typingsInstallerVersion**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6068 + +#### Inherited from + +[`InstallTypes`](InstallTypes.md).[`typingsInstallerVersion`](InstallTypes.md#typingsinstallerversion) diff --git a/docs/api_docs/namespaces/ts/namespaces/server/interfaces/InitializationFailedResponse.md b/docs/api_docs/namespaces/ts/namespaces/server/interfaces/InitializationFailedResponse.md new file mode 100644 index 0000000000000000000000000000000000000000..c7d20b4573923694237918a79549c17215cc1b86 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/server/interfaces/InitializationFailedResponse.md @@ -0,0 +1,41 @@ +[**ArkAnalyzer**](../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../globals.md) / [ts](../../../README.md) / [server](../README.md) / InitializationFailedResponse + +# Interface: InitializationFailedResponse + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6054 + +## Extends + +- [`TypingInstallerResponse`](TypingInstallerResponse.md) + +## Properties + +### kind + +> `readonly` **kind**: `"event::initializationFailed"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6055 + +#### Overrides + +[`TypingInstallerResponse`](TypingInstallerResponse.md).[`kind`](TypingInstallerResponse.md#kind) + +*** + +### message + +> `readonly` **message**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6056 + +*** + +### stack? + +> `readonly` `optional` **stack**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6057 diff --git a/docs/api_docs/namespaces/ts/namespaces/server/interfaces/InstallPackageRequest.md b/docs/api_docs/namespaces/ts/namespaces/server/interfaces/InstallPackageRequest.md new file mode 100644 index 0000000000000000000000000000000000000000..7fd65c77e16114a208a579118363d0122d44914f --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/server/interfaces/InstallPackageRequest.md @@ -0,0 +1,57 @@ +[**ArkAnalyzer**](../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../globals.md) / [ts](../../../README.md) / [server](../README.md) / InstallPackageRequest + +# Interface: InstallPackageRequest + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6043 + +## Extends + +- [`TypingInstallerRequestWithProjectName`](TypingInstallerRequestWithProjectName.md) + +## Properties + +### fileName + +> `readonly` **fileName**: [`Path`](../../../type-aliases/Path.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6045 + +*** + +### kind + +> `readonly` **kind**: `"installPackage"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6044 + +*** + +### packageName + +> `readonly` **packageName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6046 + +*** + +### projectName + +> `readonly` **projectName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6025 + +#### Inherited from + +[`TypingInstallerRequestWithProjectName`](TypingInstallerRequestWithProjectName.md).[`projectName`](TypingInstallerRequestWithProjectName.md#projectname) + +*** + +### projectRootPath + +> `readonly` **projectRootPath**: [`Path`](../../../type-aliases/Path.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6047 diff --git a/docs/api_docs/namespaces/ts/namespaces/server/interfaces/InstallTypes.md b/docs/api_docs/namespaces/ts/namespaces/server/interfaces/InstallTypes.md new file mode 100644 index 0000000000000000000000000000000000000000..c6307e00d888c4be07508141de69170c5eb39fa9 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/server/interfaces/InstallTypes.md @@ -0,0 +1,66 @@ +[**ArkAnalyzer**](../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../globals.md) / [ts](../../../README.md) / [server](../README.md) / InstallTypes + +# Interface: InstallTypes + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6065 + +## Extends + +- [`ProjectResponse`](ProjectResponse.md) + +## Extended by + +- [`BeginInstallTypes`](BeginInstallTypes.md) +- [`EndInstallTypes`](EndInstallTypes.md) + +## Properties + +### eventId + +> `readonly` **eventId**: `number` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6067 + +*** + +### kind + +> `readonly` **kind**: `"event::beginInstallTypes"` \| `"event::endInstallTypes"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6066 + +#### Overrides + +[`ProjectResponse`](ProjectResponse.md).[`kind`](ProjectResponse.md#kind) + +*** + +### packagesToInstall + +> `readonly` **packagesToInstall**: readonly `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6069 + +*** + +### projectName + +> `readonly` **projectName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6060 + +#### Inherited from + +[`ProjectResponse`](ProjectResponse.md).[`projectName`](ProjectResponse.md#projectname) + +*** + +### typingsInstallerVersion + +> `readonly` **typingsInstallerVersion**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6068 diff --git a/docs/api_docs/namespaces/ts/namespaces/server/interfaces/InvalidateCachedTypings.md b/docs/api_docs/namespaces/ts/namespaces/server/interfaces/InvalidateCachedTypings.md new file mode 100644 index 0000000000000000000000000000000000000000..fc663d729b80c52208729c3ac832bde7fbf7f022 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/server/interfaces/InvalidateCachedTypings.md @@ -0,0 +1,37 @@ +[**ArkAnalyzer**](../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../globals.md) / [ts](../../../README.md) / [server](../README.md) / InvalidateCachedTypings + +# Interface: InvalidateCachedTypings + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6062 + +## Extends + +- [`ProjectResponse`](ProjectResponse.md) + +## Properties + +### kind + +> `readonly` **kind**: `"action::invalidate"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6063 + +#### Overrides + +[`ProjectResponse`](ProjectResponse.md).[`kind`](ProjectResponse.md#kind) + +*** + +### projectName + +> `readonly` **projectName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6060 + +#### Inherited from + +[`ProjectResponse`](ProjectResponse.md).[`projectName`](ProjectResponse.md#projectname) diff --git a/docs/api_docs/namespaces/ts/namespaces/server/interfaces/PackageInstalledResponse.md b/docs/api_docs/namespaces/ts/namespaces/server/interfaces/PackageInstalledResponse.md new file mode 100644 index 0000000000000000000000000000000000000000..83b0628a9363b37585879913e81b68f3c8b3e711 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/server/interfaces/PackageInstalledResponse.md @@ -0,0 +1,53 @@ +[**ArkAnalyzer**](../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../globals.md) / [ts](../../../README.md) / [server](../README.md) / PackageInstalledResponse + +# Interface: PackageInstalledResponse + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6049 + +## Extends + +- [`ProjectResponse`](ProjectResponse.md) + +## Properties + +### kind + +> `readonly` **kind**: `"action::packageInstalled"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6050 + +#### Overrides + +[`ProjectResponse`](ProjectResponse.md).[`kind`](ProjectResponse.md#kind) + +*** + +### message + +> `readonly` **message**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6052 + +*** + +### projectName + +> `readonly` **projectName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6060 + +#### Inherited from + +[`ProjectResponse`](ProjectResponse.md).[`projectName`](ProjectResponse.md#projectname) + +*** + +### success + +> `readonly` **success**: `boolean` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6051 diff --git a/docs/api_docs/namespaces/ts/namespaces/server/interfaces/ProjectResponse.md b/docs/api_docs/namespaces/ts/namespaces/server/interfaces/ProjectResponse.md new file mode 100644 index 0000000000000000000000000000000000000000..c834451dce391ea4775d4b54bef25ded110f3b1c --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/server/interfaces/ProjectResponse.md @@ -0,0 +1,40 @@ +[**ArkAnalyzer**](../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../globals.md) / [ts](../../../README.md) / [server](../README.md) / ProjectResponse + +# Interface: ProjectResponse + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6059 + +## Extends + +- [`TypingInstallerResponse`](TypingInstallerResponse.md) + +## Extended by + +- [`PackageInstalledResponse`](PackageInstalledResponse.md) +- [`InvalidateCachedTypings`](InvalidateCachedTypings.md) +- [`InstallTypes`](InstallTypes.md) +- [`SetTypings`](SetTypings.md) + +## Properties + +### kind + +> `readonly` **kind**: `"action::set"` \| `"action::invalidate"` \| `"event::typesRegistry"` \| `"action::packageInstalled"` \| `"event::beginInstallTypes"` \| `"event::endInstallTypes"` \| `"event::initializationFailed"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6022 + +#### Inherited from + +[`TypingInstallerResponse`](TypingInstallerResponse.md).[`kind`](TypingInstallerResponse.md#kind) + +*** + +### projectName + +> `readonly` **projectName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6060 diff --git a/docs/api_docs/namespaces/ts/namespaces/server/interfaces/SetTypings.md b/docs/api_docs/namespaces/ts/namespaces/server/interfaces/SetTypings.md new file mode 100644 index 0000000000000000000000000000000000000000..95a499d22fd061008ec5bbac7324f891eb0e0de9 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/server/interfaces/SetTypings.md @@ -0,0 +1,69 @@ +[**ArkAnalyzer**](../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../globals.md) / [ts](../../../README.md) / [server](../README.md) / SetTypings + +# Interface: SetTypings + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6078 + +## Extends + +- [`ProjectResponse`](ProjectResponse.md) + +## Properties + +### compilerOptions + +> `readonly` **compilerOptions**: [`CompilerOptions`](../../../interfaces/CompilerOptions.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6080 + +*** + +### kind + +> `readonly` **kind**: `"action::set"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6083 + +#### Overrides + +[`ProjectResponse`](ProjectResponse.md).[`kind`](ProjectResponse.md#kind) + +*** + +### projectName + +> `readonly` **projectName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6060 + +#### Inherited from + +[`ProjectResponse`](ProjectResponse.md).[`projectName`](ProjectResponse.md#projectname) + +*** + +### typeAcquisition + +> `readonly` **typeAcquisition**: [`TypeAcquisition`](../../../interfaces/TypeAcquisition.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6079 + +*** + +### typings + +> `readonly` **typings**: `string`[] + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6081 + +*** + +### unresolvedImports + +> `readonly` **unresolvedImports**: [`SortedReadonlyArray`](../../../interfaces/SortedReadonlyArray.md)\<`string`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6082 diff --git a/docs/api_docs/namespaces/ts/namespaces/server/interfaces/TypesRegistryRequest.md b/docs/api_docs/namespaces/ts/namespaces/server/interfaces/TypesRegistryRequest.md new file mode 100644 index 0000000000000000000000000000000000000000..5f44d9b65db48c65ed77aad19b9e1b6fb8674ea6 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/server/interfaces/TypesRegistryRequest.md @@ -0,0 +1,17 @@ +[**ArkAnalyzer**](../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../globals.md) / [ts](../../../README.md) / [server](../README.md) / TypesRegistryRequest + +# Interface: TypesRegistryRequest + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6040 + +## Properties + +### kind + +> `readonly` **kind**: `"typesRegistry"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6041 diff --git a/docs/api_docs/namespaces/ts/namespaces/server/interfaces/TypingInstallerRequestWithProjectName.md b/docs/api_docs/namespaces/ts/namespaces/server/interfaces/TypingInstallerRequestWithProjectName.md new file mode 100644 index 0000000000000000000000000000000000000000..9af652a4c3c9a9b491b2a9768c201265849fced9 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/server/interfaces/TypingInstallerRequestWithProjectName.md @@ -0,0 +1,23 @@ +[**ArkAnalyzer**](../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../globals.md) / [ts](../../../README.md) / [server](../README.md) / TypingInstallerRequestWithProjectName + +# Interface: TypingInstallerRequestWithProjectName + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6024 + +## Extended by + +- [`DiscoverTypings`](DiscoverTypings.md) +- [`CloseProject`](CloseProject.md) +- [`InstallPackageRequest`](InstallPackageRequest.md) + +## Properties + +### projectName + +> `readonly` **projectName**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6025 diff --git a/docs/api_docs/namespaces/ts/namespaces/server/interfaces/TypingInstallerResponse.md b/docs/api_docs/namespaces/ts/namespaces/server/interfaces/TypingInstallerResponse.md new file mode 100644 index 0000000000000000000000000000000000000000..6f936f068cb7bf78d5b71c516e42c8ccf3b10c02 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/server/interfaces/TypingInstallerResponse.md @@ -0,0 +1,22 @@ +[**ArkAnalyzer**](../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../globals.md) / [ts](../../../README.md) / [server](../README.md) / TypingInstallerResponse + +# Interface: TypingInstallerResponse + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6021 + +## Extended by + +- [`InitializationFailedResponse`](InitializationFailedResponse.md) +- [`ProjectResponse`](ProjectResponse.md) + +## Properties + +### kind + +> `readonly` **kind**: `"action::set"` \| `"action::invalidate"` \| `"event::typesRegistry"` \| `"action::packageInstalled"` \| `"event::beginInstallTypes"` \| `"event::endInstallTypes"` \| `"event::initializationFailed"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6022 diff --git a/docs/api_docs/namespaces/ts/namespaces/server/type-aliases/ActionInvalidate.md b/docs/api_docs/namespaces/ts/namespaces/server/type-aliases/ActionInvalidate.md new file mode 100644 index 0000000000000000000000000000000000000000..2b31aef83edd728783ed816ce35b32e438edc04e --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/server/type-aliases/ActionInvalidate.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../globals.md) / [ts](../../../README.md) / [server](../README.md) / ActionInvalidate + +# Type Alias: ActionInvalidate + +> **ActionInvalidate**: `"action::invalidate"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6013 diff --git a/docs/api_docs/namespaces/ts/namespaces/server/type-aliases/ActionPackageInstalled.md b/docs/api_docs/namespaces/ts/namespaces/server/type-aliases/ActionPackageInstalled.md new file mode 100644 index 0000000000000000000000000000000000000000..ca1de6eb29cf746aced4a7778ddeb776e701e102 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/server/type-aliases/ActionPackageInstalled.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../globals.md) / [ts](../../../README.md) / [server](../README.md) / ActionPackageInstalled + +# Type Alias: ActionPackageInstalled + +> **ActionPackageInstalled**: `"action::packageInstalled"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6014 diff --git a/docs/api_docs/namespaces/ts/namespaces/server/type-aliases/ActionSet.md b/docs/api_docs/namespaces/ts/namespaces/server/type-aliases/ActionSet.md new file mode 100644 index 0000000000000000000000000000000000000000..cb7dbaf0b6f924cfcc4e5c5732369107677ef5aa --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/server/type-aliases/ActionSet.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../globals.md) / [ts](../../../README.md) / [server](../README.md) / ActionSet + +# Type Alias: ActionSet + +> **ActionSet**: `"action::set"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6012 diff --git a/docs/api_docs/namespaces/ts/namespaces/server/type-aliases/EventBeginInstallTypes.md b/docs/api_docs/namespaces/ts/namespaces/server/type-aliases/EventBeginInstallTypes.md new file mode 100644 index 0000000000000000000000000000000000000000..bceb8215b9d7493cc0d9b8afde6f2c0624790e4f --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/server/type-aliases/EventBeginInstallTypes.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../globals.md) / [ts](../../../README.md) / [server](../README.md) / EventBeginInstallTypes + +# Type Alias: EventBeginInstallTypes + +> **EventBeginInstallTypes**: `"event::beginInstallTypes"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6016 diff --git a/docs/api_docs/namespaces/ts/namespaces/server/type-aliases/EventEndInstallTypes.md b/docs/api_docs/namespaces/ts/namespaces/server/type-aliases/EventEndInstallTypes.md new file mode 100644 index 0000000000000000000000000000000000000000..53eb93f46ff7d695c155592048d881986acf452f --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/server/type-aliases/EventEndInstallTypes.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../globals.md) / [ts](../../../README.md) / [server](../README.md) / EventEndInstallTypes + +# Type Alias: EventEndInstallTypes + +> **EventEndInstallTypes**: `"event::endInstallTypes"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6017 diff --git a/docs/api_docs/namespaces/ts/namespaces/server/type-aliases/EventInitializationFailed.md b/docs/api_docs/namespaces/ts/namespaces/server/type-aliases/EventInitializationFailed.md new file mode 100644 index 0000000000000000000000000000000000000000..b5e576bd4104e3a2bd0526cb4238dc586796beb2 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/server/type-aliases/EventInitializationFailed.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../globals.md) / [ts](../../../README.md) / [server](../README.md) / EventInitializationFailed + +# Type Alias: EventInitializationFailed + +> **EventInitializationFailed**: `"event::initializationFailed"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6018 diff --git a/docs/api_docs/namespaces/ts/namespaces/server/type-aliases/EventTypesRegistry.md b/docs/api_docs/namespaces/ts/namespaces/server/type-aliases/EventTypesRegistry.md new file mode 100644 index 0000000000000000000000000000000000000000..6f7e4171cbd1e74ee88e17a86943b496e9018e29 --- /dev/null +++ b/docs/api_docs/namespaces/ts/namespaces/server/type-aliases/EventTypesRegistry.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../../../README.md) + +*** + +[ArkAnalyzer](../../../../../globals.md) / [ts](../../../README.md) / [server](../README.md) / EventTypesRegistry + +# Type Alias: EventTypesRegistry + +> **EventTypesRegistry**: `"event::typesRegistry"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6015 diff --git a/docs/api_docs/namespaces/ts/type-aliases/AbstractKeyword.md b/docs/api_docs/namespaces/ts/type-aliases/AbstractKeyword.md new file mode 100644 index 0000000000000000000000000000000000000000..4180e58aca818e9d153c431a410497d06258bf65 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/AbstractKeyword.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / AbstractKeyword + +# Type Alias: AbstractKeyword + +> **AbstractKeyword**: [`ModifierToken`](../interfaces/ModifierToken.md)\<[`AbstractKeyword`](../enumerations/SyntaxKind.md#abstractkeyword)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:646 diff --git a/docs/api_docs/namespaces/ts/type-aliases/AccessExpression.md b/docs/api_docs/namespaces/ts/type-aliases/AccessExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..ec1ca91a4caa7e80e458f11a3e523ca737949b78 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/AccessExpression.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / AccessExpression + +# Type Alias: AccessExpression + +> **AccessExpression**: [`PropertyAccessExpression`](../interfaces/PropertyAccessExpression.md) \| [`ElementAccessExpression`](../interfaces/ElementAccessExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1303 diff --git a/docs/api_docs/namespaces/ts/type-aliases/AccessibilityModifier.md b/docs/api_docs/namespaces/ts/type-aliases/AccessibilityModifier.md new file mode 100644 index 0000000000000000000000000000000000000000..992c4164dbf88167295fe005f78a4ceec7154ee5 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/AccessibilityModifier.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / AccessibilityModifier + +# Type Alias: AccessibilityModifier + +> **AccessibilityModifier**: [`PublicKeyword`](PublicKeyword.md) \| [`PrivateKeyword`](PrivateKeyword.md) \| [`ProtectedKeyword`](ProtectedKeyword.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:665 diff --git a/docs/api_docs/namespaces/ts/type-aliases/AccessorDeclaration.md b/docs/api_docs/namespaces/ts/type-aliases/AccessorDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..ceb18f5a4cfd0002da22abcf5a2000879113a5a0 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/AccessorDeclaration.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / AccessorDeclaration + +# Type Alias: AccessorDeclaration + +> **AccessorDeclaration**: [`GetAccessorDeclaration`](../interfaces/GetAccessorDeclaration.md) \| [`SetAccessorDeclaration`](../interfaces/SetAccessorDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:899 diff --git a/docs/api_docs/namespaces/ts/type-aliases/AccessorKeyword.md b/docs/api_docs/namespaces/ts/type-aliases/AccessorKeyword.md new file mode 100644 index 0000000000000000000000000000000000000000..8cfe41d6096b3e063f044b0abaf5b127047e9c12 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/AccessorKeyword.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / AccessorKeyword + +# Type Alias: AccessorKeyword + +> **AccessorKeyword**: [`ModifierToken`](../interfaces/ModifierToken.md)\<[`AccessorKeyword`](../enumerations/SyntaxKind.md#accessorkeyword)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:647 diff --git a/docs/api_docs/namespaces/ts/type-aliases/AdditiveOperator.md b/docs/api_docs/namespaces/ts/type-aliases/AdditiveOperator.md new file mode 100644 index 0000000000000000000000000000000000000000..43892056cd65a5aa6eaf6879a79166c60f70ecd1 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/AdditiveOperator.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / AdditiveOperator + +# Type Alias: AdditiveOperator + +> **AdditiveOperator**: [`PlusToken`](../enumerations/SyntaxKind.md#plustoken) \| [`MinusToken`](../enumerations/SyntaxKind.md#minustoken) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1143 diff --git a/docs/api_docs/namespaces/ts/type-aliases/AdditiveOperatorOrHigher.md b/docs/api_docs/namespaces/ts/type-aliases/AdditiveOperatorOrHigher.md new file mode 100644 index 0000000000000000000000000000000000000000..c075c37efe4afd6b0412c63a95d95abd65951185 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/AdditiveOperatorOrHigher.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / AdditiveOperatorOrHigher + +# Type Alias: AdditiveOperatorOrHigher + +> **AdditiveOperatorOrHigher**: [`MultiplicativeOperatorOrHigher`](MultiplicativeOperatorOrHigher.md) \| [`AdditiveOperator`](AdditiveOperator.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1144 diff --git a/docs/api_docs/namespaces/ts/type-aliases/AffectedFileResult.md b/docs/api_docs/namespaces/ts/type-aliases/AffectedFileResult.md new file mode 100644 index 0000000000000000000000000000000000000000..7f058f628b226eec9d0088106b52d6095961af8f --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/AffectedFileResult.md @@ -0,0 +1,15 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / AffectedFileResult + +# Type Alias: AffectedFileResult\ + +> **AffectedFileResult**\<`T`\>: \{ `affected`: [`SourceFile`](../interfaces/SourceFile.md) \| [`Program`](../interfaces/Program.md); `result`: `T`; \} \| `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5642 + +## Type Parameters + +• **T** diff --git a/docs/api_docs/namespaces/ts/type-aliases/ArrayBindingElement.md b/docs/api_docs/namespaces/ts/type-aliases/ArrayBindingElement.md new file mode 100644 index 0000000000000000000000000000000000000000..fc75f24f3d49deebe7f6c5cab902b2239fc5a573 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/ArrayBindingElement.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ArrayBindingElement + +# Type Alias: ArrayBindingElement + +> **ArrayBindingElement**: [`BindingElement`](../interfaces/BindingElement.md) \| [`OmittedExpression`](../interfaces/OmittedExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:836 diff --git a/docs/api_docs/namespaces/ts/type-aliases/ArrayBindingOrAssignmentElement.md b/docs/api_docs/namespaces/ts/type-aliases/ArrayBindingOrAssignmentElement.md new file mode 100644 index 0000000000000000000000000000000000000000..d5950821e564295bf35828a3774419f3e11c592f --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/ArrayBindingOrAssignmentElement.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ArrayBindingOrAssignmentElement + +# Type Alias: ArrayBindingOrAssignmentElement + +> **ArrayBindingOrAssignmentElement**: [`BindingElement`](../interfaces/BindingElement.md) \| [`OmittedExpression`](../interfaces/OmittedExpression.md) \| [`SpreadElement`](../interfaces/SpreadElement.md) \| [`ArrayLiteralExpression`](../interfaces/ArrayLiteralExpression.md) \| [`ObjectLiteralExpression`](../interfaces/ObjectLiteralExpression.md) \| [`AssignmentExpression`](../interfaces/AssignmentExpression.md)\<[`EqualsToken`](EqualsToken.md)\> \| [`Identifier`](../interfaces/Identifier.md) \| [`PropertyAccessExpression`](../interfaces/PropertyAccessExpression.md) \| [`ElementAccessExpression`](../interfaces/ElementAccessExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1181 diff --git a/docs/api_docs/namespaces/ts/type-aliases/ArrayBindingOrAssignmentPattern.md b/docs/api_docs/namespaces/ts/type-aliases/ArrayBindingOrAssignmentPattern.md new file mode 100644 index 0000000000000000000000000000000000000000..cc48d1444f3e3365985f35affbf991382e52bf93 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/ArrayBindingOrAssignmentPattern.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ArrayBindingOrAssignmentPattern + +# Type Alias: ArrayBindingOrAssignmentPattern + +> **ArrayBindingOrAssignmentPattern**: [`ArrayBindingPattern`](../interfaces/ArrayBindingPattern.md) \| [`ArrayLiteralExpression`](../interfaces/ArrayLiteralExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1185 diff --git a/docs/api_docs/namespaces/ts/type-aliases/AssertKeyword.md b/docs/api_docs/namespaces/ts/type-aliases/AssertKeyword.md new file mode 100644 index 0000000000000000000000000000000000000000..b1b073b800e552cd8cba02e040d6a4b610d1e243 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/AssertKeyword.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / AssertKeyword + +# Type Alias: AssertKeyword + +> **AssertKeyword**: [`KeywordToken`](../interfaces/KeywordToken.md)\<[`AssertKeyword`](../enumerations/SyntaxKind.md#assertkeyword)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:638 diff --git a/docs/api_docs/namespaces/ts/type-aliases/AssertionExpression.md b/docs/api_docs/namespaces/ts/type-aliases/AssertionExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..cf4b5b545a207772f8e920241e6fc31309d6ac12 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/AssertionExpression.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / AssertionExpression + +# Type Alias: AssertionExpression + +> **AssertionExpression**: [`TypeAssertion`](../interfaces/TypeAssertion.md) \| [`AsExpression`](../interfaces/AsExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1385 diff --git a/docs/api_docs/namespaces/ts/type-aliases/AssertionKey.md b/docs/api_docs/namespaces/ts/type-aliases/AssertionKey.md new file mode 100644 index 0000000000000000000000000000000000000000..12ce3029d9d558deceb939655b5df270cc6bd2d0 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/AssertionKey.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / AssertionKey + +# Type Alias: AssertionKey + +> **AssertionKey**: [`Identifier`](../interfaces/Identifier.md) \| [`StringLiteral`](../interfaces/StringLiteral.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1736 diff --git a/docs/api_docs/namespaces/ts/type-aliases/AssertsKeyword.md b/docs/api_docs/namespaces/ts/type-aliases/AssertsKeyword.md new file mode 100644 index 0000000000000000000000000000000000000000..09c1e4aaa1e36485223a1974b3442ec25398e760 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/AssertsKeyword.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / AssertsKeyword + +# Type Alias: AssertsKeyword + +> **AssertsKeyword**: [`KeywordToken`](../interfaces/KeywordToken.md)\<[`AssertsKeyword`](../enumerations/SyntaxKind.md#assertskeyword)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:637 diff --git a/docs/api_docs/namespaces/ts/type-aliases/AssertsToken.md b/docs/api_docs/namespaces/ts/type-aliases/AssertsToken.md new file mode 100644 index 0000000000000000000000000000000000000000..3d0073d0b2a3b913329f36bddd0662b5a0e626d3 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/AssertsToken.md @@ -0,0 +1,15 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / AssertsToken + +# Type Alias: ~~AssertsToken~~ + +> **AssertsToken**: [`AssertsKeyword`](AssertsKeyword.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:643 + +## Deprecated + +Use `AssertsKeyword` instead. diff --git a/docs/api_docs/namespaces/ts/type-aliases/AssignmentOperator.md b/docs/api_docs/namespaces/ts/type-aliases/AssignmentOperator.md new file mode 100644 index 0000000000000000000000000000000000000000..3642455d0a493901b466ce76620b725ccba973bb --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/AssignmentOperator.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / AssignmentOperator + +# Type Alias: AssignmentOperator + +> **AssignmentOperator**: [`EqualsToken`](../enumerations/SyntaxKind.md#equalstoken) \| [`CompoundAssignmentOperator`](CompoundAssignmentOperator.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1156 diff --git a/docs/api_docs/namespaces/ts/type-aliases/AssignmentOperatorOrHigher.md b/docs/api_docs/namespaces/ts/type-aliases/AssignmentOperatorOrHigher.md new file mode 100644 index 0000000000000000000000000000000000000000..1248f039bfa431b6994831a6c7b12975b94d355d --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/AssignmentOperatorOrHigher.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / AssignmentOperatorOrHigher + +# Type Alias: AssignmentOperatorOrHigher + +> **AssignmentOperatorOrHigher**: [`QuestionQuestionToken`](../enumerations/SyntaxKind.md#questionquestiontoken) \| [`LogicalOperatorOrHigher`](LogicalOperatorOrHigher.md) \| [`AssignmentOperator`](AssignmentOperator.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1157 diff --git a/docs/api_docs/namespaces/ts/type-aliases/AssignmentOperatorToken.md b/docs/api_docs/namespaces/ts/type-aliases/AssignmentOperatorToken.md new file mode 100644 index 0000000000000000000000000000000000000000..d821f9f53b463f7e96316c3c17afdfb47b12dad1 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/AssignmentOperatorToken.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / AssignmentOperatorToken + +# Type Alias: AssignmentOperatorToken + +> **AssignmentOperatorToken**: [`Token`](../interfaces/Token.md)\<[`AssignmentOperator`](AssignmentOperator.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1167 diff --git a/docs/api_docs/namespaces/ts/type-aliases/AssignmentPattern.md b/docs/api_docs/namespaces/ts/type-aliases/AssignmentPattern.md new file mode 100644 index 0000000000000000000000000000000000000000..5a858f98007e68c6366fad26407ebb2f16835c70 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/AssignmentPattern.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / AssignmentPattern + +# Type Alias: AssignmentPattern + +> **AssignmentPattern**: [`ObjectLiteralExpression`](../interfaces/ObjectLiteralExpression.md) \| [`ArrayLiteralExpression`](../interfaces/ArrayLiteralExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1186 diff --git a/docs/api_docs/namespaces/ts/type-aliases/AsteriskToken.md b/docs/api_docs/namespaces/ts/type-aliases/AsteriskToken.md new file mode 100644 index 0000000000000000000000000000000000000000..d720b3f1f5a532a4694c653ec0dc5c95f43b8d80 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/AsteriskToken.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / AsteriskToken + +# Type Alias: AsteriskToken + +> **AsteriskToken**: [`PunctuationToken`](../interfaces/PunctuationToken.md)\<[`AsteriskToken`](../enumerations/SyntaxKind.md#asterisktoken)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:630 diff --git a/docs/api_docs/namespaces/ts/type-aliases/AsyncKeyword.md b/docs/api_docs/namespaces/ts/type-aliases/AsyncKeyword.md new file mode 100644 index 0000000000000000000000000000000000000000..68e0675db528ad0f556bea8350ff832b24b7a860 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/AsyncKeyword.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / AsyncKeyword + +# Type Alias: AsyncKeyword + +> **AsyncKeyword**: [`ModifierToken`](../interfaces/ModifierToken.md)\<[`AsyncKeyword`](../enumerations/SyntaxKind.md#asynckeyword)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:648 diff --git a/docs/api_docs/namespaces/ts/type-aliases/AwaitKeyword.md b/docs/api_docs/namespaces/ts/type-aliases/AwaitKeyword.md new file mode 100644 index 0000000000000000000000000000000000000000..4ea81d946b758e3559b5c8e4fc3b44be049ec404 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/AwaitKeyword.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / AwaitKeyword + +# Type Alias: AwaitKeyword + +> **AwaitKeyword**: [`KeywordToken`](../interfaces/KeywordToken.md)\<[`AwaitKeyword`](../enumerations/SyntaxKind.md#awaitkeyword)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:639 diff --git a/docs/api_docs/namespaces/ts/type-aliases/AwaitKeywordToken.md b/docs/api_docs/namespaces/ts/type-aliases/AwaitKeywordToken.md new file mode 100644 index 0000000000000000000000000000000000000000..473cd5f45591889d082fc7d1376192401f272ac5 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/AwaitKeywordToken.md @@ -0,0 +1,15 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / AwaitKeywordToken + +# Type Alias: ~~AwaitKeywordToken~~ + +> **AwaitKeywordToken**: [`AwaitKeyword`](AwaitKeyword.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:641 + +## Deprecated + +Use `AwaitKeyword` instead. diff --git a/docs/api_docs/namespaces/ts/type-aliases/BaseType.md b/docs/api_docs/namespaces/ts/type-aliases/BaseType.md new file mode 100644 index 0000000000000000000000000000000000000000..bad6b84053a812cdfc36c863deb5b337899b7546 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/BaseType.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / BaseType + +# Type Alias: BaseType + +> **BaseType**: [`ObjectType`](../interfaces/ObjectType.md) \| [`IntersectionType`](../interfaces/IntersectionType.md) \| [`TypeVariable`](TypeVariable.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2827 diff --git a/docs/api_docs/namespaces/ts/type-aliases/BinaryOperator.md b/docs/api_docs/namespaces/ts/type-aliases/BinaryOperator.md new file mode 100644 index 0000000000000000000000000000000000000000..76be8a5b68903e74a717e7de61df7f873f098443 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/BinaryOperator.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / BinaryOperator + +# Type Alias: BinaryOperator + +> **BinaryOperator**: [`AssignmentOperatorOrHigher`](AssignmentOperatorOrHigher.md) \| [`CommaToken`](../enumerations/SyntaxKind.md#commatoken) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1158 diff --git a/docs/api_docs/namespaces/ts/type-aliases/BinaryOperatorToken.md b/docs/api_docs/namespaces/ts/type-aliases/BinaryOperatorToken.md new file mode 100644 index 0000000000000000000000000000000000000000..0a474a2128e793a574f0a461f74d7f6cea574fbc --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/BinaryOperatorToken.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / BinaryOperatorToken + +# Type Alias: BinaryOperatorToken + +> **BinaryOperatorToken**: [`Token`](../interfaces/Token.md)\<[`BinaryOperator`](BinaryOperator.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1160 diff --git a/docs/api_docs/namespaces/ts/type-aliases/BindingName.md b/docs/api_docs/namespaces/ts/type-aliases/BindingName.md new file mode 100644 index 0000000000000000000000000000000000000000..d3414bc9d14935cf7b0251eb779d0f825d925f3d --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/BindingName.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / BindingName + +# Type Alias: BindingName + +> **BindingName**: [`Identifier`](../interfaces/Identifier.md) \| [`BindingPattern`](BindingPattern.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:745 diff --git a/docs/api_docs/namespaces/ts/type-aliases/BindingOrAssignmentElement.md b/docs/api_docs/namespaces/ts/type-aliases/BindingOrAssignmentElement.md new file mode 100644 index 0000000000000000000000000000000000000000..67f9bb03cb206d51441132a980d31ccf6ddb1aad --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/BindingOrAssignmentElement.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / BindingOrAssignmentElement + +# Type Alias: BindingOrAssignmentElement + +> **BindingOrAssignmentElement**: [`VariableDeclaration`](../interfaces/VariableDeclaration.md) \| [`ParameterDeclaration`](../interfaces/ParameterDeclaration.md) \| [`ObjectBindingOrAssignmentElement`](ObjectBindingOrAssignmentElement.md) \| [`ArrayBindingOrAssignmentElement`](ArrayBindingOrAssignmentElement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1179 diff --git a/docs/api_docs/namespaces/ts/type-aliases/BindingOrAssignmentElementRestIndicator.md b/docs/api_docs/namespaces/ts/type-aliases/BindingOrAssignmentElementRestIndicator.md new file mode 100644 index 0000000000000000000000000000000000000000..774f85e582d49f01a314f414c975c3515098ead1 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/BindingOrAssignmentElementRestIndicator.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / BindingOrAssignmentElementRestIndicator + +# Type Alias: BindingOrAssignmentElementRestIndicator + +> **BindingOrAssignmentElementRestIndicator**: [`DotDotDotToken`](DotDotDotToken.md) \| [`SpreadElement`](../interfaces/SpreadElement.md) \| [`SpreadAssignment`](../interfaces/SpreadAssignment.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1182 diff --git a/docs/api_docs/namespaces/ts/type-aliases/BindingOrAssignmentElementTarget.md b/docs/api_docs/namespaces/ts/type-aliases/BindingOrAssignmentElementTarget.md new file mode 100644 index 0000000000000000000000000000000000000000..0e3b6388bc576fee1760cd0cfdd1b0dffb66e510 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/BindingOrAssignmentElementTarget.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / BindingOrAssignmentElementTarget + +# Type Alias: BindingOrAssignmentElementTarget + +> **BindingOrAssignmentElementTarget**: [`BindingOrAssignmentPattern`](BindingOrAssignmentPattern.md) \| [`Identifier`](../interfaces/Identifier.md) \| [`PropertyAccessExpression`](../interfaces/PropertyAccessExpression.md) \| [`ElementAccessExpression`](../interfaces/ElementAccessExpression.md) \| [`OmittedExpression`](../interfaces/OmittedExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1183 diff --git a/docs/api_docs/namespaces/ts/type-aliases/BindingOrAssignmentPattern.md b/docs/api_docs/namespaces/ts/type-aliases/BindingOrAssignmentPattern.md new file mode 100644 index 0000000000000000000000000000000000000000..1d6773bff864c52162e9351e559b0a11a1136cc5 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/BindingOrAssignmentPattern.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / BindingOrAssignmentPattern + +# Type Alias: BindingOrAssignmentPattern + +> **BindingOrAssignmentPattern**: [`ObjectBindingOrAssignmentPattern`](ObjectBindingOrAssignmentPattern.md) \| [`ArrayBindingOrAssignmentPattern`](ArrayBindingOrAssignmentPattern.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1187 diff --git a/docs/api_docs/namespaces/ts/type-aliases/BindingPattern.md b/docs/api_docs/namespaces/ts/type-aliases/BindingPattern.md new file mode 100644 index 0000000000000000000000000000000000000000..3a81e5331000f10a9b0f1b52e30ddef062cdcc4c --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/BindingPattern.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / BindingPattern + +# Type Alias: BindingPattern + +> **BindingPattern**: [`ObjectBindingPattern`](../interfaces/ObjectBindingPattern.md) \| [`ArrayBindingPattern`](../interfaces/ArrayBindingPattern.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:835 diff --git a/docs/api_docs/namespaces/ts/type-aliases/BitwiseOperator.md b/docs/api_docs/namespaces/ts/type-aliases/BitwiseOperator.md new file mode 100644 index 0000000000000000000000000000000000000000..54254ffae9a1fd5e19b6358441b061dbeaa37131 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/BitwiseOperator.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / BitwiseOperator + +# Type Alias: BitwiseOperator + +> **BitwiseOperator**: [`AmpersandToken`](../enumerations/SyntaxKind.md#ampersandtoken) \| [`BarToken`](../enumerations/SyntaxKind.md#bartoken) \| [`CaretToken`](../enumerations/SyntaxKind.md#carettoken) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1151 diff --git a/docs/api_docs/namespaces/ts/type-aliases/BitwiseOperatorOrHigher.md b/docs/api_docs/namespaces/ts/type-aliases/BitwiseOperatorOrHigher.md new file mode 100644 index 0000000000000000000000000000000000000000..ab5a4442f4c03f8a672de35b3f282bed62b940f9 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/BitwiseOperatorOrHigher.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / BitwiseOperatorOrHigher + +# Type Alias: BitwiseOperatorOrHigher + +> **BitwiseOperatorOrHigher**: [`EqualityOperatorOrHigher`](EqualityOperatorOrHigher.md) \| [`BitwiseOperator`](BitwiseOperator.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1152 diff --git a/docs/api_docs/namespaces/ts/type-aliases/BlockLike.md b/docs/api_docs/namespaces/ts/type-aliases/BlockLike.md new file mode 100644 index 0000000000000000000000000000000000000000..49343324ba06a8a3b1633432e67f355784e6ec88 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/BlockLike.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / BlockLike + +# Type Alias: BlockLike + +> **BlockLike**: [`SourceFile`](../interfaces/SourceFile.md) \| [`Block`](../interfaces/Block.md) \| [`ModuleBlock`](../interfaces/ModuleBlock.md) \| [`CaseOrDefaultClause`](CaseOrDefaultClause.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1493 diff --git a/docs/api_docs/namespaces/ts/type-aliases/BooleanLiteral.md b/docs/api_docs/namespaces/ts/type-aliases/BooleanLiteral.md new file mode 100644 index 0000000000000000000000000000000000000000..bbfd7cba45fd1fbc097aadb69d96d2908cd9098e --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/BooleanLiteral.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / BooleanLiteral + +# Type Alias: BooleanLiteral + +> **BooleanLiteral**: [`TrueLiteral`](../interfaces/TrueLiteral.md) \| [`FalseLiteral`](../interfaces/FalseLiteral.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1103 diff --git a/docs/api_docs/namespaces/ts/type-aliases/BreakOrContinueStatement.md b/docs/api_docs/namespaces/ts/type-aliases/BreakOrContinueStatement.md new file mode 100644 index 0000000000000000000000000000000000000000..6b755f743c812bb6ce03ae295b9c604f9636452b --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/BreakOrContinueStatement.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / BreakOrContinueStatement + +# Type Alias: BreakOrContinueStatement + +> **BreakOrContinueStatement**: [`BreakStatement`](../interfaces/BreakStatement.md) \| [`ContinueStatement`](../interfaces/ContinueStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1551 diff --git a/docs/api_docs/namespaces/ts/type-aliases/CallLikeExpression.md b/docs/api_docs/namespaces/ts/type-aliases/CallLikeExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..e59b3e15a6dc2a65bf939656a180d129afa1967a --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/CallLikeExpression.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / CallLikeExpression + +# Type Alias: CallLikeExpression + +> **CallLikeExpression**: [`CallExpression`](../interfaces/CallExpression.md) \| [`NewExpression`](../interfaces/NewExpression.md) \| [`TaggedTemplateExpression`](../interfaces/TaggedTemplateExpression.md) \| [`Decorator`](../interfaces/Decorator.md) \| [`JsxOpeningLikeElement`](JsxOpeningLikeElement.md) \| [`EtsComponentExpression`](../interfaces/EtsComponentExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1369 diff --git a/docs/api_docs/namespaces/ts/type-aliases/CaseOrDefaultClause.md b/docs/api_docs/namespaces/ts/type-aliases/CaseOrDefaultClause.md new file mode 100644 index 0000000000000000000000000000000000000000..e8f0fdea1f1c01fb4fcf22cbead0eca6f5fddb1a --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/CaseOrDefaultClause.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / CaseOrDefaultClause + +# Type Alias: CaseOrDefaultClause + +> **CaseOrDefaultClause**: [`CaseClause`](../interfaces/CaseClause.md) \| [`DefaultClause`](../interfaces/DefaultClause.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1583 diff --git a/docs/api_docs/namespaces/ts/type-aliases/ClassLikeDeclaration.md b/docs/api_docs/namespaces/ts/type-aliases/ClassLikeDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..2d9155e1acd17448775229e04e2fe6273b180b72 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/ClassLikeDeclaration.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ClassLikeDeclaration + +# Type Alias: ClassLikeDeclaration + +> **ClassLikeDeclaration**: [`ClassDeclaration`](../interfaces/ClassDeclaration.md) \| [`ClassExpression`](../interfaces/ClassExpression.md) \| [`StructDeclaration`](../interfaces/StructDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1631 diff --git a/docs/api_docs/namespaces/ts/type-aliases/ClassMemberModifier.md b/docs/api_docs/namespaces/ts/type-aliases/ClassMemberModifier.md new file mode 100644 index 0000000000000000000000000000000000000000..2545ca0d5e4403890d2f6e36e7476689f5c8b84b --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/ClassMemberModifier.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ClassMemberModifier + +# Type Alias: ClassMemberModifier + +> **ClassMemberModifier**: [`AccessibilityModifier`](AccessibilityModifier.md) \| [`ReadonlyKeyword`](ReadonlyKeyword.md) \| [`StaticKeyword`](StaticKeyword.md) \| [`AccessorKeyword`](AccessorKeyword.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:667 diff --git a/docs/api_docs/namespaces/ts/type-aliases/CodeActionCommand.md b/docs/api_docs/namespaces/ts/type-aliases/CodeActionCommand.md new file mode 100644 index 0000000000000000000000000000000000000000..9896bc98c1bd19a39616393729ff91ed690e6312 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/CodeActionCommand.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / CodeActionCommand + +# Type Alias: CodeActionCommand + +> **CodeActionCommand**: [`InstallPackageAction`](../interfaces/InstallPackageAction.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6633 diff --git a/docs/api_docs/namespaces/ts/type-aliases/ColonToken.md b/docs/api_docs/namespaces/ts/type-aliases/ColonToken.md new file mode 100644 index 0000000000000000000000000000000000000000..c4f60a4fe719da235722de290c7bcc6c17a33a68 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/ColonToken.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ColonToken + +# Type Alias: ColonToken + +> **ColonToken**: [`PunctuationToken`](../interfaces/PunctuationToken.md)\<[`ColonToken`](../enumerations/SyntaxKind.md#colontoken)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:628 diff --git a/docs/api_docs/namespaces/ts/type-aliases/CommentKind.md b/docs/api_docs/namespaces/ts/type-aliases/CommentKind.md new file mode 100644 index 0000000000000000000000000000000000000000..2d26c6025922d8f70ed7e99cc552b813ef6dff48 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/CommentKind.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / CommentKind + +# Type Alias: CommentKind + +> **CommentKind**: [`SingleLineCommentTrivia`](../enumerations/SyntaxKind.md#singlelinecommenttrivia) \| [`MultiLineCommentTrivia`](../enumerations/SyntaxKind.md#multilinecommenttrivia) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1845 diff --git a/docs/api_docs/namespaces/ts/type-aliases/CompilerOptionsValue.md b/docs/api_docs/namespaces/ts/type-aliases/CompilerOptionsValue.md new file mode 100644 index 0000000000000000000000000000000000000000..352277354952b9b2a3a250ef5807b0a66d968d8a --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/CompilerOptionsValue.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / CompilerOptionsValue + +# Type Alias: CompilerOptionsValue + +> **CompilerOptionsValue**: `string` \| `number` \| `boolean` \| (`string` \| `number`)[] \| `string`[] \| [`MapLike`](../interfaces/MapLike.md)\<`string`[]\> \| [`PluginImport`](../interfaces/PluginImport.md)[] \| [`ProjectReference`](../interfaces/ProjectReference.md)[] \| `null` \| `undefined` \| [`EtsOptions`](../interfaces/EtsOptions.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3073 diff --git a/docs/api_docs/namespaces/ts/type-aliases/CompletionEntryData.md b/docs/api_docs/namespaces/ts/type-aliases/CompletionEntryData.md new file mode 100644 index 0000000000000000000000000000000000000000..d371a027d44c2a835a1b26eecf17b43211fcc809 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/CompletionEntryData.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / CompletionEntryData + +# Type Alias: CompletionEntryData + +> **CompletionEntryData**: [`CompletionEntryDataUnresolved`](../interfaces/CompletionEntryDataUnresolved.md) \| [`CompletionEntryDataResolved`](../interfaces/CompletionEntryDataResolved.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7005 diff --git a/docs/api_docs/namespaces/ts/type-aliases/CompletionsTriggerCharacter.md b/docs/api_docs/namespaces/ts/type-aliases/CompletionsTriggerCharacter.md new file mode 100644 index 0000000000000000000000000000000000000000..8d890a1a6a21327cc81df6d70fa6ffc0bea477c5 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/CompletionsTriggerCharacter.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / CompletionsTriggerCharacter + +# Type Alias: CompletionsTriggerCharacter + +> **CompletionsTriggerCharacter**: `"."` \| "\"" \| `"'"` \| `` "`" `` \| `"/"` \| `"@"` \| `"<"` \| `"#"` \| `" "` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6452 diff --git a/docs/api_docs/namespaces/ts/type-aliases/CompoundAssignmentOperator.md b/docs/api_docs/namespaces/ts/type-aliases/CompoundAssignmentOperator.md new file mode 100644 index 0000000000000000000000000000000000000000..10e930ca84d90313222d79494224e508c9649730 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/CompoundAssignmentOperator.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / CompoundAssignmentOperator + +# Type Alias: CompoundAssignmentOperator + +> **CompoundAssignmentOperator**: [`PlusEqualsToken`](../enumerations/SyntaxKind.md#plusequalstoken) \| [`MinusEqualsToken`](../enumerations/SyntaxKind.md#minusequalstoken) \| [`AsteriskAsteriskEqualsToken`](../enumerations/SyntaxKind.md#asteriskasteriskequalstoken) \| [`AsteriskEqualsToken`](../enumerations/SyntaxKind.md#asteriskequalstoken) \| [`SlashEqualsToken`](../enumerations/SyntaxKind.md#slashequalstoken) \| [`PercentEqualsToken`](../enumerations/SyntaxKind.md#percentequalstoken) \| [`AmpersandEqualsToken`](../enumerations/SyntaxKind.md#ampersandequalstoken) \| [`BarEqualsToken`](../enumerations/SyntaxKind.md#barequalstoken) \| [`CaretEqualsToken`](../enumerations/SyntaxKind.md#caretequalstoken) \| [`LessThanLessThanEqualsToken`](../enumerations/SyntaxKind.md#lessthanlessthanequalstoken) \| [`GreaterThanGreaterThanGreaterThanEqualsToken`](../enumerations/SyntaxKind.md#greaterthangreaterthangreaterthanequalstoken) \| [`GreaterThanGreaterThanEqualsToken`](../enumerations/SyntaxKind.md#greaterthangreaterthanequalstoken) \| [`BarBarEqualsToken`](../enumerations/SyntaxKind.md#barbarequalstoken) \| [`AmpersandAmpersandEqualsToken`](../enumerations/SyntaxKind.md#ampersandampersandequalstoken) \| [`QuestionQuestionEqualsToken`](../enumerations/SyntaxKind.md#questionquestionequalstoken) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1155 diff --git a/docs/api_docs/namespaces/ts/type-aliases/ConciseBody.md b/docs/api_docs/namespaces/ts/type-aliases/ConciseBody.md new file mode 100644 index 0000000000000000000000000000000000000000..757b05c95097b76cc412313775a9a9d81b8f11a7 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/ConciseBody.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ConciseBody + +# Type Alias: ConciseBody + +> **ConciseBody**: [`FunctionBody`](FunctionBody.md) \| [`Expression`](../interfaces/Expression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1197 diff --git a/docs/api_docs/namespaces/ts/type-aliases/ConstKeyword.md b/docs/api_docs/namespaces/ts/type-aliases/ConstKeyword.md new file mode 100644 index 0000000000000000000000000000000000000000..7de73046f8b4812e28a38e110256006461c8da30 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/ConstKeyword.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ConstKeyword + +# Type Alias: ConstKeyword + +> **ConstKeyword**: [`ModifierToken`](../interfaces/ModifierToken.md)\<[`ConstKeyword`](../enumerations/SyntaxKind.md#constkeyword)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:649 diff --git a/docs/api_docs/namespaces/ts/type-aliases/CreateProgram.md b/docs/api_docs/namespaces/ts/type-aliases/CreateProgram.md new file mode 100644 index 0000000000000000000000000000000000000000..25a4c875c89ba43c79010a7702c24677d750e604 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/CreateProgram.md @@ -0,0 +1,47 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / CreateProgram + +# Type Alias: CreateProgram()\ + +> **CreateProgram**\<`T`\>: (`rootNames`, `options`, `host`?, `oldProgram`?, `configFileParsingDiagnostics`?, `projectReferences`?) => `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5794 + +Create the program with rootNames and options, if they are undefined, oldProgram and new configFile diagnostics create new program + +## Type Parameters + +• **T** *extends* [`BuilderProgram`](../interfaces/BuilderProgram.md) + +## Parameters + +### rootNames + +readonly `string`[] | `undefined` + +### options + +[`CompilerOptions`](../interfaces/CompilerOptions.md) | `undefined` + +### host? + +[`CompilerHost`](../interfaces/CompilerHost.md) + +### oldProgram? + +`T` + +### configFileParsingDiagnostics? + +readonly [`Diagnostic`](../interfaces/Diagnostic.md)[] + +### projectReferences? + +readonly [`ProjectReference`](../interfaces/ProjectReference.md)[] + +## Returns + +`T` diff --git a/docs/api_docs/namespaces/ts/type-aliases/CustomTransformerFactory.md b/docs/api_docs/namespaces/ts/type-aliases/CustomTransformerFactory.md new file mode 100644 index 0000000000000000000000000000000000000000..815c39bb6b71eb871eae6e41bcaedbd9609a2b35 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/CustomTransformerFactory.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / CustomTransformerFactory + +# Type Alias: CustomTransformerFactory() + +> **CustomTransformerFactory**: (`context`) => [`CustomTransformer`](../interfaces/CustomTransformer.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2341 + +## Parameters + +### context + +[`TransformationContext`](../interfaces/TransformationContext.md) + +## Returns + +[`CustomTransformer`](../interfaces/CustomTransformer.md) diff --git a/docs/api_docs/namespaces/ts/type-aliases/DeclarationName.md b/docs/api_docs/namespaces/ts/type-aliases/DeclarationName.md new file mode 100644 index 0000000000000000000000000000000000000000..d2eee05f19d0ade918a43d826188d44d6aab84c0 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/DeclarationName.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / DeclarationName + +# Type Alias: DeclarationName + +> **DeclarationName**: [`Identifier`](../interfaces/Identifier.md) \| [`PrivateIdentifier`](../interfaces/PrivateIdentifier.md) \| [`StringLiteralLike`](StringLiteralLike.md) \| [`NumericLiteral`](../interfaces/NumericLiteral.md) \| [`ComputedPropertyName`](../interfaces/ComputedPropertyName.md) \| [`ElementAccessExpression`](../interfaces/ElementAccessExpression.md) \| [`BindingPattern`](BindingPattern.md) \| [`EntityNameExpression`](EntityNameExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:697 diff --git a/docs/api_docs/namespaces/ts/type-aliases/DeclarationWithTypeParameterChildren.md b/docs/api_docs/namespaces/ts/type-aliases/DeclarationWithTypeParameterChildren.md new file mode 100644 index 0000000000000000000000000000000000000000..d0052ac3597eaa313e28c3452e4e1c1cd0413b74 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/DeclarationWithTypeParameterChildren.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / DeclarationWithTypeParameterChildren + +# Type Alias: DeclarationWithTypeParameterChildren + +> **DeclarationWithTypeParameterChildren**: [`SignatureDeclaration`](SignatureDeclaration.md) \| [`ClassLikeDeclaration`](ClassLikeDeclaration.md) \| [`InterfaceDeclaration`](../interfaces/InterfaceDeclaration.md) \| [`TypeAliasDeclaration`](../interfaces/TypeAliasDeclaration.md) \| [`JSDocTemplateTag`](../interfaces/JSDocTemplateTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1607 diff --git a/docs/api_docs/namespaces/ts/type-aliases/DeclarationWithTypeParameters.md b/docs/api_docs/namespaces/ts/type-aliases/DeclarationWithTypeParameters.md new file mode 100644 index 0000000000000000000000000000000000000000..11e7cd6e1db8bed3d920b7e052fdd31023498363 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/DeclarationWithTypeParameters.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / DeclarationWithTypeParameters + +# Type Alias: DeclarationWithTypeParameters + +> **DeclarationWithTypeParameters**: [`DeclarationWithTypeParameterChildren`](DeclarationWithTypeParameterChildren.md) \| [`JSDocTypedefTag`](../interfaces/JSDocTypedefTag.md) \| [`JSDocCallbackTag`](../interfaces/JSDocCallbackTag.md) \| [`JSDocSignature`](../interfaces/JSDocSignature.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1606 diff --git a/docs/api_docs/namespaces/ts/type-aliases/DeclareKeyword.md b/docs/api_docs/namespaces/ts/type-aliases/DeclareKeyword.md new file mode 100644 index 0000000000000000000000000000000000000000..6dc31a8326c00d7165920bc2a2bea9d91b9585ed --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/DeclareKeyword.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / DeclareKeyword + +# Type Alias: DeclareKeyword + +> **DeclareKeyword**: [`ModifierToken`](../interfaces/ModifierToken.md)\<[`DeclareKeyword`](../enumerations/SyntaxKind.md#declarekeyword)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:650 diff --git a/docs/api_docs/namespaces/ts/type-aliases/DefaultKeyword.md b/docs/api_docs/namespaces/ts/type-aliases/DefaultKeyword.md new file mode 100644 index 0000000000000000000000000000000000000000..a31e57b7aa3f7f415b407ecae56251f088cf6e3c --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/DefaultKeyword.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / DefaultKeyword + +# Type Alias: DefaultKeyword + +> **DefaultKeyword**: [`ModifierToken`](../interfaces/ModifierToken.md)\<[`DefaultKeyword`](../enumerations/SyntaxKind.md#defaultkeyword)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:651 diff --git a/docs/api_docs/namespaces/ts/type-aliases/DestructuringAssignment.md b/docs/api_docs/namespaces/ts/type-aliases/DestructuringAssignment.md new file mode 100644 index 0000000000000000000000000000000000000000..5b2dc4d13ca897853ab73b9a5cc807d8c09ecf8e --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/DestructuringAssignment.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / DestructuringAssignment + +# Type Alias: DestructuringAssignment + +> **DestructuringAssignment**: [`ObjectDestructuringAssignment`](../interfaces/ObjectDestructuringAssignment.md) \| [`ArrayDestructuringAssignment`](../interfaces/ArrayDestructuringAssignment.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1178 diff --git a/docs/api_docs/namespaces/ts/type-aliases/DestructuringPattern.md b/docs/api_docs/namespaces/ts/type-aliases/DestructuringPattern.md new file mode 100644 index 0000000000000000000000000000000000000000..c94f73dae9fc5457ecef920267ad163d4d3a6062 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/DestructuringPattern.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / DestructuringPattern + +# Type Alias: DestructuringPattern + +> **DestructuringPattern**: [`BindingPattern`](BindingPattern.md) \| [`ObjectLiteralExpression`](../interfaces/ObjectLiteralExpression.md) \| [`ArrayLiteralExpression`](../interfaces/ArrayLiteralExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2768 diff --git a/docs/api_docs/namespaces/ts/type-aliases/DiagnosticReporter.md b/docs/api_docs/namespaces/ts/type-aliases/DiagnosticReporter.md new file mode 100644 index 0000000000000000000000000000000000000000..e3c12e724059280b933425f6b8ba92bf3bc33646 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/DiagnosticReporter.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / DiagnosticReporter + +# Type Alias: DiagnosticReporter() + +> **DiagnosticReporter**: (`diagnostic`) => `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5259 + +## Parameters + +### diagnostic + +[`Diagnostic`](../interfaces/Diagnostic.md) + +## Returns + +`void` diff --git a/docs/api_docs/namespaces/ts/type-aliases/DirectoryWatcherCallback.md b/docs/api_docs/namespaces/ts/type-aliases/DirectoryWatcherCallback.md new file mode 100644 index 0000000000000000000000000000000000000000..56d644d8547c0719f31ed3d6e70f1b05a49e0ab8 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/DirectoryWatcherCallback.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / DirectoryWatcherCallback + +# Type Alias: DirectoryWatcherCallback() + +> **DirectoryWatcherCallback**: (`fileName`) => `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4522 + +## Parameters + +### fileName + +`string` + +## Returns + +`void` diff --git a/docs/api_docs/namespaces/ts/type-aliases/DocumentRegistryBucketKey.md b/docs/api_docs/namespaces/ts/type-aliases/DocumentRegistryBucketKey.md new file mode 100644 index 0000000000000000000000000000000000000000..d2e1c86a2b0851719bb74ddf8f36f1a130d81951 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/DocumentRegistryBucketKey.md @@ -0,0 +1,17 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / DocumentRegistryBucketKey + +# Type Alias: DocumentRegistryBucketKey + +> **DocumentRegistryBucketKey**: `string` & `object` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7405 + +## Type declaration + +### \_\_bucketKey + +> **\_\_bucketKey**: `any` diff --git a/docs/api_docs/namespaces/ts/type-aliases/DotDotDotToken.md b/docs/api_docs/namespaces/ts/type-aliases/DotDotDotToken.md new file mode 100644 index 0000000000000000000000000000000000000000..81c290f757331a7bde3ea19351eee8fe139e2477 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/DotDotDotToken.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / DotDotDotToken + +# Type Alias: DotDotDotToken + +> **DotDotDotToken**: [`PunctuationToken`](../interfaces/PunctuationToken.md)\<[`DotDotDotToken`](../enumerations/SyntaxKind.md#dotdotdottoken)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:625 diff --git a/docs/api_docs/namespaces/ts/type-aliases/DotToken.md b/docs/api_docs/namespaces/ts/type-aliases/DotToken.md new file mode 100644 index 0000000000000000000000000000000000000000..29b5cbe4af98b2cbae499939f249f4d97a9992b7 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/DotToken.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / DotToken + +# Type Alias: DotToken + +> **DotToken**: [`PunctuationToken`](../interfaces/PunctuationToken.md)\<[`DotToken`](../enumerations/SyntaxKind.md#dottoken)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:624 diff --git a/docs/api_docs/namespaces/ts/type-aliases/EmitHelper.md b/docs/api_docs/namespaces/ts/type-aliases/EmitHelper.md new file mode 100644 index 0000000000000000000000000000000000000000..0d92b909b6cdb8ccb0069b3c66522549779d9cee --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/EmitHelper.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / EmitHelper + +# Type Alias: EmitHelper + +> **EmitHelper**: [`ScopedEmitHelper`](../interfaces/ScopedEmitHelper.md) \| [`UnscopedEmitHelper`](../interfaces/UnscopedEmitHelper.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3567 diff --git a/docs/api_docs/namespaces/ts/type-aliases/EmitHelperUniqueNameCallback.md b/docs/api_docs/namespaces/ts/type-aliases/EmitHelperUniqueNameCallback.md new file mode 100644 index 0000000000000000000000000000000000000000..e2670a4f35b85dbd5ebbf65a900e6d38a5a2d893 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/EmitHelperUniqueNameCallback.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / EmitHelperUniqueNameCallback + +# Type Alias: EmitHelperUniqueNameCallback() + +> **EmitHelperUniqueNameCallback**: (`name`) => `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3568 + +## Parameters + +### name + +`string` + +## Returns + +`string` diff --git a/docs/api_docs/namespaces/ts/type-aliases/EndOfFileToken.md b/docs/api_docs/namespaces/ts/type-aliases/EndOfFileToken.md new file mode 100644 index 0000000000000000000000000000000000000000..25e11421e4fceeae80d2f0122b2bc1e98dacfd0a --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/EndOfFileToken.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / EndOfFileToken + +# Type Alias: EndOfFileToken + +> **EndOfFileToken**: [`Token`](../interfaces/Token.md)\<[`EndOfFileToken`](../enumerations/SyntaxKind.md#endoffiletoken)\> & [`JSDocContainer`](../interfaces/JSDocContainer.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:621 diff --git a/docs/api_docs/namespaces/ts/type-aliases/EntityName.md b/docs/api_docs/namespaces/ts/type-aliases/EntityName.md new file mode 100644 index 0000000000000000000000000000000000000000..f10ab7b882642f2a666c1cf0a83d88620efc5e5d --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/EntityName.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / EntityName + +# Type Alias: EntityName + +> **EntityName**: [`Identifier`](../interfaces/Identifier.md) \| [`QualifiedName`](../interfaces/QualifiedName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:694 diff --git a/docs/api_docs/namespaces/ts/type-aliases/EntityNameExpression.md b/docs/api_docs/namespaces/ts/type-aliases/EntityNameExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..b0d24aa9e4092c3ffc1a3537cbbb8839aaa613c4 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/EntityNameExpression.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / EntityNameExpression + +# Type Alias: EntityNameExpression + +> **EntityNameExpression**: [`Identifier`](../interfaces/Identifier.md) \| [`PropertyAccessEntityNameExpression`](../interfaces/PropertyAccessEntityNameExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1301 diff --git a/docs/api_docs/namespaces/ts/type-aliases/EntityNameOrEntityNameExpression.md b/docs/api_docs/namespaces/ts/type-aliases/EntityNameOrEntityNameExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..9d695431b1f9ec2bb398d0fb4e8b4fcbe0411465 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/EntityNameOrEntityNameExpression.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / EntityNameOrEntityNameExpression + +# Type Alias: EntityNameOrEntityNameExpression + +> **EntityNameOrEntityNameExpression**: [`EntityName`](EntityName.md) \| [`EntityNameExpression`](EntityNameExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1302 diff --git a/docs/api_docs/namespaces/ts/type-aliases/EqualityOperator.md b/docs/api_docs/namespaces/ts/type-aliases/EqualityOperator.md new file mode 100644 index 0000000000000000000000000000000000000000..e0aa07b65ebd4e4cddefdb03b93e18becf49d9e6 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/EqualityOperator.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / EqualityOperator + +# Type Alias: EqualityOperator + +> **EqualityOperator**: [`EqualsEqualsToken`](../enumerations/SyntaxKind.md#equalsequalstoken) \| [`EqualsEqualsEqualsToken`](../enumerations/SyntaxKind.md#equalsequalsequalstoken) \| [`ExclamationEqualsEqualsToken`](../enumerations/SyntaxKind.md#exclamationequalsequalstoken) \| [`ExclamationEqualsToken`](../enumerations/SyntaxKind.md#exclamationequalstoken) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1149 diff --git a/docs/api_docs/namespaces/ts/type-aliases/EqualityOperatorOrHigher.md b/docs/api_docs/namespaces/ts/type-aliases/EqualityOperatorOrHigher.md new file mode 100644 index 0000000000000000000000000000000000000000..e92bf3a7c624e57303771bd4529bced6158348a8 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/EqualityOperatorOrHigher.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / EqualityOperatorOrHigher + +# Type Alias: EqualityOperatorOrHigher + +> **EqualityOperatorOrHigher**: [`RelationalOperatorOrHigher`](RelationalOperatorOrHigher.md) \| [`EqualityOperator`](EqualityOperator.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1150 diff --git a/docs/api_docs/namespaces/ts/type-aliases/EqualsGreaterThanToken.md b/docs/api_docs/namespaces/ts/type-aliases/EqualsGreaterThanToken.md new file mode 100644 index 0000000000000000000000000000000000000000..e3d128f171a6bf3c70c175b8e3b16b6e0e02cc07 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/EqualsGreaterThanToken.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / EqualsGreaterThanToken + +# Type Alias: EqualsGreaterThanToken + +> **EqualsGreaterThanToken**: [`PunctuationToken`](../interfaces/PunctuationToken.md)\<[`EqualsGreaterThanToken`](../enumerations/SyntaxKind.md#equalsgreaterthantoken)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:631 diff --git a/docs/api_docs/namespaces/ts/type-aliases/EqualsToken.md b/docs/api_docs/namespaces/ts/type-aliases/EqualsToken.md new file mode 100644 index 0000000000000000000000000000000000000000..959b5d223ff00254e66a9264d830699d51d7129c --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/EqualsToken.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / EqualsToken + +# Type Alias: EqualsToken + +> **EqualsToken**: [`PunctuationToken`](../interfaces/PunctuationToken.md)\<[`EqualsToken`](../enumerations/SyntaxKind.md#equalstoken)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:629 diff --git a/docs/api_docs/namespaces/ts/type-aliases/ErrorCallback.md b/docs/api_docs/namespaces/ts/type-aliases/ErrorCallback.md new file mode 100644 index 0000000000000000000000000000000000000000..bb922e8423adf125d3f595696b1edba179ec87d8 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/ErrorCallback.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ErrorCallback + +# Type Alias: ErrorCallback() + +> **ErrorCallback**: (`message`, `length`) => `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4573 + +## Parameters + +### message + +[`DiagnosticMessage`](../interfaces/DiagnosticMessage.md) + +### length + +`number` + +## Returns + +`void` diff --git a/docs/api_docs/namespaces/ts/type-aliases/ExclamationToken.md b/docs/api_docs/namespaces/ts/type-aliases/ExclamationToken.md new file mode 100644 index 0000000000000000000000000000000000000000..18d258948281bceceae73b5124ff4006960d2a5f --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/ExclamationToken.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ExclamationToken + +# Type Alias: ExclamationToken + +> **ExclamationToken**: [`PunctuationToken`](../interfaces/PunctuationToken.md)\<[`ExclamationToken`](../enumerations/SyntaxKind.md#exclamationtoken)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:627 diff --git a/docs/api_docs/namespaces/ts/type-aliases/ExponentiationOperator.md b/docs/api_docs/namespaces/ts/type-aliases/ExponentiationOperator.md new file mode 100644 index 0000000000000000000000000000000000000000..782c81dc1c36a71b3f8a066ec2f2dcaed4172efb --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/ExponentiationOperator.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ExponentiationOperator + +# Type Alias: ExponentiationOperator + +> **ExponentiationOperator**: [`AsteriskAsteriskToken`](../enumerations/SyntaxKind.md#asteriskasterisktoken) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1140 diff --git a/docs/api_docs/namespaces/ts/type-aliases/ExportKeyword.md b/docs/api_docs/namespaces/ts/type-aliases/ExportKeyword.md new file mode 100644 index 0000000000000000000000000000000000000000..f40d0ca1c91c036470e71c964660f38dae0cc41a --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/ExportKeyword.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ExportKeyword + +# Type Alias: ExportKeyword + +> **ExportKeyword**: [`ModifierToken`](../interfaces/ModifierToken.md)\<[`ExportKeyword`](../enumerations/SyntaxKind.md#exportkeyword)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:652 diff --git a/docs/api_docs/namespaces/ts/type-aliases/FileWatcherCallback.md b/docs/api_docs/namespaces/ts/type-aliases/FileWatcherCallback.md new file mode 100644 index 0000000000000000000000000000000000000000..c01976beeaff44c14305f695be6a70f27d846ddc --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/FileWatcherCallback.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / FileWatcherCallback + +# Type Alias: FileWatcherCallback() + +> **FileWatcherCallback**: (`fileName`, `eventKind`, `modifiedTime`?) => `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4521 + +## Parameters + +### fileName + +`string` + +### eventKind + +[`FileWatcherEventKind`](../enumerations/FileWatcherEventKind.md) + +### modifiedTime? + +`Date` + +## Returns + +`void` diff --git a/docs/api_docs/namespaces/ts/type-aliases/FlowNode.md b/docs/api_docs/namespaces/ts/type-aliases/FlowNode.md new file mode 100644 index 0000000000000000000000000000000000000000..47a6f65f35b5680ffc68ae435759c21c5b567d15 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/FlowNode.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / FlowNode + +# Type Alias: FlowNode + +> **FlowNode**: [`FlowStart`](../interfaces/FlowStart.md) \| [`FlowLabel`](../interfaces/FlowLabel.md) \| [`FlowAssignment`](../interfaces/FlowAssignment.md) \| [`FlowCondition`](../interfaces/FlowCondition.md) \| [`FlowSwitchClause`](../interfaces/FlowSwitchClause.md) \| [`FlowArrayMutation`](../interfaces/FlowArrayMutation.md) \| [`FlowCall`](../interfaces/FlowCall.md) \| [`FlowReduceLabel`](../interfaces/FlowReduceLabel.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2062 diff --git a/docs/api_docs/namespaces/ts/type-aliases/FlowType.md b/docs/api_docs/namespaces/ts/type-aliases/FlowType.md new file mode 100644 index 0000000000000000000000000000000000000000..4ec6f52ba3ef01de892a8d91f8e1021d566d15ad --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/FlowType.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / FlowType + +# Type Alias: FlowType + +> **FlowType**: [`Type`](../interfaces/Type.md) \| [`IncompleteType`](../interfaces/IncompleteType.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2100 diff --git a/docs/api_docs/namespaces/ts/type-aliases/ForInOrOfStatement.md b/docs/api_docs/namespaces/ts/type-aliases/ForInOrOfStatement.md new file mode 100644 index 0000000000000000000000000000000000000000..efbe64e64cbeb625929ff850a103c1e5e071be18 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/ForInOrOfStatement.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ForInOrOfStatement + +# Type Alias: ForInOrOfStatement + +> **ForInOrOfStatement**: [`ForInStatement`](../interfaces/ForInStatement.md) \| [`ForOfStatement`](../interfaces/ForOfStatement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1531 diff --git a/docs/api_docs/namespaces/ts/type-aliases/ForInitializer.md b/docs/api_docs/namespaces/ts/type-aliases/ForInitializer.md new file mode 100644 index 0000000000000000000000000000000000000000..ff5bc65cc54736d028f260d75c227537bcb7e3e6 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/ForInitializer.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ForInitializer + +# Type Alias: ForInitializer + +> **ForInitializer**: [`VariableDeclarationList`](../interfaces/VariableDeclarationList.md) \| [`Expression`](../interfaces/Expression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1524 diff --git a/docs/api_docs/namespaces/ts/type-aliases/FunctionBody.md b/docs/api_docs/namespaces/ts/type-aliases/FunctionBody.md new file mode 100644 index 0000000000000000000000000000000000000000..e47a7fd7eb489b44beaaf6c5e16734b9f67de7f4 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/FunctionBody.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / FunctionBody + +# Type Alias: FunctionBody + +> **FunctionBody**: [`Block`](../interfaces/Block.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1196 diff --git a/docs/api_docs/namespaces/ts/type-aliases/FunctionLike.md b/docs/api_docs/namespaces/ts/type-aliases/FunctionLike.md new file mode 100644 index 0000000000000000000000000000000000000000..5ecd47b8adfc8de463c907cbd6f65999e1a5cde0 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/FunctionLike.md @@ -0,0 +1,15 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / FunctionLike + +# Type Alias: ~~FunctionLike~~ + +> **FunctionLike**: [`SignatureDeclaration`](SignatureDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:854 + +## Deprecated + +Use SignatureDeclaration diff --git a/docs/api_docs/namespaces/ts/type-aliases/FunctionLikeDeclaration.md b/docs/api_docs/namespaces/ts/type-aliases/FunctionLikeDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..63b11cc71e472fc8add6091afad0d58f014ea423 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/FunctionLikeDeclaration.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / FunctionLikeDeclaration + +# Type Alias: FunctionLikeDeclaration + +> **FunctionLikeDeclaration**: [`FunctionDeclaration`](../interfaces/FunctionDeclaration.md) \| [`MethodDeclaration`](../interfaces/MethodDeclaration.md) \| [`GetAccessorDeclaration`](../interfaces/GetAccessorDeclaration.md) \| [`SetAccessorDeclaration`](../interfaces/SetAccessorDeclaration.md) \| [`ConstructorDeclaration`](../interfaces/ConstructorDeclaration.md) \| [`FunctionExpression`](../interfaces/FunctionExpression.md) \| [`ArrowFunction`](../interfaces/ArrowFunction.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:852 diff --git a/docs/api_docs/namespaces/ts/type-aliases/FunctionOrConstructorTypeNode.md b/docs/api_docs/namespaces/ts/type-aliases/FunctionOrConstructorTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..6a21c301cdd5d192bda62e9581382d2156a482c9 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/FunctionOrConstructorTypeNode.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / FunctionOrConstructorTypeNode + +# Type Alias: FunctionOrConstructorTypeNode + +> **FunctionOrConstructorTypeNode**: [`FunctionTypeNode`](../interfaces/FunctionTypeNode.md) \| [`ConstructorTypeNode`](../interfaces/ConstructorTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:933 diff --git a/docs/api_docs/namespaces/ts/type-aliases/HasDecorators.md b/docs/api_docs/namespaces/ts/type-aliases/HasDecorators.md new file mode 100644 index 0000000000000000000000000000000000000000..49d0f18f3309ccab2e0b809b9cafc88f5ec11f19 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/HasDecorators.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / HasDecorators + +# Type Alias: HasDecorators + +> **HasDecorators**: [`ParameterDeclaration`](../interfaces/ParameterDeclaration.md) \| [`PropertyDeclaration`](../interfaces/PropertyDeclaration.md) \| [`MethodDeclaration`](../interfaces/MethodDeclaration.md) \| [`GetAccessorDeclaration`](../interfaces/GetAccessorDeclaration.md) \| [`SetAccessorDeclaration`](../interfaces/SetAccessorDeclaration.md) \| [`ClassExpression`](../interfaces/ClassExpression.md) \| [`ClassDeclaration`](../interfaces/ClassDeclaration.md) \| [`StructDeclaration`](../interfaces/StructDeclaration.md) \| [`FunctionDeclaration`](../interfaces/FunctionDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:612 diff --git a/docs/api_docs/namespaces/ts/type-aliases/HasExpressionInitializer.md b/docs/api_docs/namespaces/ts/type-aliases/HasExpressionInitializer.md new file mode 100644 index 0000000000000000000000000000000000000000..1af87efad9a3af90b1406b8d489443c0521b4c21 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/HasExpressionInitializer.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / HasExpressionInitializer + +# Type Alias: HasExpressionInitializer + +> **HasExpressionInitializer**: [`VariableDeclaration`](../interfaces/VariableDeclaration.md) \| [`ParameterDeclaration`](../interfaces/ParameterDeclaration.md) \| [`BindingElement`](../interfaces/BindingElement.md) \| [`PropertyDeclaration`](../interfaces/PropertyDeclaration.md) \| [`PropertyAssignment`](../interfaces/PropertyAssignment.md) \| [`EnumMember`](../interfaces/EnumMember.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:611 diff --git a/docs/api_docs/namespaces/ts/type-aliases/HasIllegalDecorators.md b/docs/api_docs/namespaces/ts/type-aliases/HasIllegalDecorators.md new file mode 100644 index 0000000000000000000000000000000000000000..2b6d8772ea5f83080408b77db65ef95aa7dd7b7e --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/HasIllegalDecorators.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / HasIllegalDecorators + +# Type Alias: HasIllegalDecorators + +> **HasIllegalDecorators**: [`PropertyAssignment`](../interfaces/PropertyAssignment.md) \| [`ShorthandPropertyAssignment`](../interfaces/ShorthandPropertyAssignment.md) \| [`FunctionDeclaration`](../interfaces/FunctionDeclaration.md) \| [`ConstructorDeclaration`](../interfaces/ConstructorDeclaration.md) \| [`IndexSignatureDeclaration`](../interfaces/IndexSignatureDeclaration.md) \| [`ClassStaticBlockDeclaration`](../interfaces/ClassStaticBlockDeclaration.md) \| [`MissingDeclaration`](../interfaces/MissingDeclaration.md) \| [`VariableStatement`](../interfaces/VariableStatement.md) \| [`InterfaceDeclaration`](../interfaces/InterfaceDeclaration.md) \| [`TypeAliasDeclaration`](../interfaces/TypeAliasDeclaration.md) \| [`EnumDeclaration`](../interfaces/EnumDeclaration.md) \| [`ModuleDeclaration`](../interfaces/ModuleDeclaration.md) \| [`ImportEqualsDeclaration`](../interfaces/ImportEqualsDeclaration.md) \| [`ImportDeclaration`](../interfaces/ImportDeclaration.md) \| [`NamespaceExportDeclaration`](../interfaces/NamespaceExportDeclaration.md) \| [`ExportDeclaration`](../interfaces/ExportDeclaration.md) \| [`ExportAssignment`](../interfaces/ExportAssignment.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:613 diff --git a/docs/api_docs/namespaces/ts/type-aliases/HasInitializer.md b/docs/api_docs/namespaces/ts/type-aliases/HasInitializer.md new file mode 100644 index 0000000000000000000000000000000000000000..bb20e4cab9f7c1349636ebe12077624e6452ab51 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/HasInitializer.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / HasInitializer + +# Type Alias: HasInitializer + +> **HasInitializer**: [`HasExpressionInitializer`](HasExpressionInitializer.md) \| [`ForStatement`](../interfaces/ForStatement.md) \| [`ForInStatement`](../interfaces/ForInStatement.md) \| [`ForOfStatement`](../interfaces/ForOfStatement.md) \| [`JsxAttribute`](../interfaces/JsxAttribute.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:610 diff --git a/docs/api_docs/namespaces/ts/type-aliases/HasJSDoc.md b/docs/api_docs/namespaces/ts/type-aliases/HasJSDoc.md new file mode 100644 index 0000000000000000000000000000000000000000..b2fc35b99d436b1737b2239148da117fad26980b --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/HasJSDoc.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / HasJSDoc + +# Type Alias: HasJSDoc + +> **HasJSDoc**: [`ParameterDeclaration`](../interfaces/ParameterDeclaration.md) \| [`CallSignatureDeclaration`](../interfaces/CallSignatureDeclaration.md) \| [`ClassStaticBlockDeclaration`](../interfaces/ClassStaticBlockDeclaration.md) \| [`ConstructSignatureDeclaration`](../interfaces/ConstructSignatureDeclaration.md) \| [`MethodSignature`](../interfaces/MethodSignature.md) \| [`PropertySignature`](../interfaces/PropertySignature.md) \| [`ArrowFunction`](../interfaces/ArrowFunction.md) \| [`ParenthesizedExpression`](../interfaces/ParenthesizedExpression.md) \| [`SpreadAssignment`](../interfaces/SpreadAssignment.md) \| [`ShorthandPropertyAssignment`](../interfaces/ShorthandPropertyAssignment.md) \| [`PropertyAssignment`](../interfaces/PropertyAssignment.md) \| [`FunctionExpression`](../interfaces/FunctionExpression.md) \| [`EmptyStatement`](../interfaces/EmptyStatement.md) \| [`DebuggerStatement`](../interfaces/DebuggerStatement.md) \| [`Block`](../interfaces/Block.md) \| [`VariableStatement`](../interfaces/VariableStatement.md) \| [`ExpressionStatement`](../interfaces/ExpressionStatement.md) \| [`IfStatement`](../interfaces/IfStatement.md) \| [`DoStatement`](../interfaces/DoStatement.md) \| [`WhileStatement`](../interfaces/WhileStatement.md) \| [`ForStatement`](../interfaces/ForStatement.md) \| [`ForInStatement`](../interfaces/ForInStatement.md) \| [`ForOfStatement`](../interfaces/ForOfStatement.md) \| [`BreakStatement`](../interfaces/BreakStatement.md) \| [`ContinueStatement`](../interfaces/ContinueStatement.md) \| [`ReturnStatement`](../interfaces/ReturnStatement.md) \| [`WithStatement`](../interfaces/WithStatement.md) \| [`SwitchStatement`](../interfaces/SwitchStatement.md) \| [`LabeledStatement`](../interfaces/LabeledStatement.md) \| [`ThrowStatement`](../interfaces/ThrowStatement.md) \| [`TryStatement`](../interfaces/TryStatement.md) \| [`FunctionDeclaration`](../interfaces/FunctionDeclaration.md) \| [`ConstructorDeclaration`](../interfaces/ConstructorDeclaration.md) \| [`MethodDeclaration`](../interfaces/MethodDeclaration.md) \| [`VariableDeclaration`](../interfaces/VariableDeclaration.md) \| [`PropertyDeclaration`](../interfaces/PropertyDeclaration.md) \| [`AccessorDeclaration`](AccessorDeclaration.md) \| [`ClassLikeDeclaration`](ClassLikeDeclaration.md) \| [`InterfaceDeclaration`](../interfaces/InterfaceDeclaration.md) \| [`TypeAliasDeclaration`](../interfaces/TypeAliasDeclaration.md) \| [`EnumMember`](../interfaces/EnumMember.md) \| [`EnumDeclaration`](../interfaces/EnumDeclaration.md) \| [`ModuleDeclaration`](../interfaces/ModuleDeclaration.md) \| [`ImportEqualsDeclaration`](../interfaces/ImportEqualsDeclaration.md) \| [`ImportDeclaration`](../interfaces/ImportDeclaration.md) \| [`NamespaceExportDeclaration`](../interfaces/NamespaceExportDeclaration.md) \| [`ExportAssignment`](../interfaces/ExportAssignment.md) \| [`IndexSignatureDeclaration`](../interfaces/IndexSignatureDeclaration.md) \| [`FunctionTypeNode`](../interfaces/FunctionTypeNode.md) \| [`ConstructorTypeNode`](../interfaces/ConstructorTypeNode.md) \| [`JSDocFunctionType`](../interfaces/JSDocFunctionType.md) \| [`ExportDeclaration`](../interfaces/ExportDeclaration.md) \| [`NamedTupleMember`](../interfaces/NamedTupleMember.md) \| [`ExportSpecifier`](../interfaces/ExportSpecifier.md) \| [`CaseClause`](../interfaces/CaseClause.md) \| [`EndOfFileToken`](EndOfFileToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:607 diff --git a/docs/api_docs/namespaces/ts/type-aliases/HasModifiers.md b/docs/api_docs/namespaces/ts/type-aliases/HasModifiers.md new file mode 100644 index 0000000000000000000000000000000000000000..f21114bd55527613a3b60dcd6252aeda18683c82 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/HasModifiers.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / HasModifiers + +# Type Alias: HasModifiers + +> **HasModifiers**: [`TypeParameterDeclaration`](../interfaces/TypeParameterDeclaration.md) \| [`ParameterDeclaration`](../interfaces/ParameterDeclaration.md) \| [`ConstructorTypeNode`](../interfaces/ConstructorTypeNode.md) \| [`PropertySignature`](../interfaces/PropertySignature.md) \| [`PropertyDeclaration`](../interfaces/PropertyDeclaration.md) \| [`MethodSignature`](../interfaces/MethodSignature.md) \| [`MethodDeclaration`](../interfaces/MethodDeclaration.md) \| [`ConstructorDeclaration`](../interfaces/ConstructorDeclaration.md) \| [`GetAccessorDeclaration`](../interfaces/GetAccessorDeclaration.md) \| [`SetAccessorDeclaration`](../interfaces/SetAccessorDeclaration.md) \| [`IndexSignatureDeclaration`](../interfaces/IndexSignatureDeclaration.md) \| [`FunctionExpression`](../interfaces/FunctionExpression.md) \| [`ArrowFunction`](../interfaces/ArrowFunction.md) \| [`ClassExpression`](../interfaces/ClassExpression.md) \| [`VariableStatement`](../interfaces/VariableStatement.md) \| [`FunctionDeclaration`](../interfaces/FunctionDeclaration.md) \| [`ClassDeclaration`](../interfaces/ClassDeclaration.md) \| [`StructDeclaration`](../interfaces/StructDeclaration.md) \| [`InterfaceDeclaration`](../interfaces/InterfaceDeclaration.md) \| [`TypeAliasDeclaration`](../interfaces/TypeAliasDeclaration.md) \| [`EnumDeclaration`](../interfaces/EnumDeclaration.md) \| [`ModuleDeclaration`](../interfaces/ModuleDeclaration.md) \| [`ImportEqualsDeclaration`](../interfaces/ImportEqualsDeclaration.md) \| [`ImportDeclaration`](../interfaces/ImportDeclaration.md) \| [`ExportAssignment`](../interfaces/ExportAssignment.md) \| [`ExportDeclaration`](../interfaces/ExportDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:614 diff --git a/docs/api_docs/namespaces/ts/type-aliases/HasType.md b/docs/api_docs/namespaces/ts/type-aliases/HasType.md new file mode 100644 index 0000000000000000000000000000000000000000..aef9f96397ad9aa47b471d07749e08ec3e1dee74 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/HasType.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / HasType + +# Type Alias: HasType + +> **HasType**: [`SignatureDeclaration`](SignatureDeclaration.md) \| [`VariableDeclaration`](../interfaces/VariableDeclaration.md) \| [`ParameterDeclaration`](../interfaces/ParameterDeclaration.md) \| [`PropertySignature`](../interfaces/PropertySignature.md) \| [`PropertyDeclaration`](../interfaces/PropertyDeclaration.md) \| [`TypePredicateNode`](../interfaces/TypePredicateNode.md) \| [`ParenthesizedTypeNode`](../interfaces/ParenthesizedTypeNode.md) \| [`TypeOperatorNode`](../interfaces/TypeOperatorNode.md) \| [`MappedTypeNode`](../interfaces/MappedTypeNode.md) \| [`AssertionExpression`](AssertionExpression.md) \| [`TypeAliasDeclaration`](../interfaces/TypeAliasDeclaration.md) \| [`JSDocTypeExpression`](../interfaces/JSDocTypeExpression.md) \| [`JSDocNonNullableType`](../interfaces/JSDocNonNullableType.md) \| [`JSDocNullableType`](../interfaces/JSDocNullableType.md) \| [`JSDocOptionalType`](../interfaces/JSDocOptionalType.md) \| [`JSDocVariadicType`](../interfaces/JSDocVariadicType.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:608 diff --git a/docs/api_docs/namespaces/ts/type-aliases/HasTypeArguments.md b/docs/api_docs/namespaces/ts/type-aliases/HasTypeArguments.md new file mode 100644 index 0000000000000000000000000000000000000000..c50f0ed087017986d92bfee14b2e9a3dbd8a2914 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/HasTypeArguments.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / HasTypeArguments + +# Type Alias: HasTypeArguments + +> **HasTypeArguments**: [`CallExpression`](../interfaces/CallExpression.md) \| [`NewExpression`](../interfaces/NewExpression.md) \| [`TaggedTemplateExpression`](../interfaces/TaggedTemplateExpression.md) \| [`JsxOpeningElement`](../interfaces/JsxOpeningElement.md) \| [`JsxSelfClosingElement`](../interfaces/JsxSelfClosingElement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:609 diff --git a/docs/api_docs/namespaces/ts/type-aliases/ImportOrExportSpecifier.md b/docs/api_docs/namespaces/ts/type-aliases/ImportOrExportSpecifier.md new file mode 100644 index 0000000000000000000000000000000000000000..dde3a66cb1df13a9f94593284419244fd9627ae3 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/ImportOrExportSpecifier.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ImportOrExportSpecifier + +# Type Alias: ImportOrExportSpecifier + +> **ImportOrExportSpecifier**: [`ImportSpecifier`](../interfaces/ImportSpecifier.md) \| [`ExportSpecifier`](../interfaces/ExportSpecifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1799 diff --git a/docs/api_docs/namespaces/ts/type-aliases/InKeyword.md b/docs/api_docs/namespaces/ts/type-aliases/InKeyword.md new file mode 100644 index 0000000000000000000000000000000000000000..eb6940c5563392abc43471447369fb1b6d9f23f8 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/InKeyword.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / InKeyword + +# Type Alias: InKeyword + +> **InKeyword**: [`ModifierToken`](../interfaces/ModifierToken.md)\<[`InKeyword`](../enumerations/SyntaxKind.md#inkeyword)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:653 diff --git a/docs/api_docs/namespaces/ts/type-aliases/IncrementExpression.md b/docs/api_docs/namespaces/ts/type-aliases/IncrementExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..8a485731c3f303858787ad34e9b6383ba1d7a6ca --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/IncrementExpression.md @@ -0,0 +1,13 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / IncrementExpression + +# Type Alias: IncrementExpression + +> **IncrementExpression**: [`UpdateExpression`](../interfaces/UpdateExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1069 + +Deprecated, please use UpdateExpression diff --git a/docs/api_docs/namespaces/ts/type-aliases/InvalidatedProject.md b/docs/api_docs/namespaces/ts/type-aliases/InvalidatedProject.md new file mode 100644 index 0000000000000000000000000000000000000000..fb7a80b80f0280f5333c8f20a6a09c757a11535d --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/InvalidatedProject.md @@ -0,0 +1,15 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / InvalidatedProject + +# Type Alias: InvalidatedProject\ + +> **InvalidatedProject**\<`T`\>: [`UpdateOutputFileStampsProject`](../interfaces/UpdateOutputFileStampsProject.md) \| [`BuildInvalidedProject`](../interfaces/BuildInvalidedProject.md)\<`T`\> \| [`UpdateBundleProject`](../interfaces/UpdateBundleProject.md)\<`T`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6009 + +## Type Parameters + +• **T** *extends* [`BuilderProgram`](../interfaces/BuilderProgram.md) diff --git a/docs/api_docs/namespaces/ts/type-aliases/JSDocComment.md b/docs/api_docs/namespaces/ts/type-aliases/JSDocComment.md new file mode 100644 index 0000000000000000000000000000000000000000..01a09e6047e83fcb53e478afe5da04978d7731c5 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/JSDocComment.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JSDocComment + +# Type Alias: JSDocComment + +> **JSDocComment**: [`JSDocText`](../interfaces/JSDocText.md) \| [`JSDocLink`](../interfaces/JSDocLink.md) \| [`JSDocLinkCode`](../interfaces/JSDocLinkCode.md) \| [`JSDocLinkPlain`](../interfaces/JSDocLinkPlain.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1931 diff --git a/docs/api_docs/namespaces/ts/type-aliases/JSDocNamespaceBody.md b/docs/api_docs/namespaces/ts/type-aliases/JSDocNamespaceBody.md new file mode 100644 index 0000000000000000000000000000000000000000..6b72f68caed3cb03179ef9d493b7be12bda7c0dd --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/JSDocNamespaceBody.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JSDocNamespaceBody + +# Type Alias: JSDocNamespaceBody + +> **JSDocNamespaceBody**: [`Identifier`](../interfaces/Identifier.md) \| [`JSDocNamespaceDeclaration`](../interfaces/JSDocNamespaceDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1688 diff --git a/docs/api_docs/namespaces/ts/type-aliases/JSDocSyntaxKind.md b/docs/api_docs/namespaces/ts/type-aliases/JSDocSyntaxKind.md new file mode 100644 index 0000000000000000000000000000000000000000..20adf905ac0ff1f0461538a91ef070b5be8f54df --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/JSDocSyntaxKind.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JSDocSyntaxKind + +# Type Alias: JSDocSyntaxKind + +> **JSDocSyntaxKind**: [`EndOfFileToken`](../enumerations/SyntaxKind.md#endoffiletoken) \| [`WhitespaceTrivia`](../enumerations/SyntaxKind.md#whitespacetrivia) \| [`AtToken`](../enumerations/SyntaxKind.md#attoken) \| [`NewLineTrivia`](../enumerations/SyntaxKind.md#newlinetrivia) \| [`AsteriskToken`](../enumerations/SyntaxKind.md#asterisktoken) \| [`OpenBraceToken`](../enumerations/SyntaxKind.md#openbracetoken) \| [`CloseBraceToken`](../enumerations/SyntaxKind.md#closebracetoken) \| [`LessThanToken`](../enumerations/SyntaxKind.md#lessthantoken) \| [`GreaterThanToken`](../enumerations/SyntaxKind.md#greaterthantoken) \| [`OpenBracketToken`](../enumerations/SyntaxKind.md#openbrackettoken) \| [`CloseBracketToken`](../enumerations/SyntaxKind.md#closebrackettoken) \| [`EqualsToken`](../enumerations/SyntaxKind.md#equalstoken) \| [`CommaToken`](../enumerations/SyntaxKind.md#commatoken) \| [`DotToken`](../enumerations/SyntaxKind.md#dottoken) \| [`Identifier`](../enumerations/SyntaxKind.md#identifier) \| [`BacktickToken`](../enumerations/SyntaxKind.md#backticktoken) \| [`HashToken`](../enumerations/SyntaxKind.md#hashtoken) \| [`Unknown`](../enumerations/SyntaxKind.md#unknown) \| [`KeywordSyntaxKind`](KeywordSyntaxKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:514 diff --git a/docs/api_docs/namespaces/ts/type-aliases/JSDocTypeReferencingNode.md b/docs/api_docs/namespaces/ts/type-aliases/JSDocTypeReferencingNode.md new file mode 100644 index 0000000000000000000000000000000000000000..7832188910f25b47eeee205af758b51d9da8465e --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/JSDocTypeReferencingNode.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JSDocTypeReferencingNode + +# Type Alias: JSDocTypeReferencingNode + +> **JSDocTypeReferencingNode**: [`JSDocVariadicType`](../interfaces/JSDocVariadicType.md) \| [`JSDocOptionalType`](../interfaces/JSDocOptionalType.md) \| [`JSDocNullableType`](../interfaces/JSDocNullableType.md) \| [`JSDocNonNullableType`](../interfaces/JSDocNonNullableType.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1904 diff --git a/docs/api_docs/namespaces/ts/type-aliases/JsFileExtensionInfo.md b/docs/api_docs/namespaces/ts/type-aliases/JsFileExtensionInfo.md new file mode 100644 index 0000000000000000000000000000000000000000..1858ad6dbcab84d6a076069a232024c1946c203d --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/JsFileExtensionInfo.md @@ -0,0 +1,15 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JsFileExtensionInfo + +# Type Alias: ~~JsFileExtensionInfo~~ + +> **JsFileExtensionInfo**: [`FileExtensionInfo`](../interfaces/FileExtensionInfo.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2968 + +## Deprecated + +Use FileExtensionInfo instead. diff --git a/docs/api_docs/namespaces/ts/type-aliases/JsonObjectExpression.md b/docs/api_docs/namespaces/ts/type-aliases/JsonObjectExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..217473aa73250afd2ee0873217130b9a6caeb335 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/JsonObjectExpression.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JsonObjectExpression + +# Type Alias: JsonObjectExpression + +> **JsonObjectExpression**: [`ObjectLiteralExpression`](../interfaces/ObjectLiteralExpression.md) \| [`ArrayLiteralExpression`](../interfaces/ArrayLiteralExpression.md) \| [`JsonMinusNumericLiteral`](../interfaces/JsonMinusNumericLiteral.md) \| [`NumericLiteral`](../interfaces/NumericLiteral.md) \| [`StringLiteral`](../interfaces/StringLiteral.md) \| [`BooleanLiteral`](BooleanLiteral.md) \| [`NullLiteral`](../interfaces/NullLiteral.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2226 diff --git a/docs/api_docs/namespaces/ts/type-aliases/JsxAttributeLike.md b/docs/api_docs/namespaces/ts/type-aliases/JsxAttributeLike.md new file mode 100644 index 0000000000000000000000000000000000000000..63700407bfd6fbafe398a8f05ee6da12c951038b --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/JsxAttributeLike.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JsxAttributeLike + +# Type Alias: JsxAttributeLike + +> **JsxAttributeLike**: [`JsxAttribute`](../interfaces/JsxAttribute.md) \| [`JsxSpreadAttribute`](../interfaces/JsxSpreadAttribute.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1405 diff --git a/docs/api_docs/namespaces/ts/type-aliases/JsxAttributeValue.md b/docs/api_docs/namespaces/ts/type-aliases/JsxAttributeValue.md new file mode 100644 index 0000000000000000000000000000000000000000..9ade410605f018374a079bf99ffb3309f09de913 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/JsxAttributeValue.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JsxAttributeValue + +# Type Alias: JsxAttributeValue + +> **JsxAttributeValue**: [`StringLiteral`](../interfaces/StringLiteral.md) \| [`JsxExpression`](../interfaces/JsxExpression.md) \| [`JsxElement`](../interfaces/JsxElement.md) \| [`JsxSelfClosingElement`](../interfaces/JsxSelfClosingElement.md) \| [`JsxFragment`](../interfaces/JsxFragment.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1447 diff --git a/docs/api_docs/namespaces/ts/type-aliases/JsxChild.md b/docs/api_docs/namespaces/ts/type-aliases/JsxChild.md new file mode 100644 index 0000000000000000000000000000000000000000..9aa5ea5a0e37aa325f844f2c4ae3d29b24061e1f --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/JsxChild.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JsxChild + +# Type Alias: JsxChild + +> **JsxChild**: [`JsxText`](../interfaces/JsxText.md) \| [`JsxExpression`](../interfaces/JsxExpression.md) \| [`JsxElement`](../interfaces/JsxElement.md) \| [`JsxSelfClosingElement`](../interfaces/JsxSelfClosingElement.md) \| [`JsxFragment`](../interfaces/JsxFragment.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1469 diff --git a/docs/api_docs/namespaces/ts/type-aliases/JsxOpeningLikeElement.md b/docs/api_docs/namespaces/ts/type-aliases/JsxOpeningLikeElement.md new file mode 100644 index 0000000000000000000000000000000000000000..ba321f9ceb0a8ef82bb0dcd1f1e9b463cf616124 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/JsxOpeningLikeElement.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JsxOpeningLikeElement + +# Type Alias: JsxOpeningLikeElement + +> **JsxOpeningLikeElement**: [`JsxSelfClosingElement`](../interfaces/JsxSelfClosingElement.md) \| [`JsxOpeningElement`](../interfaces/JsxOpeningElement.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1404 diff --git a/docs/api_docs/namespaces/ts/type-aliases/JsxTagNameExpression.md b/docs/api_docs/namespaces/ts/type-aliases/JsxTagNameExpression.md new file mode 100644 index 0000000000000000000000000000000000000000..edc07e67dd26ff2fd72698e49a3220642faaf713 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/JsxTagNameExpression.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JsxTagNameExpression + +# Type Alias: JsxTagNameExpression + +> **JsxTagNameExpression**: [`Identifier`](../interfaces/Identifier.md) \| [`ThisExpression`](../interfaces/ThisExpression.md) \| [`JsxTagNamePropertyAccess`](../interfaces/JsxTagNamePropertyAccess.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1406 diff --git a/docs/api_docs/namespaces/ts/type-aliases/JsxTokenSyntaxKind.md b/docs/api_docs/namespaces/ts/type-aliases/JsxTokenSyntaxKind.md new file mode 100644 index 0000000000000000000000000000000000000000..b0e1575219f609e50fa767815a82997578fc5665 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/JsxTokenSyntaxKind.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / JsxTokenSyntaxKind + +# Type Alias: JsxTokenSyntaxKind + +> **JsxTokenSyntaxKind**: [`LessThanSlashToken`](../enumerations/SyntaxKind.md#lessthanslashtoken) \| [`EndOfFileToken`](../enumerations/SyntaxKind.md#endoffiletoken) \| [`ConflictMarkerTrivia`](../enumerations/SyntaxKind.md#conflictmarkertrivia) \| [`JsxText`](../enumerations/SyntaxKind.md#jsxtext) \| [`JsxTextAllWhiteSpaces`](../enumerations/SyntaxKind.md#jsxtextallwhitespaces) \| [`OpenBraceToken`](../enumerations/SyntaxKind.md#openbracetoken) \| [`LessThanToken`](../enumerations/SyntaxKind.md#lessthantoken) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:513 diff --git a/docs/api_docs/namespaces/ts/type-aliases/KeywordSyntaxKind.md b/docs/api_docs/namespaces/ts/type-aliases/KeywordSyntaxKind.md new file mode 100644 index 0000000000000000000000000000000000000000..fb8eaa6e4d00041e909831e19e46ab052f9100f3 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/KeywordSyntaxKind.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / KeywordSyntaxKind + +# Type Alias: KeywordSyntaxKind + +> **KeywordSyntaxKind**: [`AbstractKeyword`](../enumerations/SyntaxKind.md#abstractkeyword) \| [`AccessorKeyword`](../enumerations/SyntaxKind.md#accessorkeyword) \| [`AnyKeyword`](../enumerations/SyntaxKind.md#anykeyword) \| [`AsKeyword`](../enumerations/SyntaxKind.md#askeyword) \| [`AssertsKeyword`](../enumerations/SyntaxKind.md#assertskeyword) \| [`AssertKeyword`](../enumerations/SyntaxKind.md#assertkeyword) \| [`AsyncKeyword`](../enumerations/SyntaxKind.md#asynckeyword) \| [`AwaitKeyword`](../enumerations/SyntaxKind.md#awaitkeyword) \| [`BigIntKeyword`](../enumerations/SyntaxKind.md#bigintkeyword) \| [`BooleanKeyword`](../enumerations/SyntaxKind.md#booleankeyword) \| [`BreakKeyword`](../enumerations/SyntaxKind.md#breakkeyword) \| [`CaseKeyword`](../enumerations/SyntaxKind.md#casekeyword) \| [`CatchKeyword`](../enumerations/SyntaxKind.md#catchkeyword) \| [`ClassKeyword`](../enumerations/SyntaxKind.md#classkeyword) \| [`StructKeyword`](../enumerations/SyntaxKind.md#structkeyword) \| [`ConstKeyword`](../enumerations/SyntaxKind.md#constkeyword) \| [`ConstructorKeyword`](../enumerations/SyntaxKind.md#constructorkeyword) \| [`ContinueKeyword`](../enumerations/SyntaxKind.md#continuekeyword) \| [`DebuggerKeyword`](../enumerations/SyntaxKind.md#debuggerkeyword) \| [`DeclareKeyword`](../enumerations/SyntaxKind.md#declarekeyword) \| [`DefaultKeyword`](../enumerations/SyntaxKind.md#defaultkeyword) \| [`DeleteKeyword`](../enumerations/SyntaxKind.md#deletekeyword) \| [`DoKeyword`](../enumerations/SyntaxKind.md#dokeyword) \| [`ElseKeyword`](../enumerations/SyntaxKind.md#elsekeyword) \| [`EnumKeyword`](../enumerations/SyntaxKind.md#enumkeyword) \| [`ExportKeyword`](../enumerations/SyntaxKind.md#exportkeyword) \| [`ExtendsKeyword`](../enumerations/SyntaxKind.md#extendskeyword) \| [`FalseKeyword`](../enumerations/SyntaxKind.md#falsekeyword) \| [`FinallyKeyword`](../enumerations/SyntaxKind.md#finallykeyword) \| [`ForKeyword`](../enumerations/SyntaxKind.md#forkeyword) \| [`FromKeyword`](../enumerations/SyntaxKind.md#fromkeyword) \| [`FunctionKeyword`](../enumerations/SyntaxKind.md#functionkeyword) \| [`GetKeyword`](../enumerations/SyntaxKind.md#getkeyword) \| [`GlobalKeyword`](../enumerations/SyntaxKind.md#globalkeyword) \| [`IfKeyword`](../enumerations/SyntaxKind.md#ifkeyword) \| [`ImplementsKeyword`](../enumerations/SyntaxKind.md#implementskeyword) \| [`ImportKeyword`](../enumerations/SyntaxKind.md#importkeyword) \| [`InferKeyword`](../enumerations/SyntaxKind.md#inferkeyword) \| [`InKeyword`](../enumerations/SyntaxKind.md#inkeyword) \| [`InstanceOfKeyword`](../enumerations/SyntaxKind.md#instanceofkeyword) \| [`InterfaceKeyword`](../enumerations/SyntaxKind.md#interfacekeyword) \| [`IntrinsicKeyword`](../enumerations/SyntaxKind.md#intrinsickeyword) \| [`IsKeyword`](../enumerations/SyntaxKind.md#iskeyword) \| [`KeyOfKeyword`](../enumerations/SyntaxKind.md#keyofkeyword) \| [`LetKeyword`](../enumerations/SyntaxKind.md#letkeyword) \| [`ModuleKeyword`](../enumerations/SyntaxKind.md#modulekeyword) \| [`NamespaceKeyword`](../enumerations/SyntaxKind.md#namespacekeyword) \| [`NeverKeyword`](../enumerations/SyntaxKind.md#neverkeyword) \| [`NewKeyword`](../enumerations/SyntaxKind.md#newkeyword) \| [`NullKeyword`](../enumerations/SyntaxKind.md#nullkeyword) \| [`NumberKeyword`](../enumerations/SyntaxKind.md#numberkeyword) \| [`ObjectKeyword`](../enumerations/SyntaxKind.md#objectkeyword) \| [`OfKeyword`](../enumerations/SyntaxKind.md#ofkeyword) \| [`PackageKeyword`](../enumerations/SyntaxKind.md#packagekeyword) \| [`PrivateKeyword`](../enumerations/SyntaxKind.md#privatekeyword) \| [`ProtectedKeyword`](../enumerations/SyntaxKind.md#protectedkeyword) \| [`PublicKeyword`](../enumerations/SyntaxKind.md#publickeyword) \| [`ReadonlyKeyword`](../enumerations/SyntaxKind.md#readonlykeyword) \| [`OutKeyword`](../enumerations/SyntaxKind.md#outkeyword) \| [`OverrideKeyword`](../enumerations/SyntaxKind.md#overridekeyword) \| [`RequireKeyword`](../enumerations/SyntaxKind.md#requirekeyword) \| [`ReturnKeyword`](../enumerations/SyntaxKind.md#returnkeyword) \| [`SatisfiesKeyword`](../enumerations/SyntaxKind.md#satisfieskeyword) \| [`SetKeyword`](../enumerations/SyntaxKind.md#setkeyword) \| [`StaticKeyword`](../enumerations/SyntaxKind.md#statickeyword) \| [`StringKeyword`](../enumerations/SyntaxKind.md#stringkeyword) \| [`SuperKeyword`](../enumerations/SyntaxKind.md#superkeyword) \| [`SwitchKeyword`](../enumerations/SyntaxKind.md#switchkeyword) \| [`SymbolKeyword`](../enumerations/SyntaxKind.md#symbolkeyword) \| [`ThisKeyword`](../enumerations/SyntaxKind.md#thiskeyword) \| [`ThrowKeyword`](../enumerations/SyntaxKind.md#throwkeyword) \| [`TrueKeyword`](../enumerations/SyntaxKind.md#truekeyword) \| [`TryKeyword`](../enumerations/SyntaxKind.md#trykeyword) \| [`TypeKeyword`](../enumerations/SyntaxKind.md#typekeyword) \| [`LazyKeyword`](../enumerations/SyntaxKind.md#lazykeyword) \| [`TypeOfKeyword`](../enumerations/SyntaxKind.md#typeofkeyword) \| [`UndefinedKeyword`](../enumerations/SyntaxKind.md#undefinedkeyword) \| [`UniqueKeyword`](../enumerations/SyntaxKind.md#uniquekeyword) \| [`UnknownKeyword`](../enumerations/SyntaxKind.md#unknownkeyword) \| [`VarKeyword`](../enumerations/SyntaxKind.md#varkeyword) \| [`VoidKeyword`](../enumerations/SyntaxKind.md#voidkeyword) \| [`WhileKeyword`](../enumerations/SyntaxKind.md#whilekeyword) \| [`WithKeyword`](../enumerations/SyntaxKind.md#withkeyword) \| [`YieldKeyword`](../enumerations/SyntaxKind.md#yieldkeyword) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:509 diff --git a/docs/api_docs/namespaces/ts/type-aliases/KeywordTypeSyntaxKind.md b/docs/api_docs/namespaces/ts/type-aliases/KeywordTypeSyntaxKind.md new file mode 100644 index 0000000000000000000000000000000000000000..77bd043e8c41fc8cebcc58244d3060e14fb9dfb1 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/KeywordTypeSyntaxKind.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / KeywordTypeSyntaxKind + +# Type Alias: KeywordTypeSyntaxKind + +> **KeywordTypeSyntaxKind**: [`AnyKeyword`](../enumerations/SyntaxKind.md#anykeyword) \| [`BigIntKeyword`](../enumerations/SyntaxKind.md#bigintkeyword) \| [`BooleanKeyword`](../enumerations/SyntaxKind.md#booleankeyword) \| [`IntrinsicKeyword`](../enumerations/SyntaxKind.md#intrinsickeyword) \| [`NeverKeyword`](../enumerations/SyntaxKind.md#neverkeyword) \| [`NumberKeyword`](../enumerations/SyntaxKind.md#numberkeyword) \| [`ObjectKeyword`](../enumerations/SyntaxKind.md#objectkeyword) \| [`StringKeyword`](../enumerations/SyntaxKind.md#stringkeyword) \| [`SymbolKeyword`](../enumerations/SyntaxKind.md#symbolkeyword) \| [`UndefinedKeyword`](../enumerations/SyntaxKind.md#undefinedkeyword) \| [`UnknownKeyword`](../enumerations/SyntaxKind.md#unknownkeyword) \| [`VoidKeyword`](../enumerations/SyntaxKind.md#voidkeyword) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:511 diff --git a/docs/api_docs/namespaces/ts/type-aliases/LiteralSyntaxKind.md b/docs/api_docs/namespaces/ts/type-aliases/LiteralSyntaxKind.md new file mode 100644 index 0000000000000000000000000000000000000000..93dd6cdd27d6e84a1d6c0d3f40330d456b740151 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/LiteralSyntaxKind.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / LiteralSyntaxKind + +# Type Alias: LiteralSyntaxKind + +> **LiteralSyntaxKind**: [`NumericLiteral`](../enumerations/SyntaxKind.md#numericliteral) \| [`BigIntLiteral`](../enumerations/SyntaxKind.md#bigintliteral) \| [`StringLiteral`](../enumerations/SyntaxKind.md#stringliteral) \| [`JsxText`](../enumerations/SyntaxKind.md#jsxtext) \| [`JsxTextAllWhiteSpaces`](../enumerations/SyntaxKind.md#jsxtextallwhitespaces) \| [`RegularExpressionLiteral`](../enumerations/SyntaxKind.md#regularexpressionliteral) \| [`NoSubstitutionTemplateLiteral`](../enumerations/SyntaxKind.md#nosubstitutiontemplateliteral) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:506 diff --git a/docs/api_docs/namespaces/ts/type-aliases/LiteralToken.md b/docs/api_docs/namespaces/ts/type-aliases/LiteralToken.md new file mode 100644 index 0000000000000000000000000000000000000000..2773537d08ba47eaad849da0fe15174c2f87962f --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/LiteralToken.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / LiteralToken + +# Type Alias: LiteralToken + +> **LiteralToken**: [`NumericLiteral`](../interfaces/NumericLiteral.md) \| [`BigIntLiteral`](../interfaces/BigIntLiteral.md) \| [`StringLiteral`](../interfaces/StringLiteral.md) \| [`JsxText`](../interfaces/JsxText.md) \| [`RegularExpressionLiteral`](../interfaces/RegularExpressionLiteral.md) \| [`NoSubstitutionTemplateLiteral`](../interfaces/NoSubstitutionTemplateLiteral.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1249 diff --git a/docs/api_docs/namespaces/ts/type-aliases/LogicalOperator.md b/docs/api_docs/namespaces/ts/type-aliases/LogicalOperator.md new file mode 100644 index 0000000000000000000000000000000000000000..cb50b391ae654a16784b95099c9b071f4fd7f3c0 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/LogicalOperator.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / LogicalOperator + +# Type Alias: LogicalOperator + +> **LogicalOperator**: [`AmpersandAmpersandToken`](../enumerations/SyntaxKind.md#ampersandampersandtoken) \| [`BarBarToken`](../enumerations/SyntaxKind.md#barbartoken) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1153 diff --git a/docs/api_docs/namespaces/ts/type-aliases/LogicalOperatorOrHigher.md b/docs/api_docs/namespaces/ts/type-aliases/LogicalOperatorOrHigher.md new file mode 100644 index 0000000000000000000000000000000000000000..896c1c673d0981ca187bd5371470b40b99c1d674 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/LogicalOperatorOrHigher.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / LogicalOperatorOrHigher + +# Type Alias: LogicalOperatorOrHigher + +> **LogicalOperatorOrHigher**: [`BitwiseOperatorOrHigher`](BitwiseOperatorOrHigher.md) \| [`LogicalOperator`](LogicalOperator.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1154 diff --git a/docs/api_docs/namespaces/ts/type-aliases/LogicalOrCoalescingAssignmentOperator.md b/docs/api_docs/namespaces/ts/type-aliases/LogicalOrCoalescingAssignmentOperator.md new file mode 100644 index 0000000000000000000000000000000000000000..1de6ccb9e4347ea93408d7a987ee0d5e3311ea70 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/LogicalOrCoalescingAssignmentOperator.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / LogicalOrCoalescingAssignmentOperator + +# Type Alias: LogicalOrCoalescingAssignmentOperator + +> **LogicalOrCoalescingAssignmentOperator**: [`AmpersandAmpersandEqualsToken`](../enumerations/SyntaxKind.md#ampersandampersandequalstoken) \| [`BarBarEqualsToken`](../enumerations/SyntaxKind.md#barbarequalstoken) \| [`QuestionQuestionEqualsToken`](../enumerations/SyntaxKind.md#questionquestionequalstoken) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1159 diff --git a/docs/api_docs/namespaces/ts/type-aliases/MemberName.md b/docs/api_docs/namespaces/ts/type-aliases/MemberName.md new file mode 100644 index 0000000000000000000000000000000000000000..1e6e6777a4a5a052786d2c1145e232b9172dff2b --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/MemberName.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / MemberName + +# Type Alias: MemberName + +> **MemberName**: [`Identifier`](../interfaces/Identifier.md) \| [`PrivateIdentifier`](../interfaces/PrivateIdentifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:696 diff --git a/docs/api_docs/namespaces/ts/type-aliases/MinusToken.md b/docs/api_docs/namespaces/ts/type-aliases/MinusToken.md new file mode 100644 index 0000000000000000000000000000000000000000..a1f1868a2cc28845a46fdcd329c1fbeccc2f5851 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/MinusToken.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / MinusToken + +# Type Alias: MinusToken + +> **MinusToken**: [`PunctuationToken`](../interfaces/PunctuationToken.md)\<[`MinusToken`](../enumerations/SyntaxKind.md#minustoken)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:633 diff --git a/docs/api_docs/namespaces/ts/type-aliases/Modifier.md b/docs/api_docs/namespaces/ts/type-aliases/Modifier.md new file mode 100644 index 0000000000000000000000000000000000000000..fc6f8a817ca1bdf88db686d1860220b31e609aac --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/Modifier.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / Modifier + +# Type Alias: Modifier + +> **Modifier**: [`AbstractKeyword`](AbstractKeyword.md) \| [`AccessorKeyword`](AccessorKeyword.md) \| [`AsyncKeyword`](AsyncKeyword.md) \| [`ConstKeyword`](ConstKeyword.md) \| [`DeclareKeyword`](DeclareKeyword.md) \| [`DefaultKeyword`](DefaultKeyword.md) \| [`ExportKeyword`](ExportKeyword.md) \| [`InKeyword`](InKeyword.md) \| [`PrivateKeyword`](PrivateKeyword.md) \| [`ProtectedKeyword`](ProtectedKeyword.md) \| [`PublicKeyword`](PublicKeyword.md) \| [`OutKeyword`](OutKeyword.md) \| [`OverrideKeyword`](OverrideKeyword.md) \| [`ReadonlyKeyword`](ReadonlyKeyword.md) \| [`StaticKeyword`](StaticKeyword.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:663 diff --git a/docs/api_docs/namespaces/ts/type-aliases/ModifierLike.md b/docs/api_docs/namespaces/ts/type-aliases/ModifierLike.md new file mode 100644 index 0000000000000000000000000000000000000000..eba4d1133bcd5a7c8fad14d88036c3ec9bcbf3f0 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/ModifierLike.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ModifierLike + +# Type Alias: ModifierLike + +> **ModifierLike**: [`Modifier`](Modifier.md) \| [`Decorator`](../interfaces/Decorator.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:664 diff --git a/docs/api_docs/namespaces/ts/type-aliases/ModifierSyntaxKind.md b/docs/api_docs/namespaces/ts/type-aliases/ModifierSyntaxKind.md new file mode 100644 index 0000000000000000000000000000000000000000..b54d8069cda649ca8d0d46ca7c432baea4387812 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/ModifierSyntaxKind.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ModifierSyntaxKind + +# Type Alias: ModifierSyntaxKind + +> **ModifierSyntaxKind**: [`AbstractKeyword`](../enumerations/SyntaxKind.md#abstractkeyword) \| [`AccessorKeyword`](../enumerations/SyntaxKind.md#accessorkeyword) \| [`AsyncKeyword`](../enumerations/SyntaxKind.md#asynckeyword) \| [`ConstKeyword`](../enumerations/SyntaxKind.md#constkeyword) \| [`DeclareKeyword`](../enumerations/SyntaxKind.md#declarekeyword) \| [`DefaultKeyword`](../enumerations/SyntaxKind.md#defaultkeyword) \| [`ExportKeyword`](../enumerations/SyntaxKind.md#exportkeyword) \| [`InKeyword`](../enumerations/SyntaxKind.md#inkeyword) \| [`PrivateKeyword`](../enumerations/SyntaxKind.md#privatekeyword) \| [`ProtectedKeyword`](../enumerations/SyntaxKind.md#protectedkeyword) \| [`PublicKeyword`](../enumerations/SyntaxKind.md#publickeyword) \| [`ReadonlyKeyword`](../enumerations/SyntaxKind.md#readonlykeyword) \| [`OutKeyword`](../enumerations/SyntaxKind.md#outkeyword) \| [`OverrideKeyword`](../enumerations/SyntaxKind.md#overridekeyword) \| [`StaticKeyword`](../enumerations/SyntaxKind.md#statickeyword) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:510 diff --git a/docs/api_docs/namespaces/ts/type-aliases/ModifiersArray.md b/docs/api_docs/namespaces/ts/type-aliases/ModifiersArray.md new file mode 100644 index 0000000000000000000000000000000000000000..8ebe4c9e044bd37120bb00ab4b959ecf71a3cedd --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/ModifiersArray.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ModifiersArray + +# Type Alias: ModifiersArray + +> **ModifiersArray**: [`NodeArray`](../interfaces/NodeArray.md)\<[`Modifier`](Modifier.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:668 diff --git a/docs/api_docs/namespaces/ts/type-aliases/ModuleBody.md b/docs/api_docs/namespaces/ts/type-aliases/ModuleBody.md new file mode 100644 index 0000000000000000000000000000000000000000..dc52b46994cc432be8598e32b7a5f36e53613b9d --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/ModuleBody.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ModuleBody + +# Type Alias: ModuleBody + +> **ModuleBody**: [`NamespaceBody`](NamespaceBody.md) \| [`JSDocNamespaceBody`](JSDocNamespaceBody.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1675 diff --git a/docs/api_docs/namespaces/ts/type-aliases/ModuleName.md b/docs/api_docs/namespaces/ts/type-aliases/ModuleName.md new file mode 100644 index 0000000000000000000000000000000000000000..27489b8af9c2a1f1cf59cc74765a7890b23dba0f --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/ModuleName.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ModuleName + +# Type Alias: ModuleName + +> **ModuleName**: [`Identifier`](../interfaces/Identifier.md) \| [`StringLiteral`](../interfaces/StringLiteral.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1674 diff --git a/docs/api_docs/namespaces/ts/type-aliases/ModuleReference.md b/docs/api_docs/namespaces/ts/type-aliases/ModuleReference.md new file mode 100644 index 0000000000000000000000000000000000000000..829c0f66c816079f69b40fe9beb08305cd7f9360 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/ModuleReference.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ModuleReference + +# Type Alias: ModuleReference + +> **ModuleReference**: [`EntityName`](EntityName.md) \| [`ExternalModuleReference`](../interfaces/ExternalModuleReference.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1698 diff --git a/docs/api_docs/namespaces/ts/type-aliases/MultiplicativeOperator.md b/docs/api_docs/namespaces/ts/type-aliases/MultiplicativeOperator.md new file mode 100644 index 0000000000000000000000000000000000000000..22c1de9e96b2d635ab792cce9b24fdf3a716e36c --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/MultiplicativeOperator.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / MultiplicativeOperator + +# Type Alias: MultiplicativeOperator + +> **MultiplicativeOperator**: [`AsteriskToken`](../enumerations/SyntaxKind.md#asterisktoken) \| [`SlashToken`](../enumerations/SyntaxKind.md#slashtoken) \| [`PercentToken`](../enumerations/SyntaxKind.md#percenttoken) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1141 diff --git a/docs/api_docs/namespaces/ts/type-aliases/MultiplicativeOperatorOrHigher.md b/docs/api_docs/namespaces/ts/type-aliases/MultiplicativeOperatorOrHigher.md new file mode 100644 index 0000000000000000000000000000000000000000..bd5bc52df9462fad26b586ee0ff5204862749023 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/MultiplicativeOperatorOrHigher.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / MultiplicativeOperatorOrHigher + +# Type Alias: MultiplicativeOperatorOrHigher + +> **MultiplicativeOperatorOrHigher**: [`ExponentiationOperator`](ExponentiationOperator.md) \| [`MultiplicativeOperator`](MultiplicativeOperator.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1142 diff --git a/docs/api_docs/namespaces/ts/type-aliases/NamedExportBindings.md b/docs/api_docs/namespaces/ts/type-aliases/NamedExportBindings.md new file mode 100644 index 0000000000000000000000000000000000000000..b97b13dc1de17c04dbcf40b7d64a24de76a090cf --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/NamedExportBindings.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / NamedExportBindings + +# Type Alias: NamedExportBindings + +> **NamedExportBindings**: [`NamespaceExport`](../interfaces/NamespaceExport.md) \| [`NamedExports`](../interfaces/NamedExports.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1727 diff --git a/docs/api_docs/namespaces/ts/type-aliases/NamedImportBindings.md b/docs/api_docs/namespaces/ts/type-aliases/NamedImportBindings.md new file mode 100644 index 0000000000000000000000000000000000000000..21678e21eba7773ba5d605f4243b504b6d42da4f --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/NamedImportBindings.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / NamedImportBindings + +# Type Alias: NamedImportBindings + +> **NamedImportBindings**: [`NamespaceImport`](../interfaces/NamespaceImport.md) \| [`NamedImports`](../interfaces/NamedImports.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1726 diff --git a/docs/api_docs/namespaces/ts/type-aliases/NamedImportsOrExports.md b/docs/api_docs/namespaces/ts/type-aliases/NamedImportsOrExports.md new file mode 100644 index 0000000000000000000000000000000000000000..cfe1302c92c03a0825e331533d6048cfc26f6792 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/NamedImportsOrExports.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / NamedImportsOrExports + +# Type Alias: NamedImportsOrExports + +> **NamedImportsOrExports**: [`NamedImports`](../interfaces/NamedImports.md) \| [`NamedExports`](../interfaces/NamedExports.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1784 diff --git a/docs/api_docs/namespaces/ts/type-aliases/NamespaceBody.md b/docs/api_docs/namespaces/ts/type-aliases/NamespaceBody.md new file mode 100644 index 0000000000000000000000000000000000000000..08266257fa6353c0847ee41b3cfae3615501c5db --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/NamespaceBody.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / NamespaceBody + +# Type Alias: NamespaceBody + +> **NamespaceBody**: [`ModuleBlock`](../interfaces/ModuleBlock.md) \| [`NamespaceDeclaration`](../interfaces/NamespaceDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1683 diff --git a/docs/api_docs/namespaces/ts/type-aliases/ObjectBindingOrAssignmentElement.md b/docs/api_docs/namespaces/ts/type-aliases/ObjectBindingOrAssignmentElement.md new file mode 100644 index 0000000000000000000000000000000000000000..162fe59c0dbdd7e2b83ac80bcccf991441de75bf --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/ObjectBindingOrAssignmentElement.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ObjectBindingOrAssignmentElement + +# Type Alias: ObjectBindingOrAssignmentElement + +> **ObjectBindingOrAssignmentElement**: [`BindingElement`](../interfaces/BindingElement.md) \| [`PropertyAssignment`](../interfaces/PropertyAssignment.md) \| [`ShorthandPropertyAssignment`](../interfaces/ShorthandPropertyAssignment.md) \| [`SpreadAssignment`](../interfaces/SpreadAssignment.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1180 diff --git a/docs/api_docs/namespaces/ts/type-aliases/ObjectBindingOrAssignmentPattern.md b/docs/api_docs/namespaces/ts/type-aliases/ObjectBindingOrAssignmentPattern.md new file mode 100644 index 0000000000000000000000000000000000000000..e1db0ffe0687ff1a33d3d16675fe01e9244e0ea4 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/ObjectBindingOrAssignmentPattern.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ObjectBindingOrAssignmentPattern + +# Type Alias: ObjectBindingOrAssignmentPattern + +> **ObjectBindingOrAssignmentPattern**: [`ObjectBindingPattern`](../interfaces/ObjectBindingPattern.md) \| [`ObjectLiteralExpression`](../interfaces/ObjectLiteralExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1184 diff --git a/docs/api_docs/namespaces/ts/type-aliases/ObjectLiteralElementLike.md b/docs/api_docs/namespaces/ts/type-aliases/ObjectLiteralElementLike.md new file mode 100644 index 0000000000000000000000000000000000000000..cb005a71af2d9bac4dc03499df7df35211082608 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/ObjectLiteralElementLike.md @@ -0,0 +1,13 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ObjectLiteralElementLike + +# Type Alias: ObjectLiteralElementLike + +> **ObjectLiteralElementLike**: [`PropertyAssignment`](../interfaces/PropertyAssignment.md) \| [`ShorthandPropertyAssignment`](../interfaces/ShorthandPropertyAssignment.md) \| [`SpreadAssignment`](../interfaces/SpreadAssignment.md) \| [`MethodDeclaration`](../interfaces/MethodDeclaration.md) \| [`AccessorDeclaration`](AccessorDeclaration.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:802 + +Unlike ObjectLiteralElement, excludes JSXAttribute and JSXSpreadAttribute. diff --git a/docs/api_docs/namespaces/ts/type-aliases/ObjectTypeDeclaration.md b/docs/api_docs/namespaces/ts/type-aliases/ObjectTypeDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..9947648eaff6b1b5a169358784b418616bd58570 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/ObjectTypeDeclaration.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ObjectTypeDeclaration + +# Type Alias: ObjectTypeDeclaration + +> **ObjectTypeDeclaration**: [`ClassLikeDeclaration`](ClassLikeDeclaration.md) \| [`InterfaceDeclaration`](../interfaces/InterfaceDeclaration.md) \| [`TypeLiteralNode`](../interfaces/TypeLiteralNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1605 diff --git a/docs/api_docs/namespaces/ts/type-aliases/OptionalChain.md b/docs/api_docs/namespaces/ts/type-aliases/OptionalChain.md new file mode 100644 index 0000000000000000000000000000000000000000..b621470ca652f64777892b2e4eb232f4e2511aa3 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/OptionalChain.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / OptionalChain + +# Type Alias: OptionalChain + +> **OptionalChain**: [`PropertyAccessChain`](../interfaces/PropertyAccessChain.md) \| [`ElementAccessChain`](../interfaces/ElementAccessChain.md) \| [`CallChain`](../interfaces/CallChain.md) \| [`NonNullChain`](../interfaces/NonNullChain.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1346 diff --git a/docs/api_docs/namespaces/ts/type-aliases/OutKeyword.md b/docs/api_docs/namespaces/ts/type-aliases/OutKeyword.md new file mode 100644 index 0000000000000000000000000000000000000000..24c46b4f0dcbb98270b9a7424bf97dad1dc8378e --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/OutKeyword.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / OutKeyword + +# Type Alias: OutKeyword + +> **OutKeyword**: [`ModifierToken`](../interfaces/ModifierToken.md)\<[`OutKeyword`](../enumerations/SyntaxKind.md#outkeyword)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:658 diff --git a/docs/api_docs/namespaces/ts/type-aliases/OverrideKeyword.md b/docs/api_docs/namespaces/ts/type-aliases/OverrideKeyword.md new file mode 100644 index 0000000000000000000000000000000000000000..c2df872569d0b6dd9c77e1bfa3571cb3bf4dfb46 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/OverrideKeyword.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / OverrideKeyword + +# Type Alias: OverrideKeyword + +> **OverrideKeyword**: [`ModifierToken`](../interfaces/ModifierToken.md)\<[`OverrideKeyword`](../enumerations/SyntaxKind.md#overridekeyword)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:659 diff --git a/docs/api_docs/namespaces/ts/type-aliases/ParameterPropertyDeclaration.md b/docs/api_docs/namespaces/ts/type-aliases/ParameterPropertyDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..6812003bf59a4fd5db1fb03e6d048c8294bfb7a2 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/ParameterPropertyDeclaration.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ParameterPropertyDeclaration + +# Type Alias: ParameterPropertyDeclaration + +> **ParameterPropertyDeclaration**: [`ParameterDeclaration`](../interfaces/ParameterDeclaration.md) & `object` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4667 + +## Type declaration + +### name + +> **name**: [`Identifier`](../interfaces/Identifier.md) + +### parent + +> **parent**: [`ConstructorDeclaration`](../interfaces/ConstructorDeclaration.md) diff --git a/docs/api_docs/namespaces/ts/type-aliases/ParameterPropertyModifier.md b/docs/api_docs/namespaces/ts/type-aliases/ParameterPropertyModifier.md new file mode 100644 index 0000000000000000000000000000000000000000..861811cb16e760e674dd2288efd420a08a883c17 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/ParameterPropertyModifier.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ParameterPropertyModifier + +# Type Alias: ParameterPropertyModifier + +> **ParameterPropertyModifier**: [`AccessibilityModifier`](AccessibilityModifier.md) \| [`ReadonlyKeyword`](ReadonlyKeyword.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:666 diff --git a/docs/api_docs/namespaces/ts/type-aliases/Path.md b/docs/api_docs/namespaces/ts/type-aliases/Path.md new file mode 100644 index 0000000000000000000000000000000000000000..5ef3329510b3761d9165a04e2e57658c7f3d36c4 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/Path.md @@ -0,0 +1,17 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / Path + +# Type Alias: Path + +> **Path**: `string` & `object` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:94 + +## Type declaration + +### \_\_pathBrand + +> **\_\_pathBrand**: `any` diff --git a/docs/api_docs/namespaces/ts/type-aliases/PlusToken.md b/docs/api_docs/namespaces/ts/type-aliases/PlusToken.md new file mode 100644 index 0000000000000000000000000000000000000000..d746a4fc1e15d06249e56f5fe499e88a646c8d8e --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/PlusToken.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / PlusToken + +# Type Alias: PlusToken + +> **PlusToken**: [`PunctuationToken`](../interfaces/PunctuationToken.md)\<[`PlusToken`](../enumerations/SyntaxKind.md#plustoken)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:632 diff --git a/docs/api_docs/namespaces/ts/type-aliases/PostfixUnaryOperator.md b/docs/api_docs/namespaces/ts/type-aliases/PostfixUnaryOperator.md new file mode 100644 index 0000000000000000000000000000000000000000..1809e11ba68760d6e762e77009d11b232e1092e9 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/PostfixUnaryOperator.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / PostfixUnaryOperator + +# Type Alias: PostfixUnaryOperator + +> **PostfixUnaryOperator**: [`PlusPlusToken`](../enumerations/SyntaxKind.md#plusplustoken) \| [`MinusMinusToken`](../enumerations/SyntaxKind.md#minusminustoken) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1079 diff --git a/docs/api_docs/namespaces/ts/type-aliases/PrefixUnaryOperator.md b/docs/api_docs/namespaces/ts/type-aliases/PrefixUnaryOperator.md new file mode 100644 index 0000000000000000000000000000000000000000..23516396e29d6e3744b5a04b81519a450cc463a8 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/PrefixUnaryOperator.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / PrefixUnaryOperator + +# Type Alias: PrefixUnaryOperator + +> **PrefixUnaryOperator**: [`PlusPlusToken`](../enumerations/SyntaxKind.md#plusplustoken) \| [`MinusMinusToken`](../enumerations/SyntaxKind.md#minusminustoken) \| [`PlusToken`](../enumerations/SyntaxKind.md#plustoken) \| [`MinusToken`](../enumerations/SyntaxKind.md#minustoken) \| [`TildeToken`](../enumerations/SyntaxKind.md#tildetoken) \| [`ExclamationToken`](../enumerations/SyntaxKind.md#exclamationtoken) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1073 diff --git a/docs/api_docs/namespaces/ts/type-aliases/PrivateKeyword.md b/docs/api_docs/namespaces/ts/type-aliases/PrivateKeyword.md new file mode 100644 index 0000000000000000000000000000000000000000..38f3169e8fd6ce22aad9a54768920850ef8feeda --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/PrivateKeyword.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / PrivateKeyword + +# Type Alias: PrivateKeyword + +> **PrivateKeyword**: [`ModifierToken`](../interfaces/ModifierToken.md)\<[`PrivateKeyword`](../enumerations/SyntaxKind.md#privatekeyword)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:654 diff --git a/docs/api_docs/namespaces/ts/type-aliases/PropertyName.md b/docs/api_docs/namespaces/ts/type-aliases/PropertyName.md new file mode 100644 index 0000000000000000000000000000000000000000..d351c152793225f4f44f667918b8629d606fee6b --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/PropertyName.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / PropertyName + +# Type Alias: PropertyName + +> **PropertyName**: [`Identifier`](../interfaces/Identifier.md) \| [`StringLiteral`](../interfaces/StringLiteral.md) \| [`NumericLiteral`](../interfaces/NumericLiteral.md) \| [`ComputedPropertyName`](../interfaces/ComputedPropertyName.md) \| [`PrivateIdentifier`](../interfaces/PrivateIdentifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:695 diff --git a/docs/api_docs/namespaces/ts/type-aliases/PropertyNameLiteral.md b/docs/api_docs/namespaces/ts/type-aliases/PropertyNameLiteral.md new file mode 100644 index 0000000000000000000000000000000000000000..534fe0aafe70d3f2258a4e0540fdd34783c07889 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/PropertyNameLiteral.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / PropertyNameLiteral + +# Type Alias: PropertyNameLiteral + +> **PropertyNameLiteral**: [`Identifier`](../interfaces/Identifier.md) \| [`StringLiteralLike`](StringLiteralLike.md) \| [`NumericLiteral`](../interfaces/NumericLiteral.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1043 diff --git a/docs/api_docs/namespaces/ts/type-aliases/ProtectedKeyword.md b/docs/api_docs/namespaces/ts/type-aliases/ProtectedKeyword.md new file mode 100644 index 0000000000000000000000000000000000000000..e8d4e0a06f95d94c216972bac328cf354bcfc0c3 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/ProtectedKeyword.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ProtectedKeyword + +# Type Alias: ProtectedKeyword + +> **ProtectedKeyword**: [`ModifierToken`](../interfaces/ModifierToken.md)\<[`ProtectedKeyword`](../enumerations/SyntaxKind.md#protectedkeyword)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:655 diff --git a/docs/api_docs/namespaces/ts/type-aliases/PseudoLiteralSyntaxKind.md b/docs/api_docs/namespaces/ts/type-aliases/PseudoLiteralSyntaxKind.md new file mode 100644 index 0000000000000000000000000000000000000000..b36045ec43e3be19ce84b3b361662f9c7156671f --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/PseudoLiteralSyntaxKind.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / PseudoLiteralSyntaxKind + +# Type Alias: PseudoLiteralSyntaxKind + +> **PseudoLiteralSyntaxKind**: [`TemplateHead`](../enumerations/SyntaxKind.md#templatehead) \| [`TemplateMiddle`](../enumerations/SyntaxKind.md#templatemiddle) \| [`TemplateTail`](../enumerations/SyntaxKind.md#templatetail) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:507 diff --git a/docs/api_docs/namespaces/ts/type-aliases/PseudoLiteralToken.md b/docs/api_docs/namespaces/ts/type-aliases/PseudoLiteralToken.md new file mode 100644 index 0000000000000000000000000000000000000000..ce193ee81a9c805a383c9a13b354d5cdd58c9031 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/PseudoLiteralToken.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / PseudoLiteralToken + +# Type Alias: PseudoLiteralToken + +> **PseudoLiteralToken**: [`TemplateHead`](../interfaces/TemplateHead.md) \| [`TemplateMiddle`](../interfaces/TemplateMiddle.md) \| [`TemplateTail`](../interfaces/TemplateTail.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1262 diff --git a/docs/api_docs/namespaces/ts/type-aliases/PublicKeyword.md b/docs/api_docs/namespaces/ts/type-aliases/PublicKeyword.md new file mode 100644 index 0000000000000000000000000000000000000000..7894273d56c93676713535ccfde11557f66f67f4 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/PublicKeyword.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / PublicKeyword + +# Type Alias: PublicKeyword + +> **PublicKeyword**: [`ModifierToken`](../interfaces/ModifierToken.md)\<[`PublicKeyword`](../enumerations/SyntaxKind.md#publickeyword)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:656 diff --git a/docs/api_docs/namespaces/ts/type-aliases/PunctuationSyntaxKind.md b/docs/api_docs/namespaces/ts/type-aliases/PunctuationSyntaxKind.md new file mode 100644 index 0000000000000000000000000000000000000000..fa8a3a64e23e5abf71d9c2b4c397dc50f248c9a3 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/PunctuationSyntaxKind.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / PunctuationSyntaxKind + +# Type Alias: PunctuationSyntaxKind + +> **PunctuationSyntaxKind**: [`OpenBraceToken`](../enumerations/SyntaxKind.md#openbracetoken) \| [`CloseBraceToken`](../enumerations/SyntaxKind.md#closebracetoken) \| [`OpenParenToken`](../enumerations/SyntaxKind.md#openparentoken) \| [`CloseParenToken`](../enumerations/SyntaxKind.md#closeparentoken) \| [`OpenBracketToken`](../enumerations/SyntaxKind.md#openbrackettoken) \| [`CloseBracketToken`](../enumerations/SyntaxKind.md#closebrackettoken) \| [`DotToken`](../enumerations/SyntaxKind.md#dottoken) \| [`DotDotDotToken`](../enumerations/SyntaxKind.md#dotdotdottoken) \| [`SemicolonToken`](../enumerations/SyntaxKind.md#semicolontoken) \| [`CommaToken`](../enumerations/SyntaxKind.md#commatoken) \| [`QuestionDotToken`](../enumerations/SyntaxKind.md#questiondottoken) \| [`LessThanToken`](../enumerations/SyntaxKind.md#lessthantoken) \| [`LessThanSlashToken`](../enumerations/SyntaxKind.md#lessthanslashtoken) \| [`GreaterThanToken`](../enumerations/SyntaxKind.md#greaterthantoken) \| [`LessThanEqualsToken`](../enumerations/SyntaxKind.md#lessthanequalstoken) \| [`GreaterThanEqualsToken`](../enumerations/SyntaxKind.md#greaterthanequalstoken) \| [`EqualsEqualsToken`](../enumerations/SyntaxKind.md#equalsequalstoken) \| [`ExclamationEqualsToken`](../enumerations/SyntaxKind.md#exclamationequalstoken) \| [`EqualsEqualsEqualsToken`](../enumerations/SyntaxKind.md#equalsequalsequalstoken) \| [`ExclamationEqualsEqualsToken`](../enumerations/SyntaxKind.md#exclamationequalsequalstoken) \| [`EqualsGreaterThanToken`](../enumerations/SyntaxKind.md#equalsgreaterthantoken) \| [`PlusToken`](../enumerations/SyntaxKind.md#plustoken) \| [`MinusToken`](../enumerations/SyntaxKind.md#minustoken) \| [`AsteriskToken`](../enumerations/SyntaxKind.md#asterisktoken) \| [`AsteriskAsteriskToken`](../enumerations/SyntaxKind.md#asteriskasterisktoken) \| [`SlashToken`](../enumerations/SyntaxKind.md#slashtoken) \| [`PercentToken`](../enumerations/SyntaxKind.md#percenttoken) \| [`PlusPlusToken`](../enumerations/SyntaxKind.md#plusplustoken) \| [`MinusMinusToken`](../enumerations/SyntaxKind.md#minusminustoken) \| [`LessThanLessThanToken`](../enumerations/SyntaxKind.md#lessthanlessthantoken) \| [`GreaterThanGreaterThanToken`](../enumerations/SyntaxKind.md#greaterthangreaterthantoken) \| [`GreaterThanGreaterThanGreaterThanToken`](../enumerations/SyntaxKind.md#greaterthangreaterthangreaterthantoken) \| [`AmpersandToken`](../enumerations/SyntaxKind.md#ampersandtoken) \| [`BarToken`](../enumerations/SyntaxKind.md#bartoken) \| [`CaretToken`](../enumerations/SyntaxKind.md#carettoken) \| [`ExclamationToken`](../enumerations/SyntaxKind.md#exclamationtoken) \| [`TildeToken`](../enumerations/SyntaxKind.md#tildetoken) \| [`AmpersandAmpersandToken`](../enumerations/SyntaxKind.md#ampersandampersandtoken) \| [`BarBarToken`](../enumerations/SyntaxKind.md#barbartoken) \| [`QuestionQuestionToken`](../enumerations/SyntaxKind.md#questionquestiontoken) \| [`QuestionToken`](../enumerations/SyntaxKind.md#questiontoken) \| [`ColonToken`](../enumerations/SyntaxKind.md#colontoken) \| [`AtToken`](../enumerations/SyntaxKind.md#attoken) \| [`BacktickToken`](../enumerations/SyntaxKind.md#backticktoken) \| [`HashToken`](../enumerations/SyntaxKind.md#hashtoken) \| [`EqualsToken`](../enumerations/SyntaxKind.md#equalstoken) \| [`PlusEqualsToken`](../enumerations/SyntaxKind.md#plusequalstoken) \| [`MinusEqualsToken`](../enumerations/SyntaxKind.md#minusequalstoken) \| [`AsteriskEqualsToken`](../enumerations/SyntaxKind.md#asteriskequalstoken) \| [`AsteriskAsteriskEqualsToken`](../enumerations/SyntaxKind.md#asteriskasteriskequalstoken) \| [`SlashEqualsToken`](../enumerations/SyntaxKind.md#slashequalstoken) \| [`PercentEqualsToken`](../enumerations/SyntaxKind.md#percentequalstoken) \| [`LessThanLessThanEqualsToken`](../enumerations/SyntaxKind.md#lessthanlessthanequalstoken) \| [`GreaterThanGreaterThanEqualsToken`](../enumerations/SyntaxKind.md#greaterthangreaterthanequalstoken) \| [`GreaterThanGreaterThanGreaterThanEqualsToken`](../enumerations/SyntaxKind.md#greaterthangreaterthangreaterthanequalstoken) \| [`AmpersandEqualsToken`](../enumerations/SyntaxKind.md#ampersandequalstoken) \| [`BarEqualsToken`](../enumerations/SyntaxKind.md#barequalstoken) \| [`CaretEqualsToken`](../enumerations/SyntaxKind.md#caretequalstoken) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:508 diff --git a/docs/api_docs/namespaces/ts/type-aliases/QuestionDotToken.md b/docs/api_docs/namespaces/ts/type-aliases/QuestionDotToken.md new file mode 100644 index 0000000000000000000000000000000000000000..a6adceb8d9b5b0dad1289de288409ace7e866578 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/QuestionDotToken.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / QuestionDotToken + +# Type Alias: QuestionDotToken + +> **QuestionDotToken**: [`PunctuationToken`](../interfaces/PunctuationToken.md)\<[`QuestionDotToken`](../enumerations/SyntaxKind.md#questiondottoken)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:634 diff --git a/docs/api_docs/namespaces/ts/type-aliases/QuestionToken.md b/docs/api_docs/namespaces/ts/type-aliases/QuestionToken.md new file mode 100644 index 0000000000000000000000000000000000000000..04b90caccfcbd4f4fa0053bd05814da250f7b718 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/QuestionToken.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / QuestionToken + +# Type Alias: QuestionToken + +> **QuestionToken**: [`PunctuationToken`](../interfaces/PunctuationToken.md)\<[`QuestionToken`](../enumerations/SyntaxKind.md#questiontoken)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:626 diff --git a/docs/api_docs/namespaces/ts/type-aliases/ReadonlyKeyword.md b/docs/api_docs/namespaces/ts/type-aliases/ReadonlyKeyword.md new file mode 100644 index 0000000000000000000000000000000000000000..a74599546ff916dc35a43c7073728aae12aef28d --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/ReadonlyKeyword.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ReadonlyKeyword + +# Type Alias: ReadonlyKeyword + +> **ReadonlyKeyword**: [`ModifierToken`](../interfaces/ModifierToken.md)\<[`ReadonlyKeyword`](../enumerations/SyntaxKind.md#readonlykeyword)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:657 diff --git a/docs/api_docs/namespaces/ts/type-aliases/ReadonlyToken.md b/docs/api_docs/namespaces/ts/type-aliases/ReadonlyToken.md new file mode 100644 index 0000000000000000000000000000000000000000..a44ee4d9604cb3f2fe3ef04c3e2fb04268c5c89c --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/ReadonlyToken.md @@ -0,0 +1,15 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ReadonlyToken + +# Type Alias: ~~ReadonlyToken~~ + +> **ReadonlyToken**: [`ReadonlyKeyword`](ReadonlyKeyword.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:662 + +## Deprecated + +Use `ReadonlyKeyword` instead. diff --git a/docs/api_docs/namespaces/ts/type-aliases/RedirectTargetsMap.md b/docs/api_docs/namespaces/ts/type-aliases/RedirectTargetsMap.md new file mode 100644 index 0000000000000000000000000000000000000000..b6be2309bd3bec7b298061a4349d3890a48fd024 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/RedirectTargetsMap.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / RedirectTargetsMap + +# Type Alias: RedirectTargetsMap + +> **RedirectTargetsMap**: [`ReadonlyESMap`](../interfaces/ReadonlyESMap.md)\<[`Path`](Path.md), readonly `string`[]\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2335 diff --git a/docs/api_docs/namespaces/ts/type-aliases/RefactorTriggerReason.md b/docs/api_docs/namespaces/ts/type-aliases/RefactorTriggerReason.md new file mode 100644 index 0000000000000000000000000000000000000000..4bdf334fc955b58fc0deea5e53b65e20da478b10 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/RefactorTriggerReason.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / RefactorTriggerReason + +# Type Alias: RefactorTriggerReason + +> **RefactorTriggerReason**: `"implicit"` \| `"invoked"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6694 diff --git a/docs/api_docs/namespaces/ts/type-aliases/RelationalOperator.md b/docs/api_docs/namespaces/ts/type-aliases/RelationalOperator.md new file mode 100644 index 0000000000000000000000000000000000000000..62eca4c2d48e590388208782044343917a6e7eeb --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/RelationalOperator.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / RelationalOperator + +# Type Alias: RelationalOperator + +> **RelationalOperator**: [`LessThanToken`](../enumerations/SyntaxKind.md#lessthantoken) \| [`LessThanEqualsToken`](../enumerations/SyntaxKind.md#lessthanequalstoken) \| [`GreaterThanToken`](../enumerations/SyntaxKind.md#greaterthantoken) \| [`GreaterThanEqualsToken`](../enumerations/SyntaxKind.md#greaterthanequalstoken) \| [`InstanceOfKeyword`](../enumerations/SyntaxKind.md#instanceofkeyword) \| [`InKeyword`](../enumerations/SyntaxKind.md#inkeyword) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1147 diff --git a/docs/api_docs/namespaces/ts/type-aliases/RelationalOperatorOrHigher.md b/docs/api_docs/namespaces/ts/type-aliases/RelationalOperatorOrHigher.md new file mode 100644 index 0000000000000000000000000000000000000000..8749a5580f00ed9a2469d810e25f3ef7f516988f --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/RelationalOperatorOrHigher.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / RelationalOperatorOrHigher + +# Type Alias: RelationalOperatorOrHigher + +> **RelationalOperatorOrHigher**: [`ShiftOperatorOrHigher`](ShiftOperatorOrHigher.md) \| [`RelationalOperator`](RelationalOperator.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1148 diff --git a/docs/api_docs/namespaces/ts/type-aliases/RenameInfo.md b/docs/api_docs/namespaces/ts/type-aliases/RenameInfo.md new file mode 100644 index 0000000000000000000000000000000000000000..b45e85c62f3de00043bb365d630b32836a946797 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/RenameInfo.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / RenameInfo + +# Type Alias: RenameInfo + +> **RenameInfo**: [`RenameInfoSuccess`](../interfaces/RenameInfoSuccess.md) \| [`RenameInfoFailure`](../interfaces/RenameInfoFailure.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6889 diff --git a/docs/api_docs/namespaces/ts/type-aliases/ReportEmitErrorSummary.md b/docs/api_docs/namespaces/ts/type-aliases/ReportEmitErrorSummary.md new file mode 100644 index 0000000000000000000000000000000000000000..68f309462826cecfbd5d4aad4cd6de756dac8b61 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/ReportEmitErrorSummary.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ReportEmitErrorSummary + +# Type Alias: ReportEmitErrorSummary() + +> **ReportEmitErrorSummary**: (`errorCount`, `filesInError`) => `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5930 + +## Parameters + +### errorCount + +`number` + +### filesInError + +([`ReportFileInError`](../interfaces/ReportFileInError.md) \| `undefined`)[] + +## Returns + +`void` diff --git a/docs/api_docs/namespaces/ts/type-aliases/ResolvedConfigFileName.md b/docs/api_docs/namespaces/ts/type-aliases/ResolvedConfigFileName.md new file mode 100644 index 0000000000000000000000000000000000000000..7db74c688e8f9560fc36316eb42ff5c266264976 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/ResolvedConfigFileName.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ResolvedConfigFileName + +# Type Alias: ResolvedConfigFileName + +> **ResolvedConfigFileName**: `string` & `object` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2252 + +Branded string for keeping track of when we've turned an ambiguous path +specified like "./blah" to an absolute path to an actual +tsconfig file, e.g. "/root/blah/tsconfig.json" + +## Type declaration + +### \_isResolvedConfigFileName + +> **\_isResolvedConfigFileName**: `never` diff --git a/docs/api_docs/namespaces/ts/type-aliases/ShiftOperator.md b/docs/api_docs/namespaces/ts/type-aliases/ShiftOperator.md new file mode 100644 index 0000000000000000000000000000000000000000..1d8f2461894bc28b5fe4152825bfdd842f9427fc --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/ShiftOperator.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ShiftOperator + +# Type Alias: ShiftOperator + +> **ShiftOperator**: [`LessThanLessThanToken`](../enumerations/SyntaxKind.md#lessthanlessthantoken) \| [`GreaterThanGreaterThanToken`](../enumerations/SyntaxKind.md#greaterthangreaterthantoken) \| [`GreaterThanGreaterThanGreaterThanToken`](../enumerations/SyntaxKind.md#greaterthangreaterthangreaterthantoken) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1145 diff --git a/docs/api_docs/namespaces/ts/type-aliases/ShiftOperatorOrHigher.md b/docs/api_docs/namespaces/ts/type-aliases/ShiftOperatorOrHigher.md new file mode 100644 index 0000000000000000000000000000000000000000..aa63527aafc68b636f8a041b51c980caa1418745 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/ShiftOperatorOrHigher.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ShiftOperatorOrHigher + +# Type Alias: ShiftOperatorOrHigher + +> **ShiftOperatorOrHigher**: [`AdditiveOperatorOrHigher`](AdditiveOperatorOrHigher.md) \| [`ShiftOperator`](ShiftOperator.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1146 diff --git a/docs/api_docs/namespaces/ts/type-aliases/SignatureDeclaration.md b/docs/api_docs/namespaces/ts/type-aliases/SignatureDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..3ded719cdaa0b035e7d81c9db2dd8a889ebb3d67 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/SignatureDeclaration.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / SignatureDeclaration + +# Type Alias: SignatureDeclaration + +> **SignatureDeclaration**: [`CallSignatureDeclaration`](../interfaces/CallSignatureDeclaration.md) \| [`ConstructSignatureDeclaration`](../interfaces/ConstructSignatureDeclaration.md) \| [`MethodSignature`](../interfaces/MethodSignature.md) \| [`IndexSignatureDeclaration`](../interfaces/IndexSignatureDeclaration.md) \| [`FunctionTypeNode`](../interfaces/FunctionTypeNode.md) \| [`ConstructorTypeNode`](../interfaces/ConstructorTypeNode.md) \| [`JSDocFunctionType`](../interfaces/JSDocFunctionType.md) \| [`FunctionDeclaration`](../interfaces/FunctionDeclaration.md) \| [`MethodDeclaration`](../interfaces/MethodDeclaration.md) \| [`ConstructorDeclaration`](../interfaces/ConstructorDeclaration.md) \| [`AccessorDeclaration`](AccessorDeclaration.md) \| [`FunctionExpression`](../interfaces/FunctionExpression.md) \| [`ArrowFunction`](../interfaces/ArrowFunction.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:738 diff --git a/docs/api_docs/namespaces/ts/type-aliases/SignatureHelpRetriggerCharacter.md b/docs/api_docs/namespaces/ts/type-aliases/SignatureHelpRetriggerCharacter.md new file mode 100644 index 0000000000000000000000000000000000000000..368879036bb76069af9c9917e902fdce9983f755 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/SignatureHelpRetriggerCharacter.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / SignatureHelpRetriggerCharacter + +# Type Alias: SignatureHelpRetriggerCharacter + +> **SignatureHelpRetriggerCharacter**: [`SignatureHelpTriggerCharacter`](SignatureHelpTriggerCharacter.md) \| `")"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6474 diff --git a/docs/api_docs/namespaces/ts/type-aliases/SignatureHelpTriggerCharacter.md b/docs/api_docs/namespaces/ts/type-aliases/SignatureHelpTriggerCharacter.md new file mode 100644 index 0000000000000000000000000000000000000000..5b49ad542abf9364859aed83401d56dc41920da7 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/SignatureHelpTriggerCharacter.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / SignatureHelpTriggerCharacter + +# Type Alias: SignatureHelpTriggerCharacter + +> **SignatureHelpTriggerCharacter**: `","` \| `"("` \| `"<"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6473 diff --git a/docs/api_docs/namespaces/ts/type-aliases/SignatureHelpTriggerReason.md b/docs/api_docs/namespaces/ts/type-aliases/SignatureHelpTriggerReason.md new file mode 100644 index 0000000000000000000000000000000000000000..4b97671c97feae9115510475f84b219e3ddfb73b --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/SignatureHelpTriggerReason.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / SignatureHelpTriggerReason + +# Type Alias: SignatureHelpTriggerReason + +> **SignatureHelpTriggerReason**: [`SignatureHelpInvokedReason`](../interfaces/SignatureHelpInvokedReason.md) \| [`SignatureHelpCharacterTypedReason`](../interfaces/SignatureHelpCharacterTypedReason.md) \| [`SignatureHelpRetriggeredReason`](../interfaces/SignatureHelpRetriggeredReason.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6478 diff --git a/docs/api_docs/namespaces/ts/type-aliases/StaticKeyword.md b/docs/api_docs/namespaces/ts/type-aliases/StaticKeyword.md new file mode 100644 index 0000000000000000000000000000000000000000..c02cdc34b49230c15c34ad6095aa6738b86ed3ff --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/StaticKeyword.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / StaticKeyword + +# Type Alias: StaticKeyword + +> **StaticKeyword**: [`ModifierToken`](../interfaces/ModifierToken.md)\<[`StaticKeyword`](../enumerations/SyntaxKind.md#statickeyword)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:660 diff --git a/docs/api_docs/namespaces/ts/type-aliases/String.md b/docs/api_docs/namespaces/ts/type-aliases/String.md new file mode 100644 index 0000000000000000000000000000000000000000..426c1c6b9caeb46512fddabd6a9edb4bb5dd00dd --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/String.md @@ -0,0 +1,18 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / \_\_String + +# Type Alias: \_\_String + +> **\_\_String**: `string` & `object` \| `void` & `object` \| [`InternalSymbolName`](../enumerations/InternalSymbolName.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2705 + +This represents a string whose leading underscore have been escaped by adding extra leading underscores. +The shape of this brand is rather unique compared to others we've used. +Instead of just an intersection of a string and an object, it is that union-ed +with an intersection of void and an object. This makes it wholly incompatible +with a normal string (which is good, it cannot be misused on assignment or on usage), +while still being comparable with a normal string via === (also good) and castable from a string. diff --git a/docs/api_docs/namespaces/ts/type-aliases/StringLiteralLike.md b/docs/api_docs/namespaces/ts/type-aliases/StringLiteralLike.md new file mode 100644 index 0000000000000000000000000000000000000000..a517fb623d082380264654075c258486a024c29c --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/StringLiteralLike.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / StringLiteralLike + +# Type Alias: StringLiteralLike + +> **StringLiteralLike**: [`StringLiteral`](../interfaces/StringLiteral.md) \| [`NoSubstitutionTemplateLiteral`](../interfaces/NoSubstitutionTemplateLiteral.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1042 diff --git a/docs/api_docs/namespaces/ts/type-aliases/StructuredType.md b/docs/api_docs/namespaces/ts/type-aliases/StructuredType.md new file mode 100644 index 0000000000000000000000000000000000000000..4417f579659f456c9a3b5d0b2d4b7a2be1899ba0 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/StructuredType.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / StructuredType + +# Type Alias: StructuredType + +> **StructuredType**: [`ObjectType`](../interfaces/ObjectType.md) \| [`UnionType`](../interfaces/UnionType.md) \| [`IntersectionType`](../interfaces/IntersectionType.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2881 diff --git a/docs/api_docs/namespaces/ts/type-aliases/SuperProperty.md b/docs/api_docs/namespaces/ts/type-aliases/SuperProperty.md new file mode 100644 index 0000000000000000000000000000000000000000..92460193135e4f4ffc1668192f52ab3bb3906e21 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/SuperProperty.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / SuperProperty + +# Type Alias: SuperProperty + +> **SuperProperty**: [`SuperPropertyAccessExpression`](../interfaces/SuperPropertyAccessExpression.md) \| [`SuperElementAccessExpression`](../interfaces/SuperElementAccessExpression.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1335 diff --git a/docs/api_docs/namespaces/ts/type-aliases/SymbolTable.md b/docs/api_docs/namespaces/ts/type-aliases/SymbolTable.md new file mode 100644 index 0000000000000000000000000000000000000000..9d344ebe219a7587e2327bfcb169d72897d0fbbb --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/SymbolTable.md @@ -0,0 +1,13 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / SymbolTable + +# Type Alias: SymbolTable + +> **SymbolTable**: [`UnderscoreEscapedMap`](../interfaces/UnderscoreEscapedMap.md)\<[`Symbol`](../interfaces/Symbol.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2717 + +SymbolTable based on ES6 Map interface. diff --git a/docs/api_docs/namespaces/ts/type-aliases/TemplateLiteral.md b/docs/api_docs/namespaces/ts/type-aliases/TemplateLiteral.md new file mode 100644 index 0000000000000000000000000000000000000000..4087423480cd6029a96dfe6adf41c144bb9fb88e --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/TemplateLiteral.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TemplateLiteral + +# Type Alias: TemplateLiteral + +> **TemplateLiteral**: [`TemplateExpression`](../interfaces/TemplateExpression.md) \| [`NoSubstitutionTemplateLiteral`](../interfaces/NoSubstitutionTemplateLiteral.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1269 diff --git a/docs/api_docs/namespaces/ts/type-aliases/TemplateLiteralToken.md b/docs/api_docs/namespaces/ts/type-aliases/TemplateLiteralToken.md new file mode 100644 index 0000000000000000000000000000000000000000..fec5a35102eb33f50e83bfd13e01dd28a9384c4d --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/TemplateLiteralToken.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TemplateLiteralToken + +# Type Alias: TemplateLiteralToken + +> **TemplateLiteralToken**: [`NoSubstitutionTemplateLiteral`](../interfaces/NoSubstitutionTemplateLiteral.md) \| [`PseudoLiteralToken`](PseudoLiteralToken.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1263 diff --git a/docs/api_docs/namespaces/ts/type-aliases/TokenSyntaxKind.md b/docs/api_docs/namespaces/ts/type-aliases/TokenSyntaxKind.md new file mode 100644 index 0000000000000000000000000000000000000000..fdc062d6614521c9b8b8fb41e160744520de2fa9 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/TokenSyntaxKind.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TokenSyntaxKind + +# Type Alias: TokenSyntaxKind + +> **TokenSyntaxKind**: [`Unknown`](../enumerations/SyntaxKind.md#unknown) \| [`EndOfFileToken`](../enumerations/SyntaxKind.md#endoffiletoken) \| [`TriviaSyntaxKind`](TriviaSyntaxKind.md) \| [`LiteralSyntaxKind`](LiteralSyntaxKind.md) \| [`PseudoLiteralSyntaxKind`](PseudoLiteralSyntaxKind.md) \| [`PunctuationSyntaxKind`](PunctuationSyntaxKind.md) \| [`Identifier`](../enumerations/SyntaxKind.md#identifier) \| [`KeywordSyntaxKind`](KeywordSyntaxKind.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:512 diff --git a/docs/api_docs/namespaces/ts/type-aliases/Transformer.md b/docs/api_docs/namespaces/ts/type-aliases/Transformer.md new file mode 100644 index 0000000000000000000000000000000000000000..5dd695fbe6916a6dd3803f8e0b0669ab7ca654e8 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/Transformer.md @@ -0,0 +1,27 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / Transformer + +# Type Alias: Transformer()\ + +> **Transformer**\<`T`\>: (`node`) => `T` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4172 + +A function that transforms a node. + +## Type Parameters + +• **T** *extends* [`Node`](../interfaces/Node.md) + +## Parameters + +### node + +`T` + +## Returns + +`T` diff --git a/docs/api_docs/namespaces/ts/type-aliases/TransformerFactory.md b/docs/api_docs/namespaces/ts/type-aliases/TransformerFactory.md new file mode 100644 index 0000000000000000000000000000000000000000..4f0207e2424416e350d5423f3d5b86ce7d02db17 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/TransformerFactory.md @@ -0,0 +1,28 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TransformerFactory + +# Type Alias: TransformerFactory()\ + +> **TransformerFactory**\<`T`\>: (`context`) => [`Transformer`](Transformer.md)\<`T`\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4168 + +A function that is used to initialize and return a `Transformer` callback, which in turn +will be used to transform one or more nodes. + +## Type Parameters + +• **T** *extends* [`Node`](../interfaces/Node.md) + +## Parameters + +### context + +[`TransformationContext`](../interfaces/TransformationContext.md) + +## Returns + +[`Transformer`](Transformer.md)\<`T`\> diff --git a/docs/api_docs/namespaces/ts/type-aliases/TriviaSyntaxKind.md b/docs/api_docs/namespaces/ts/type-aliases/TriviaSyntaxKind.md new file mode 100644 index 0000000000000000000000000000000000000000..2a53ca1fd8fb2631703296ed85672ee6c4029ac5 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/TriviaSyntaxKind.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TriviaSyntaxKind + +# Type Alias: TriviaSyntaxKind + +> **TriviaSyntaxKind**: [`SingleLineCommentTrivia`](../enumerations/SyntaxKind.md#singlelinecommenttrivia) \| [`MultiLineCommentTrivia`](../enumerations/SyntaxKind.md#multilinecommenttrivia) \| [`NewLineTrivia`](../enumerations/SyntaxKind.md#newlinetrivia) \| [`WhitespaceTrivia`](../enumerations/SyntaxKind.md#whitespacetrivia) \| [`ShebangTrivia`](../enumerations/SyntaxKind.md#shebangtrivia) \| [`ConflictMarkerTrivia`](../enumerations/SyntaxKind.md#conflictmarkertrivia) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:505 diff --git a/docs/api_docs/namespaces/ts/type-aliases/TypeOfTag.md b/docs/api_docs/namespaces/ts/type-aliases/TypeOfTag.md new file mode 100644 index 0000000000000000000000000000000000000000..bd6ee83854b20c6768e03780cf86b4b5881a4780 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/TypeOfTag.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TypeOfTag + +# Type Alias: TypeOfTag + +> **TypeOfTag**: `"undefined"` \| `"number"` \| `"bigint"` \| `"boolean"` \| `"string"` \| `"symbol"` \| `"object"` \| `"function"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:3608 diff --git a/docs/api_docs/namespaces/ts/type-aliases/TypeOnlyAliasDeclaration.md b/docs/api_docs/namespaces/ts/type-aliases/TypeOnlyAliasDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..6f71cf09e3a36cad8be7bf82bedd735a50c8d63f --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/TypeOnlyAliasDeclaration.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TypeOnlyAliasDeclaration + +# Type Alias: TypeOnlyAliasDeclaration + +> **TypeOnlyAliasDeclaration**: [`ImportClause`](../interfaces/ImportClause.md) & `object` \| [`ImportEqualsDeclaration`](../interfaces/ImportEqualsDeclaration.md) & `object` \| [`NamespaceImport`](../interfaces/NamespaceImport.md) & `object` \| [`ImportSpecifier`](../interfaces/ImportSpecifier.md) & \{ `isTypeOnly`: `true`; \} \| \{ `parent`: [`NamedImports`](../interfaces/NamedImports.md) & `object`; \} \| [`ExportSpecifier`](../interfaces/ExportSpecifier.md) & \{ `isTypeOnly`: `true`; \} \| \{ `parent`: [`NamedExports`](../interfaces/NamedExports.md) & `object`; \} + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1801 diff --git a/docs/api_docs/namespaces/ts/type-aliases/TypeOnlyCompatibleAliasDeclaration.md b/docs/api_docs/namespaces/ts/type-aliases/TypeOnlyCompatibleAliasDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..5df92deeca2259c8db38220fda76c603a20146b3 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/TypeOnlyCompatibleAliasDeclaration.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TypeOnlyCompatibleAliasDeclaration + +# Type Alias: TypeOnlyCompatibleAliasDeclaration + +> **TypeOnlyCompatibleAliasDeclaration**: [`ImportClause`](../interfaces/ImportClause.md) \| [`ImportEqualsDeclaration`](../interfaces/ImportEqualsDeclaration.md) \| [`NamespaceImport`](../interfaces/NamespaceImport.md) \| [`ImportOrExportSpecifier`](ImportOrExportSpecifier.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:1800 diff --git a/docs/api_docs/namespaces/ts/type-aliases/TypePredicate.md b/docs/api_docs/namespaces/ts/type-aliases/TypePredicate.md new file mode 100644 index 0000000000000000000000000000000000000000..fad271573595d03ca240901a2fdf3c83b0143360 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/TypePredicate.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TypePredicate + +# Type Alias: TypePredicate + +> **TypePredicate**: [`ThisTypePredicate`](../interfaces/ThisTypePredicate.md) \| [`IdentifierTypePredicate`](../interfaces/IdentifierTypePredicate.md) \| [`AssertsThisTypePredicate`](../interfaces/AssertsThisTypePredicate.md) \| [`AssertsIdentifierTypePredicate`](../interfaces/AssertsIdentifierTypePredicate.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2605 diff --git a/docs/api_docs/namespaces/ts/type-aliases/TypeReferenceType.md b/docs/api_docs/namespaces/ts/type-aliases/TypeReferenceType.md new file mode 100644 index 0000000000000000000000000000000000000000..d7c70e1dfb34d4212444d4c6bfd1a3711265906c --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/TypeReferenceType.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TypeReferenceType + +# Type Alias: TypeReferenceType + +> **TypeReferenceType**: [`TypeReferenceNode`](../interfaces/TypeReferenceNode.md) \| [`ExpressionWithTypeArguments`](../interfaces/ExpressionWithTypeArguments.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:948 diff --git a/docs/api_docs/namespaces/ts/type-aliases/TypeVariable.md b/docs/api_docs/namespaces/ts/type-aliases/TypeVariable.md new file mode 100644 index 0000000000000000000000000000000000000000..130224169c953f740e28720cace4fb2f2ad8c2ce --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/TypeVariable.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / TypeVariable + +# Type Alias: TypeVariable + +> **TypeVariable**: [`TypeParameter`](../interfaces/TypeParameter.md) \| [`IndexedAccessType`](../interfaces/IndexedAccessType.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2897 diff --git a/docs/api_docs/namespaces/ts/type-aliases/UnionOrIntersectionTypeNode.md b/docs/api_docs/namespaces/ts/type-aliases/UnionOrIntersectionTypeNode.md new file mode 100644 index 0000000000000000000000000000000000000000..fb5eab29de0eb8daa7ef137c0a081171158c3db1 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/UnionOrIntersectionTypeNode.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / UnionOrIntersectionTypeNode + +# Type Alias: UnionOrIntersectionTypeNode + +> **UnionOrIntersectionTypeNode**: [`UnionTypeNode`](../interfaces/UnionTypeNode.md) \| [`IntersectionTypeNode`](../interfaces/IntersectionTypeNode.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:991 diff --git a/docs/api_docs/namespaces/ts/type-aliases/UnparsedNode.md b/docs/api_docs/namespaces/ts/type-aliases/UnparsedNode.md new file mode 100644 index 0000000000000000000000000000000000000000..24cd4fb5e30c965036c44b1f6d8d075f908e3a89 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/UnparsedNode.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / UnparsedNode + +# Type Alias: UnparsedNode + +> **UnparsedNode**: [`UnparsedPrologue`](../interfaces/UnparsedPrologue.md) \| [`UnparsedSourceText`](UnparsedSourceText.md) \| [`UnparsedSyntheticReference`](../interfaces/UnparsedSyntheticReference.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2190 diff --git a/docs/api_docs/namespaces/ts/type-aliases/UnparsedSourceText.md b/docs/api_docs/namespaces/ts/type-aliases/UnparsedSourceText.md new file mode 100644 index 0000000000000000000000000000000000000000..0544f8e71e8c484081eac5c80dc067b187e4af94 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/UnparsedSourceText.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / UnparsedSourceText + +# Type Alias: UnparsedSourceText + +> **UnparsedSourceText**: [`UnparsedPrepend`](../interfaces/UnparsedPrepend.md) \| [`UnparsedTextLike`](../interfaces/UnparsedTextLike.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2189 diff --git a/docs/api_docs/namespaces/ts/type-aliases/VariableLikeDeclaration.md b/docs/api_docs/namespaces/ts/type-aliases/VariableLikeDeclaration.md new file mode 100644 index 0000000000000000000000000000000000000000..5f3a15a3892c813ea0ac014cde31680273d9ef1e --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/VariableLikeDeclaration.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / VariableLikeDeclaration + +# Type Alias: VariableLikeDeclaration + +> **VariableLikeDeclaration**: [`VariableDeclaration`](../interfaces/VariableDeclaration.md) \| [`ParameterDeclaration`](../interfaces/ParameterDeclaration.md) \| [`BindingElement`](../interfaces/BindingElement.md) \| [`PropertyDeclaration`](../interfaces/PropertyDeclaration.md) \| [`PropertyAssignment`](../interfaces/PropertyAssignment.md) \| [`PropertySignature`](../interfaces/PropertySignature.md) \| [`JsxAttribute`](../interfaces/JsxAttribute.md) \| [`ShorthandPropertyAssignment`](../interfaces/ShorthandPropertyAssignment.md) \| [`EnumMember`](../interfaces/EnumMember.md) \| [`JSDocPropertyTag`](../interfaces/JSDocPropertyTag.md) \| [`JSDocParameterTag`](../interfaces/JSDocParameterTag.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:821 diff --git a/docs/api_docs/namespaces/ts/type-aliases/VisitResult.md b/docs/api_docs/namespaces/ts/type-aliases/VisitResult.md new file mode 100644 index 0000000000000000000000000000000000000000..e4eb057dfcdae83b2f5af14fcb981b455856bf50 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/VisitResult.md @@ -0,0 +1,15 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / VisitResult + +# Type Alias: VisitResult\ + +> **VisitResult**\<`T`\>: `T` \| readonly `T`[] \| `undefined` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4185 + +## Type Parameters + +• **T** *extends* [`Node`](../interfaces/Node.md) diff --git a/docs/api_docs/namespaces/ts/type-aliases/Visitor.md b/docs/api_docs/namespaces/ts/type-aliases/Visitor.md new file mode 100644 index 0000000000000000000000000000000000000000..c88478f073b2827cf2f5f49fad8d6d127e9efbc5 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/Visitor.md @@ -0,0 +1,23 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / Visitor + +# Type Alias: Visitor() + +> **Visitor**: (`node`) => [`VisitResult`](VisitResult.md)\<[`Node`](../interfaces/Node.md)\> + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4176 + +A function that accepts and possibly transforms a node. + +## Parameters + +### node + +[`Node`](../interfaces/Node.md) + +## Returns + +[`VisitResult`](VisitResult.md)\<[`Node`](../interfaces/Node.md)\> diff --git a/docs/api_docs/namespaces/ts/type-aliases/WatchStatusReporter.md b/docs/api_docs/namespaces/ts/type-aliases/WatchStatusReporter.md new file mode 100644 index 0000000000000000000000000000000000000000..1b8b736e910b0004de44d276b14488e4598a5dda --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/WatchStatusReporter.md @@ -0,0 +1,33 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / WatchStatusReporter + +# Type Alias: WatchStatusReporter() + +> **WatchStatusReporter**: (`diagnostic`, `newLine`, `options`, `errorCount`?) => `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5792 + +## Parameters + +### diagnostic + +[`Diagnostic`](../interfaces/Diagnostic.md) + +### newLine + +`string` + +### options + +[`CompilerOptions`](../interfaces/CompilerOptions.md) + +### errorCount? + +`number` + +## Returns + +`void` diff --git a/docs/api_docs/namespaces/ts/type-aliases/WithMetadata.md b/docs/api_docs/namespaces/ts/type-aliases/WithMetadata.md new file mode 100644 index 0000000000000000000000000000000000000000..5d4c2a2da32fb31e65f55ff246b5edaf308c837f --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/WithMetadata.md @@ -0,0 +1,21 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / WithMetadata + +# Type Alias: WithMetadata\ + +> **WithMetadata**\<`T`\>: `T` & `object` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:6263 + +## Type declaration + +### metadata? + +> `optional` **metadata**: `unknown` + +## Type Parameters + +• **T** diff --git a/docs/api_docs/namespaces/ts/type-aliases/WriteFileCallback.md b/docs/api_docs/namespaces/ts/type-aliases/WriteFileCallback.md new file mode 100644 index 0000000000000000000000000000000000000000..cee91ac1e1f8beaa3cb69ea059ed5b9ef252cb28 --- /dev/null +++ b/docs/api_docs/namespaces/ts/type-aliases/WriteFileCallback.md @@ -0,0 +1,41 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / WriteFileCallback + +# Type Alias: WriteFileCallback() + +> **WriteFileCallback**: (`fileName`, `text`, `writeByteOrderMark`, `onError`?, `sourceFiles`?, `data`?) => `void` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:2257 + +## Parameters + +### fileName + +`string` + +### text + +`string` + +### writeByteOrderMark + +`boolean` + +### onError? + +(`message`) => `void` + +### sourceFiles? + +readonly [`SourceFile`](../interfaces/SourceFile.md)[] + +### data? + +[`WriteFileCallbackData`](../interfaces/WriteFileCallbackData.md) + +## Returns + +`void` diff --git a/docs/api_docs/namespaces/ts/variables/factory.md b/docs/api_docs/namespaces/ts/variables/factory.md new file mode 100644 index 0000000000000000000000000000000000000000..2077fde873e9b611c4b119fe0f3628cddaddf97e --- /dev/null +++ b/docs/api_docs/namespaces/ts/variables/factory.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / factory + +# Variable: factory + +> `const` **factory**: [`NodeFactory`](../interfaces/NodeFactory.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4923 diff --git a/docs/api_docs/namespaces/ts/variables/ohModulesPathPart.md b/docs/api_docs/namespaces/ts/variables/ohModulesPathPart.md new file mode 100644 index 0000000000000000000000000000000000000000..cd11c0b38380fff5cc7234d3886c025e0f09246b --- /dev/null +++ b/docs/api_docs/namespaces/ts/variables/ohModulesPathPart.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / ohModulesPathPart + +# Variable: ohModulesPathPart + +> `const` **ohModulesPathPart**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:5425 diff --git a/docs/api_docs/namespaces/ts/variables/servicesVersion.md b/docs/api_docs/namespaces/ts/variables/servicesVersion.md new file mode 100644 index 0000000000000000000000000000000000000000..fb37deab427b39247ff503717da23918570f3736 --- /dev/null +++ b/docs/api_docs/namespaces/ts/variables/servicesVersion.md @@ -0,0 +1,13 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / servicesVersion + +# Variable: servicesVersion + +> `const` **servicesVersion**: `"0.8"` = `"0.8"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:7432 + +The version of the language service API diff --git a/docs/api_docs/namespaces/ts/variables/sys.md b/docs/api_docs/namespaces/ts/variables/sys.md new file mode 100644 index 0000000000000000000000000000000000000000..112823fbf1d226e423af4db5191dcebc196b714a --- /dev/null +++ b/docs/api_docs/namespaces/ts/variables/sys.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / sys + +# Variable: sys + +> **sys**: [`System`](../interfaces/System.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4569 diff --git a/docs/api_docs/namespaces/ts/variables/unchangedTextChangeRange.md b/docs/api_docs/namespaces/ts/variables/unchangedTextChangeRange.md new file mode 100644 index 0000000000000000000000000000000000000000..5bf0cdab0040a2feae30177f51c4b83f451bb8d2 --- /dev/null +++ b/docs/api_docs/namespaces/ts/variables/unchangedTextChangeRange.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / unchangedTextChangeRange + +# Variable: unchangedTextChangeRange + +> **unchangedTextChangeRange**: [`TextChangeRange`](../interfaces/TextChangeRange.md) + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:4656 diff --git a/docs/api_docs/namespaces/ts/variables/version.md b/docs/api_docs/namespaces/ts/variables/version.md new file mode 100644 index 0000000000000000000000000000000000000000..9932b9ec79c86ed45d17789ff13c620383c532b5 --- /dev/null +++ b/docs/api_docs/namespaces/ts/variables/version.md @@ -0,0 +1,13 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / version + +# Variable: version + +> `const` **version**: `string` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:19 + +The version of the TypeScript compiler release diff --git a/docs/api_docs/namespaces/ts/variables/versionMajorMinor.md b/docs/api_docs/namespaces/ts/variables/versionMajorMinor.md new file mode 100644 index 0000000000000000000000000000000000000000..18790edd2807be716facabe0e7848af8c97107d5 --- /dev/null +++ b/docs/api_docs/namespaces/ts/variables/versionMajorMinor.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../../../README.md) + +*** + +[ArkAnalyzer](../../../globals.md) / [ts](../README.md) / versionMajorMinor + +# Variable: versionMajorMinor + +> `const` **versionMajorMinor**: `"4.9"` = `"4.9"` + +Defined in: node\_modules/ohos-typescript/lib/typescript.d.ts:17 diff --git a/docs/api_docs/type-aliases/AliasTypeOriginalModel.md b/docs/api_docs/type-aliases/AliasTypeOriginalModel.md new file mode 100644 index 0000000000000000000000000000000000000000..1624ac5911683a77bb53b87aa6c85f00369599b5 --- /dev/null +++ b/docs/api_docs/type-aliases/AliasTypeOriginalModel.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / AliasTypeOriginalModel + +# Type Alias: AliasTypeOriginalModel + +> **AliasTypeOriginalModel**: [`Type`](../classes/Type.md) \| [`ImportInfo`](../classes/ImportInfo.md) \| [`Local`](../classes/Local.md) \| [`ArkClass`](../classes/ArkClass.md) \| [`ArkMethod`](../classes/ArkMethod.md) \| [`ArkField`](../classes/ArkField.md) + +Defined in: src/core/base/Expr.ts:944 diff --git a/docs/api_docs/type-aliases/BaseSignature.md b/docs/api_docs/type-aliases/BaseSignature.md new file mode 100644 index 0000000000000000000000000000000000000000..b281c7ce646a75774b8b66a95fbf2d70e882671a --- /dev/null +++ b/docs/api_docs/type-aliases/BaseSignature.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / BaseSignature + +# Type Alias: BaseSignature + +> **BaseSignature**: [`ClassSignature`](../classes/ClassSignature.md) \| [`NamespaceSignature`](../classes/NamespaceSignature.md) + +Defined in: src/core/model/ArkSignature.ts:189 diff --git a/docs/api_docs/type-aliases/BinaryOperator.md b/docs/api_docs/type-aliases/BinaryOperator.md new file mode 100644 index 0000000000000000000000000000000000000000..52f1284982afad92e914083292c3f0899727e64c --- /dev/null +++ b/docs/api_docs/type-aliases/BinaryOperator.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / BinaryOperator + +# Type Alias: BinaryOperator + +> **BinaryOperator**: [`NormalBinaryOperator`](../enumerations/NormalBinaryOperator.md) \| [`RelationalBinaryOperator`](../enumerations/RelationalBinaryOperator.md) + +Defined in: src/core/base/Expr.ts:539 diff --git a/docs/api_docs/type-aliases/CallSiteID.md b/docs/api_docs/type-aliases/CallSiteID.md new file mode 100644 index 0000000000000000000000000000000000000000..3d37361de7242dd825fee096c7a0710d10572522 --- /dev/null +++ b/docs/api_docs/type-aliases/CallSiteID.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / CallSiteID + +# Type Alias: CallSiteID + +> **CallSiteID**: `number` + +Defined in: src/callgraph/model/CallGraph.ts:29 diff --git a/docs/api_docs/type-aliases/FuncID.md b/docs/api_docs/type-aliases/FuncID.md new file mode 100644 index 0000000000000000000000000000000000000000..a05fd647bed607339ffd0ffd049be2ab971e7adb --- /dev/null +++ b/docs/api_docs/type-aliases/FuncID.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / FuncID + +# Type Alias: FuncID + +> **FuncID**: `number` + +Defined in: src/callgraph/model/CallGraph.ts:30 diff --git a/docs/api_docs/type-aliases/InterProceduralEdge.md b/docs/api_docs/type-aliases/InterProceduralEdge.md new file mode 100644 index 0000000000000000000000000000000000000000..f8db2bc91be98d5170c9d859584817f090b09e82 --- /dev/null +++ b/docs/api_docs/type-aliases/InterProceduralEdge.md @@ -0,0 +1,25 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / InterProceduralEdge + +# Type Alias: InterProceduralEdge + +> **InterProceduralEdge**: `object` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:948 + +## Type declaration + +### dst + +> **dst**: [`Value`](../interfaces/Value.md) + +### kind + +> **kind**: [`PagEdgeKind`](../enumerations/PagEdgeKind.md) + +### src + +> **src**: [`InterProceduralSrcType`](InterProceduralSrcType.md) diff --git a/docs/api_docs/type-aliases/InterProceduralSrcType.md b/docs/api_docs/type-aliases/InterProceduralSrcType.md new file mode 100644 index 0000000000000000000000000000000000000000..5e77e8a8b81e535f2c2d0440e990aecba1257b76 --- /dev/null +++ b/docs/api_docs/type-aliases/InterProceduralSrcType.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / InterProceduralSrcType + +# Type Alias: InterProceduralSrcType + +> **InterProceduralSrcType**: [`Local`](../classes/Local.md) + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:946 diff --git a/docs/api_docs/type-aliases/IntraProceduralEdge.md b/docs/api_docs/type-aliases/IntraProceduralEdge.md new file mode 100644 index 0000000000000000000000000000000000000000..8be439bd8de20947cf8f41dcfa15ae4ac83be428 --- /dev/null +++ b/docs/api_docs/type-aliases/IntraProceduralEdge.md @@ -0,0 +1,29 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / IntraProceduralEdge + +# Type Alias: IntraProceduralEdge + +> **IntraProceduralEdge**: `object` + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:947 + +## Type declaration + +### dst + +> **dst**: [`Value`](../interfaces/Value.md) + +### kind + +> **kind**: [`PagEdgeKind`](../enumerations/PagEdgeKind.md) + +### src + +> **src**: [`Value`](../interfaces/Value.md) + +### stmt + +> **stmt**: [`Stmt`](../classes/Stmt.md) diff --git a/docs/api_docs/type-aliases/Kind.md b/docs/api_docs/type-aliases/Kind.md new file mode 100644 index 0000000000000000000000000000000000000000..b9ff1bbf105d8ba1454af735d6945982ba3bff08 --- /dev/null +++ b/docs/api_docs/type-aliases/Kind.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / Kind + +# Type Alias: Kind + +> **Kind**: `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:17 diff --git a/docs/api_docs/type-aliases/Method.md b/docs/api_docs/type-aliases/Method.md new file mode 100644 index 0000000000000000000000000000000000000000..d12db382554ee1b15c1035729e7640f11bb13162 --- /dev/null +++ b/docs/api_docs/type-aliases/Method.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / Method + +# Type Alias: Method + +> **Method**: [`MethodSignature`](../classes/MethodSignature.md) + +Defined in: src/callgraph/model/CallGraph.ts:28 diff --git a/docs/api_docs/type-aliases/NodeID.md b/docs/api_docs/type-aliases/NodeID.md new file mode 100644 index 0000000000000000000000000000000000000000..1c19cd4e485112e9966eac5f651aa6d6f33dfd28 --- /dev/null +++ b/docs/api_docs/type-aliases/NodeID.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / NodeID + +# Type Alias: NodeID + +> **NodeID**: `number` + +Defined in: src/core/graph/BaseExplicitGraph.ts:16 diff --git a/docs/api_docs/type-aliases/PagNodeType.md b/docs/api_docs/type-aliases/PagNodeType.md new file mode 100644 index 0000000000000000000000000000000000000000..a8ba0a9da65268a9aa88e3dc176218553dcd4a77 --- /dev/null +++ b/docs/api_docs/type-aliases/PagNodeType.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / PagNodeType + +# Type Alias: PagNodeType + +> **PagNodeType**: [`Value`](../interfaces/Value.md) + +Defined in: src/callgraph/pointerAnalysis/Pag.ts:35 diff --git a/docs/api_docs/type-aliases/Signature.md b/docs/api_docs/type-aliases/Signature.md new file mode 100644 index 0000000000000000000000000000000000000000..861117a7ce5c65969b09eb3f56598063ecbb33d3 --- /dev/null +++ b/docs/api_docs/type-aliases/Signature.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / Signature + +# Type Alias: Signature + +> **Signature**: [`FileSignature`](../classes/FileSignature.md) \| [`NamespaceSignature`](../classes/NamespaceSignature.md) \| [`ClassSignature`](../classes/ClassSignature.md) \| [`MethodSignature`](../classes/MethodSignature.md) \| [`FieldSignature`](../classes/FieldSignature.md) \| [`LocalSignature`](../classes/LocalSignature.md) + +Defined in: src/core/model/ArkSignature.ts:23 diff --git a/docs/api_docs/variables/ALL.md b/docs/api_docs/variables/ALL.md new file mode 100644 index 0000000000000000000000000000000000000000..eff2fe5cd09f717cd262208737c01fda238a347a --- /dev/null +++ b/docs/api_docs/variables/ALL.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / ALL + +# Variable: ALL + +> `const` **ALL**: `"*"` = `'*'` + +Defined in: src/core/common/TSConst.ts:23 diff --git a/docs/api_docs/variables/ANONYMOUS_CLASS_DELIMITER.md b/docs/api_docs/variables/ANONYMOUS_CLASS_DELIMITER.md new file mode 100644 index 0000000000000000000000000000000000000000..0d08ae7fc9a8001da966293e370ea73f480f16e1 --- /dev/null +++ b/docs/api_docs/variables/ANONYMOUS_CLASS_DELIMITER.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / ANONYMOUS\_CLASS\_DELIMITER + +# Variable: ANONYMOUS\_CLASS\_DELIMITER + +> `const` **ANONYMOUS\_CLASS\_DELIMITER**: `"$"` = `NAME_DELIMITER` + +Defined in: src/core/common/Const.ts:25 diff --git a/docs/api_docs/variables/ANONYMOUS_CLASS_PREFIX.md b/docs/api_docs/variables/ANONYMOUS_CLASS_PREFIX.md new file mode 100644 index 0000000000000000000000000000000000000000..3a013669174346aefa86b625ed3c4628a95fc82b --- /dev/null +++ b/docs/api_docs/variables/ANONYMOUS_CLASS_PREFIX.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / ANONYMOUS\_CLASS\_PREFIX + +# Variable: ANONYMOUS\_CLASS\_PREFIX + +> `const` **ANONYMOUS\_CLASS\_PREFIX**: `string` + +Defined in: src/core/common/Const.ts:24 diff --git a/docs/api_docs/variables/ANONYMOUS_METHOD_PREFIX.md b/docs/api_docs/variables/ANONYMOUS_METHOD_PREFIX.md new file mode 100644 index 0000000000000000000000000000000000000000..1c40c3bb60ba0302371f36df39fd1ccebbd17af4 --- /dev/null +++ b/docs/api_docs/variables/ANONYMOUS_METHOD_PREFIX.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / ANONYMOUS\_METHOD\_PREFIX + +# Variable: ANONYMOUS\_METHOD\_PREFIX + +> `const` **ANONYMOUS\_METHOD\_PREFIX**: `string` + +Defined in: src/core/common/Const.ts:31 diff --git a/docs/api_docs/variables/ANY_KEYWORD.md b/docs/api_docs/variables/ANY_KEYWORD.md new file mode 100644 index 0000000000000000000000000000000000000000..fd090bab1b9319ce51049781115a3460e568c3b4 --- /dev/null +++ b/docs/api_docs/variables/ANY_KEYWORD.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / ANY\_KEYWORD + +# Variable: ANY\_KEYWORD + +> `const` **ANY\_KEYWORD**: `"any"` = `'any'` + +Defined in: src/core/common/TSConst.ts:31 diff --git a/docs/api_docs/variables/API_COMMON.md b/docs/api_docs/variables/API_COMMON.md new file mode 100644 index 0000000000000000000000000000000000000000..2cca174e32e201a2426784c1bf47ca6d1c368f4d --- /dev/null +++ b/docs/api_docs/variables/API_COMMON.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / API\_COMMON + +# Variable: API\_COMMON + +> `const` **API\_COMMON**: `string` + +Defined in: src/core/common/EtsConst.ts:1027 diff --git a/docs/api_docs/variables/API_INTERNAL.md b/docs/api_docs/variables/API_INTERNAL.md new file mode 100644 index 0000000000000000000000000000000000000000..83d8ec9d264a4de2eed721d9950626c6c745bd81 --- /dev/null +++ b/docs/api_docs/variables/API_INTERNAL.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / API\_INTERNAL + +# Variable: API\_INTERNAL + +> `const` **API\_INTERNAL**: `string` + +Defined in: src/core/common/EtsConst.ts:1026 diff --git a/docs/api_docs/variables/BOOLEAN_KEYWORD.md b/docs/api_docs/variables/BOOLEAN_KEYWORD.md new file mode 100644 index 0000000000000000000000000000000000000000..03c05864f8b46634d3e69731d7f479e780c85ff5 --- /dev/null +++ b/docs/api_docs/variables/BOOLEAN_KEYWORD.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / BOOLEAN\_KEYWORD + +# Variable: BOOLEAN\_KEYWORD + +> `const` **BOOLEAN\_KEYWORD**: `"boolean"` = `'boolean'` + +Defined in: src/core/common/TSConst.ts:33 diff --git a/docs/api_docs/variables/BUILDER_DECORATOR.md b/docs/api_docs/variables/BUILDER_DECORATOR.md new file mode 100644 index 0000000000000000000000000000000000000000..501db50a72e186b53e88347512ec8b8fab4643f6 --- /dev/null +++ b/docs/api_docs/variables/BUILDER_DECORATOR.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / BUILDER\_DECORATOR + +# Variable: BUILDER\_DECORATOR + +> `const` **BUILDER\_DECORATOR**: `string` = `'Builder'` + +Defined in: src/core/common/EtsConst.ts:991 diff --git a/docs/api_docs/variables/BUILDER_PARAM_DECORATOR.md b/docs/api_docs/variables/BUILDER_PARAM_DECORATOR.md new file mode 100644 index 0000000000000000000000000000000000000000..ec4e04e2c900db75a64dbd80227eb5188ad52a40 --- /dev/null +++ b/docs/api_docs/variables/BUILDER_PARAM_DECORATOR.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / BUILDER\_PARAM\_DECORATOR + +# Variable: BUILDER\_PARAM\_DECORATOR + +> `const` **BUILDER\_PARAM\_DECORATOR**: `string` = `'BuilderParam'` + +Defined in: src/core/common/EtsConst.ts:992 diff --git a/docs/api_docs/variables/BUILDIN_ATOMIC_COMPONENT.md b/docs/api_docs/variables/BUILDIN_ATOMIC_COMPONENT.md new file mode 100644 index 0000000000000000000000000000000000000000..fbaf346022a6d81eba39e90206f507ae37fec476 --- /dev/null +++ b/docs/api_docs/variables/BUILDIN_ATOMIC_COMPONENT.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / BUILDIN\_ATOMIC\_COMPONENT + +# Variable: BUILDIN\_ATOMIC\_COMPONENT + +> `const` **BUILDIN\_ATOMIC\_COMPONENT**: `Set`\<`string`\> + +Defined in: src/core/common/EtsConst.ts:934 diff --git a/docs/api_docs/variables/BUILDIN_SYSTEM_COMPONENT.md b/docs/api_docs/variables/BUILDIN_SYSTEM_COMPONENT.md new file mode 100644 index 0000000000000000000000000000000000000000..8ca41a102dc8d783b503a3cad2093ca2dd052c39 --- /dev/null +++ b/docs/api_docs/variables/BUILDIN_SYSTEM_COMPONENT.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / BUILDIN\_SYSTEM\_COMPONENT + +# Variable: BUILDIN\_SYSTEM\_COMPONENT + +> `const` **BUILDIN\_SYSTEM\_COMPONENT**: `Set`\<`string`\> + +Defined in: src/core/common/EtsConst.ts:928 diff --git a/docs/api_docs/variables/BUILD_PROFILE_JSON5.md b/docs/api_docs/variables/BUILD_PROFILE_JSON5.md new file mode 100644 index 0000000000000000000000000000000000000000..977ed20a9e1744d14af04ffe3e8b499a2efadcbc --- /dev/null +++ b/docs/api_docs/variables/BUILD_PROFILE_JSON5.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / BUILD\_PROFILE\_JSON5 + +# Variable: BUILD\_PROFILE\_JSON5 + +> `const` **BUILD\_PROFILE\_JSON5**: `"build-profile.json5"` = `'build-profile.json5'` + +Defined in: src/core/common/EtsConst.ts:1034 diff --git a/docs/api_docs/variables/CALLBACK_METHOD_NAME.md b/docs/api_docs/variables/CALLBACK_METHOD_NAME.md new file mode 100644 index 0000000000000000000000000000000000000000..fb74b9acba7772b41a05340567da6f818e608d67 --- /dev/null +++ b/docs/api_docs/variables/CALLBACK_METHOD_NAME.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / CALLBACK\_METHOD\_NAME + +# Variable: CALLBACK\_METHOD\_NAME + +> `const` **CALLBACK\_METHOD\_NAME**: `string`[] + +Defined in: src/utils/entryMethodUtils.ts:49 diff --git a/docs/api_docs/variables/CALL_BACK.md b/docs/api_docs/variables/CALL_BACK.md new file mode 100644 index 0000000000000000000000000000000000000000..c8d35c65873866575bf2f41f2375a241764d5162 --- /dev/null +++ b/docs/api_docs/variables/CALL_BACK.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / CALL\_BACK + +# Variable: CALL\_BACK + +> `const` **CALL\_BACK**: `string` = `'Callback'` + +Defined in: src/core/common/EtsConst.ts:1030 diff --git a/docs/api_docs/variables/CALL_SIGNATURE_NAME.md b/docs/api_docs/variables/CALL_SIGNATURE_NAME.md new file mode 100644 index 0000000000000000000000000000000000000000..b910371ebd1779ca7d1ef7a8c1731934ddd9e3c9 --- /dev/null +++ b/docs/api_docs/variables/CALL_SIGNATURE_NAME.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / CALL\_SIGNATURE\_NAME + +# Variable: CALL\_SIGNATURE\_NAME + +> `const` **CALL\_SIGNATURE\_NAME**: `"create"` = `'create'` + +Defined in: src/core/common/Const.ts:32 diff --git a/docs/api_docs/variables/COMPONENT_ATTRIBUTE.md b/docs/api_docs/variables/COMPONENT_ATTRIBUTE.md new file mode 100644 index 0000000000000000000000000000000000000000..ea760f3a50ffbf2b69074e7f4ef23308cb9739ce --- /dev/null +++ b/docs/api_docs/variables/COMPONENT_ATTRIBUTE.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / COMPONENT\_ATTRIBUTE + +# Variable: COMPONENT\_ATTRIBUTE + +> `const` **COMPONENT\_ATTRIBUTE**: `string` = `'Attribute'` + +Defined in: src/core/common/EtsConst.ts:1029 diff --git a/docs/api_docs/variables/COMPONENT_BRANCH_FUNCTION.md b/docs/api_docs/variables/COMPONENT_BRANCH_FUNCTION.md new file mode 100644 index 0000000000000000000000000000000000000000..a3936da56fc9d6dffa573e0c5df3de02159ba314 --- /dev/null +++ b/docs/api_docs/variables/COMPONENT_BRANCH_FUNCTION.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / COMPONENT\_BRANCH\_FUNCTION + +# Variable: COMPONENT\_BRANCH\_FUNCTION + +> `const` **COMPONENT\_BRANCH\_FUNCTION**: `string` = `'branch'` + +Defined in: src/core/common/EtsConst.ts:1013 diff --git a/docs/api_docs/variables/COMPONENT_BUILD_FUNCTION.md b/docs/api_docs/variables/COMPONENT_BUILD_FUNCTION.md new file mode 100644 index 0000000000000000000000000000000000000000..09d9a2197d6342c4393048bea127063cdedb0193 --- /dev/null +++ b/docs/api_docs/variables/COMPONENT_BUILD_FUNCTION.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / COMPONENT\_BUILD\_FUNCTION + +# Variable: COMPONENT\_BUILD\_FUNCTION + +> `const` **COMPONENT\_BUILD\_FUNCTION**: `string` = `'build'` + +Defined in: src/core/common/EtsConst.ts:1014 diff --git a/docs/api_docs/variables/COMPONENT_COMMON.md b/docs/api_docs/variables/COMPONENT_COMMON.md new file mode 100644 index 0000000000000000000000000000000000000000..717e6156e4d08f650d1ff6bc333ddbd31dffe848 --- /dev/null +++ b/docs/api_docs/variables/COMPONENT_COMMON.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / COMPONENT\_COMMON + +# Variable: COMPONENT\_COMMON + +> `const` **COMPONENT\_COMMON**: `string` = `'Common'` + +Defined in: src/core/common/EtsConst.ts:1024 diff --git a/docs/api_docs/variables/COMPONENT_CREATE_FUNCTION.md b/docs/api_docs/variables/COMPONENT_CREATE_FUNCTION.md new file mode 100644 index 0000000000000000000000000000000000000000..5ae6d789b873a8f27bb89f51ff5c4597c318fce6 --- /dev/null +++ b/docs/api_docs/variables/COMPONENT_CREATE_FUNCTION.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / COMPONENT\_CREATE\_FUNCTION + +# Variable: COMPONENT\_CREATE\_FUNCTION + +> `const` **COMPONENT\_CREATE\_FUNCTION**: `string` = `'create'` + +Defined in: src/core/common/EtsConst.ts:1006 diff --git a/docs/api_docs/variables/COMPONENT_CUSTOMVIEW.md b/docs/api_docs/variables/COMPONENT_CUSTOMVIEW.md new file mode 100644 index 0000000000000000000000000000000000000000..205004edf73d12457e26406c6a52806b809a01c8 --- /dev/null +++ b/docs/api_docs/variables/COMPONENT_CUSTOMVIEW.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / COMPONENT\_CUSTOMVIEW + +# Variable: COMPONENT\_CUSTOMVIEW + +> `const` **COMPONENT\_CUSTOMVIEW**: `string` = `'View'` + +Defined in: src/core/common/EtsConst.ts:1008 diff --git a/docs/api_docs/variables/COMPONENT_DECORATOR.md b/docs/api_docs/variables/COMPONENT_DECORATOR.md new file mode 100644 index 0000000000000000000000000000000000000000..b82bc480d118334c7954cb08c579cc841b8d8816 --- /dev/null +++ b/docs/api_docs/variables/COMPONENT_DECORATOR.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / COMPONENT\_DECORATOR + +# Variable: COMPONENT\_DECORATOR + +> `const` **COMPONENT\_DECORATOR**: `Set`\<`string`\> + +Defined in: src/core/common/EtsConst.ts:989 diff --git a/docs/api_docs/variables/COMPONENT_FOR_EACH.md b/docs/api_docs/variables/COMPONENT_FOR_EACH.md new file mode 100644 index 0000000000000000000000000000000000000000..c31785a4d326c6abaf1e65f0c5eda8502e52950c --- /dev/null +++ b/docs/api_docs/variables/COMPONENT_FOR_EACH.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / COMPONENT\_FOR\_EACH + +# Variable: COMPONENT\_FOR\_EACH + +> `const` **COMPONENT\_FOR\_EACH**: `string` = `'ForEach'` + +Defined in: src/core/common/EtsConst.ts:925 diff --git a/docs/api_docs/variables/COMPONENT_IF.md b/docs/api_docs/variables/COMPONENT_IF.md new file mode 100644 index 0000000000000000000000000000000000000000..cf359badd6286a73302328ffcbf8507ca13ee9ff --- /dev/null +++ b/docs/api_docs/variables/COMPONENT_IF.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / COMPONENT\_IF + +# Variable: COMPONENT\_IF + +> `const` **COMPONENT\_IF**: `string` = `'If'` + +Defined in: src/core/common/EtsConst.ts:1011 diff --git a/docs/api_docs/variables/COMPONENT_IF_BRANCH.md b/docs/api_docs/variables/COMPONENT_IF_BRANCH.md new file mode 100644 index 0000000000000000000000000000000000000000..2617e996e90a047a24e3ba8fbec5c9c5723d7a99 --- /dev/null +++ b/docs/api_docs/variables/COMPONENT_IF_BRANCH.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / COMPONENT\_IF\_BRANCH + +# Variable: COMPONENT\_IF\_BRANCH + +> `const` **COMPONENT\_IF\_BRANCH**: `string` = `'IfBranch'` + +Defined in: src/core/common/EtsConst.ts:1012 diff --git a/docs/api_docs/variables/COMPONENT_INSTANCE.md b/docs/api_docs/variables/COMPONENT_INSTANCE.md new file mode 100644 index 0000000000000000000000000000000000000000..0d13119fdaa416d802cfafc15c8cf8e805208d52 --- /dev/null +++ b/docs/api_docs/variables/COMPONENT_INSTANCE.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / COMPONENT\_INSTANCE + +# Variable: COMPONENT\_INSTANCE + +> `const` **COMPONENT\_INSTANCE**: `string` = `'Instance'` + +Defined in: src/core/common/EtsConst.ts:1025 diff --git a/docs/api_docs/variables/COMPONENT_LAZY_FOR_EACH.md b/docs/api_docs/variables/COMPONENT_LAZY_FOR_EACH.md new file mode 100644 index 0000000000000000000000000000000000000000..64e715697f784edb6ae2feb153899881f201481c --- /dev/null +++ b/docs/api_docs/variables/COMPONENT_LAZY_FOR_EACH.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / COMPONENT\_LAZY\_FOR\_EACH + +# Variable: COMPONENT\_LAZY\_FOR\_EACH + +> `const` **COMPONENT\_LAZY\_FOR\_EACH**: `string` = `'LazyForEach'` + +Defined in: src/core/common/EtsConst.ts:926 diff --git a/docs/api_docs/variables/COMPONENT_LIFECYCLE_METHOD_NAME.md b/docs/api_docs/variables/COMPONENT_LIFECYCLE_METHOD_NAME.md new file mode 100644 index 0000000000000000000000000000000000000000..7901ea80d1498d99444fedc38bee24eb7842ef9b --- /dev/null +++ b/docs/api_docs/variables/COMPONENT_LIFECYCLE_METHOD_NAME.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / COMPONENT\_LIFECYCLE\_METHOD\_NAME + +# Variable: COMPONENT\_LIFECYCLE\_METHOD\_NAME + +> `const` **COMPONENT\_LIFECYCLE\_METHOD\_NAME**: `string`[] + +Defined in: src/utils/entryMethodUtils.ts:68 diff --git a/docs/api_docs/variables/COMPONENT_PATH.md b/docs/api_docs/variables/COMPONENT_PATH.md new file mode 100644 index 0000000000000000000000000000000000000000..e2b8672fe0130e75d9eb28161f64c4a654894a94 --- /dev/null +++ b/docs/api_docs/variables/COMPONENT_PATH.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / COMPONENT\_PATH + +# Variable: COMPONENT\_PATH + +> `const` **COMPONENT\_PATH**: `string` + +Defined in: src/core/common/EtsConst.ts:1023 diff --git a/docs/api_docs/variables/COMPONENT_POP_FUNCTION.md b/docs/api_docs/variables/COMPONENT_POP_FUNCTION.md new file mode 100644 index 0000000000000000000000000000000000000000..20a8e70cb24ea27b8a96b5c5d0729ec3c8195acb --- /dev/null +++ b/docs/api_docs/variables/COMPONENT_POP_FUNCTION.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / COMPONENT\_POP\_FUNCTION + +# Variable: COMPONENT\_POP\_FUNCTION + +> `const` **COMPONENT\_POP\_FUNCTION**: `string` = `'pop'` + +Defined in: src/core/common/EtsConst.ts:1007 diff --git a/docs/api_docs/variables/COMPONENT_REPEAT.md b/docs/api_docs/variables/COMPONENT_REPEAT.md new file mode 100644 index 0000000000000000000000000000000000000000..b1b2141a3d1cc7bb96361cc25026ae59d59359c6 --- /dev/null +++ b/docs/api_docs/variables/COMPONENT_REPEAT.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / COMPONENT\_REPEAT + +# Variable: COMPONENT\_REPEAT + +> `const` **COMPONENT\_REPEAT**: `string` = `'Repeat'` + +Defined in: src/core/common/EtsConst.ts:1009 diff --git a/docs/api_docs/variables/CONSTRUCTOR_NAME.md b/docs/api_docs/variables/CONSTRUCTOR_NAME.md new file mode 100644 index 0000000000000000000000000000000000000000..0c1d8809c47c1da5c2cc779f64b1bec69a4449e5 --- /dev/null +++ b/docs/api_docs/variables/CONSTRUCTOR_NAME.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / CONSTRUCTOR\_NAME + +# Variable: CONSTRUCTOR\_NAME + +> `const` **CONSTRUCTOR\_NAME**: `"constructor"` = `'constructor'` + +Defined in: src/core/common/TSConst.ts:16 diff --git a/docs/api_docs/variables/DECLARE_KEYWORD.md b/docs/api_docs/variables/DECLARE_KEYWORD.md new file mode 100644 index 0000000000000000000000000000000000000000..27dded9c6949e6ef62994bc373f1b39b66d8282a --- /dev/null +++ b/docs/api_docs/variables/DECLARE_KEYWORD.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / DECLARE\_KEYWORD + +# Variable: DECLARE\_KEYWORD + +> `const` **DECLARE\_KEYWORD**: `"DeclareKeyword"` = `'DeclareKeyword'` + +Defined in: src/core/common/TSConst.ts:28 diff --git a/docs/api_docs/variables/DEFAULT.md b/docs/api_docs/variables/DEFAULT.md new file mode 100644 index 0000000000000000000000000000000000000000..e4394919bcb65b6964d6046f824a042768f47bcf --- /dev/null +++ b/docs/api_docs/variables/DEFAULT.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / DEFAULT + +# Variable: DEFAULT + +> `const` **DEFAULT**: `"default"` = `'default'` + +Defined in: src/core/common/TSConst.ts:21 diff --git a/docs/api_docs/variables/DEFAULT_ARK_CLASS_NAME.md b/docs/api_docs/variables/DEFAULT_ARK_CLASS_NAME.md new file mode 100644 index 0000000000000000000000000000000000000000..80e4008a7d68126b41b127b6850dbccddb40d611 --- /dev/null +++ b/docs/api_docs/variables/DEFAULT_ARK_CLASS_NAME.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / DEFAULT\_ARK\_CLASS\_NAME + +# Variable: DEFAULT\_ARK\_CLASS\_NAME + +> `const` **DEFAULT\_ARK\_CLASS\_NAME**: `string` + +Defined in: src/core/common/Const.ts:23 diff --git a/docs/api_docs/variables/DEFAULT_ARK_METHOD_NAME.md b/docs/api_docs/variables/DEFAULT_ARK_METHOD_NAME.md new file mode 100644 index 0000000000000000000000000000000000000000..0675b67170fdb7401c043922a51ddaccf575e847 --- /dev/null +++ b/docs/api_docs/variables/DEFAULT_ARK_METHOD_NAME.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / DEFAULT\_ARK\_METHOD\_NAME + +# Variable: DEFAULT\_ARK\_METHOD\_NAME + +> `const` **DEFAULT\_ARK\_METHOD\_NAME**: `string` + +Defined in: src/core/common/Const.ts:28 diff --git a/docs/api_docs/variables/DEFAULT_NAME.md b/docs/api_docs/variables/DEFAULT_NAME.md new file mode 100644 index 0000000000000000000000000000000000000000..6716094cf48e9e7d89939a4311653a7f40143483 --- /dev/null +++ b/docs/api_docs/variables/DEFAULT_NAME.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / DEFAULT\_NAME + +# Variable: DEFAULT\_NAME + +> `const` **DEFAULT\_NAME**: `"dflt"` = `'dflt'` + +Defined in: src/core/common/Const.ts:20 diff --git a/docs/api_docs/variables/ENTRY_DECORATOR.md b/docs/api_docs/variables/ENTRY_DECORATOR.md new file mode 100644 index 0000000000000000000000000000000000000000..c0ff91fb4655f974d10eaf7650b86ba875e9f5d6 --- /dev/null +++ b/docs/api_docs/variables/ENTRY_DECORATOR.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / ENTRY\_DECORATOR + +# Variable: ENTRY\_DECORATOR + +> `const` **ENTRY\_DECORATOR**: `string` = `'Entry'` + +Defined in: src/core/common/EtsConst.ts:990 diff --git a/docs/api_docs/variables/ETS_COMPILER_OPTIONS.md b/docs/api_docs/variables/ETS_COMPILER_OPTIONS.md new file mode 100644 index 0000000000000000000000000000000000000000..eed27c3aba88e02208f9db9f80b83226e910588f --- /dev/null +++ b/docs/api_docs/variables/ETS_COMPILER_OPTIONS.md @@ -0,0 +1,109 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / ETS\_COMPILER\_OPTIONS + +# Variable: ETS\_COMPILER\_OPTIONS + +> `const` **ETS\_COMPILER\_OPTIONS**: `object` + +Defined in: src/core/common/EtsConst.ts:18 + +## Type declaration + +### ets + +> **ets**: `object` + +#### ets.components + +> **components**: `string`[] + +#### ets.concurrent + +> **concurrent**: `object` + +#### ets.concurrent.decorator + +> **decorator**: `string` = `'Concurrent'` + +#### ets.customComponent + +> **customComponent**: `string` = `'CustomComponent'` + +#### ets.emitDecorators + +> **emitDecorators**: `object`[] + +#### ets.extend + +> **extend**: `object` + +#### ets.extend.components + +> **components**: `object`[] + +#### ets.extend.decorator + +> **decorator**: `string`[] + +#### ets.libs + +> **libs**: `never`[] = `[]` + +#### ets.propertyDecorators + +> **propertyDecorators**: `object`[] + +#### ets.render + +> **render**: `object` + +#### ets.render.decorator + +> **decorator**: `string`[] + +#### ets.render.method + +> **method**: `string`[] + +#### ets.styles + +> **styles**: `object` + +#### ets.styles.component + +> **component**: `object` + +#### ets.styles.component.instance + +> **instance**: `string` = `'CommonInstance'` + +#### ets.styles.component.name + +> **name**: `string` = `'Common'` + +#### ets.styles.component.type + +> **type**: `string` = `'T'` + +#### ets.styles.decorator + +> **decorator**: `string` = `'Styles'` + +#### ets.styles.property + +> **property**: `string` = `'stateStyles'` + +#### ets.syntaxComponents + +> **syntaxComponents**: `object` + +#### ets.syntaxComponents.attrUICallback + +> **attrUICallback**: `object`[] + +#### ets.syntaxComponents.paramsUICallback + +> **paramsUICallback**: `string`[] diff --git a/docs/api_docs/variables/GLOBAL_THIS_NAME.md b/docs/api_docs/variables/GLOBAL_THIS_NAME.md new file mode 100644 index 0000000000000000000000000000000000000000..884a778100fe9e389aae08dac9fccdb3421dc7b4 --- /dev/null +++ b/docs/api_docs/variables/GLOBAL_THIS_NAME.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / GLOBAL\_THIS\_NAME + +# Variable: GLOBAL\_THIS\_NAME + +> `const` **GLOBAL\_THIS\_NAME**: `string` = `'globalThis'` + +Defined in: src/core/common/TSConst.ts:19 diff --git a/docs/api_docs/variables/IMPORT.md b/docs/api_docs/variables/IMPORT.md new file mode 100644 index 0000000000000000000000000000000000000000..4e2e8eae317040d23ba57d8d6f958a8adaaf4c9a --- /dev/null +++ b/docs/api_docs/variables/IMPORT.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / IMPORT + +# Variable: IMPORT + +> `const` **IMPORT**: `"import"` = `'import'` + +Defined in: src/core/common/TSConst.ts:25 diff --git a/docs/api_docs/variables/INSTANCE_INIT_METHOD_NAME.md b/docs/api_docs/variables/INSTANCE_INIT_METHOD_NAME.md new file mode 100644 index 0000000000000000000000000000000000000000..ffa98b797b8116f2090afaea741d50401d160733 --- /dev/null +++ b/docs/api_docs/variables/INSTANCE_INIT_METHOD_NAME.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / INSTANCE\_INIT\_METHOD\_NAME + +# Variable: INSTANCE\_INIT\_METHOD\_NAME + +> `const` **INSTANCE\_INIT\_METHOD\_NAME**: `string` + +Defined in: src/core/common/Const.ts:29 diff --git a/docs/api_docs/variables/LEXICAL_ENV_NAME_PREFIX.md b/docs/api_docs/variables/LEXICAL_ENV_NAME_PREFIX.md new file mode 100644 index 0000000000000000000000000000000000000000..8883b4baf974f2e5b2ce9efa7d963453c3ca54d8 --- /dev/null +++ b/docs/api_docs/variables/LEXICAL_ENV_NAME_PREFIX.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / LEXICAL\_ENV\_NAME\_PREFIX + +# Variable: LEXICAL\_ENV\_NAME\_PREFIX + +> `const` **LEXICAL\_ENV\_NAME\_PREFIX**: `string` + +Defined in: src/core/common/Const.ts:44 diff --git a/docs/api_docs/variables/LIFECYCLE_METHOD_NAME.md b/docs/api_docs/variables/LIFECYCLE_METHOD_NAME.md new file mode 100644 index 0000000000000000000000000000000000000000..be6dcc27953d03e0fac535ce5b34c6d30bfb7d70 --- /dev/null +++ b/docs/api_docs/variables/LIFECYCLE_METHOD_NAME.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / LIFECYCLE\_METHOD\_NAME + +# Variable: LIFECYCLE\_METHOD\_NAME + +> `const` **LIFECYCLE\_METHOD\_NAME**: `string`[] + +Defined in: src/utils/entryMethodUtils.ts:21 diff --git a/docs/api_docs/variables/NAME_DELIMITER.md b/docs/api_docs/variables/NAME_DELIMITER.md new file mode 100644 index 0000000000000000000000000000000000000000..39809c567bf3114f4e04ce758fedc926ecf22678 --- /dev/null +++ b/docs/api_docs/variables/NAME_DELIMITER.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / NAME\_DELIMITER + +# Variable: NAME\_DELIMITER + +> `const` **NAME\_DELIMITER**: `"$"` = `'$'` + +Defined in: src/core/common/Const.ts:17 diff --git a/docs/api_docs/variables/NAME_PREFIX.md b/docs/api_docs/variables/NAME_PREFIX.md new file mode 100644 index 0000000000000000000000000000000000000000..c2cb0ae600d5a1da28f5ab2e694b84f3d71ecbc7 --- /dev/null +++ b/docs/api_docs/variables/NAME_PREFIX.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / NAME\_PREFIX + +# Variable: NAME\_PREFIX + +> `const` **NAME\_PREFIX**: `"%"` = `'%'` + +Defined in: src/core/common/Const.ts:18 diff --git a/docs/api_docs/variables/NEVER_KEYWORD.md b/docs/api_docs/variables/NEVER_KEYWORD.md new file mode 100644 index 0000000000000000000000000000000000000000..2e8b5f12d2dbe736b4bc584a8ee5ffc8104a3899 --- /dev/null +++ b/docs/api_docs/variables/NEVER_KEYWORD.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / NEVER\_KEYWORD + +# Variable: NEVER\_KEYWORD + +> `const` **NEVER\_KEYWORD**: `"never"` = `'never'` + +Defined in: src/core/common/TSConst.ts:37 diff --git a/docs/api_docs/variables/NULL_KEYWORD.md b/docs/api_docs/variables/NULL_KEYWORD.md new file mode 100644 index 0000000000000000000000000000000000000000..d04d90749ef83806ee43019adf11e460706fcbec --- /dev/null +++ b/docs/api_docs/variables/NULL_KEYWORD.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / NULL\_KEYWORD + +# Variable: NULL\_KEYWORD + +> `const` **NULL\_KEYWORD**: `"null"` = `'null'` + +Defined in: src/core/common/TSConst.ts:29 diff --git a/docs/api_docs/variables/NUMBER_KEYWORD.md b/docs/api_docs/variables/NUMBER_KEYWORD.md new file mode 100644 index 0000000000000000000000000000000000000000..2364a4a6976606c95fda1b4c2b82c5af364aaf12 --- /dev/null +++ b/docs/api_docs/variables/NUMBER_KEYWORD.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / NUMBER\_KEYWORD + +# Variable: NUMBER\_KEYWORD + +> `const` **NUMBER\_KEYWORD**: `"number"` = `'number'` + +Defined in: src/core/common/TSConst.ts:34 diff --git a/docs/api_docs/variables/OH_PACKAGE_JSON5.md b/docs/api_docs/variables/OH_PACKAGE_JSON5.md new file mode 100644 index 0000000000000000000000000000000000000000..e31a32b3d18283eaa5cd1a20d77105c64b5f8672 --- /dev/null +++ b/docs/api_docs/variables/OH_PACKAGE_JSON5.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / OH\_PACKAGE\_JSON5 + +# Variable: OH\_PACKAGE\_JSON5 + +> `const` **OH\_PACKAGE\_JSON5**: `"oh-package.json5"` = `'oh-package.json5'` + +Defined in: src/core/common/EtsConst.ts:1033 diff --git a/docs/api_docs/variables/ON_OFF.md b/docs/api_docs/variables/ON_OFF.md new file mode 100644 index 0000000000000000000000000000000000000000..f84f5f5f32e7b2e339678ab4aaa2efb048492a37 --- /dev/null +++ b/docs/api_docs/variables/ON_OFF.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / ON\_OFF + +# Variable: ON\_OFF + +> `const` **ON\_OFF**: `Set`\<`string`\> + +Defined in: src/core/common/EtsConst.ts:1031 diff --git a/docs/api_docs/variables/SPECIAL_CONTAINER_COMPONENT.md b/docs/api_docs/variables/SPECIAL_CONTAINER_COMPONENT.md new file mode 100644 index 0000000000000000000000000000000000000000..b545818099205487edc11a8bd5813e34fb38bc71 --- /dev/null +++ b/docs/api_docs/variables/SPECIAL_CONTAINER_COMPONENT.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / SPECIAL\_CONTAINER\_COMPONENT + +# Variable: SPECIAL\_CONTAINER\_COMPONENT + +> `const` **SPECIAL\_CONTAINER\_COMPONENT**: `Set`\<`string`\> + +Defined in: src/core/common/EtsConst.ts:1016 diff --git a/docs/api_docs/variables/STATIC_INIT_METHOD_NAME.md b/docs/api_docs/variables/STATIC_INIT_METHOD_NAME.md new file mode 100644 index 0000000000000000000000000000000000000000..35d9fae5c22513f112cb98c46ccf21f6b5493876 --- /dev/null +++ b/docs/api_docs/variables/STATIC_INIT_METHOD_NAME.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / STATIC\_INIT\_METHOD\_NAME + +# Variable: STATIC\_INIT\_METHOD\_NAME + +> `const` **STATIC\_INIT\_METHOD\_NAME**: `string` + +Defined in: src/core/common/Const.ts:30 diff --git a/docs/api_docs/variables/STRING_KEYWORD.md b/docs/api_docs/variables/STRING_KEYWORD.md new file mode 100644 index 0000000000000000000000000000000000000000..fd4c8baa3c291a09d9dd67adddd66d70bdb2863e --- /dev/null +++ b/docs/api_docs/variables/STRING_KEYWORD.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / STRING\_KEYWORD + +# Variable: STRING\_KEYWORD + +> `const` **STRING\_KEYWORD**: `"string"` = `'string'` + +Defined in: src/core/common/TSConst.ts:35 diff --git a/docs/api_docs/variables/SUPER_NAME.md b/docs/api_docs/variables/SUPER_NAME.md new file mode 100644 index 0000000000000000000000000000000000000000..e33258cdbb3b907748c304a0522fe9e7204232d6 --- /dev/null +++ b/docs/api_docs/variables/SUPER_NAME.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / SUPER\_NAME + +# Variable: SUPER\_NAME + +> `const` **SUPER\_NAME**: `"super"` = `'super'` + +Defined in: src/core/common/TSConst.ts:17 diff --git a/docs/api_docs/variables/TEMP_LOCAL_PREFIX.md b/docs/api_docs/variables/TEMP_LOCAL_PREFIX.md new file mode 100644 index 0000000000000000000000000000000000000000..cf202f1ac1de568437567fbb79078d61402c7684 --- /dev/null +++ b/docs/api_docs/variables/TEMP_LOCAL_PREFIX.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / TEMP\_LOCAL\_PREFIX + +# Variable: TEMP\_LOCAL\_PREFIX + +> `const` **TEMP\_LOCAL\_PREFIX**: `"%"` = `NAME_PREFIX` + +Defined in: src/core/common/Const.ts:43 diff --git a/docs/api_docs/variables/THIS_NAME.md b/docs/api_docs/variables/THIS_NAME.md new file mode 100644 index 0000000000000000000000000000000000000000..32fbdbe3c5500922147e4c49ea7b4949f7fb190f --- /dev/null +++ b/docs/api_docs/variables/THIS_NAME.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / THIS\_NAME + +# Variable: THIS\_NAME + +> `const` **THIS\_NAME**: `"this"` = `'this'` + +Defined in: src/core/common/TSConst.ts:18 diff --git a/docs/api_docs/variables/TSCONFIG_JSON.md b/docs/api_docs/variables/TSCONFIG_JSON.md new file mode 100644 index 0000000000000000000000000000000000000000..347c3d3360f28eed63effb8847b0de5473542821 --- /dev/null +++ b/docs/api_docs/variables/TSCONFIG_JSON.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / TSCONFIG\_JSON + +# Variable: TSCONFIG\_JSON + +> `const` **TSCONFIG\_JSON**: `"tsconfig.json"` = `'tsconfig.json'` + +Defined in: src/core/common/TSConst.ts:38 diff --git a/docs/api_docs/variables/UNDEFINED_KEYWORD.md b/docs/api_docs/variables/UNDEFINED_KEYWORD.md new file mode 100644 index 0000000000000000000000000000000000000000..e2e5b7cd8a98fc25dceb971fe68074016027414a --- /dev/null +++ b/docs/api_docs/variables/UNDEFINED_KEYWORD.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / UNDEFINED\_KEYWORD + +# Variable: UNDEFINED\_KEYWORD + +> `const` **UNDEFINED\_KEYWORD**: `"undefined"` = `'undefined'` + +Defined in: src/core/common/TSConst.ts:30 diff --git a/docs/api_docs/variables/UNKNOWN_CLASS_NAME.md b/docs/api_docs/variables/UNKNOWN_CLASS_NAME.md new file mode 100644 index 0000000000000000000000000000000000000000..badfb648abee6e275319cf88d764996132bff2e5 --- /dev/null +++ b/docs/api_docs/variables/UNKNOWN_CLASS_NAME.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / UNKNOWN\_CLASS\_NAME + +# Variable: UNKNOWN\_CLASS\_NAME + +> `const` **UNKNOWN\_CLASS\_NAME**: `""` = `''` + +Defined in: src/core/common/Const.ts:38 diff --git a/docs/api_docs/variables/UNKNOWN_FIELD_NAME.md b/docs/api_docs/variables/UNKNOWN_FIELD_NAME.md new file mode 100644 index 0000000000000000000000000000000000000000..7e01f27e104de5a55493bc281b4371a6af969586 --- /dev/null +++ b/docs/api_docs/variables/UNKNOWN_FIELD_NAME.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / UNKNOWN\_FIELD\_NAME + +# Variable: UNKNOWN\_FIELD\_NAME + +> `const` **UNKNOWN\_FIELD\_NAME**: `""` = `''` + +Defined in: src/core/common/Const.ts:39 diff --git a/docs/api_docs/variables/UNKNOWN_FILE_NAME.md b/docs/api_docs/variables/UNKNOWN_FILE_NAME.md new file mode 100644 index 0000000000000000000000000000000000000000..fed0d460ca2bc52582c375c003ada090b0522427 --- /dev/null +++ b/docs/api_docs/variables/UNKNOWN_FILE_NAME.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / UNKNOWN\_FILE\_NAME + +# Variable: UNKNOWN\_FILE\_NAME + +> `const` **UNKNOWN\_FILE\_NAME**: `string` + +Defined in: src/core/common/Const.ts:36 diff --git a/docs/api_docs/variables/UNKNOWN_KEYWORD.md b/docs/api_docs/variables/UNKNOWN_KEYWORD.md new file mode 100644 index 0000000000000000000000000000000000000000..45cc502941bc74143f7c29c6d5730eb75c1dc5b2 --- /dev/null +++ b/docs/api_docs/variables/UNKNOWN_KEYWORD.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / UNKNOWN\_KEYWORD + +# Variable: UNKNOWN\_KEYWORD + +> `const` **UNKNOWN\_KEYWORD**: `"unknown"` = `'unknown'` + +Defined in: src/core/common/TSConst.ts:32 diff --git a/docs/api_docs/variables/UNKNOWN_METHOD_NAME.md b/docs/api_docs/variables/UNKNOWN_METHOD_NAME.md new file mode 100644 index 0000000000000000000000000000000000000000..2e1803b7ef7125bbcb7fd17712380db405120646 --- /dev/null +++ b/docs/api_docs/variables/UNKNOWN_METHOD_NAME.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / UNKNOWN\_METHOD\_NAME + +# Variable: UNKNOWN\_METHOD\_NAME + +> `const` **UNKNOWN\_METHOD\_NAME**: `""` = `''` + +Defined in: src/core/common/Const.ts:40 diff --git a/docs/api_docs/variables/UNKNOWN_NAME.md b/docs/api_docs/variables/UNKNOWN_NAME.md new file mode 100644 index 0000000000000000000000000000000000000000..97ef66e04b2641fbe467004e212bcd49bb90c602 --- /dev/null +++ b/docs/api_docs/variables/UNKNOWN_NAME.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / UNKNOWN\_NAME + +# Variable: UNKNOWN\_NAME + +> `const` **UNKNOWN\_NAME**: `"unk"` = `'unk'` + +Defined in: src/core/common/Const.ts:19 diff --git a/docs/api_docs/variables/UNKNOWN_NAMESPACE_NAME.md b/docs/api_docs/variables/UNKNOWN_NAMESPACE_NAME.md new file mode 100644 index 0000000000000000000000000000000000000000..29b0b9d191a77a2e01d268f9d6639abf7364c77f --- /dev/null +++ b/docs/api_docs/variables/UNKNOWN_NAMESPACE_NAME.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / UNKNOWN\_NAMESPACE\_NAME + +# Variable: UNKNOWN\_NAMESPACE\_NAME + +> `const` **UNKNOWN\_NAMESPACE\_NAME**: `string` + +Defined in: src/core/common/Const.ts:37 diff --git a/docs/api_docs/variables/UNKNOWN_PROJECT_NAME.md b/docs/api_docs/variables/UNKNOWN_PROJECT_NAME.md new file mode 100644 index 0000000000000000000000000000000000000000..ca8f8367f1a03e5c850297ee399c2686e656b4c4 --- /dev/null +++ b/docs/api_docs/variables/UNKNOWN_PROJECT_NAME.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / UNKNOWN\_PROJECT\_NAME + +# Variable: UNKNOWN\_PROJECT\_NAME + +> `const` **UNKNOWN\_PROJECT\_NAME**: `string` + +Defined in: src/core/common/Const.ts:35 diff --git a/docs/api_docs/variables/VOID_KEYWORD.md b/docs/api_docs/variables/VOID_KEYWORD.md new file mode 100644 index 0000000000000000000000000000000000000000..241671e7c486dc2a21a78944020b7840ed877940 --- /dev/null +++ b/docs/api_docs/variables/VOID_KEYWORD.md @@ -0,0 +1,11 @@ +[**ArkAnalyzer**](../README.md) + +*** + +[ArkAnalyzer](../globals.md) / VOID\_KEYWORD + +# Variable: VOID\_KEYWORD + +> `const` **VOID\_KEYWORD**: `"void"` = `'void'` + +Defined in: src/core/common/TSConst.ts:36 diff --git a/package.json b/package.json index 7323488963ca2f497382f48dfe591fed704b4deb..5763dab7146376ae56d56138a164b337568bf3dd 100644 --- a/package.json +++ b/package.json @@ -29,7 +29,8 @@ "devDependencies": { "@vitest/coverage-v8": "^1.5.0", "ts-node": "^10.9.1", - "typedoc": "^0.25.13", + "typedoc": "^0.27.7", + "typedoc-plugin-markdown": "^4.4.2", "vitest": "^1.5.0" } } diff --git a/typedoc.json b/typedoc.json index ec32ca7d8858f97b55af86eaf272ae3fec2a9934..6df3380ad40a512a236cf316c4c543ad749a68a9 100644 --- a/typedoc.json +++ b/typedoc.json @@ -16,6 +16,9 @@ ], "excludeInternal": true, "useTsLinkResolution": true, - "out": "doc", + "plugin": [ + "typedoc-plugin-markdown" + ], + "out": "docs/api_docs", "readme": "./README.en.md" } \ No newline at end of file