Class Deserializer

Deserializes TypeDoc's JSON output back to Reflection instances.

Index

Constructors

Properties

logger oldFileIdToNewFileId oldIdToNewId project projectRoot reflectionBuilders typeBuilders

Methods

addDeserializer constructReflection constructType defer fromObject revive reviveMany reviveProject reviveProjects reviveType

Constructors

constructor

new Deserializer(logger: Logger): Deserializer
Parameters
- logger: Logger
Returns Deserializer
- Defined in node_modules/.pnpm/typedoc@0.28.17_typescript@5.9.3/node_modules/typedoc/dist/lib/serialization/deserializer.d.ts:36

Properties

logger

logger: Logger

oldFileIdToNewFileId

oldFileIdToNewFileId: Record<FileId, FileId | undefined>

oldIdToNewId

oldIdToNewId: Record<ReflectionId, ReflectionId | undefined>

project

project: ProjectReflection | undefined

projectRoot

projectRoot: NormalizedPath

Only set when deserializing.

reflectionBuilders

reflectionBuilders: {
    declaration: (
        parent: Reflection,
        obj: ReferenceReflection | DeclarationReflection,
    ) => DeclarationReflection;
    document: (
        parent: Reflection,
        obj: DocumentReflection,
    ) => DocumentReflection;
    param: (
        parent: SignatureReflection,
        obj: ParameterReflection,
    ) => ParameterReflection;
    project: (parent: Reflection, obj: ProjectReflection) => ProjectReflection;
    reference: (
        parent: Reflection,
        obj: ReferenceReflection,
    ) => ReferenceReflection;
    signature: (
        parent: DeclarationReflection,
        obj: SignatureReflection,
    ) => SignatureReflection;
    typeParam: (
        parent: NonNullable<
            DeclarationReflection
            | SignatureReflection
            | undefined,
        >,
        obj: TypeParameterReflection,
    ) => TypeParameterReflection;
}

typeBuilders

typeBuilders: {
    array: (obj: ArrayType, de: Deserializer) => ArrayType;
    conditional: (obj: ConditionalType, de: Deserializer) => ConditionalType;
    indexedAccess: (
        obj: IndexedAccessType,
        de: Deserializer,
    ) => IndexedAccessType;
    inferred: (obj: InferredType, de: Deserializer) => InferredType;
    intersection: (obj: IntersectionType, de: Deserializer) => IntersectionType;
    intrinsic: (obj: IntrinsicType, de: Deserializer) => IntrinsicType;
    literal: (obj: LiteralType, de: Deserializer) => LiteralType;
    mapped: (obj: MappedType, de: Deserializer) => MappedType;
    namedTupleMember: (
        obj: NamedTupleMemberType,
        de: Deserializer,
    ) => NamedTupleMember;
    optional: (obj: OptionalType, de: Deserializer) => OptionalType;
    predicate: (obj: PredicateType, de: Deserializer) => PredicateType;
    query: (obj: QueryType, de: Deserializer) => QueryType;
    reference: (obj: ReferenceType, de: Deserializer) => ReferenceType;
    reflection: (obj: ReflectionType, de: Deserializer) => ReflectionType;
    rest: (obj: RestType, de: Deserializer) => RestType;
    templateLiteral: (
        obj: TemplateLiteralType,
        de: Deserializer,
    ) => TemplateLiteralType;
    tuple: (obj: TupleType, de: Deserializer) => TupleType;
    typeOperator: (obj: TypeOperatorType, de: Deserializer) => TypeOperatorType;
    union: (obj: UnionType, de: Deserializer) => UnionType;
    unknown: (obj: UnknownType, de: Deserializer) => UnknownType;
}

Methods

addDeserializer

addDeserializer(de: DeserializerComponent): void
Parameters
- de: DeserializerComponent
Returns void
- Defined in node_modules/.pnpm/typedoc@0.28.17_typescript@5.9.3/node_modules/typedoc/dist/lib/serialization/deserializer.d.ts:37

constructReflection

constructReflection<T extends SomeReflection>(
obj: T,
): ReflectionVariant[T["variant"]]
Type Parameters
- T extends SomeReflection
Parameters
- obj: T
Returns ReflectionVariant[T["variant"]]
- Defined in node_modules/.pnpm/typedoc@0.28.17_typescript@5.9.3/node_modules/typedoc/dist/lib/serialization/deserializer.d.ts:58

constructType

constructType<T extends SomeType>(obj: T): TypeKindMap[T["type"]]
Type Parameters
- T extends SomeType
Parameters
- obj: T
Returns TypeKindMap[T["type"]]
- Defined in node_modules/.pnpm/typedoc@0.28.17_typescript@5.9.3/node_modules/typedoc/dist/lib/serialization/deserializer.d.ts:59

defer

defer(cb: (project: ProjectReflection) => void): void
Defers work until the initial pass of serialization has been completed. This can be used to set up references which cannot be immediately restored.

May only be called when deserializing.
Parameters
- cb: (project: ProjectReflection) => void
Returns void
- Defined in node_modules/.pnpm/typedoc@0.28.17_typescript@5.9.3/node_modules/typedoc/dist/lib/serialization/deserializer.d.ts:69

fromObject

