🌲 Timber - Shared Typescript types
The Timber JS library packages are written in Typescript.
Various types are shared between multiple packages. Those shared types have been separated out into their own package, to make it easier for importing.
That's what you'll find in this package.
You can import a shared type into a Typescript project by importing directly from this package:
// For example, `ITimberLog`;
Config options for the Timber Base class for creating a Timber client instance.
Enum representing a log level between debug -> error:
You can add meta information to your logs by adding a
number to a string field (or any nested object containing fields of the same.)
We call this 'context' and these are the types:
/*** Context type - a string/number/bool/Date, or a nested object of the same*/;;
The log object which is implicitly created by calling
.log() (or any explicit log level function - e.g.
.info()), and is passed down the chain for Timber middleware before syncing with Timber.io
A type representing a Middleware function passed to
The type of the function passed to
.setSync(), for syncing a log with Timber.io:
Note: Differs from the
Middleware type because it receives - and resolves to a Promise of - an array of batched