index.d.ts 1.2 KB

123456789101112131415161718192021222324
  1. import { ConsolaInstance, ConsolaOptions } from './core.js';
  2. export { ConfirmPromptOptions, Consola, ConsolaReporter, FormatOptions, InputLogObject, LogLevel, LogLevels, LogObject, LogType, LogTypes, MultiSelectOptions, PromptOptions, SelectPromptOptions, TextPromptOptions } from './core.js';
  3. /**
  4. * Factory function to create a new Consola instance tailored for use in different environments.
  5. * It automatically adjusts logging levels based on environment variables and execution context.
  6. *
  7. * @param {Partial<ConsolaOptions & { fancy: boolean }>} [options={}] - Optional configuration options. See {@link ConsolaOptions}.
  8. * @returns {ConsolaInstance} A new Consola instance with configurations based on the given options and the execution environment.
  9. */
  10. declare function createConsola(options?: Partial<ConsolaOptions & {
  11. fancy: boolean;
  12. }>): ConsolaInstance;
  13. /**
  14. * A default instance of Consola, created and configured for immediate use.
  15. * This instance is configured based on the execution environment and the options provided.
  16. *
  17. * @type {ConsolaInstance} consola - The default Consola instance, ready to use.
  18. */
  19. declare const consola: ConsolaInstance;
  20. // @ts-ignore
  21. export = consola;
  22. export { ConsolaInstance, ConsolaOptions, consola, createConsola };