Skip to content

Commit fd0a97b

Browse files
committed
upd: add new onProjectChanged API
1 parent 613e4f1 commit fd0a97b

File tree

1 file changed

+32
-14
lines changed

1 file changed

+32
-14
lines changed

content/docs/extension-docs/scripts/modules/bridge-project.md

Lines changed: 32 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,15 @@ Force compilation of the project using the specified compiler config.
1717

1818
#### Parameters
1919

20-
| Name | Type | Description |
21-
| :------ | :------ | :------ |
20+
| Name | Type | Description |
21+
| :----------- | :------- | :------------------------------------------------------------------------------------------------------------------------- |
2222
| `configFile` | `string` | The name of the compiler config to compiler with. The config should be in the "<projectName>/.bridge/compiler/" directory. |
2323

2424
#### Returns
2525

2626
`Promise`<`void`\>
2727

28-
___
28+
---
2929

3030
### compileFiles
3131

@@ -35,15 +35,15 @@ Force the compilation of specified files.
3535

3636
#### Parameters
3737

38-
| Name | Type | Description |
39-
| :------ | :------ | :------ |
38+
| Name | Type | Description |
39+
| :------ | :--------- | :--------------------------------------------------------------- |
4040
| `paths` | `string`[] | The paths of the files to compile, relative to the project root. |
4141

4242
#### Returns
4343

4444
`Promise`<`void`\>
4545

46-
___
46+
---
4747

4848
### hasPack
4949

@@ -53,15 +53,15 @@ Check whether the current project contains the specified packs.
5353

5454
#### Parameters
5555

56-
| Name | Type | Description |
57-
| :------ | :------ | :------ |
56+
| Name | Type | Description |
57+
| :------ | :---------------------------------------- | :------------------------- |
5858
| `packs` | [`PackTypeId`](../README.md#packtypeid)[] | The pack ids to check for. |
5959

6060
#### Returns
6161

6262
`boolean`
6363

64-
___
64+
---
6565

6666
### registerExporter
6767

@@ -71,15 +71,15 @@ Register a pack exporter to be used to export the project.
7171

7272
#### Parameters
7373

74-
| Name | Type | Description |
75-
| :------ | :------ | :------ |
74+
| Name | Type | Description |
75+
| :--------- | :---------------------------------------- | :----------------------------------- |
7676
| `exporter` | [`IExporter`](../interfaces/iexporter.md) | The exporter definition to register. |
7777

7878
#### Returns
7979

8080
`void`
8181

82-
___
82+
---
8383

8484
### unlinkFile
8585

@@ -89,10 +89,28 @@ Remove a file from the fileSystem, compiler and packIndexer.
8989

9090
#### Parameters
9191

92-
| Name | Type | Description |
93-
| :------ | :------ | :------ |
92+
| Name | Type | Description |
93+
| :----- | :------- | :------------------------------ |
9494
| `path` | `string` | The path to the file to unlink. |
9595

9696
#### Returns
9797

9898
`Promise`<`void`\>
99+
100+
---
101+
102+
### onProjectChanged
103+
104+
**onProjectChanged**(`cb`): `IDisposable`
105+
106+
Get notified when the current project changes.
107+
108+
#### Parameters
109+
110+
| Name | Type | Description |
111+
| :--- | :---------------------------------- | :-------------------------------------------- |
112+
| `cb` | (`projectName`: `string`) => `void` | The function to call when the project changes |
113+
114+
#### Returns
115+
116+
`IDisposable`

0 commit comments

Comments
 (0)