@loopback/docs 6.0.5 → 7.0.0

package/site/apidocs/core.lifecycleobserverregistry.stop.md

@@ -0,0 +1,27 @@
+---
+lang: en
+title: 'API docs: core.lifecycleobserverregistry.stop'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
+sidebar: lb4_sidebar
+editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/core
+permalink: /doc/en/lb4/apidocs.core.lifecycleobserverregistry.stop.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/core](./core.md) &gt; [LifeCycleObserverRegistry](./core.lifecycleobserverregistry.md) &gt; [stop](./core.lifecycleobserverregistry.stop.md)
+
+## LifeCycleObserverRegistry.stop() method
+
+Notify all life cycle observers by group of `stop`
+
+**Signature:**
+
+```typescript
+stop(): Promise<void>;
+```
+**Returns:**
+
+Promise&lt;void&gt;
+
+

package/site/apidocs/core.md

@@ -0,0 +1,88 @@
+---
+lang: en
+title: 'API docs: core'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
+sidebar: lb4_sidebar
+editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/core
+permalink: /doc/en/lb4/apidocs.core.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/core](./core.md)
+
+## core package
+
+The core foundation for LoopBack 4. It can also serve as the platform to build large-scale Node.js applications and frameworks.
+
+## Remarks
+
+For examples of how to leverage `@loopback/core` to build composable and extensible projects, check out the [core tutorial](https://loopback.io/doc/en/lb4/core-tutorial.html)<!-- -->.
+
+## Classes
+
+|  Class | Description |
+|  --- | --- |
+|  [Application](./core.application.md) | Application is the container for various types of artifacts, such as components, servers, controllers, repositories, datasources, connectors, and models. |
+|  [LifeCycleObserverRegistry](./core.lifecycleobserverregistry.md) | A context-based registry for life cycle observers |
+
+## Functions
+
+|  Function | Description |
+|  --- | --- |
+|  [addExtension(context, extensionPointName, extensionClass, options)](./core.addextension.md) | Register an extension for the given extension point to the context |
+|  [asLifeCycleObserver(binding)](./core.aslifecycleobserver.md) | A <code>BindingTemplate</code> function to configure the binding as life cycle observer by tagging it with <code>CoreTags.LIFE_CYCLE_OBSERVER</code>. |
+|  [asService(serviceInterface)](./core.asservice.md) | Create a binding template for a service interface |
+|  [createServiceBinding(cls, options)](./core.createservicebinding.md) | Create a service binding from a class or provider |
+|  [extensionFilter(extensionPointNames)](./core.extensionfilter.md) | A factory function to create binding filter for extensions of a named extension point |
+|  [extensionFor(extensionPointNames)](./core.extensionfor.md) | A factory function to create binding template for extensions of the given extension point |
+|  [extensionPoint(name, specs)](./core.extensionpoint.md) | Decorate a class as a named extension point. If the decoration is not present, the name of the class will be used. |
+|  [extensions(extensionPointName, metadata)](./core.extensions.md) | Shortcut to inject extensions for the given extension point. |
+|  [filterByServiceInterface(serviceInterface)](./core.filterbyserviceinterface.md) | Create a binding filter by service class |
+|  [isLifeCycleObserver(obj)](./core.islifecycleobserver.md) | Test if an object implements LifeCycleObserver |
+|  [isLifeCycleObserverClass(ctor)](./core.islifecycleobserverclass.md) | Test if a class implements LifeCycleObserver |
+|  [lifeCycleObserver(group, specs)](./core.lifecycleobserver.md) | Sugar decorator to mark a class as life cycle observer |
+|  [mountComponent(app, component)](./core.mountcomponent.md) | Mount a component to an Application. |
+|  [service(serviceInterface, metadata)](./core.service.md) | <code>@service</code> injects a service instance that matches the class or interface. |
+
+## Interfaces
+
+|  Interface | Description |
+|  --- | --- |
+|  [ApplicationConfig](./core.applicationconfig.md) | Configuration for application |
+|  [ApplicationMetadata](./core.applicationmetadata.md) | Type description for <code>package.json</code> |
+|  [ClassMap](./core.classmap.md) | A map of classes to be bound to a context |
+|  [Component](./core.component.md) | A component declares a set of artifacts so that they can be contributed to an application as a group |
+|  [LifeCycleObserver](./core.lifecycleobserver.md) | Observers to handle life cycle init/start/stop events |
+|  [ProviderMap](./core.providermap.md) | A map of provider classes to be bound to a context |
+|  [Server](./core.server.md) | Defines the requirements to implement a Server for LoopBack applications: start() : Promise<void> stop() : Promise<void> It is recommended that each Server implementation creates its own child Context, which inherits from the parent Application context. This way, any Server-specific bindings will remain local to the Server instance, and will avoid polluting its parent module scope. |
+|  [ServiceOptions](./core.serviceoptions.md) | Options to register a service binding |
+
+## Namespaces
+
+|  Namespace | Description |
+|  --- | --- |
+|  [CoreBindings](./core.corebindings.md) | Namespace for core binding keys |
+|  [CoreTags](./core.coretags.md) |  |
+|  [extensions](./core.extensions.md) |  |
+
+## Variables
+
+|  Variable | Description |
+|  --- | --- |
+|  [DEFAULT\_ORDERED\_GROUPS](./core.default_ordered_groups.md) |  |
+|  [lifeCycleObserverFilter](./core.lifecycleobserverfilter.md) | Find all life cycle observer bindings. By default, a binding tagged with <code>CoreTags.LIFE_CYCLE_OBSERVER</code>. It's used as <code>BindingFilter</code>. |
+
+## Type Aliases
+
+|  Type Alias | Description |
+|  --- | --- |
+|  [ControllerClass](./core.controllerclass.md) |  |
+|  [LifeCycleObserverGroup](./core.lifecycleobservergroup.md) | A group of life cycle observers |
+|  [LifeCycleObserverOptions](./core.lifecycleobserveroptions.md) |  |
+|  [MixinTarget](./core.mixintarget.md) | A replacement for <code>typeof Target</code> to be used in mixin class definitions. This is a workaround for TypeScript limitation described in - https://github.com/microsoft/TypeScript/issues/17293 - https://github.com/microsoft/TypeScript/issues/17744 - https://github.com/microsoft/TypeScript/issues/36060 |
+|  [ServiceInterface](./core.serviceinterface.md) | Representing an interface for services. In TypeScript, the <code>interface</code> does not have reflections at runtime. We use a string, a symbol or a Function as the type for the service interface. |
+|  [ServiceOrProviderClass](./core.serviceorproviderclass.md) |  |
+|  [ShutdownOptions](./core.shutdownoptions.md) | Options to set up application shutdown |
+
+

package/site/apidocs/core.mixintarget.md

@@ -0,0 +1,65 @@
+---
+lang: en
+title: 'API docs: core.mixintarget'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
+sidebar: lb4_sidebar
+editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/core
+permalink: /doc/en/lb4/apidocs.core.mixintarget.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/core](./core.md) &gt; [MixinTarget](./core.mixintarget.md)
+
+## MixinTarget type
+
+A replacement for `typeof Target` to be used in mixin class definitions. This is a workaround for TypeScript limitation described in - https://github.com/microsoft/TypeScript/issues/17293 - https://github.com/microsoft/TypeScript/issues/17744 - https://github.com/microsoft/TypeScript/issues/36060
+
+**Signature:**
+
+```typescript
+export type MixinTarget<T extends object> = Constructor<{
+    [P in keyof T]: T[P];
+}>;
+```
+**References:** [Constructor](./context.constructor.md)
+
+## Example
+
+
+```ts
+export function MyMixin<T extends MixinTarget<Application>>(superClass: T) {
+  return class extends superClass {
+    // contribute new class members
+  }
+};
+```
+TypeScript does not allow class mixins to access protected members from the base class. You can use the following approach as a workaround:
+
+```ts
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore
+(this as unknown as {YourBaseClass}).protectedMember
+```
+The directive `@ts-ignore` suppresses compiler error about accessing a protected member from outside. Unfortunately, it also disables other compile-time checks (e.g. to verify that a protected method was invoked with correct arguments, and so on). This is the same behavior you would get by using `Constructor<any>` instead of `MixinTarget<Application>`<!-- -->. The major improvement is that TypeScript can still infer the return type of the protected member, therefore `any` is NOT introduced to subsequent code.
+
+TypeScript also does not allow mixin class to overwrite a method inherited from a mapped type, see https://github.com/microsoft/TypeScript/issues/38496 As a workaround, use `@ts-ignore` to disable the error.
+
+```ts
+export function RepositoryMixin<T extends MixinTarget<Application>>(
+superClass: T,
+) {
+  return class extends superClass {
+   // @ts-ignore
+   public component<C extends Component = Component>(
+     componentCtor: Constructor<C>,
+     nameOrOptions?: string | BindingFromClassOptions,
+   ) {
+     const binding = super.component(componentCtor, nameOrOptions);
+     // ...
+     return binding;
+   }
+}
+```
+
+

