docs: update path mappings and exports (#29810)

1) Path mappings are to be added in the workspace tsconfig files, hence the path needs to be `./` and not `../`
2) Fix export symbol as it cannot contain `-`

Fixes #29807

PR Close #29810
This commit is contained in:
Alan Agius 2019-04-10 14:41:51 +02:00 committed by Igor Minar
parent 675f3909d7
commit 17c4ed9d0f
1 changed files with 3 additions and 3 deletions

View File

@ -131,7 +131,7 @@ A linked library will then have its own set of Angular libraries that it uses fo
However, this can cause problems while building or running your application. However, this can cause problems while building or running your application.
To get around this problem you can use TypeScript path mapping to tell TypeScript that it should load some modules from a specific location. To get around this problem you can use TypeScript path mapping to tell TypeScript that it should load some modules from a specific location.
List all the peer dependencies that your library uses in the TypeScript configuration file `./tsconfig.json`, and point them at the local copy in the app's `node_modules` folder. List all the peer dependencies that your library uses in the workspace TypeScript configuration file `./tsconfig.json`, and point them at the local copy in the app's `node_modules` folder.
``` ```
{ {
@ -140,7 +140,7 @@ List all the peer dependencies that your library uses in the TypeScript configur
// paths are relative to `baseUrl` path. // paths are relative to `baseUrl` path.
"paths": { "paths": {
"@angular/*": [ "@angular/*": [
"../node_modules/@angular/*" "./node_modules/@angular/*"
] ]
} }
} }
@ -162,7 +162,7 @@ To use your own library in an app:
* In your apps, import from the library by name: * In your apps, import from the library by name:
``` ```
import { my-export } from 'my-lib'; import { myExport } from 'my-lib';
``` ```
### Building and rebuilding your library ### Building and rebuilding your library