JsonLazyRef

@tsed/schema

Usage

import { JsonLazyRef } from "@tsed/schema";

See /packages/specs/schema/src/domain/JsonLazyRef.ts.

Overview

class JsonLazyRef {
    readonly getType: () => Type<any>;
    readonly isLazyRef = true;
    constructor(getType: () => Type<any>);
    get target(): Type<any>;
    get schema(): import("@tsed/schema").JsonSchema<import("json-schema").JSONSchema7Type>;
    get name(): string;
}

Description

Lazy reference to a schema type for handling circular dependencies.

JsonLazyRef provides a deferred reference mechanism for types that may not be available at decoration time due to circular dependencies or forward references. The actual type is resolved lazily when needed, avoiding initialization order issues.

Usage

class User {
  @Property()
  name: string;

  // Circular reference - user has a manager who is also a user
  @Property()
  manager: User; // Internally uses lazy ref
}

Use Cases

• Circular Dependencies: Classes that reference themselves or each other
• Forward References: References to classes defined later in the file
• Conditional Imports: Types that may not be available immediately

How It Works

The lazy ref wraps a function that returns the type, delaying type resolution until the schema is actually needed during schema generation.

readonly getType:

readonly getType: () => Type<any>;

readonly isLazyRef

readonly isLazyRef = true;

get target

get target(): Type<any>;

get schema

get schema(): import("@tsed/schema").JsonSchema<import("json-schema").JSONSchema7Type>;

get name

get name(): string;