package/site/apidocs/core.mountcomponent.md

@@ -0,0 +1,35 @@
+---
+lang: en
+title: 'API docs: core.mountcomponent'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
+sidebar: lb4_sidebar
+editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/core
+permalink: /doc/en/lb4/apidocs.core.mountcomponent.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/core](./core.md) &gt; [mountComponent](./core.mountcomponent.md)
+
+## mountComponent() function
+
+Mount a component to an Application.
+
+**Signature:**
+
+```typescript
+export declare function mountComponent(app: Application, component: Component): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  app | [Application](./core.application.md) | Application |
+|  component | [Component](./core.component.md) | Component instance |
+
+**Returns:**
+
+void
+
+

package/site/apidocs/core.providermap.md

@@ -0,0 +1,23 @@
+---
+lang: en
+title: 'API docs: core.providermap'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
+sidebar: lb4_sidebar
+editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/core
+permalink: /doc/en/lb4/apidocs.core.providermap.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/core](./core.md) &gt; [ProviderMap](./core.providermap.md)
+
+## ProviderMap interface
+
+A map of provider classes to be bound to a context
+
+**Signature:**
+
+```typescript
+export interface ProviderMap 
+```
+

package/site/apidocs/core.server.listening.md

@@ -0,0 +1,23 @@
+---
+lang: en
+title: 'API docs: core.server.listening'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
+sidebar: lb4_sidebar
+editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/core
+permalink: /doc/en/lb4/apidocs.core.server.listening.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/core](./core.md) &gt; [Server](./core.server.md) &gt; [listening](./core.server.listening.md)
+
+## Server.listening property
+
+Tells whether the server is listening for connections or not
+
+**Signature:**
+
+```typescript
+readonly listening: boolean;
+```
+

package/site/apidocs/core.server.md

@@ -0,0 +1,31 @@
+---
+lang: en
+title: 'API docs: core.server'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
+sidebar: lb4_sidebar
+editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/core
+permalink: /doc/en/lb4/apidocs.core.server.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/core](./core.md) &gt; [Server](./core.server.md)
+
+## Server interface
+
+Defines the requirements to implement a Server for LoopBack applications: start() : Promise<void> stop() : Promise<void> It is recommended that each Server implementation creates its own child Context, which inherits from the parent Application context. This way, any Server-specific bindings will remain local to the Server instance, and will avoid polluting its parent module scope.
+
+**Signature:**
+
+```typescript
+export interface Server extends LifeCycleObserver 
+```
+**Extends:** [LifeCycleObserver](./core.lifecycleobserver.md)
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [listening](./core.server.listening.md) | <code>readonly</code> | boolean | Tells whether the server is listening for connections or not |
+
+

package/site/apidocs/core.service.md

@@ -0,0 +1,55 @@
+---
+lang: en
+title: 'API docs: core.service'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
+sidebar: lb4_sidebar
+editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/core
+permalink: /doc/en/lb4/apidocs.core.service.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/core](./core.md) &gt; [service](./core.service.md)
+
+## service() function
+
+`@service` injects a service instance that matches the class or interface.
+
+**Signature:**
+
+```typescript
+export declare function service(serviceInterface?: ServiceInterface, metadata?: InjectionMetadata): (target: Object, member: string | undefined, methodDescriptorOrParameterIndex?: number | TypedPropertyDescriptor<any> | undefined) => void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  serviceInterface | [ServiceInterface](./core.serviceinterface.md) | <p>_(Optional)_ Interface for the service. It can be in one of the following forms:</p><p>- A class, such as MyService - A string that identifies the interface, such as <code>'MyService'</code> - A symbol that identifies the interface, such as <code>Symbol('MyService')</code></p><p>If not provided, the value is inferred from the design:type of the parameter or property</p> |
+|  metadata | [InjectionMetadata](./context.injectionmetadata.md) | _(Optional)_ |
+
+**Returns:**
+
+(target: Object, member: string \| undefined, methodDescriptorOrParameterIndex?: number \| TypedPropertyDescriptor&lt;any&gt; \| undefined) =&gt; void
+
+## Example
+
+
+```ts
+
+const ctx = new Context();
+ctx.bind('my-service').toClass(MyService);
+ctx.bind('logger').toClass(Logger);
+
+export class MyController {
+  constructor(@service(MyService) private myService: MyService) {}
+
+  @service()
+  private logger: Logger;
+}
+
+ctx.bind('my-controller').toClass(MyController);
+await myController = ctx.get<MyController>('my-controller');
+```
+
+

