# JsonSchemaRegistry Class deprecated
Module | import { JsonSchemaRegistry } from "@tsed/common" |
---|---|
Source | /packages/common/src/jsonschema/registries/JsonSchemesRegistry.ts |
# Overview
class JsonSchemaRegistry extends Registry<any, Partial<JsonSchema>> {
/**
*
* @param schema
* @param type
* @param collectionType
*/
/**
*
* @param <span class="token punctuation">{</span><a href="/api/core/interfaces/Type.html"><span class="token">Type</span></a><<span class="token keyword">any</span>><span class="token punctuation">}</span> target
* @param <span class="token punctuation">{</span><span class="token keyword">string</span><span class="token punctuation">}</span> propertyKey
* @param type
* @param collectionType
* @returns <span class="token punctuation">{</span><a href="/api/common/jsonschema/class/JsonSchema.html"><span class="token">JsonSchema</span></a><span class="token punctuation">}</span>
*/
<span class="token function">property</span><span class="token punctuation">(</span>target<span class="token punctuation">:</span> <a href="/api/core/interfaces/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><span class="token punctuation">,</span> type<span class="token punctuation">:</span> <span class="token keyword">any</span><span class="token punctuation">,</span> collectionType?<span class="token punctuation">:</span> <span class="token keyword">any</span><span class="token punctuation">)</span><span class="token punctuation">:</span> <a href="/api/common/jsonschema/class/JsonSchema.html"><span class="token">JsonSchema</span></a><span class="token punctuation">;</span>
/**
*
* @param target
* @param <span class="token punctuation">{</span><span class="token keyword">string</span><span class="token punctuation">}</span> propertyKey
* @param value
*/
<span class="token function">required</span><span class="token punctuation">(</span>target<span class="token punctuation">:</span> <span class="token keyword">any</span><span class="token punctuation">,</span> propertyKey<span class="token punctuation">:</span> <span class="token keyword">string</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> <span class="token keyword">any</span><span class="token punctuation">;</span>
/**
*
* @param <span class="token punctuation">{</span><a href="/api/core/interfaces/Type.html"><span class="token">Type</span></a><<span class="token keyword">any</span>><span class="token punctuation">}</span> target
* @param options
* @returns <span class="token punctuation">{</span>JSONSchema6<span class="token punctuation">}</span>
*/
<span class="token function">getSchemaDefinition</span><span class="token punctuation">(</span>target<span class="token punctuation">:</span> <a href="/api/core/interfaces/Type.html"><span class="token">Type</span></a><<span class="token keyword">any</span>><span class="token punctuation">,</span> options?<span class="token punctuation">:</span> Partial<<a href="/api/common/jsonschema/registries/GetSchemaOptions.html"><span class="token">GetSchemaOptions</span></a>><span class="token punctuation">)</span><span class="token punctuation">:</span> JSONSchema6<span class="token punctuation">;</span>
/**
*
* @param <span class="token punctuation">{</span><a href="/api/core/interfaces/Type.html"><span class="token">Type</span></a><<span class="token keyword">any</span>><span class="token punctuation">}</span> target
* @param options
* @returns <span class="token punctuation">{</span>JSONSchema6<span class="token punctuation">}</span>
*/
/**
*
* @param <span class="token punctuation">{</span><a href="/api/common/jsonschema/class/JsonSchema.html"><span class="token">JsonSchema</span></a><span class="token punctuation">}</span> schema
* @param options
*/
/**
*
* @param <span class="token punctuation">{</span><span class="token keyword">string</span><span class="token punctuation">}</span> ref
* @returns <span class="token punctuation">{</span><span class="token keyword">string</span><span class="token punctuation">}</span>
*/
/**
*
* @param <span class="token punctuation">{</span><span class="token keyword">string</span><span class="token punctuation">}</span> name
* @returns <span class="token punctuation">{</span><a href="/api/common/jsonschema/class/JsonSchema.html"><span class="token">JsonSchema</span></a><span class="token punctuation">}</span>
*/
}
# Description
Registry to store all schemes.
WARNING
This class will be removed in v6
# Members
property(target: Type<any>, propertyKey: string, type: any, collectionType?: any): JsonSchema;
required(target: any, propertyKey: string, value?: boolean): any;
getSchemaDefinition(target: Type<any>, options?: Partial<GetSchemaOptions>): JSONSchema6;
- Session & cookies
- Passport.js
- TypeORM
- Mongoose
- GraphQL
- Socket.io
- Swagger
- AJV
- Multer
- Serve static files
- Templating
- Throw HTTP Exceptions
- Customize 404
- AWS
- Jest
- Seq
- Controllers
- Providers
- Model
- Converters
- Middlewares
- Pipes
- Interceptors
- Authentication
- Hooks
- Injection scopes
- Custom providers
- Custom endpoint decorator
- Testing