TypeDoc API - v0.28.20
    Preparing search index...

    Class Deserializer

    Deserializes TypeDoc's JSON output back to Reflection instances.

    Index
    constructor
    addDeserializer constructReflection constructType defer fromObject revive reviveMany reviveProject reviveProjects reviveType
    logger oldFileIdToNewFileId oldIdToNewId project projectRoot reflectionBuilders typeBuilders
    logger: Logger
    oldFileIdToNewFileId: Record<FileId, FileId | undefined> = {}
    oldIdToNewId: Record<ReflectionId, ReflectionId | undefined> = {}
    project: ProjectReflection | undefined
    projectRoot: NormalizedPath

    Only set when deserializing.

    reflectionBuilders: {
        declaration: (
            parent: Reflection,
            obj: JSONOutput.DeclarationReflection | JSONOutput.ReferenceReflection,
        ) => DeclarationReflection;
        document: (
            parent: Reflection,
            obj: JSONOutput.DocumentReflection,
        ) => DocumentReflection;
        param: (
            parent: SignatureReflection,
            obj: JSONOutput.ParameterReflection,
        ) => ParameterReflection;
        project: (
            parent: Reflection,
            obj: JSONOutput.ProjectReflection,
        ) => ProjectReflection;
        reference: (
            parent: Reflection,
            obj: JSONOutput.ReferenceReflection,
        ) => ReferenceReflection;
        signature: (
            parent: DeclarationReflection,
            obj: JSONOutput.SignatureReflection,
        ) => SignatureReflection;
        typeParam: (
            parent: NonNullable<
                DeclarationReflection
                | SignatureReflection
                | undefined,
            >,
            obj: JSONOutput.TypeParameterReflection,
        ) => TypeParameterReflection;
    } = ...
    typeBuilders: {
        array: (obj: JSONOutput.ArrayType, de: Deserializer) => ArrayType;
        conditional: (
            obj: JSONOutput.ConditionalType,
            de: Deserializer,
        ) => ConditionalType;
        indexedAccess: (
            obj: JSONOutput.IndexedAccessType,
            de: Deserializer,
        ) => IndexedAccessType;
        inferred: (obj: JSONOutput.InferredType, de: Deserializer) => InferredType;
        intersection: (
            obj: JSONOutput.IntersectionType,
            de: Deserializer,
        ) => IntersectionType;
        intrinsic: (
            obj: JSONOutput.IntrinsicType,
            de: Deserializer,
        ) => IntrinsicType;
        literal: (obj: JSONOutput.LiteralType, de: Deserializer) => LiteralType;
        mapped: (obj: JSONOutput.MappedType, de: Deserializer) => MappedType;
        namedTupleMember: (
            obj: NamedTupleMemberType,
            de: Deserializer,
        ) => NamedTupleMember;
        optional: (obj: JSONOutput.OptionalType, de: Deserializer) => OptionalType;
        predicate: (
            obj: JSONOutput.PredicateType,
            de: Deserializer,
        ) => PredicateType;
        query: (obj: JSONOutput.QueryType, de: Deserializer) => QueryType;
        reference: (
            obj: JSONOutput.ReferenceType,
            de: Deserializer,
        ) => ReferenceType;
        reflection: (
            obj: JSONOutput.ReflectionType,
            de: Deserializer,
        ) => ReflectionType;
        rest: (obj: JSONOutput.RestType, de: Deserializer) => RestType;
        templateLiteral: (
            obj: JSONOutput.TemplateLiteralType,
            de: Deserializer,
        ) => TemplateLiteralType;
        tuple: (obj: JSONOutput.TupleType, de: Deserializer) => TupleType;
        typeOperator: (
            obj: JSONOutput.TypeOperatorType,
            de: Deserializer,
        ) => TypeOperatorType;
        union: (obj: JSONOutput.UnionType, de: Deserializer) => UnionType;
        unknown: (obj: JSONOutput.UnknownType, de: Deserializer) => UnknownType;
    } = ...

    Settings
    Member Visibility

    On This Page
    Constructors
    Methods
    Properties