Page Contents

Home > @loopback/metadata

metadata package

A package with utilities to help developers implement TypeScript decorators, define/merge metadata, and inspect metadata.

Remarks

Utilities:

  • Reflector: Wrapper of reflect-metadata. - Decorator factories: A set of factories for class/method/property/parameter decorators to apply metadata to a given class and its static or instance members. - MetadataInspector: High level APIs to inspect a class and/or its members to get metadata applied by decorators.

Classes

Class Description
[ClassDecoratorFactory](/doc/en/lb4/apidocs.metadata.classdecoratorfactory.html) Factory for class decorators
[DecoratorFactory](/doc/en/lb4/apidocs.metadata.decoratorfactory.html) Base factory class for decorator functions
[MetadataAccessor](/doc/en/lb4/apidocs.metadata.metadataaccessor.html) A strongly-typed metadata accessor via reflection
[MetadataInspector](/doc/en/lb4/apidocs.metadata.metadatainspector.html) Inspector for metadata applied by decorators
[MethodDecoratorFactory](/doc/en/lb4/apidocs.metadata.methoddecoratorfactory.html) Factory for method decorators
[MethodMultiDecoratorFactory](/doc/en/lb4/apidocs.metadata.methodmultidecoratorfactory.html) Factory for an append-array of method-level decorators The `@response` metadata for a method is an array. Each item in the array should be a single value, containing a response code and a single spec or Model. This should allow:
[MethodParameterDecoratorFactory](/doc/en/lb4/apidocs.metadata.methodparameterdecoratorfactory.html) Factory for method level parameter decorator.
[NamespacedReflect](/doc/en/lb4/apidocs.metadata.namespacedreflect.html)
[ParameterDecoratorFactory](/doc/en/lb4/apidocs.metadata.parameterdecoratorfactory.html) Factory for parameter decorators
[PropertyDecoratorFactory](/doc/en/lb4/apidocs.metadata.propertydecoratorfactory.html) Factory for property decorators

Interfaces

Interface Description
[DecoratorOptions](/doc/en/lb4/apidocs.metadata.decoratoroptions.html) Options for a decorator
[DesignTimeMethodMetadata](/doc/en/lb4/apidocs.metadata.designtimemethodmetadata.html) Design time metadata for a method.
[InspectionOptions](/doc/en/lb4/apidocs.metadata.inspectionoptions.html) Options for inspection
[MetadataMap](/doc/en/lb4/apidocs.metadata.metadatamap.html) An object mapping keys to corresponding metadata

Variables

Variable Description
[Reflector](/doc/en/lb4/apidocs.metadata.reflector.html)

Type Aliases

Type Alias Description
[DecoratorType](/doc/en/lb4/apidocs.metadata.decoratortype.html) Decorator function types
[MetadataKey](/doc/en/lb4/apidocs.metadata.metadatakey.html) Key for metadata access via reflection