package/site/apidocs/core.serviceinterface.md

@@ -0,0 +1,23 @@
+---
+lang: en
+title: 'API docs: core.serviceinterface'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
+sidebar: lb4_sidebar
+editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/core
+permalink: /doc/en/lb4/apidocs.core.serviceinterface.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/core](./core.md) &gt; [ServiceInterface](./core.serviceinterface.md)
+
+## ServiceInterface type
+
+Representing an interface for services. In TypeScript, the `interface` does not have reflections at runtime. We use a string, a symbol or a Function as the type for the service interface.
+
+**Signature:**
+
+```typescript
+export type ServiceInterface = string | symbol | Function;
+```
+

package/site/apidocs/core.serviceoptions.interface.md

@@ -0,0 +1,21 @@
+---
+lang: en
+title: 'API docs: core.serviceoptions.interface'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
+sidebar: lb4_sidebar
+editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/core
+permalink: /doc/en/lb4/apidocs.core.serviceoptions.interface.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/core](./core.md) &gt; [ServiceOptions](./core.serviceoptions.md) &gt; [interface](./core.serviceoptions.interface.md)
+
+## ServiceOptions.interface property
+
+**Signature:**
+
+```typescript
+interface?: ServiceInterface;
+```
+

package/site/apidocs/core.serviceoptions.md

