# @types/lerna-alias

> TypeScript definitions for lerna-alias

Latest version **3.0.4** (published 2023-11-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/lerna-alias
pnpm add @types/lerna-alias
yarn add @types/lerna-alias
bun add @types/lerna-alias
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 3.0.4 |
| Published | 2023-11-21 |
| First published | 2020-01-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 6.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51433 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/lerna-alias
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/lerna-alias
- npm.io page: https://npm.io/package/@types/lerna-alias

## Recent versions

- 3.0.4 (latest) — 2023-11-21
- 3.0.1 (ts3.6) — 2021-07-08
- 3.0.0 (ts2.8) — 2020-01-17
- 3.0.3 — 2023-11-07
- 3.0.2 — 2023-10-18

## README

# Installation
> `npm install --save @types/lerna-alias`

# Summary
This package contains type definitions for lerna-alias (https://github.com/Andarist/lerna-alias#readme).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/lerna-alias.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/lerna-alias/index.d.ts)
````ts
export interface Aliases {
    /**
     * Key is the package name or an appropriate mapping for the tool.
     * Value is a local directory path to the package resolved using
     * `sourceDirectory` and `mainFields` options.
     */
    [packageName: string]: string;
}

export interface Options {
    /**
     * From which directory the lerna monorepo should be searched for
     * @default `process.cwd()`
     */
    directory?: string | undefined;
    /**
     * Optional array of `mainFields` that should be used to resolve package's entry point,
     * similar to https://webpack.js.org/configuration/resolve/#resolve-mainfields .
     * Using this takes precedence over default `sourceDirectory` option.
     */
    mainFields?: readonly string[] | undefined;
    /**
     * Which directory should be considered as containing source files of a package.
     * If specified as false it will use package's root.
     * @default 'src'
     */
    sourceDirectory?: string | false | undefined;
}

/**
 * Returns Jest-style aliases to the source of a package: a map from `'^package-name$'`
 * to package source root, for example `'/path/to/package-name/src/index'`
 * (the exact form of the path may vary depending on options).
 */
export function jest(options?: Options): Aliases;

/**
 * Returns Rollup-style aliases to the source of a package: a map from `'package-name'`
 * to package source root, for example `'/path/to/package-name/src/index'`
 * (the exact form of the path may vary depending on options).
 */
export function rollup(options?: Options): Aliases;

/**
 * Returns Webpack-style aliases to the source of a package: a map from `'package-name$'`
 * to package source root, for example `'/path/to/package-name/src/index'`
 * (the exact form of the path may vary depending on options).
 */
export function webpack(options?: Options): Aliases;

````

### Additional Details
 * Last updated: Mon, 20 Nov 2023 23:36:24 GMT
 * Dependencies: none

# Credits
These definitions were written by [Elizabeth Craig](https://github.com/ecraig12345).

---
_Source: https://npm.io/package/@types/lerna-alias · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._