docs: Include external types and improve typedocs

* Use typedoc plugin to include Pino types in typedocs
* Use media to include screenshot in typedocs

.github/workflows/typedoc_deploy.yml

@@ -20,7 +20,7 @@ jobs:
       - run: npm run build
 
       - name: Create the docs directory locally in CI
-        run: npx typedoc
+        run: npm run typedoc
 
       - name: Deploy 🚀
         uses: JamesIves/github-pages-deploy-action@4.1.4

README.md

@@ -20,8 +20,10 @@ Features:
   * Add or use your own streams for destinations
   * All pino-pretty configs are exposed and extensible
 
-<img src="/example/example.png"
-alt="log output example" height="500">
+<img src="/assets/example.png"
+alt="log output example">
+<img src="media://example.png"
+alt="log output example">
 
 # Install
 

package.json

@@ -5,7 +5,7 @@
   "repository": "https://github.com/foxxmd/logging",
   "description": "",
   "scripts": {
-    "typedoc": "typedoc",
+    "typedoc": "typedoc --plugin typedoc-plugin-missing-exports --media ./assets",
     "build": "tsc",
     "prepare": "tshy",
     "test": "mocha --reporter spec --recursive ./tests/*.test.ts",
@@ -50,6 +50,8 @@
     "ts-node": "^10.9.1",
     "tsconfig-paths": "^4.2.0",
     "tshy": "^1.7.0",
+    "typedoc": "^0.25.11",
+    "typedoc-plugin-missing-exports": "^2.2.0",
     "typescript": "^5.3.3",
     "with-local-tmp-dir": "^5.0.1",
     "yaml": "^2.3.4"

src/factory.ts

@@ -1,6 +1,7 @@
 import {prettyConsole, prettyFile, prettyOptsFactory} from "./pretty.js";
 import {buildDestinationStream, buildDestinationRollingFile, buildDestinationStdout, buildDestinationStderr, buildDestinationFile} from "./destinations.js";
 import {buildLogger} from './loggers.js';
+import {FileDestination, StreamDestination} from './types.js'
 
 export {
     prettyConsole,
@@ -13,3 +14,8 @@ export {
     buildDestinationRollingFile,
     buildLogger
 }
+
+export type {
+    FileDestination,
+    StreamDestination
+}

src/types.ts

@@ -25,7 +25,7 @@ export interface LogOptions {
      *
      * May also be specified using env LOG_PATH or a function that returns a string
      *
-     * @default 'CWD/logs/app.log
+     * @default 'CWD/logs/app.log'
      * */
     filePath?: string | (() => string)
     /**