TypeDoc API - v0.28.1

    Class ReflectionSymbolId

    This exists so that TypeDoc can store a unique identifier for a ts.Symbol without keeping a reference to the ts.Symbol itself. This identifier should be stable across runs so long as the symbol is exported from the same file.

    Index

    Constructors

    Methods

    Properties

    packageName: string

    The name of the package which this symbol ID resides within.

    packagePath: NormalizedPath

    Path to the source file containing this symbol. Note that this is NOT an absolute path, but a package-relative path according to the directory containing package.json for the package name.

    pos: number = Infinity

    Note: This is not serialized. It exists for sorting by declaration order, but should not be needed when deserializing from JSON. Will be set to Infinity if the ID was deserialized from JSON.

    qualifiedName: string

    Qualified name of this symbol within the source file.

    transientId: number = NaN

    Note: This is not serialized. It exists to support detection of the differences between symbols which share declarations, but are instantiated with different type parameters. This will be NaN if the symbol reference is not transient. Note: This can only be non-NaN if pos is finite.

    fileName?: NormalizedPath

    Note: This is not serialized, only packageName and packagePath path information is preserved when serializing. This is set so that it is available to plugins when initially converting a project.

    UNKNOWN_PACKAGE: "<unknown>"

    This will only be used if we somehow cannot find a package.json file for source code. This is very unlikely, but if it occurs then the packageName will be set to this string, and packagePath will have the absolute path to the source file.

    MMNEPVFCICPMFPCPTTAAATR