refactor: import metadata-related APIs from @loopback/core

Remove references to `@loopback/metadata`, rework code and docs to import from `@loopback/core` instead. Signed-off-by: Miroslav Bajtoš <[email protected]>
loopbackio · Jun 9, 2020 · d39d007 · d39d007
1 parent 4d6bff9
commit d39d007
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 10 deletions.
diff --git a/docs/site/Creating-decorators.md b/docs/site/Creating-decorators.md
@@ -7,5 +7,5 @@ source: loopback-next
 file: packages/metadata/README.md
 sidebar: lb4_sidebar
 permalink: /doc/en/lb4/Creating-decorators.html
-summary: A tutorial to use `@loopback/metadata` module to create new decorators
+summary: A tutorial to use `@loopback/core` module to create new decorators
 ---
diff --git a/docs/site/tutorials/core/10-advanced-recipes.md b/docs/site/tutorials/core/10-advanced-recipes.md
@@ -15,7 +15,7 @@ You can create your own
 [decorator](https://loopback.io/doc/en/lb4/Decorators.html):
 
 1. Create a new decorator from scratch by using `DecoratorFactory` from
-   `@loopback/metadata`. See an example in
+   `@loopback/core`. See an example in
    [custom-inject-decorator.ts](https://github.com/strongloop/loopback-next/blob/master/examples/context/src/custom-inject-decorator.ts)
 
 2. Create a sugar decorator for an existing decorator.

diff --git a/docs/site/tutorials/core/2-architecture.md b/docs/site/tutorials/core/2-architecture.md
@@ -54,13 +54,16 @@ LoopBack 4 core is an open source TypeScript platform for Node.js, specializing
 in building large scale applications with great flexibility, composability, and
 extensibility.
 
-The following key modules are used by the LoopBack framework to offer API and
-Microservice capabilities. They can be used independently as a base platform to
-build large scale applications in TypeScript and Node.js.
+The module [@loopback/core](https://www.npmjs.com/package/@loopback/core) is
+used by the LoopBack framework to offer API and Microservice capabilities.
+
+It builds on top of the following lower-level modules:
 
 - [@loopback/metadata](https://www.npmjs.com/package/@loopback/metadata)
 - [@loopback/context](https://www.npmjs.com/package/@loopback/context)
-- [@loopback/core](https://www.npmjs.com/package/@loopback/core)
+
+Any of these three modules can be used independently as a base platform to build
+large scale applications in TypeScript and Node.js.
 
 ## Design goals
 

diff --git a/examples/log-extension/README.md b/examples/log-extension/README.md
@@ -169,15 +169,15 @@ extension to add extra processing accordingly.
 
 For this extension, the decorator marks which controller methods should be
 logged (and optionally at which level they should be logged). We leverage
-`@loopback/metadata` module to implement the decorator and inspection function.
+`@loopback/core` module to implement the decorator and inspection function.
 
 ```ts
 import {LOG_LEVEL, EXAMPLE_LOG_BINDINGS} from '../keys';
 import {
   Constructor,
   MethodDecoratorFactory,
   MetadataInspector,
-} from '@loopback/context';
+} from '@loopback/core';
 import {LevelMetadata} from '../types';
 
 /**

diff --git a/examples/log-extension/src/keys.ts b/examples/log-extension/src/keys.ts
@@ -4,7 +4,7 @@
 // License text available at https://opensource.org/licenses/MIT
 
 import {BindingKey} from '@loopback/core';
-import {TimerFn, LogFn, LogWriterFn} from './types';
+import {LogFn, LogWriterFn, TimerFn} from './types';
 
 /**
  * Binding keys used by this component.
@@ -19,7 +19,7 @@ export namespace EXAMPLE_LOG_BINDINGS {
 }
 
 /**
- * The key used to store log-related via @loopback/metadata and reflection.
+ * The key used to store log-related metadata via decorators and reflection.
  */
 export const EXAMPLE_LOG_METADATA_KEY = 'example.log.metadata';