@scalar/typebox/build/esm/type/module/module.d.mts

Json Schema Type Builder with Static Type Resolution for TypeScript

import { Kind } from '../symbols/index.mjs';
import { SchemaOptions, TSchema } from '../schema/index.mjs';
import { TProperties } from '../object/index.mjs';
import { Static } from '../static/index.mjs';
import { TComputeModuleProperties } from './compute.mjs';
import { TInferFromModuleKey } from './infer.mjs';
export interface TDefinitions<ModuleProperties extends TProperties> extends TSchema {
    static: {
        [K in keyof ModuleProperties]: Static<ModuleProperties[K]>;
    };
    $defs: ModuleProperties;
}
export interface TImport<ModuleProperties extends TProperties = {}, Key extends keyof ModuleProperties = keyof ModuleProperties> extends TSchema {
    [Kind]: 'Import';
    static: TInferFromModuleKey<ModuleProperties, Key>;
    $defs: ModuleProperties;
    $ref: Key;
}
export declare class TModule<ModuleProperties extends TProperties, ComputedModuleProperties extends TProperties = TComputeModuleProperties<ModuleProperties>> {
    private readonly $defs;
    constructor($defs: ModuleProperties);
    /** `[Json]` Imports a Type by Key. */
    Import<Key extends keyof ComputedModuleProperties>(key: Key, options?: SchemaOptions): TImport<ComputedModuleProperties, Key>;
    private WithIdentifiers;
}
/** `[Json]` Creates a Type Definition Module. */
export declare function Module<Properties extends TProperties>(properties: Properties): TModule<Properties>;