UNPKG

1.02 kBTypeScriptView Raw
1import type { Deserializer } from "../../serialization/deserializer";
2import type { SourceReference as JSONSourceReference } from "../../serialization/schema";
3/**
4 * Represents references of reflections to their defining source files.
5 *
6 * @see {@link DeclarationReflection.sources}
7 */
8export declare class SourceReference {
9 /**
10 * The filename of the source file.
11 */
12 fileName: string;
13 /**
14 * The absolute filename of the source file.
15 * @internal
16 */
17 fullFileName: string;
18 /**
19 * The one based number of the line that emitted the declaration.
20 */
21 line: number;
22 /**
23 * The index of the character that emitted the declaration.
24 */
25 character: number;
26 /**
27 * URL for displaying the source file.
28 */
29 url?: string;
30 constructor(fileName: string, line: number, character: number);
31 equals(other: SourceReference): boolean;
32 toObject(): JSONSourceReference;
33 fromObject(_de: Deserializer, obj: JSONSourceReference): void;
34}