UNPKG

@loopback/docs

Version:

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

65 lines (34 loc) 1.16 kB
--- lang: en title: 'API docs: tsdocs.getpackageswithtsdocs' keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI sidebar: lb4_sidebar editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/tsdocs permalink: /doc/en/lb4/apidocs.tsdocs.getpackageswithtsdocs.html --- <!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](./index.md) &gt; [@loopback/tsdocs](./tsdocs.md) &gt; [getPackagesWithTsDocs](./tsdocs.getpackageswithtsdocs.md) ## getPackagesWithTsDocs() function Get an array of lerna-managed TypeScript packages to generate tsdocs **Signature:** ```typescript export declare function getPackagesWithTsDocs(rootDir?: string): Promise<LernaPackage[]>; ``` ## Parameters <table><thead><tr><th> Parameter </th><th> Type </th><th> Description </th></tr></thead> <tbody><tr><td markdown="1"> rootDir </td><td markdown="1"> string </td><td markdown="1"> _(Optional)_ Root directory to find the monorepo </td></tr> </tbody></table> **Returns:** Promise&lt;[LernaPackage](./tsdocs.lernapackage.md)<!-- -->\[\]&gt;