@loopback/docs
Version:
Documentation for LoopBack 4
38 lines (25 loc) • 1.2 kB
Markdown
---
lang: en
title: 'API docs: repository-json-schema.getjsonschema'
keywords: LoopBack 4.0, LoopBack 4
sidebar: lb4_sidebar
editurl: https://github.com/strongloop/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) > [@loopback/repository-json-schema](./repository-json-schema.md) > [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 | <code>Function & {</code><br/><code> prototype: T;</code><br/><code>}</code> | Constructor of class to get JSON Schema from |
| options | <code>JsonSchemaOptions<T></code> | |
<b>Returns:</b>
`JSONSchema`