Class FileRegistry

Hierarchy (View Summary)

FileRegistry
- Models.ValidatingFileRegistry

Index

Constructors

Methods

fromObject getName getNameToAbsoluteMap getReflectionPath register registerAbsolute registerReflection removeReflection resolve toObject

Properties

mediaToPath mediaToReflection names nameUsage nextId pathToMedia reflectionToPath

Constructors

constructor

new FileRegistry(): Models.FileRegistry
Returns Models.FileRegistry

Methods

fromObject

fromObject(de: Deserializer, obj: JSONOutput.FileRegistry): void
Revive a file registry from disc. Note that in the packages context this may be called multiple times on a single object, and should merge in files from the other registries.
Parameters
- de: Deserializer
- obj: JSONOutput.FileRegistry
Returns void
- Defined in lib/models/FileRegistry.ts:143

getName

getName(id: number): undefined | string
Parameters
- id: number
Returns undefined | string
- Defined in lib/models/FileRegistry.ts:84

getNameToAbsoluteMap

getNameToAbsoluteMap(): ReadonlyMap<string, string>
Returns ReadonlyMap<string, string>
- Defined in lib/models/FileRegistry.ts:110

getReflectionPath

getReflectionPath(reflection: Models.Reflection): undefined | string
Parameters
- reflection: Models.Reflection
Returns undefined | string
- Defined in lib/models/FileRegistry.ts:52

register

register(
sourcePath: string,
relativePath: string,
): undefined | { anchor: undefined | string; target: number }
Parameters
- sourcePath: string
- relativePath: string
Returns undefined | { anchor: undefined | string; target: number }
- Defined in lib/models/FileRegistry.ts:56

registerAbsolute

registerAbsolute(
absolute: string,
): { anchor: undefined | string; target: number }
Parameters
- absolute: string
Returns { anchor: undefined | string; target: number }
- Defined in lib/models/FileRegistry.ts:22

registerReflection

registerReflection(absolute: string, reflection: Models.Reflection): void
Internal
Called by ProjectReflection.registerReflection
Parameters
- absolute: string
- reflection: Models.Reflection
Returns void
- Defined in lib/models/FileRegistry.ts:45

removeReflection

removeReflection(reflection: Models.Reflection): void
Parameters
- reflection: Models.Reflection
Returns void
- Defined in lib/models/FileRegistry.ts:65

resolve

resolve(
id: number,
project: Models.ProjectReflection,
): undefined | string | Models.Reflection
Parameters
- id: number
- project: Models.ProjectReflection
Returns undefined | string | Models.Reflection
- Defined in lib/models/FileRegistry.ts:73

toObject

toObject(ser: Serializer): JSONOutput.FileRegistry
Parameters
- ser: Serializer
Returns JSONOutput.FileRegistry
- Defined in lib/models/FileRegistry.ts:118

Properties

`Protected`mediaToPath

mediaToPath: Map<number, string> = ...

`Protected`mediaToReflection

mediaToReflection: Map<number, Models.ReflectionId> = ...

`Protected`names

names: Map<number, string> = ...

`Protected`nameUsage

nameUsage: Map<string, number> = ...

`Protected`nextId

nextId: number = 1

`Protected`pathToMedia

pathToMedia: Map<string, number> = ...

`Protected`reflectionToPath

reflectionToPath: Map<Models.ReflectionId, string> = ...