Options
All
  • Public
  • Public/Protected
  • All
Menu

Log abstraction for output of a specific activity. Not intended as a long-running log but for a short-lived activity. Not a technical log of this project but a log of meaningful activity on behalf of users.

Hierarchy

  • WritableLog
    • ProgressLog

Implemented by

Index

Properties

Optional log

log: string

The content already written to the log. This is optional as some implementations may choose to not expose their log as a string as it could be too long.

name

name: string

Name. Should relate to the immediate activity we're logging.

Optional stripAnsi

stripAnsi: boolean

Set to true if ANSI escape characters should be stripped from the data before writing to log.

Optional url

url: string

Return the url of the log if it is persisted

Methods

close

  • close(): Promise<void>

flush

  • flush(): Promise<void>

isAvailable

  • isAvailable(): Promise<boolean>
  • Is this logger available at this point in time? E.g. if it's backed by a service, is that service up?

    Returns Promise<boolean>

write

  • write(what: string): void
  • Function that appends to the log.

    Parameters

    • what: string

    Returns void

Generated using TypeDoc