feat: add getLogLevelName

Author: gajus

.README/README.md

@@ -426,6 +426,26 @@ Produces output:
 
 ```
 
+## Utilities
+
+### `getLogLevelName`
+
+Provides log level name (trace, debug, ...) for a numeric log level (10, 20, ...).
+
+If numeric log level is between two ranges, then resolves to the one with greater severity (e.g. 5 => trace).
+
+If numeric log level is greater than the maximum supported, then falls back to the greatest severity (fatal).
+
+```js
+import {
+  getLogLevelName,
+} from 'roarr';
+import type {
+  LogLevelName,
+} from 'roarr';
+
+getLogLevelName(numericLogLevel: number): LogLevelName;
+```
 ## Middlewares
 
 Roarr logger supports middlewares implemented as [`child`](#child) message translate functions, e.g.

README.md

@@ -26,6 +26,8 @@ JSON logger for Node.js and browser.
         * [`warn`](#roarr-api-warn)
         * [`error`](#roarr-api-error)
         * [`fatal`](#roarr-api-fatal)
+    * [Utilities](#roarr-utilities)
+        * [`getLogLevelName`](#roarr-utilities-getloglevelname)
     * [Middlewares](#roarr-middlewares)
     * [CLI program](#roarr-cli-program)
     * [Transports](#roarr-transports)
@@ -485,6 +487,28 @@ Produces output:
 
 ```
 
+<a name="roarr-utilities"></a>
+## Utilities
+
+<a name="roarr-utilities-getloglevelname"></a>
+### <code>getLogLevelName</code>
+
+Provides log level name (trace, debug, ...) for a numeric log level (10, 20, ...).
+
+If numeric log level is between two ranges, then resolves to the one with greater severity (e.g. 5 => trace).
+
+If numeric log level is greater than the maximum supported, then falls back to the greatest severity (fatal).
+
+```js
+import {
+  getLogLevelName,
+} from 'roarr';
+import type {
+  LogLevelName,
+} from 'roarr';
+
+getLogLevelName(numericLogLevel: number): LogLevelName;
+```
 <a name="roarr-middlewares"></a>
 ## Middlewares
 

src/Roarr.ts

@@ -15,6 +15,9 @@ import {
 import {
   createRoarrInitialGlobalState,
 } from './factories/createRoarrInitialGlobalState';
+import {
+  getLogLevelName,
+} from './getLogLevelName';
 import type {
   RoarrGlobalState,
 } from './types';
@@ -66,6 +69,7 @@ const Roarr = logFactory((message) => {
 
 export type {
   Logger,
+  LogLevelName,
   LogWriter,
   Message,
   MessageEventHandler,
@@ -74,6 +78,7 @@ export type {
 } from './types';
 
 export {
+  getLogLevelName,
   logLevels,
   Roarr,
   ROARR,

src/browser.ts

@@ -8,6 +8,9 @@ import {
 import {
   createRoarrInitialGlobalStateBrowser,
 } from './factories/createRoarrInitialGlobalStateBrowser';
+import {
+  getLogLevelName,
+} from './getLogLevelName';
 import type {
   RoarrGlobalState,
 } from './types';
@@ -28,13 +31,15 @@ const Roarr = createLogger((message) => {
 
 export type {
   Logger,
+  LogLevelName,
   Message,
   MessageEventHandler,
   RoarrGlobalState,
   TranslateMessageFunction,
 } from './types';
 
 export {
+  getLogLevelName,
   logLevels,
   Roarr,
   ROARR,

src/types.ts

@@ -69,3 +69,6 @@ export type Logger = LogMethod & {
 };
 
 export type MessageEventHandler = (message: Message) => void;
+
+// eslint-disable-next-line @typescript-eslint/sort-type-union-intersection-members
+export type LogLevelName = 'trace' | 'debug' | 'info' | 'error' | 'fatal' | 'warn';