@loopback/docs
Version:
Documentation files rendered at [https://loopback.io](https://loopback.io)
81 lines (41 loc) • 1.35 kB
Markdown
---
lang: en
title: 'API docs: openapi-spec-builder.componentsspecbuilder.withlink'
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.withlink.html
---
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@loopback/openapi-spec-builder](./openapi-spec-builder.md) > [ComponentsSpecBuilder](./openapi-spec-builder.componentsspecbuilder.md) > [withLink](./openapi-spec-builder.componentsspecbuilder.withlink.md)
## ComponentsSpecBuilder.withLink() method
Define a component link.
**Signature:**
```typescript
withLink(name: string, link: LinkObject | 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 link
</td></tr>
<tr><td markdown="1">
link
</td><td markdown="1">
LinkObject \| ReferenceObject
</td><td markdown="1">
Specification of the link
</td></tr>
</tbody></table>
**Returns:**
this