Fully Qualified Names (FQNs)
→ node properties that uniquely identify a concept within or across projects
Properties:
Name | Description |
---|---|
globalFqn | Global fully qualified name that uniquely identifies the code construct across all scanned projects. |
localFqn | Local fully qualified name that uniquely identifies the code construct within its containing project. This property mainly serves convenience purposes as it is shorter and, therefore, easier to handle than the globalFqn .In contrast to the globalFqn , this identifier is also independent of the machine |
globalFqn
Examples:
/home/myuser/dev/my-project/src/my-module.ts
for a :TS:Module"/home/myuser/dev/my-project/src/my-module.ts".myClass
for global declarations (like :TS:Class)"some-package".someDeclaration
for external declarations from Node.js packages (:TS:ExternalDeclaration)"/home/myuser/dev/my-project/src/my-module.ts".myClass.someMethod
for declaration members (like :TS:Method)
localFqn
Examples:
./src/my-module.ts
for a :TS:Module"./src/my-module.ts".myClass
for global declarations (like :TS:Class)"some-package".someDeclaration
for external declarations from Node.js packages (:TS:ExternalDeclaration)"./src/my-module.ts".myClass.someMethod
for declaration members (like :TS:Method)
Note
For declarations that are part of a
index.ts
(x
) module, the module path ends with the containing directory, omitting the file name.
E.g. alocalFqn
for the classMyClass
in the file./some/path/index.ts
would look like"./some/path".MyClass
.