1. module pino
   1. function pino (opts, stream)
   2. function pino.pretty (opts)
   3. number pino.LOG_VERSION
   4. object pino.levels
   5. object pino.serializers
   6. object pino.stdSerializers
   7. object pino.time
   8. object pino.tools
2. module pino.levels
   1. function pino.levels.isStandardLevel (level)
   2. function pino.levels.isStandardLevelVal (val)
   3. object pino.levels
   4. object pino.levels.lscache
   5. object pino.levels.nums
3. module pino.serializers
   1. function pino.serializers.asErrValue (err)
   2. function pino.serializers.asReqValue (req)
   3. function pino.serializers.asResValue (res)
   4. function pino.serializers.mapHttpRequest (req)
   5. function pino.serializers.mapHttpResponse (res)
4. module pino.stdSerializers
   1. function pino.stdSerializers.err (err)
   2. function pino.stdSerializers.req (req)
   3. function pino.stdSerializers.res (res)
5. module pino.time
   1. function pino.time.getNoTime ()
   2. function pino.time.getSlowTime ()
   3. function pino.time.getTime ()
6. module pino.tools
   1. function pino.tools.applyOptions (opts)
   2. function pino.tools.copy (a, b)
   3. function pino.tools.defineLevelsProperty (onObject)
   4. function pino.tools.genLog (z)
   5. function pino.tools.noop ()
   6. function pino.tools.streamIsBlockable (s)

module pino

function pino (opts, stream)

• description and source-code

  function pino(opts, stream) {
    var iopts = opts
    var istream = stream
    if (iopts && (iopts.writable || iopts._writableState)) {
      istream = iopts
      iopts = defaultOptions
    }
    iopts = Object.assign({}, defaultOptions, iopts)
    if (iopts.extreme && iopts.prettyPrint) throw Error('cannot enable pretty print in extreme mode')
    istream = istream || process.stdout
    if (iopts.prettyPrint) {
      var prettyOpts = Object.assign({ messageKey: iopts.messageKey }, iopts.prettyPrint)
      var pstream = pretty(prettyOpts)
      var origStream = istream
      pump(pstream, origStream, function (err) {
        if (err) instance.emit('error', err)
      })
      istream = pstream
    }
  
    // internal options
    iopts.stringify = iopts.safe ? stringifySafe : JSON.stringify
    iopts.formatOpts = {lowres: true}
    iopts.messageKeyString = `,"${iopts.messageKey}":`
    iopts.end = ',"v":' + LOG_VERSION + '}\n'
    iopts.cache = !iopts.extreme ? null : {
      size: 4096,
      buf: ''
    }
    iopts.chindings = ''
  
    if (iopts.enabled === false) {
      iopts.level = 'silent'
    }
  
    var instance = Object.create(pinoPrototype)
    instance.stream = istream
    tools.defineLevelsProperty(instance)
    tools.applyOptions.call(instance, iopts)
    if (iopts.cache) setTimeout(waitForFDSettle, 100)
  
    var settleTries = 0
    function waitForFDSettle () {
      var isBlockable = tools.streamIsBlockable(istream)
      if (isBlockable === false && settleTries > 10) {
        return instance.emit('error', Error('stream must have a file descriptor in extreme mode'))
      } else if (isBlockable === true) {
        return events(instance, extremeModeExitHandler)
      }
      settleTries += 1
      setTimeout(waitForFDSettle, 100)
    }
  
    function extremeModeExitHandler () {
      var buf = iopts.cache.buf
      if (buf) {
        // We need to block the process exit long enough to flush the buffer
        // to the destination stream. We do that by forcing a synchronous
        // write directly to the stream's file descriptor.
        var fd = (istream.fd) ? istream.fd : istream._handle.fd
        fs.writeSync(fd, buf)
      }
    }
  
    return instance
  }

• example usage

  n/a

function pino.pretty (opts)

