setConfig
setConfig(
cfg):void
Defined in: packages/log/src/index.ts:46
Sets log configuration.
Parameters
Section titled “Parameters”The configuration, optionally including a theme.
format?
Section titled “format?”"text" | "json"
The configuration format.
jsonSpace?
Section titled “jsonSpace?”number
How much space in the JSON output of objects. This does not change spacing in JSON logs, only for objects passed into log functions.
stderr?
Section titled “stderr?”{ _construct?: (callback) => void; _destroy?: { }; _final?: { }; _write?: { }; _writev?: (chunks, callback) => void; [captureRejectionSymbol]?: <K>(error, event, …args) => void; addListener?: { }; closed?: boolean; compose?: { }; cork?: () => void; destroy?: { }; destroyed?: boolean; emit?: { }; end?: { }; errored?: Error | null; eventNames?: () => (string | symbol)[]; getMaxListeners?: () => number; listenerCount?: { }; listeners?: { }; off?: { }; on?: { }; once?: { }; pipe?: { }; prependListener?: { }; prependOnceListener?: { }; rawListeners?: { }; removeAllListeners?: { }; removeListener?: { }; setDefaultEncoding?: { }; setMaxListeners?: { }; uncork?: () => void; writable?: boolean; writableAborted?: boolean; writableCorked?: number; writableEnded?: boolean; writableFinished?: boolean; writableHighWaterMark?: number; writableLength?: number; writableNeedDrain?: boolean; writableObjectMode?: boolean; write?: { }; }
Standard error output.
stderr._construct?
Section titled “stderr._construct?”(callback) => void
stderr._destroy?
Section titled “stderr._destroy?”{ }
stderr._final?
Section titled “stderr._final?”{ }
stderr._write?
Section titled “stderr._write?”{ }
stderr._writev?
Section titled “stderr._writev?”(chunks, callback) => void
stderr.[captureRejectionSymbol]?
Section titled “stderr.[captureRejectionSymbol]?”<K>(error, event, …args) => void
stderr.addListener?
Section titled “stderr.addListener?”{ }
stderr.closed?
Section titled “stderr.closed?”boolean
Is true after 'close' has been emitted.
Since
v18.0.0
stderr.compose?
Section titled “stderr.compose?”{ }
stderr.cork?
Section titled “stderr.cork?”() => void
stderr.destroy?
Section titled “stderr.destroy?”{ }
stderr.destroyed?
Section titled “stderr.destroyed?”boolean
Is true after writable.destroy() has been called.
Since
v8.0.0
stderr.emit?
Section titled “stderr.emit?”{ }
stderr.end?
Section titled “stderr.end?”{ }
stderr.errored?
Section titled “stderr.errored?”Error | null
Returns error if the stream has been destroyed with an error.
Since
v18.0.0
stderr.eventNames?
Section titled “stderr.eventNames?”() => (string | symbol)[]
stderr.getMaxListeners?
Section titled “stderr.getMaxListeners?”() => number
stderr.listenerCount?
Section titled “stderr.listenerCount?”{ }
stderr.listeners?
Section titled “stderr.listeners?”{ }
stderr.off?
Section titled “stderr.off?”{ }
stderr.on?
Section titled “stderr.on?”{ }
stderr.once?
Section titled “stderr.once?”{ }
stderr.pipe?
Section titled “stderr.pipe?”{ }
stderr.prependListener?
Section titled “stderr.prependListener?”{ }
stderr.prependOnceListener?
Section titled “stderr.prependOnceListener?”{ }
stderr.rawListeners?
Section titled “stderr.rawListeners?”{ }
stderr.removeAllListeners?
Section titled “stderr.removeAllListeners?”{ }
stderr.removeListener?
Section titled “stderr.removeListener?”{ }
stderr.setDefaultEncoding?
Section titled “stderr.setDefaultEncoding?”{ }
stderr.setMaxListeners?
Section titled “stderr.setMaxListeners?”{ }
stderr.uncork?
Section titled “stderr.uncork?”() => void
stderr.writable?
Section titled “stderr.writable?”boolean
Is true if it is safe to call writable.write(), which means
the stream has not been destroyed, errored, or ended.
Since
v11.4.0
stderr.writableAborted?
Section titled “stderr.writableAborted?”boolean
Returns whether the stream was destroyed or errored before emitting 'finish'.
Since
v18.0.0, v16.17.0
stderr.writableCorked?
Section titled “stderr.writableCorked?”number
Number of times writable.uncork() needs to be
called in order to fully uncork the stream.
Since
v13.2.0, v12.16.0
stderr.writableEnded?
Section titled “stderr.writableEnded?”boolean
Is true after writable.end() has been called. This property
does not indicate whether the data has been flushed, for this use writable.writableFinished instead.
Since
v12.9.0
stderr.writableFinished?
Section titled “stderr.writableFinished?”boolean
Is set to true immediately before the 'finish' event is emitted.
Since
v12.6.0
stderr.writableHighWaterMark?
Section titled “stderr.writableHighWaterMark?”number
Return the value of highWaterMark passed when creating this Writable.
Since
v9.3.0
stderr.writableLength?
Section titled “stderr.writableLength?”number
This property contains the number of bytes (or objects) in the queue
ready to be written. The value provides introspection data regarding
the status of the highWaterMark.
Since
v9.4.0
stderr.writableNeedDrain?
Section titled “stderr.writableNeedDrain?”boolean
Is true if the stream’s buffer has been full and stream will emit 'drain'.
Since
v15.2.0, v14.17.0
stderr.writableObjectMode?
Section titled “stderr.writableObjectMode?”boolean
Getter for the property objectMode of a given Writable stream.
Since
v12.3.0
stderr.write?
Section titled “stderr.write?”{ }
stdout?
Section titled “stdout?”{ _construct?: (callback) => void; _destroy?: { }; _final?: { }; _write?: { }; _writev?: (chunks, callback) => void; [captureRejectionSymbol]?: <K>(error, event, …args) => void; addListener?: { }; closed?: boolean; compose?: { }; cork?: () => void; destroy?: { }; destroyed?: boolean; emit?: { }; end?: { }; errored?: Error | null; eventNames?: () => (string | symbol)[]; getMaxListeners?: () => number; listenerCount?: { }; listeners?: { }; off?: { }; on?: { }; once?: { }; pipe?: { }; prependListener?: { }; prependOnceListener?: { }; rawListeners?: { }; removeAllListeners?: { }; removeListener?: { }; setDefaultEncoding?: { }; setMaxListeners?: { }; uncork?: () => void; writable?: boolean; writableAborted?: boolean; writableCorked?: number; writableEnded?: boolean; writableFinished?: boolean; writableHighWaterMark?: number; writableLength?: number; writableNeedDrain?: boolean; writableObjectMode?: boolean; write?: { }; }
Standard output.
stdout._construct?
Section titled “stdout._construct?”(callback) => void
stdout._destroy?
Section titled “stdout._destroy?”{ }
stdout._final?
Section titled “stdout._final?”{ }
stdout._write?
Section titled “stdout._write?”{ }
stdout._writev?
Section titled “stdout._writev?”(chunks, callback) => void
stdout.[captureRejectionSymbol]?
Section titled “stdout.[captureRejectionSymbol]?”<K>(error, event, …args) => void
stdout.addListener?
Section titled “stdout.addListener?”{ }
stdout.closed?
Section titled “stdout.closed?”boolean
Is true after 'close' has been emitted.
Since
v18.0.0
stdout.compose?
Section titled “stdout.compose?”{ }
stdout.cork?
Section titled “stdout.cork?”() => void
stdout.destroy?
Section titled “stdout.destroy?”{ }
stdout.destroyed?
Section titled “stdout.destroyed?”boolean
Is true after writable.destroy() has been called.
Since
v8.0.0
stdout.emit?
Section titled “stdout.emit?”{ }
stdout.end?
Section titled “stdout.end?”{ }
stdout.errored?
Section titled “stdout.errored?”Error | null
Returns error if the stream has been destroyed with an error.
Since
v18.0.0
stdout.eventNames?
Section titled “stdout.eventNames?”() => (string | symbol)[]
stdout.getMaxListeners?
Section titled “stdout.getMaxListeners?”() => number
stdout.listenerCount?
Section titled “stdout.listenerCount?”{ }
stdout.listeners?
Section titled “stdout.listeners?”{ }
stdout.off?
Section titled “stdout.off?”{ }
stdout.on?
Section titled “stdout.on?”{ }
stdout.once?
Section titled “stdout.once?”{ }
stdout.pipe?
Section titled “stdout.pipe?”{ }
stdout.prependListener?
Section titled “stdout.prependListener?”{ }
stdout.prependOnceListener?
Section titled “stdout.prependOnceListener?”{ }
stdout.rawListeners?
Section titled “stdout.rawListeners?”{ }
stdout.removeAllListeners?
Section titled “stdout.removeAllListeners?”{ }
stdout.removeListener?
Section titled “stdout.removeListener?”{ }
stdout.setDefaultEncoding?
Section titled “stdout.setDefaultEncoding?”{ }
stdout.setMaxListeners?
Section titled “stdout.setMaxListeners?”{ }
stdout.uncork?
Section titled “stdout.uncork?”() => void
stdout.writable?
Section titled “stdout.writable?”boolean
Is true if it is safe to call writable.write(), which means
the stream has not been destroyed, errored, or ended.
Since
v11.4.0
stdout.writableAborted?
Section titled “stdout.writableAborted?”boolean
Returns whether the stream was destroyed or errored before emitting 'finish'.
Since
v18.0.0, v16.17.0
stdout.writableCorked?
Section titled “stdout.writableCorked?”number
Number of times writable.uncork() needs to be
called in order to fully uncork the stream.
Since
v13.2.0, v12.16.0
stdout.writableEnded?
Section titled “stdout.writableEnded?”boolean
Is true after writable.end() has been called. This property
does not indicate whether the data has been flushed, for this use writable.writableFinished instead.
Since
v12.9.0
stdout.writableFinished?
Section titled “stdout.writableFinished?”boolean
Is set to true immediately before the 'finish' event is emitted.
Since
v12.6.0
stdout.writableHighWaterMark?
Section titled “stdout.writableHighWaterMark?”number
Return the value of highWaterMark passed when creating this Writable.
Since
v9.3.0
stdout.writableLength?
Section titled “stdout.writableLength?”number
This property contains the number of bytes (or objects) in the queue
ready to be written. The value provides introspection data regarding
the status of the highWaterMark.
Since
v9.4.0
stdout.writableNeedDrain?
Section titled “stdout.writableNeedDrain?”boolean
Is true if the stream’s buffer has been full and stream will emit 'drain'.
Since
v15.2.0, v14.17.0
stdout.writableObjectMode?
Section titled “stdout.writableObjectMode?”boolean
Getter for the property objectMode of a given Writable stream.
Since
v12.3.0
stdout.write?
Section titled “stdout.write?”{ }
Returns
Section titled “Returns”void