JsonPropertyStore

@tsed/schema

Usage

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

See /packages/specs/schema/src/types/domain/JsonPropertyStore.ts.

Overview

class JsonPropertyStore extends JsonEntityStore {
    readonly parent: JsonClassStore;
    get required(): boolean;
    set required(value: boolean);
    get allowedRequiredValues(): any[];
    discriminatorKey(): this;
    isDiscriminatorKey(): boolean;
    isRequired(value: any): boolean;
    protected build(): void;
    static get(target: Type<any>, propertyKey: string | symbol): JsonPropertyStore;
}

readonly parent

readonly parent: JsonClassStore;

get required

get required(): boolean;

Return the required state.

set required

set required(value: boolean);

Change the state of the required data.

get allowedRequiredValues

get allowedRequiredValues(): any[];

discriminatorKey

discriminatorKey(): this;

isDiscriminatorKey

isDiscriminatorKey(): boolean;

isRequired

isRequired(value: any): boolean;

Check precondition between value, required and allowedRequiredValues to know if the entity is required.

protected build

protected build(): void;

static get

static get(target: Type<any>, propertyKey: string | symbol): JsonPropertyStore;