@loopback/boot/src/keys.ts

A collection of Booters for LoopBack 4 Applications

// Copyright IBM Corp. and LoopBack contributors 2018,2020. All Rights Reserved.
// Node module: @loopback/boot
// This file is licensed under the MIT License.
// License text available at https://opensource.org/licenses/MIT

import {BindingKey} from '@loopback/core';
import {Bootstrapper} from './bootstrapper';
import {BootOptions} from './types';

/**
 * Namespace for boot related binding keys
 */
export namespace BootBindings {
  /**
   * Binding key for boot options
   */
  export const BOOT_OPTIONS = BindingKey.create<BootOptions>('boot.options');
  /**
   * Binding key for determining project root directory
   */
  export const PROJECT_ROOT = BindingKey.create<string>('boot.project_root');

  /**
   * Binding key for binding the BootStrapper class
   */
  export const BOOTSTRAPPER_KEY = BindingKey.create<Bootstrapper>(
    'application.bootstrapper',
  );

  /**
   * Booter binding namespace
   */
  export const BOOTERS = 'booters';
  export const BOOTER_PREFIX = 'booters';
}

/**
 * Namespace for boot related tags
 */
export namespace BootTags {
  export const BOOTER = 'booter';
  /**
   * @deprecated Use `BootTags.BOOTER` instead.
   */
  export const BOOTER_TAG = BootTags.BOOTER;
}