@@ -0,0 +1,31 @@
+---
+lang: en
+title: 'API docs: core.serviceoptions'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
+sidebar: lb4_sidebar
+editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/core
+permalink: /doc/en/lb4/apidocs.core.serviceoptions.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/core](./core.md) &gt; [ServiceOptions](./core.serviceoptions.md)
+
+## ServiceOptions interface
+
+Options to register a service binding
+
+**Signature:**
+
+```typescript
+export interface ServiceOptions extends BindingFromClassOptions 
+```
+**Extends:** [BindingFromClassOptions](./context.bindingfromclassoptions.md)
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [interface?](./core.serviceoptions.interface.md) |  | [ServiceInterface](./core.serviceinterface.md) | _(Optional)_ |
+
+

package/site/apidocs/core.serviceorproviderclass.md

@@ -0,0 +1,23 @@
+---
+lang: en
+title: 'API docs: core.serviceorproviderclass'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
+sidebar: lb4_sidebar
+editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/core
+permalink: /doc/en/lb4/apidocs.core.serviceorproviderclass.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/core](./core.md) &gt; [ServiceOrProviderClass](./core.serviceorproviderclass.md)
+
+## ServiceOrProviderClass type
+
+**Signature:**
+
+```typescript
+export type ServiceOrProviderClass<T = any> = Constructor<T | Provider<T>> | DynamicValueProviderClass<T>;
+```
+**References:** [Constructor](./context.constructor.md)<!-- -->, [Provider](./context.provider.md)<!-- -->, [DynamicValueProviderClass](./context.dynamicvalueproviderclass.md)
+
+

package/site/apidocs/core.shutdownoptions.md

@@ -0,0 +1,26 @@
+---
+lang: en
+title: 'API docs: core.shutdownoptions'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
+sidebar: lb4_sidebar
+editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/core
+permalink: /doc/en/lb4/apidocs.core.shutdownoptions.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/core](./core.md) &gt; [ShutdownOptions](./core.shutdownoptions.md)
+
+## ShutdownOptions type
+
+Options to set up application shutdown
+
+**Signature:**
+
+```typescript
+export type ShutdownOptions = {
+    signals?: NodeJS.Signals[];
+    gracePeriod?: number;
+};
+```
+

package/site/apidocs/cron.ascronjob.md

