UNPKG

@loopback/docs

Version:

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

81 lines (41 loc) 1.4 kB
--- lang: en title: 'API docs: openapi-spec-builder.componentsspecbuilder.withcallback' keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI sidebar: lb4_sidebar editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/openapi-spec-builder permalink: /doc/en/lb4/apidocs.openapi-spec-builder.componentsspecbuilder.withcallback.html --- <!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](./index.md) &gt; [@loopback/openapi-spec-builder](./openapi-spec-builder.md) &gt; [ComponentsSpecBuilder](./openapi-spec-builder.componentsspecbuilder.md) &gt; [withCallback](./openapi-spec-builder.componentsspecbuilder.withcallback.md) ## ComponentsSpecBuilder.withCallback() method Define a component callback. **Signature:** ```typescript withCallback(name: string, callback: CallbackObject | ReferenceObject): this; ``` ## Parameters <table><thead><tr><th> Parameter </th><th> Type </th><th> Description </th></tr></thead> <tbody><tr><td markdown="1"> name </td><td markdown="1"> string </td><td markdown="1"> The name of the callback </td></tr> <tr><td markdown="1"> callback </td><td markdown="1"> CallbackObject \| ReferenceObject </td><td markdown="1"> Specification of the callback </td></tr> </tbody></table> **Returns:** this