UNPKG

@loopback/docs

Version:

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

38 lines (24 loc) 1.38 kB
--- lang: en title: 'API docs: repository-json-schema.getfilterjsonschemafor' 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.getfilterjsonschemafor.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; [getFilterJsonSchemaFor](./repository-json-schema.getfilterjsonschemafor.md) ## getFilterJsonSchemaFor() function Build a JSON schema describing the format of the "filter" object used to query model instances. Note we don't take the model properties into account yet and return a generic json schema allowing any "where" condition. <b>Signature:</b> ```typescript export declare function getFilterJsonSchemaFor(modelCtor: typeof Model, options?: FilterSchemaOptions): JsonSchema; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | | modelCtor | typeof [Model](./repository.model.md) | The model constructor to build the filter schema for. | | options | [FilterSchemaOptions](./repository-json-schema.filterschemaoptions.md) | Options to build the filter schema. | <b>Returns:</b> JsonSchema