• description and source-code

  function pretty(opts) {
    var timeTransOnly = opts && opts.timeTransOnly
    var formatter = opts && opts.formatter
    var levelFirst = opts && opts.levelFirst
    var messageKey = opts && opts.messageKey
    messageKey = messageKey || 'msg'
  
    var stream = split(mapLine)
    var ctx
    var levelColors
  
    var pipe = stream.pipe
  
    stream.pipe = function (dest, opts) {
      ctx = new chalk.constructor({
        enabled: !!(chalk.supportsColor && dest.isTTY)
      })
  
      levelColors = {
        default: ctx.white,
        60: ctx.bgRed,
        50: ctx.red,
        40: ctx.yellow,
        30: ctx.green,
        20: ctx.blue,
        10: ctx.grey
      }
  
      pipe.call(stream, dest, opts)
    }
  
    return stream
  
    function mapLine (line) {
      var parsed = new Parse(line)
      var value = parsed.value
  
      if (parsed.err || !isPinoLine(value)) {
        // pass through
        return line + '\n'
      }
  
      if (formatter) {
        return opts.formatter(parsed.value) + '\n'
      }
  
      if (timeTransOnly) {
        value.time = asISODate(value.time)
        return JSON.stringify(value) + '\n'
      }
  
      line = (levelFirst)
          ? asColoredLevel(value) + ' [' + asISODate(value.time) + ']'
          : '[' + asISODate(value.time) + '] ' + asColoredLevel(value)
  
      line += ' ('
      if (value.name) {
        line += value.name + '/'
      }
      line += value.pid + ' on ' + value.hostname + ')'
      line += ': '
      if (value[messageKey]) {
        line += ctx.cyan(value[messageKey])
      }
      line += '\n'
      if (value.type === 'Error') {
        line += '    ' + withSpaces(value.stack) + '\n'
      } else {
        line += filter(value, messageKey)
      }
      return line
    }
  
    function asISODate (time) {
      return new Date(time).toISOString()
    }
  
    function asColoredLevel (value) {
      if (levelColors.hasOwnProperty(value.level)) {
        return levelColors[value.level](levels[value.level])
      } else {
        return levelColors.default(levels.default)
      }
    }
  }

• example usage

  n/a

module pino.levels

function pino.levels.isStandardLevel (level)

• description and source-code

  isStandardLevel = function (level) {
    if (Infinity === level) {
      return true
    }
    return keys.indexOf(level) > -1
  }

• example usage

  ...
    this._levelVal = num
  
    for (var key in this.levels.values) {
      if (num > this.levels.values[key]) {
        this[key] = tools.noop
        continue
      }
      this[key] = levels.isStandardLevel(key) ? pinoPrototype[key] : tools.genLog(this.
  levels.values[key])
    }
  }
  Object.defineProperty(pinoPrototype, 'levelVal', {
    get: getLevelVal,
    set: setLevelVal
  })
  ...

function pino.levels.isStandardLevelVal (val)

• description and source-code

  isStandardLevelVal = function (val) {
    if (!isFinite(val)) {
      return true
    }
    return keys.indexOf(val + '') > -1
  }

