@sap/artifact-management 1.20.0 → 1.20.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +17 -0
- package/dist/projectapi.js +1 -1
- package/dist/src/plugins/cap/readers/CapModuleReader.js +2 -2
- package/dist/src/plugins/cap/readers/CapModuleReader.js.map +1 -1
- package/dist/src/project-api/NodeWorkspace.js +11 -1
- package/dist/src/project-api/NodeWorkspace.js.map +1 -1
- package/dist/src/project-api/VSCodeWorkspace.js +19 -1
- package/dist/src/project-api/VSCodeWorkspace.js.map +1 -1
- package/dist/src/project-api/WorkspaceApi.js.map +1 -1
- package/dist/src/project-api/WorkspaceImpl.js +4 -0
- package/dist/src/project-api/WorkspaceImpl.js.map +1 -1
- package/dist/tsconfig.tsbuildinfo +11 -9
- package/dist/types/src/project-api/NodeWorkspace.d.ts +2 -1
- package/dist/types/src/project-api/VSCodeWorkspace.d.ts +4 -2
- package/dist/types/src/project-api/WorkspaceApi.d.ts +1 -0
- package/dist/types/src/project-api/WorkspaceImpl.d.ts +1 -0
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -103,6 +103,23 @@ const ws = new WorkspaceImpl(workspacePath);
|
|
|
103
103
|
const projects = await ws.getProjects();
|
|
104
104
|
```
|
|
105
105
|
|
|
106
|
+
### Get Project
|
|
107
|
+
###### Description
|
|
108
|
+
Get the project with specific path.Return the ProjectAPI object based on the path.
|
|
109
|
+
###### Method
|
|
110
|
+
`getProject(path: string) : Promise<ProjectApi>`
|
|
111
|
+
|
|
112
|
+
###### Parameters
|
|
113
|
+
- path: the path of a project. It could be absolute or relative.
|
|
114
|
+
###### returns
|
|
115
|
+
- `ProjectApi` instance or `undefined`
|
|
116
|
+
|
|
117
|
+
###### Example
|
|
118
|
+
```
|
|
119
|
+
const ws = new WorkspaceImpl(workspacePath);
|
|
120
|
+
const path = '/Users/me/projects/lcap-project';
|
|
121
|
+
const project = await ws.getProject(path);
|
|
122
|
+
```
|
|
106
123
|
|
|
107
124
|
### Get Project URIs
|
|
108
125
|
###### Description
|