# Class JsonPropertyStore
ClassModule | import { JsonPropertyStore } from "@tsed/schema" |
---|---|
Source | /packages/specs/schema/src/types/domain/JsonPropertyStore.ts |
# Overview
class JsonPropertyStore extends JsonEntityStore {
readonly parent: JsonClassStore;
get <span class="token function">required</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">:</span> <span class="token keyword">boolean</span><span class="token punctuation">;</span>
set <span class="token function">required</span><span class="token punctuation">(</span>value<span class="token punctuation">:</span> <span class="token keyword">boolean</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
get <span class="token function">allowedRequiredValues</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">:</span> <span class="token keyword">any</span><span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">;</span>
<span class="token function">discriminatorKey</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">:</span> this<span class="token punctuation">;</span>
<span class="token function">isDiscriminatorKey</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">:</span> <span class="token keyword">boolean</span><span class="token punctuation">;</span>
<span class="token function">isRequired</span><span class="token punctuation">(</span>value<span class="token punctuation">:</span> <span class="token keyword">any</span><span class="token punctuation">)</span><span class="token punctuation">:</span> <span class="token keyword">boolean</span><span class="token punctuation">;</span>
<span class="token keyword">protected</span> <span class="token function">build</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">:</span> <span class="token keyword">void</span><span class="token punctuation">;</span>
<span class="token keyword">static</span> <span class="token function">get</span><span class="token punctuation">(</span>target<span class="token punctuation">:</span> <a href="/api/core/types/domain/Type.html"><span class="token">Type</span></a><<span class="token keyword">any</span>><span class="token punctuation">,</span> propertyKey<span class="token punctuation">:</span> <span class="token keyword">string</span> | symbol<span class="token punctuation">)</span><span class="token punctuation">:</span> JsonPropertyStore<span class="token punctuation">;</span>
}
# Members
readonly parent: JsonClassStore;
get required(): boolean;
Return the required state.
set required(value: boolean);
Change the state of the required data.
get allowedRequiredValues(): any[];
discriminatorKey(): this;
isDiscriminatorKey(): boolean;
isRequired(value: any): boolean;
Check precondition between value, required and allowedRequiredValues to know if the entity is required.
protected build(): void;
static get(target: Type<any>, propertyKey: string | symbol): JsonPropertyStore;