@jsonjoy.com/json-type/lib/type/classes/ObjectType.d.ts

High-performance JSON Pointer implementation

import { JsExpression } from '@jsonjoy.com/util/lib/codegen/util/JsExpression';
import * as schema from '../../schema';
import type { ValidatorCodegenContext } from '../../codegen/validator/ValidatorCodegenContext';
import type { ValidationPath } from '../../codegen/validator/types';
import type { JsonTextEncoderCodegenContext } from '../../codegen/json/JsonTextEncoderCodegenContext';
import type { CborEncoderCodegenContext } from '../../codegen/binary/CborEncoderCodegenContext';
import type { JsonEncoderCodegenContext } from '../../codegen/binary/JsonEncoderCodegenContext';
import type { MessagePackEncoderCodegenContext } from '../../codegen/binary/MessagePackEncoderCodegenContext';
import type { CapacityEstimatorCodegenContext } from '../../codegen/capacity/CapacityEstimatorCodegenContext';
import { AbstractType } from './AbstractType';
import type * as jsonSchema from '../../json-schema';
import type { SchemaOf, SchemaOfObjectFields, Type } from '../types';
import type { TypeSystem } from '../../system/TypeSystem';
import type { json_string } from '@jsonjoy.com/util/lib/json-brand';
import type * as ts from '../../typescript/types';
import type { TypeExportContext } from '../../system/TypeExportContext';
import type { ExcludeFromTuple, PickFromTuple } from '../../util/types';
export declare class ObjectFieldType<K extends string, V extends Type> extends AbstractType<schema.ObjectFieldSchema<K, SchemaOf<V>>> {
    readonly key: K;
    readonly value: V;
    protected schema: schema.ObjectFieldSchema<K, any>;
    constructor(key: K, value: V);
    getSchema(): schema.ObjectFieldSchema<K, SchemaOf<V>>;
    getOptions(): schema.Optional<schema.ObjectFieldSchema<K, SchemaOf<V>>>;
    validateSchema(): void;
    protected toStringTitle(): string;
    toString(tab?: string): string;
}
export declare class ObjectOptionalFieldType<K extends string, V extends Type> extends ObjectFieldType<K, V> {
    readonly key: K;
    readonly value: V;
    optional: boolean;
    constructor(key: K, value: V);
    protected toStringTitle(): string;
}
export declare class ObjectType<F extends ObjectFieldType<any, any>[] = ObjectFieldType<any, any>[]> extends AbstractType<schema.ObjectSchema<SchemaOfObjectFields<F>>> {
    readonly fields: F;
    protected schema: schema.ObjectSchema<any>;
    constructor(fields: F);
    getSchema(): schema.ObjectSchema<SchemaOfObjectFields<F>>;
    toJsonSchema(ctx?: TypeExportContext): jsonSchema.JsonSchemaObject;
    getOptions(): schema.Optional<schema.ObjectSchema<SchemaOfObjectFields<F>>>;
    getField<K extends keyof schema.TypeOf<schema.ObjectSchema<SchemaOfObjectFields<F>>>>(key: K): ObjectFieldType<string, Type> | undefined;
    extend<F2 extends ObjectFieldType<any, any>[]>(o: ObjectType<F2>): ObjectType<[...F, ...F2]>;
    omit<K extends keyof schema.TypeOf<schema.ObjectSchema<SchemaOfObjectFields<F>>>>(key: K): ObjectType<ExcludeFromTuple<F, ObjectFieldType<K extends string ? K : never, any>>>;
    pick<K extends keyof schema.TypeOf<schema.ObjectSchema<SchemaOfObjectFields<F>>>>(key: K): ObjectType<PickFromTuple<F, ObjectFieldType<K extends string ? K : never, any>>>;
    validateSchema(): void;
    codegenValidator(ctx: ValidatorCodegenContext, path: ValidationPath, r: string): void;
    codegenJsonTextEncoder(ctx: JsonTextEncoderCodegenContext, value: JsExpression): void;
    codegenCborEncoder(ctx: CborEncoderCodegenContext, value: JsExpression): void;
    codegenMessagePackEncoder(ctx: MessagePackEncoderCodegenContext, value: JsExpression): void;
    codegenJsonEncoder(ctx: JsonEncoderCodegenContext, value: JsExpression): void;
    codegenCapacityEstimator(ctx: CapacityEstimatorCodegenContext, value: JsExpression): void;
    random(): Record<string, unknown>;
    toTypeScriptAst(): ts.TsTypeLiteral;
    toJson(value: unknown, system?: TypeSystem | undefined): json_string<unknown>;
    toString(tab?: string): string;
}