Class SourceReference

Represents references of reflections to their defining source files.

See

DeclarationReflection.sources

Index

Constructors

Properties

character fileName fullFileName line url?

Methods

equals fromObject toObject

Constructors

constructor

new SourceReference(
    fileName: string,
    line: number,
    character: number,
): SourceReference
Parameters
- fileName: string
- line: number
- character: number
Returns SourceReference
- Defined in node_modules/.pnpm/typedoc@0.28.17_typescript@5.9.3/node_modules/typedoc/dist/lib/models/SourceReference.d.ts:29

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.

Methods

equals

equals(other: SourceReference): boolean
Parameters
- other: SourceReference
Returns boolean
- Defined in node_modules/.pnpm/typedoc@0.28.17_typescript@5.9.3/node_modules/typedoc/dist/lib/models/SourceReference.d.ts:30

fromObject

fromObject(_de: Deserializer, obj: SourceReference): void
Parameters
- _de: Deserializer
- obj: SourceReference
Returns void
- Defined in node_modules/.pnpm/typedoc@0.28.17_typescript@5.9.3/node_modules/typedoc/dist/lib/models/SourceReference.d.ts:32

toObject

toObject(): SourceReference
Returns SourceReference
- Defined in node_modules/.pnpm/typedoc@0.28.17_typescript@5.9.3/node_modules/typedoc/dist/lib/models/SourceReference.d.ts:31