Class SourceReference

Represents references of reflections to their defining source files.

See

DeclarationReflection.sources

Index

Constructors

Methods

equals fromObject toObject

Properties

character fileName fullFileName line url?

Constructors

constructor

new SourceReference(
    fileName: string,
    line: number,
    character: number,
): Models.SourceReference
Parameters
- fileName: string
- line: number
- character: number
Returns Models.SourceReference
- Defined in lib/models/SourceReference.ts:35

Methods

equals

equals(other: Models.SourceReference): boolean
Parameters
- other: Models.SourceReference
Returns boolean
- Defined in lib/models/SourceReference.ts:42

fromObject

fromObject(_de: Deserializer, obj: JSONOutput.SourceReference): void
Parameters
- _de: Deserializer
- obj: JSONOutput.SourceReference
Returns void
- Defined in lib/models/SourceReference.ts:59

toObject

toObject(): JSONOutput.SourceReference
Returns JSONOutput.SourceReference
- Defined in lib/models/SourceReference.ts:50

Properties

character

character: number

The index of the character that emitted the declaration.

fileName

fileName: string

The filename of the source file.

`Internal`fullFileName

fullFileName: string

The absolute filename of the source file.

line

line: number

The one based number of the line that emitted the declaration.

`Optional`url

url?: string

URL for displaying the source file.