Interface IApiLogger

A logger for strict API messages.

Hierarchy

  • IApiLogger

Methods

  • Write strict typed DEBUG message.

    Parameters

    • log: IApiLog

      A complete log object to submit.

    Returns void

    Example

    import { createApiLogger } from '@egomobile/log';

    const log = createApiLogger();
    log.debug('my message');
    log.debug('my message', 'my details');
    log.debug('my message with metadata', { foo: { value: 42 } });
    log.debug('my message with metadata', 'and details', { foo: { value: 42 } });
  • Parameters

    • message: string

    Returns void

  • Parameters

    • message: string
    • details: string

    Returns void

  • Parameters

    Returns void

  • Parameters

    Returns void

  • Write strict typed ERROR message.

    Parameters

    • log: IApiLog

      A complete log object to submit.

    Returns void

    Example

    import { createApiLogger } from '@egomobile/log';

    const log = createApiLogger();
    log.error('my message');
    log.error('my message', 'my details');
    log.error('my message with metadata', { foo: { value: 42 } });
    log.error('my message with metadata', 'and details', { foo: { value: 42 } });
  • Parameters

    • message: string

    Returns void

  • Parameters

    • message: string
    • details: string

    Returns void

  • Parameters

    Returns void

  • Parameters

    Returns void

  • Creates a copy of this logger and automatically a specific prefix to each message and details value.

    Parameters

    • prefix: string

      The prefix.

    Returns IApiLogger

    The new instance.

    Example

    import { createApiLogger } from '@egomobile/log';

    const log = createApiLogger();
    log.info('my message'); // logs 'my message'

    const logWithPrefix = log.withPrefix('FOO-PREFIX: ');
    logWithPrefix.info('my message'); // logs 'FOO-PREFIX: my message'

Generated using TypeDoc