UNPKG

@loopback/docs

Version:

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

155 lines (73 loc) 2.08 kB
--- lang: en title: 'API docs: rest.infospecenhancer' 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.infospecenhancer.html --- <!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](./index.md) &gt; [@loopback/rest](./rest.md) &gt; [InfoSpecEnhancer](./rest.infospecenhancer.md) ## InfoSpecEnhancer class An OpenAPI spec enhancer to populate `info` with application metadata (package.json). **Signature:** ```typescript export declare class InfoSpecEnhancer implements OASEnhancer ``` **Implements:** [OASEnhancer](./openapi-v3.oasenhancer.md) ## Constructors <table><thead><tr><th> Constructor </th><th> Modifiers </th><th> Description </th></tr></thead> <tbody><tr><td markdown="1"> [(constructor)(pkg)](./rest.infospecenhancer._constructor_.md) </td><td markdown="1"> </td><td markdown="1"> Constructs a new instance of the `InfoSpecEnhancer` class </td></tr> </tbody></table> ## Properties <table><thead><tr><th> Property </th><th> Modifiers </th><th> Type </th><th> Description </th></tr></thead> <tbody><tr><td markdown="1"> [name](./rest.infospecenhancer.name.md) </td><td markdown="1"> </td><td markdown="1"> string </td><td markdown="1"> </td></tr> <tr><td markdown="1"> [pkg?](./rest.infospecenhancer.pkg.md) </td><td markdown="1"> `readonly` </td><td markdown="1"> [ApplicationMetadata](./core.applicationmetadata.md) \| undefined </td><td markdown="1"> _(Optional)_ </td></tr> </tbody></table> ## Methods <table><thead><tr><th> Method </th><th> Modifiers </th><th> Description </th></tr></thead> <tbody><tr><td markdown="1"> [modifySpec(spec)](./rest.infospecenhancer.modifyspec.md) </td><td markdown="1"> </td><td markdown="1"> </td></tr> </tbody></table>