Skip to content

Commit 8e05f4e

Browse files
committed
Add documentation for originalPath
1 parent 82d4ccc commit 8e05f4e

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

src/compiler/moduleNameResolver.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,14 @@ namespace ts {
2929
path: string;
3030
extension: Extension;
3131
packageId: PackageId | undefined;
32+
/**
33+
* When the resolved is not created from cache, the value is
34+
* - string if original Path if it is symbolic link to the resolved path
35+
* - undefined if path is not a symbolic link
36+
* When the resolved is created using value from cache of ResolvedModuleWithFailedLookupLocations, the value is:
37+
* - string if original Path if it is symbolic link to the resolved path
38+
* - true if path is not a symbolic link - this indicates that the originalPath calculation is already done and needs to be skipped
39+
*/
3240
originalPath?: string | true;
3341
}
3442

0 commit comments

Comments
 (0)