Skończyłem bawiąc się z dekoratorami i postanowiłem udokumentować to, co wymyśliłem dla każdego, kto chce to wykorzystać, zanim jakakolwiek dokumentacja wyjdzie na jaw. Jeśli zauważysz jakieś błędy, możesz to edytować.

Uwagi Ogólne

• dekoratory są wywoływane, gdy klasa jest zadeklarowana-Nie, gdy obiekt jest instancją.
• na tej samej klasie/właściwości/metodzie/parametrze można zdefiniować wiele dekoratorów.
• dekoratorów nie wolno na konstruktorów.

Prawidłowym dekoratorem powinno być:

1. przypisany do jednego z typów dekoratorów (ClassDecorator | PropertyDecorator | MethodDecorator | ParameterDecorator).
2. Zwraca wartość (w przypadku dekoratorów klas i dekoratorów metod), którą można przypisać do dekoratorowanej wartości.

Numer referencyjny

Method / Formal Accessor Decorator

Parametry implementacji:

• target: prototyp klasy (Object).
• propertyKey: nazwa metody (string | symbol).
• descriptor: A TypedPropertyDescriptor - jeśli nie jesteś zaznajomiony z kluczami deskryptora, polecam przeczytać o tym w tej dokumentacji na Object.defineProperty (jest to trzeci parametr).

Przykład-Bez Argumentów

Użycie:

class MyClass {
    @log
    myMethod(arg: string) { 
        return "Message -- " + arg;
    }
}

Realizacja:

function log(target: Object, propertyKey: string, descriptor: TypedPropertyDescriptor<any>) {
    const originalMethod = descriptor.value; // save a reference to the original method

    // NOTE: Do not use arrow syntax here. Use a function expression in 
    // order to use the correct value of `this` in this method (see notes below)
    descriptor.value = function(...args: any[]) {
        // pre
        console.log("The method args are: " + JSON.stringify(args));
        // run and store result
        const result = originalMethod.apply(this, args);
        // post
        console.log("The return value is: " + result);
        // return the result of the original method (or modify it before returning)
        return result;
    };

    return descriptor;
}

Wejście:

new MyClass().myMethod("testing");

Wyjście:

Metoda args to: ["testowanie"]

Wartość zwracana to: Message -- testing

Uwagi:

• nie używaj składni strzałek przy ustawianiu wartości deskryptora. kontekst this nie będzie instancją, jeśli to zrobisz.
• lepiej zmodyfikować oryginalny deskryptor, niż nadpisać bieżący, zwracając nowy deskryptor. Pozwala to na użycie wielu dekoratorów, które edytują deskryptor bez nadpisywania tego, co zrobił inny dekorator. Robiąc pozwala to na jednoczesne użycie czegoś w rodzaju @enumerable(false) i @log (przykład: Bad vs Good)
• przydatne : argument type TypedPropertyDescriptor Może być użyty do ograniczenia, jakie podpisy metody (przykład metody ) lub podpisów accessora ( przykład Accessora ) można umieścić na dekoratorze.

Przykład - Z Argumentami (Fabryka Dekoratorów)

Używając argumentów, musisz zadeklarować funkcję za pomocą dekoratora parametry zwracają następnie funkcję z podpisem przykładu bez argumentów.

class MyClass {
    @enumerable(false)
    get prop() {
        return true;
    }
}

function enumerable(isEnumerable: boolean) {
    return (target: Object, propertyKey: string, descriptor: TypedPropertyDescriptor<any>) => {
        descriptor.enumerable = isEnumerable;
        return descriptor;
    };
}

Dekorator Metody Statycznej

Podobne do dekoratora metody z pewnymi różnicami:

• jej parametrem target jest sama funkcja konstruktora, a nie prototyp.
• deskryptor jest zdefiniowany na funkcji konstruktora, a nie na prototypie.

Dekorator Klasy

@isTestable
class MyClass {}

Realizacja parametr:

• target: klasa, na której deklaruje się dekorator (TFunction extends Function).

Przykład użycia: używanie API metadanych do przechowywania informacji na klasie.

Dekorator Nieruchomości

class MyClass {
    @serialize
    name: string;
}

Parametry implementacji:

• target: prototyp klasy (Object).
• propertyKey: nazwa nieruchomości (string | symbol).

Przykład użycia : Tworzenie dekoratora @serialize("serializedName") i dodanie nazwy właściwości do listy właściwości do serializacji.

Dekorator Parametru

class MyClass {
    myMethod(@myDecorator myParameter: string) {}
}

Parametry implementacji:

• target: prototyp klasy (Function-wygląda na to, że Function już nie działa. Powinieneś użyć any lub Object tutaj, aby użyć dekoratora w dowolnej klasie. Lub Określ typ (Y) klasy, do których chcesz ją ograniczyć)
• propertyKey: nazwa metody (string | symbol).
• parameterIndex: The indeks parametru na liście parametrów funkcji (number).

Prosty przykład

Szczegółowy przykład(y)

• Jeśli chcesz dowiedzieć się więcej na ten temat, skontaktuj się z nami.]}