@@ -0,0 +1,34 @@
+---
+lang: en
+title: 'API docs: cron.ascronjob'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
+sidebar: lb4_sidebar
+editurl: https://github.com/loopbackio/loopback-next/tree/master/extensions/cron
+permalink: /doc/en/lb4/apidocs.cron.ascronjob.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/cron](./cron.md) &gt; [asCronJob](./cron.ascronjob.md)
+
+## asCronJob() function
+
+A `BindingTemplate` function to configure the binding as a cron job.
+
+**Signature:**
+
+```typescript
+export declare function asCronJob<T = unknown>(binding: Binding<T>): Binding<T>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  binding | [Binding](./context.binding.md)<!-- -->&lt;T&gt; | Binding object |
+
+**Returns:**
+
+[Binding](./context.binding.md)<!-- -->&lt;T&gt;
+
+

package/site/apidocs/cron.cron_job_scheduler.md

@@ -0,0 +1,23 @@
+---
+lang: en
+title: 'API docs: cron.cron_job_scheduler'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
+sidebar: lb4_sidebar
+editurl: https://github.com/loopbackio/loopback-next/tree/master/extensions/cron
+permalink: /doc/en/lb4/apidocs.cron.cron_job_scheduler.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/cron](./cron.md) &gt; [CRON\_JOB\_SCHEDULER](./cron.cron_job_scheduler.md)
+
+## CRON\_JOB\_SCHEDULER variable
+
+Name of the cron job extension point
+
+**Signature:**
+
+```typescript
+CRON_JOB_SCHEDULER = "cron.jobScheduler"
+```
+

package/site/apidocs/cron.cronbindings.component.md

@@ -0,0 +1,23 @@
+---
+lang: en
+title: 'API docs: cron.cronbindings.component'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
+sidebar: lb4_sidebar
+editurl: https://github.com/loopbackio/loopback-next/tree/master/extensions/cron
+permalink: /doc/en/lb4/apidocs.cron.cronbindings.component.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/cron](./cron.md) &gt; [CronBindings](./cron.cronbindings.md) &gt; [COMPONENT](./cron.cronbindings.component.md)
+
+## CronBindings.COMPONENT variable
+
+Binding key for `CronComponent`
+
+**Signature:**
+
+```typescript
+COMPONENT: BindingKey<CronComponent>
+```
+

package/site/apidocs/cron.cronbindings.cron_job_namespace.md

@@ -0,0 +1,23 @@
+---
+lang: en
+title: 'API docs: cron.cronbindings.cron_job_namespace'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
+sidebar: lb4_sidebar
+editurl: https://github.com/loopbackio/loopback-next/tree/master/extensions/cron
+permalink: /doc/en/lb4/apidocs.cron.cronbindings.cron_job_namespace.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/cron](./cron.md) &gt; [CronBindings](./cron.cronbindings.md) &gt; [CRON\_JOB\_NAMESPACE](./cron.cronbindings.cron_job_namespace.md)
+
+## CronBindings.CRON\_JOB\_NAMESPACE variable
+
+Namespace for cron jobs
+
+**Signature:**
+
+```typescript
+CRON_JOB_NAMESPACE = "cron.jobs"
+```
+

package/site/apidocs/cron.cronbindings.md

@@ -0,0 +1,31 @@
+---
+lang: en
+title: 'API docs: cron.cronbindings'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
+sidebar: lb4_sidebar
+editurl: https://github.com/loopbackio/loopback-next/tree/master/extensions/cron
+permalink: /doc/en/lb4/apidocs.cron.cronbindings.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/cron](./cron.md) &gt; [CronBindings](./cron.cronbindings.md)
+
+## CronBindings namespace
+
+Binding keys used by this component.
+
+**Signature:**
+
+```typescript
+export declare namespace CronBindings 
+```
+
+## Variables
+
+|  Variable | Description |
+|  --- | --- |
+|  [COMPONENT](./cron.cronbindings.component.md) | Binding key for <code>CronComponent</code> |
+|  [CRON\_JOB\_NAMESPACE](./cron.cronbindings.cron_job_namespace.md) | Namespace for cron jobs |
+
+

package/site/apidocs/cron.croncomponent._constructor_.md

@@ -0,0 +1,30 @@
+---
+lang: en
+title: 'API docs: cron.croncomponent._constructor_'
+keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
+sidebar: lb4_sidebar
+editurl: https://github.com/loopbackio/loopback-next/tree/master/extensions/cron
+permalink: /doc/en/lb4/apidocs.cron.croncomponent._constructor_.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/cron](./cron.md) &gt; [CronComponent](./cron.croncomponent.md) &gt; [(constructor)](./cron.croncomponent._constructor_.md)
+
+## CronComponent.(constructor)
+
+Constructs a new instance of the `CronComponent` class
+
+**Signature:**
+
+```typescript
+constructor(getJobs: Getter<CronJob[]>);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  getJobs | Getter&lt;[CronJob](./cron.cronjob.md)<!-- -->\[\]&gt; |  |
+
+