fromObject<T>(
receiver: { fromObject(d: Deserializer, o: T): void },
obj: T,
): void
Type Parameters
- T
Parameters
- receiver: { fromObject(d: Deserializer, o: T): void }
- obj: T
Returns void
- Defined in node_modules/.pnpm/typedoc@0.28.17_typescript@5.9.3/node_modules/typedoc/dist/lib/serialization/deserializer.d.ts:60

revive

revive<T extends object, U extends Deserializable<T>>(
source: T,
creator: (obj: T) => U,
): U
Type Parameters
- T extends object
- U extends Deserializable<T>
Parameters
- source: T
- creator: (obj: T) => U
Returns U
- Defined in node_modules/.pnpm/typedoc@0.28.17_typescript@5.9.3/node_modules/typedoc/dist/lib/serialization/deserializer.d.ts:52
revive<T extends object, U extends Deserializable<T>>(
source: T | undefined,
creator: (obj: T) => U,
): U | undefined
Type Parameters
- T extends object
- U extends Deserializable<T>
Parameters
- source: T | undefined
- creator: (obj: T) => U
Returns U | undefined
- Defined in node_modules/.pnpm/typedoc@0.28.17_typescript@5.9.3/node_modules/typedoc/dist/lib/serialization/deserializer.d.ts:53

reviveMany

reviveMany<T, U extends Deserializable<T>>(
sourceArray: T[],
creator: (obj: T) => U,
): U[]
Type Parameters
- T
- U extends Deserializable<T>
Parameters
- sourceArray: T[]
- creator: (obj: T) => U
Returns U[]
- Defined in node_modules/.pnpm/typedoc@0.28.17_typescript@5.9.3/node_modules/typedoc/dist/lib/serialization/deserializer.d.ts:54
reviveMany<T, U extends Deserializable<T>>(
sourceArray: T[] | undefined,
creator: (obj: T) => U,
): U[] | undefined
Type Parameters
- T
- U extends Deserializable<T>
Parameters
- sourceArray: T[] | undefined
- creator: (obj: T) => U
Returns U[] | undefined
- Defined in node_modules/.pnpm/typedoc@0.28.17_typescript@5.9.3/node_modules/typedoc/dist/lib/serialization/deserializer.d.ts:55

reviveProject

reviveProject(
    name: string,
    projectObj: ProjectReflection,
    options: { projectRoot: NormalizedPath; registry: FileRegistry },
): ProjectReflection
Revive a single project into the structure it was originally created with. This is generally not appropriate for merging multiple projects since projects may contain reflections in their root, not inside a module.
Parameters
- name: string
- projectObj: ProjectReflection
- options: { projectRoot: NormalizedPath; registry: FileRegistry }
Returns ProjectReflection
- Defined in node_modules/.pnpm/typedoc@0.28.17_typescript@5.9.3/node_modules/typedoc/dist/lib/serialization/deserializer.d.ts:43

reviveProjects

reviveProjects(
    name: string,
    projects: readonly ProjectReflection[],
    options: {
        alwaysCreateEntryPointModule: boolean;
        projectRoot: NormalizedPath;
        registry: FileRegistry;
    },
): ProjectReflection
Parameters
- name: string
- projects: readonly ProjectReflection[]
- options: {
      alwaysCreateEntryPointModule: boolean;
      projectRoot: NormalizedPath;
      registry: FileRegistry;
  }
Returns ProjectReflection
- Defined in node_modules/.pnpm/typedoc@0.28.17_typescript@5.9.3/node_modules/typedoc/dist/lib/serialization/deserializer.d.ts:47

reviveType

reviveType<T extends SomeType>(obj: T): TypeKindMap[T["type"]]
Type Parameters
- T extends SomeType
Parameters
- obj: T
Returns TypeKindMap[T["type"]]
- Defined in node_modules/.pnpm/typedoc@0.28.17_typescript@5.9.3/node_modules/typedoc/dist/lib/serialization/deserializer.d.ts:56
reviveType<T extends SomeType>(
obj: T | undefined,
): TypeKindMap[T["type"]] | undefined
Type Parameters
- T extends SomeType
Parameters
- obj: T | undefined
Returns TypeKindMap[T["type"]] | undefined
- Defined in node_modules/.pnpm/typedoc@0.28.17_typescript@5.9.3/node_modules/typedoc/dist/lib/serialization/deserializer.d.ts:57

Class Deserializer

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Deserializer

Properties

logger

oldFileIdToNewFileId

oldIdToNewId

project

projectRoot

reflectionBuilders

typeBuilders

Methods

addDeserializer

Parameters

Returns void

constructReflection

Type Parameters

Parameters

Returns ReflectionVariant[T["variant"]]

constructType

Type Parameters

Parameters

Returns TypeKindMap[T["type"]]

defer

Parameters

Returns void

fromObject

Type Parameters

Parameters

Returns void

revive

Type Parameters

Parameters

Returns U

Type Parameters

Parameters

Returns U | undefined

reviveMany

Type Parameters

Parameters

Returns U[]

Type Parameters

Parameters

Returns U[] | undefined

reviveProject

Parameters

Returns ProjectReflection

reviveProjects

Parameters

Returns ProjectReflection

reviveType

Type Parameters

Parameters

Returns TypeKindMap[T["type"]]

Type Parameters

Parameters

Returns TypeKindMap[T["type"]] | undefined

Settings

On This Page