declarations/core-decorators/core-decorators.d.ts

[](https://www.npmjs.com/package/declarations)

// Type definitions for core-decorators.js v0.10
// Project: https://github.com/jayphelps/core-decorators.js
// Definitions by: Qubo <https://github.com/tkqubo>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

declare module "core-decorators" {
    export interface ClassDecorator {
      <TFunction extends Function>(target: TFunction): TFunction|void;
    }

    export interface ParameterDecorator {
      (target: Object, propertyKey: string|symbol, parameterIndex: number): void;
    }

    export interface PropertyDecorator {
        (target: Object, propertyKey: string|symbol): void;
    }

    export interface MethodDecorator {
      <T>(target: Object, propertyKey: string|symbol, descriptor: TypedPropertyDescriptor<T>): TypedPropertyDescriptor<T>|void;
    }

    export interface PropertyOrMethodDecorator extends MethodDecorator, PropertyDecorator {
        (target: Object, propertyKey: string|symbol): void;
    }

    export interface Deprecate extends MethodDecorator {
        (message?: string, option?: DeprecateOption): MethodDecorator;
    }

    export interface DeprecateOption {
        url: string;
    }

    export interface ThrottleOptions {
        /** allows to trigger function on the leading. */
        leading?: boolean;
        /** allows to trigger function on the trailing edge of the wait interval. */
        trailing?: boolean;
    }

    export interface Console {
        log(message?: any, ...optionalParams: any[]): void;
        time(timerName?: string): void;
        timeEnd(timerName?: string): void;
    }

    /**
     * Forces invocations of this function to always have this refer to the class instance,
     * even if the function is passed around or would otherwise lose its this context. e.g. var fn = context.method;
     */
    var autobind: Function;
    /**
     * Marks a property or method as not being writable.
     */
    var readonly: PropertyOrMethodDecorator;
    /**
     * Checks that the marked method indeed overrides a function with the same signature somewhere on the prototype chain.
     */
    var override: MethodDecorator;
    /**
     * Calls console.warn() with a deprecation message. Provide a custom message to override the default one. You can also provide an options hash with a url, for further reading.
     */
    var deprecate: Deprecate;
    /**
     * Calls console.warn() with a deprecation message. Provide a custom message to override the default one. You can also provide an options hash with a url, for further reading.
     */
    var deprecated: Deprecate;
    /**
     * Creates a new debounced function which will be invoked after wait milliseconds since the time it was invoked. Default timeout is 300 ms.
     */
    var debounce: (wait: number) => MethodDecorator;
    /**
     * Creates a new throttled function which will be invoked in every wait milliseconds. Default timeout is 300 ms.
     */
    var throttle: (wait: number, options?: ThrottleOptions) => MethodDecorator;
    /**
     * Suppresses any JavaScript console.warn() call while the decorated function is called. (i.e. on the stack)
     */
    var suppressWarnings: MethodDecorator;
    /**
     * Marks a property or method as not being enumerable.
     */
    var nonenumerable: PropertyOrMethodDecorator;
    /**
     * Marks a property or method as not being writable.
     */
    var nonconfigurable: PropertyOrMethodDecorator;
    /**
     * Initial implementation included, likely slow. WIP.
     */
    var memoize: MethodDecorator;
    /**
     * Immediately applies the provided function and arguments to the method, allowing you to wrap methods with arbitrary helpers like those provided by lodash.
     * The first argument is the function to apply, all further arguments will be passed to that decorating function.
     */
    var decorate: (func: Function, ...args: any[]) => MethodDecorator;
    /**
     * Prevents a property initializer from running until the decorated property is actually looked up.
     * Useful to prevent excess allocations that might otherwise not be used, but be careful not to over-optimize things.
     */
    var lazyInitialize: PropertyDecorator;
    /**
     * Mixes in all property descriptors from the provided Plain Old JavaScript Objects (aka POJOs) as arguments.
     * Mixins are applied in the order they are passed, but do not override descriptors already on the class, including those inherited traditionally.
     */
    var mixin: (...mixins: any[]) => ClassDecorator;
    /**
     * Mixes in all property descriptors from the provided Plain Old JavaScript Objects (aka POJOs) as arguments.
     * Mixins are applied in the order they are passed, but do not override descriptors already on the class, including those inherited traditionally.
     */
    var mixins: (...mixins: any[]) => ClassDecorator;
    /**
     * Uses console.time and console.timeEnd to provide function timings with a unique label whose default prefix is ClassName.method. Supply a first argument to override the prefix:
     */
    var time: (label: string, console?: Console) => MethodDecorator;

    export {
        autobind,
        readonly,
        override,
        deprecate,
        deprecated,
        debounce,
        throttle,
        suppressWarnings,
        nonenumerable,
        nonconfigurable,
        memoize,
        decorate,
        lazyInitialize,
        mixin,
        mixins,
        time,
    };
}