Interface JsonDeserializerOptions

Interface

Module	import { JsonDeserializerOptions } from "@tsed/json-mapper"
Source	/packages/json-mapper/src/utils/deserialize.ts

Overview

interface JsonDeserializerOptions<T = any, C = any> extends MetadataTypes<T, C> {
types?<span class="token punctuation">:</span> Map&lt;<a href="/api/core/interfaces/Type.html"><span class="token">Type</span></a>&lt;<span class="token keyword">any</span>&gt;<span class="token punctuation">,</span> <a href="/api/json-mapper/interfaces/JsonMapperMethods.html"><span class="token">JsonMapperMethods</span></a>&gt;<span class="token punctuation">;</span>

useAlias?<span class="token punctuation">:</span> <span class="token keyword">boolean</span><span class="token punctuation">;</span>

additionalProperties?<span class="token punctuation">:</span> <span class="token keyword">boolean</span><span class="token punctuation">;</span>

store?<span class="token punctuation">:</span> <a href="/api/schema/domain/JsonEntityStore.html"><span class="token">JsonEntityStore</span></a><span class="token punctuation">;</span>

groups?<span class="token punctuation">:</span> <span class="token keyword">string</span><span class="token punctuation">[</span><span class="token punctuation">]</span> | false<span class="token punctuation">;</span>
<span class="token punctuation">[</span>key<span class="token punctuation">:</span> <span class="token keyword">string</span><span class="token punctuation">]</span><span class="token punctuation">:</span> <span class="token keyword">any</span><span class="token punctuation">;</span>
}

Members

types?: Map<Type<any>, JsonMapperMethods>;

Types used to map complex types (Symbol, Array, Set, Map)

---

useAlias?: boolean;

useAlias mapping

---

additionalProperties?: boolean;

Accept additionalProperties or ignore it

---

store?: JsonEntityStore;

Use the store which have all metadata to deserialize correctly the model. This property is useful when you deal with metadata parameters.

---

groups?: string[] | false;

---

[key: string]: any;