UNPKG

@loopback/docs

Version:

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

113 lines (55 loc) 1.72 kB
--- lang: en title: 'API docs: rest.validatevalueagainstschema' keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI sidebar: lb4_sidebar editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/rest permalink: /doc/en/lb4/apidocs.rest.validatevalueagainstschema.html --- <!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](./index.md) &gt; [@loopback/rest](./rest.md) &gt; [validateValueAgainstSchema](./rest.validatevalueagainstschema.md) ## validateValueAgainstSchema() function Validate the value against JSON schema. **Signature:** ```typescript export declare function validateValueAgainstSchema(value: any, schema: SchemaObject | ReferenceObject, globalSchemas?: SchemasObject, options?: ValueValidationOptions): Promise<any>; ``` ## Parameters <table><thead><tr><th> Parameter </th><th> Type </th><th> Description </th></tr></thead> <tbody><tr><td markdown="1"> value </td><td markdown="1"> any </td><td markdown="1"> The data value. </td></tr> <tr><td markdown="1"> schema </td><td markdown="1"> SchemaObject \| ReferenceObject </td><td markdown="1"> The JSON schema used to perform the validation. </td></tr> <tr><td markdown="1"> globalSchemas </td><td markdown="1"> SchemasObject </td><td markdown="1"> _(Optional)_ Schema references. </td></tr> <tr><td markdown="1"> options </td><td markdown="1"> [ValueValidationOptions](./rest.valuevalidationoptions.md) </td><td markdown="1"> _(Optional)_ Value validation options. </td></tr> </tbody></table> **Returns:** Promise&lt;any&gt;