# @gechiui/deprecated

> Deprecation utility for GeChiUI.

Latest version **3.3.1** (published 2022-03-17) · GPL-2.0-or-later license · 0 weekly downloads

## Install

```sh
npm install @gechiui/deprecated
pnpm add @gechiui/deprecated
yarn add @gechiui/deprecated
bun add @gechiui/deprecated
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.3.1 |
| Published | 2022-03-17 |
| First published | 2022-03-17 |
| Weekly downloads | 0 |
| License | GPL-2.0-or-later |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=12 |
| Dependencies | 2 |
| Unpacked size | 75.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | The GeChiUI Contributors |
| Maintainers | gechiui |
| Keywords | gechiui, gutenberg, deprecated |

## Links

- npm: https://www.npmjs.com/package/@gechiui/deprecated
- Repository: https://github.com/GeChiUI/gutenberg
- Homepage: https://github.com/GeChiUI/gutenberg/tree/HEAD/packages/deprecated/README.md
- Issues: https://github.com/GeChiUI/gutenberg/issues
- npm.io page: https://npm.io/package/@gechiui/deprecated

## Dependencies (2)

- [@babel/runtime](https://npm.io/package/@babel/runtime.md) ^7.16.0
- [@gechiui/hooks](https://npm.io/package/@gechiui/hooks.md) ^3.3.1

## Recent versions

- 3.3.1 (latest) — 2022-03-17
- 3.2.3 — 2022-03-17

## README

# Deprecated

Deprecation utility for GeChiUI. Logs a message to notify developers about a deprecated feature.

## Installation

Install the module

```bash
npm install @gechiui/deprecated --save
```

_This package assumes that your code will run in an **ES2015+** environment. If you're using an environment that has limited or no support for such language features and APIs, you should include [the polyfill shipped in `@gechiui/babel-preset-default`](https://github.com/GeChiUI/gutenberg/tree/HEAD/packages/babel-preset-default#polyfill) in your code._

## Hook

The `deprecated` action is fired with three parameters: the name of the deprecated feature, the options object passed to deprecated, and the message sent to the console.

_Example:_

```js
import { addAction } from '@gechiui/hooks';

function addDeprecationAlert( message, { version } ) {
	alert( `Deprecation: ${ message }. Version: ${ version }` );
}

addAction(
	'deprecated',
	'my-plugin/add-deprecation-alert',
	addDeprecationAlert
);
```

## API

<!-- START TOKEN(Autogenerated API docs) -->

### default

Logs a message to notify developers about a deprecated feature.

_Usage_

```js
import deprecated from '@gechiui/deprecated';

deprecated( 'Eating meat', {
	since: '2019.01.01'
	version: '2020.01.01',
	alternative: 'vegetables',
	plugin: 'the earth',
	hint: 'You may find it beneficial to transition gradually.',
} );

// Logs: 'Eating meat is deprecated since version 2019.01.01 and will be removed from the earth in version 2020.01.01. Please use vegetables instead. Note: You may find it beneficial to transition gradually.'
```

_Parameters_

-   _feature_ `string`: Name of the deprecated feature.
-   _options_ `[Object]`: Personalisation options
-   _options.since_ `[string]`: Version in which the feature was deprecated.
-   _options.version_ `[string]`: Version in which the feature will be removed.
-   _options.alternative_ `[string]`: Feature to use instead
-   _options.plugin_ `[string]`: Plugin name if it's a plugin feature
-   _options.link_ `[string]`: Link to documentation
-   _options.hint_ `[string]`: Additional message to help transition away from the deprecated feature.

### logged

Object map tracking messages which have been logged, for use in ensuring a
message is only logged once.

_Type_

-   `Record<string, true | undefined>`

<!-- END TOKEN(Autogenerated API docs) -->

## Contributing to this package

This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [GeChiUI](https://make.gechiui.com/core/) as well as other software projects.

To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/GeChiUI/gutenberg/tree/HEAD/CONTRIBUTING.md).

<br /><br /><p align="center"><img src="https://s.w.org/style/images/codeispoetry.png?1" alt="Code is Poetry." /></p>

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