UNPKG

@loopback/docs

Version:

Documentation files rendered at [https://loopback.io](https://loopback.io)

38 lines (25 loc) 1.23 kB
--- lang: en title: 'API docs: repository-json-schema.getjsonschema' keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI sidebar: lb4_sidebar editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/repository-json-schema permalink: /doc/en/lb4/apidocs.repository-json-schema.getjsonschema.html --- <!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](./index.md) &gt; [@loopback/repository-json-schema](./repository-json-schema.md) &gt; [getJsonSchema](./repository-json-schema.getjsonschema.md) ## getJsonSchema() function Gets the JSON Schema of a TypeScript model/class by seeing if one exists in a cache. If not, one is generated and then cached. <b>Signature:</b> ```typescript export declare function getJsonSchema<T extends object>(ctor: Function & { prototype: T; }, options?: JsonSchemaOptions<T>): JsonSchema; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | | ctor | Function &amp; { prototype: T; } | Constructor of class to get JSON Schema from | | options | [JsonSchemaOptions](./repository-json-schema.jsonschemaoptions.md)<!-- -->&lt;T&gt; | | <b>Returns:</b> JsonSchema