• example usage

  ...
      data += '"' + key + '":' + this.stringify(value) + ','
    }
  }
  data = this.chindings + data.substr(0, data.length - 1)
  
  var opts = {
    level: bindings.level || this.level,
    levelVal: levels.isStandardLevelVal(this.levelVal) ? undefined : this.levelVal,
    serializers: bindings.hasOwnProperty('serializers') ? Object.assign({}, this.serializers, bindings.serializers) : this
  .serializers,
    stringify: this.stringify,
    end: this.end,
    name: this.name,
    timestamp: this.timestamp,
    slowtime: this.slowtime,
    chindings: data,
  ...

module pino.serializers

function pino.serializers.asErrValue (err)

• description and source-code

  function asErrValue(err) {
    var obj = {
      type: err.constructor.name,
      message: err.message,
      stack: err.stack
    }
    for (var key in err) {
      if (obj[key] === undefined) {
        obj[key] = err[key]
      }
    }
    return obj
  }

• example usage

  n/a

function pino.serializers.asReqValue (req)

• description and source-code

  function asReqValue(req) {
    return {
      method: req.method,
      url: req.url,
      headers: req.headers,
      remoteAddress: req.connection.remoteAddress,
      remotePort: req.connection.remotePort
    }
  }

• example usage

  n/a

function pino.serializers.asResValue (res)

• description and source-code

  function asResValue(res) {
    return {
      statusCode: res.statusCode,
      header: res._header
    }
  }

• example usage

  n/a

function pino.serializers.mapHttpRequest (req)

• description and source-code

  function mapHttpRequest(req) {
    return {
      req: asReqValue(req)
    }
  }

• example usage

  ...
  var p
  if (typeof a === 'object' && a !== null) {
    m = a
    n = [b, c, d, e, f, g, h, i, j, k]
    l = 1
  
    if (m.method && m.headers && m.socket) {
      m = serializers.mapHttpRequest(m)
    } else if (typeof m.setHeader === 'function') {
      m = serializers.mapHttpResponse(m)
    }
  } else {
    n = [a, b, c, d, e, f, g, h, i, j, k]
  }
  p = n.length = arguments.length - l
  ...

function pino.serializers.mapHttpResponse (res)

• description and source-code

  function mapHttpResponse(res) {
    return {
      res: asResValue(res)
    }
  }

• example usage

  ...
    m = a
    n = [b, c, d, e, f, g, h, i, j, k]
    l = 1
  
    if (m.method && m.headers && m.socket) {
      m = serializers.mapHttpRequest(m)
    } else if (typeof m.setHeader === 'function') {
      m = serializers.mapHttpResponse(m)
    }
  } else {
    n = [a, b, c, d, e, f, g, h, i, j, k]
  }
  p = n.length = arguments.length - l
  if (p > 1) {
    l = typeof a === 'string' ? countInterp(a, '%j') : 0
  ...

module pino.stdSerializers

function pino.stdSerializers.err (err)

• description and source-code

  function asErrValue(err) {
    var obj = {
      type: err.constructor.name,
      message: err.message,
      stack: err.stack
    }
    for (var key in err) {
      if (obj[key] === undefined) {
        obj[key] = err[key]
      }
    }
    return obj
  }

• example usage

  n/a

function pino.stdSerializers.req (req)

• description and source-code

  function asReqValue(req) {
    return {
      method: req.method,
      url: req.url,
      headers: req.headers,
      remoteAddress: req.connection.remoteAddress,
      remotePort: req.connection.remotePort
    }
  }

• example usage

  n/a

function pino.stdSerializers.res (res)

• description and source-code

  function asResValue(res) {
    return {
      statusCode: res.statusCode,
      header: res._header
    }
  }

• example usage

  n/a

module pino.time

function pino.time.getNoTime ()

• description and source-code

  function getNoTime() {
    return ''
  }

• example usage

  n/a

function pino.time.getSlowTime ()

• description and source-code

  function getSlowTime() {
    return ',"time":"' + (new Date()).toISOString() + '"'
  }

• example usage

  n/a

function pino.time.getTime ()

• description and source-code

  function getTime() {
    return ',"time":' + Date.now()
  }

• example usage

  n/a

module pino.tools

function pino.tools.applyOptions (opts)

• description and source-code

  function applyOptions(opts) {
    this.serializers = opts.serializers
    this.stringify = opts.stringify
    this.end = opts.end
    this.name = opts.name
    this.timestamp = opts.timestamp
    this.slowtime = opts.slowtime
    this.chindings = opts.chindings
    this.cache = opts.cache
    this.formatOpts = opts.formatOpts
    this.onTerminated = opts.onTerminated
    this.messageKey = opts.messageKey
    this.messageKeyString = opts.messageKeyString
  
    if (opts.level && opts.levelVal) {
      var levelIsStandard = levels.isStandardLevel(opts.level)
      var valIsStandard = levels.isStandardLevelVal(opts.levelVal)
      if (valIsStandard) throw Error('level value is already used: ' + opts.levelVal)
      if (levelIsStandard === false && valIsStandard === false) this.addLevel(opts.level, opts.levelVal)
    }
    this._setLevel(opts.level)
    this._baseLog = flatstr(baseLog +
      (this.name === undefined ? '' : '"name":' + this.stringify(this.name) + ','))
  
    if (opts.timestamp === false) {
      this.time = time.getNoTime
    } else if (opts.slowtime) {
      this.time = time.getSlowTime
    } else {
      this.time = time.getTime
    }
  }

• example usage

  n/a

function pino.tools.copy (a, b)

• description and source-code

  function copy(a, b) {
    for (var k in b) { a[k] = b[k] }
    return a
  }

• example usage

  ...
  
  Object.defineProperty(pinoPrototype, 'level', {
    get: pinoPrototype._getLevel,
    set: pinoPrototype._setLevel
  })
  
  Object.defineProperty(pinoPrototype, '_lscache', {
    value: tools.copy({}, levels.lscache)
  })
  
  Object.defineProperty(
    pinoPrototype,
    'LOG_VERSION',
    {value: LOG_VERSION}
  )
  ...

function pino.tools.defineLevelsProperty (onObject)

• description and source-code

  function defineLevelsProperty(onObject) {
    Object.defineProperty(onObject, 'levels', {
      value: {
        values: copy({}, levels.levels),
        labels: copy({}, levels.nums)
      },
      enumerable: true
    })
    Object.defineProperty(onObject.levels.values, 'silent', {value: Infinity})
    Object.defineProperty(onObject.levels.labels, Infinity, {value: 'silent'})
  }

• example usage

  ...
  
  if (iopts.enabled === false) {
    iopts.level = 'silent'
  }
  
  var instance = Object.create(pinoPrototype)
  instance.stream = istream
  tools.defineLevelsProperty(instance)
  tools.applyOptions.call(instance, iopts)
  if (iopts.cache) setTimeout(waitForFDSettle, 100)
  
  var settleTries = 0
  function waitForFDSettle () {
    var isBlockable = tools.streamIsBlockable(istream)
    if (isBlockable === false && settleTries > 10) {
  ...

function pino.tools.genLog (z)

• description and source-code

  function genLog(z) {
    return function LOG (a, b, c, d, e, f, g, h, i, j, k) {
      var l = 0
      var m = null
      var n = null
      var o
      var p
      if (typeof a === 'object' && a !== null) {
        m = a
        n = [b, c, d, e, f, g, h, i, j, k]
        l = 1
  
        if (m.method && m.headers && m.socket) {
          m = serializers.mapHttpRequest(m)
        } else if (typeof m.setHeader === 'function') {
          m = serializers.mapHttpResponse(m)
        }
      } else {
        n = [a, b, c, d, e, f, g, h, i, j, k]
      }
      p = n.length = arguments.length - l
      if (p > 1) {
        l = typeof a === 'string' ? countInterp(a, '%j') : 0
        if (l) {
          n.length = l + countInterp(a, '%d') + countInterp(a, '%s') + 1
          o = `${util.format.apply(null, n)}`
        } else {
          o = format(n, this.formatOpts)
        }
      } else if (p) {
        o = n[0]
      }
      this.write(m, o, z)
    }
  }

• example usage

  ...
    enumerable: true
  }
  })
  
  var levelMethods = ['fatal', 'error', 'warn', 'info', 'debug', 'trace'
  ;]
  levelMethods.forEach(function (m) {
  Object.defineProperty(pinoPrototype, m, {
    value: tools.genLog(levels.levels[m]),
    enumerable: true,
    writable: true
  })
  })
  
  function getLevelVal () {
  return this._levelVal
  ...

function pino.tools.noop ()

• description and source-code

  function noop() {}

• example usage

  n/a

function pino.tools.streamIsBlockable (s)

• description and source-code

  function streamIsBlockable(s) {
    if (s.hasOwnProperty('_handle') && s._handle.hasOwnProperty('fd') && s._handle.fd) return true
    if (s.hasOwnProperty('fd') && s.fd) return true
    return false
  }

• example usage

  ...
  instance.stream = istream
  tools.defineLevelsProperty(instance)
  tools.applyOptions.call(instance, iopts)
  if (iopts.cache) setTimeout(waitForFDSettle, 100)
  
  var settleTries = 0
  function waitForFDSettle () {
    var isBlockable = tools.streamIsBlockable(istream)
    if (isBlockable === false && settleTries > 10) {
      return instance.emit('error', Error('stream must have a file descriptor in extreme mode'))
    } else if (isBlockable === true) {
      return events(instance, extremeModeExitHandler)
    }
    settleTries += 1
    setTimeout(waitForFDSettle, 100)
  ...