---
url: https://relizy.dev/typedoc/interfaces/PreviewPackage.md
---
[relizy](../index.md) / PreviewPackage

# Interface: PreviewPackage

Defined in: [packages/relizy/src/core/release-preview.ts:41](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/core/release-preview.ts#L41)

## Properties

### breakingPeerDependency?

> `optional` **breakingPeerDependency?**: `string`

Defined in: [packages/relizy/src/core/release-preview.ts:68](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/core/release-preview.ts#L68)

A peer dependency making a breaking change that the published range of the package rejects

***

### bump

> **bump**: [`PreviewBumpType`](../type-aliases/PreviewBumpType.md)

Defined in: [packages/relizy/src/core/release-preview.ts:49](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/core/release-preview.ts#L49)

`major`, `minor`... computed from the two versions

***

### commits

> **commits**: [`PreviewCommit`](PreviewCommit.md)\[]

Defined in: [packages/relizy/src/core/release-preview.ts:57](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/core/release-preview.ts#L57)

***

### dependency?

> `optional` **dependency?**: `object`

Defined in: [packages/relizy/src/core/release-preview.ts:59](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/core/release-preview.ts#L59)

Set for the `dependency` reason

#### chain

> **chain**: `string`\[]

The dependencies leading to the one that bumps it, the first one released by commits last

#### group?

> `optional` **group?**: `string`

The version group releasing the dependency, when it is another one

#### outOfRange?

> `optional` **outOfRange?**: `object`

The new version of the dependency is out of the published range of the package: the range, the field and the new version

##### outOfRange.field

> **field**: `"dependencies"` | `"peerDependencies"` | `"devDependencies"`

##### outOfRange.name

> **name**: `string`

##### outOfRange.newVersion

> **newVersion**: `string`

##### outOfRange.range

> **range**: `string` | `null`

***

### name

> **name**: `string`

Defined in: [packages/relizy/src/core/release-preview.ts:42](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/core/release-preview.ts#L42)

***

### newVersion

> **newVersion**: `string`

Defined in: [packages/relizy/src/core/release-preview.ts:47](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/core/release-preview.ts#L47)

***

### oldVersion

> **oldVersion**: `string`

Defined in: [packages/relizy/src/core/release-preview.ts:46](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/core/release-preview.ts#L46)

***

### path

> **path**: `string`

Defined in: [packages/relizy/src/core/release-preview.ts:44](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/core/release-preview.ts#L44)

Directory of the package, relative to the project (`.` for the root)

***

### private

> **private**: `boolean`

Defined in: [packages/relizy/src/core/release-preview.ts:45](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/core/release-preview.ts#L45)

***

### reason

> **reason**: `"commits"` | `"dependency"` | `"graduation"` | `"unified"` | `"forced"`

Defined in: [packages/relizy/src/core/release-preview.ts:56](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/core/release-preview.ts#L56)

Why it is released: its `commits`, a bumped `dependency` (see `dependency`), the `graduation`
of its prerelease, `forced` (`force`), or the `unified` version it follows

***

### tag?

> `optional` **tag?**: `string`

Defined in: [packages/relizy/src/core/release-preview.ts:51](https://github.com/LouisMazel/relizy/blob/b6643ceb9b0195df93c3f9f14cf5200f7ccc2322/packages/relizy/src/core/release-preview.ts#L51)

The release tag of the package: its own tag in an `independent` group, the one of the repository otherwise
