deprecated-decorator

deprecated-decorator

Version 0.1.6
Published 8 years ago
No dependencies
MIT license

Install

npm i deprecated-decorator

yarn add deprecated-decorator

pnpm add deprecated-decorator

Overview

A simple decorator for deprecated methods and properties.

Index

Functions

function deprecated

deprecated: {
    (options?: DeprecatedOptions): DeprecatedDecorator;
    (alternative?: string, version?: string, url?: string): DeprecatedDecorator;
    <T extends Function>(fn: T): T;
    <T extends Function>(options: DeprecatedOptions, fn: T): T;
    <T extends Function>(alternative: string, fn: T): T;
    <T extends Function>(alternative: string, version: string, fn: T): T;
    <T extends Function>(
        alternative: string,
        version: string,
        url: string,
        fn: T
    ): T;
};

Interfaces

interface DeprecatedOptions

interface DeprecatedOptions {}

property alternative

alternative?: string;

property url

url?: string;

property version

version?: string;

Type Aliases

type DeprecatedDecorator

type DeprecatedDecorator = ClassDecorator & PropertyDecorator;

Package Files (1)

bld/index.d.ts

Dependencies (0)

No dependencies.

Dev Dependencies (5)

Peer Dependencies (0)

No peer dependencies.

Badge

To add a badge like this oneto your package's README, use the codes available below.

You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/deprecated-decorator.

Markdown

[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/deprecated-decorator)

HTML

<a href="https://www.jsdocs.io/package/deprecated-decorator"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>

Updated 2 years ago.
Package analyzed in 2140 ms.
Missing or incorrect documentation? Open an issue for this package.