Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add type declarations #148

Merged
merged 8 commits into from Dec 13, 2021
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
62 changes: 62 additions & 0 deletions index.d.ts
@@ -0,0 +1,62 @@
// Type definitions for hapi-pino 9.0
// Definitions by: Rodrigo Saboya <https://github.com/saboya>
// Todd Bealmear <https://github.com/todd>
// Matt Jeanes <https://github.com/BlooJeans>
// Kyle Gray <https://github.com/GoPro16>
// TypeScript Version: 2.8

/// <reference types='node' />

import type { pino } from 'pino';

import { Plugin, Request } from '@hapi/hapi';

declare module '@hapi/hapi' {
interface Server {
logger: pino.Logger;
}

interface Request {
logger: pino.Logger;
}
}

declare namespace HapiPino {
interface Serializers {
[key: string]: pino.SerializerFn;
}

interface Options {
timestamp?: boolean | (() => string) | undefined;
logQueryParams?: boolean | undefined;
logPayload?: boolean | undefined;
logRouteTags?: boolean | undefined;
logRequestStart?: boolean | ((req: Request) => boolean) | undefined;
logRequestComplete?: boolean | ((req: Request) => boolean) | undefined;
stream?: NodeJS.WriteStream | undefined;
prettyPrint?: boolean | pino.PrettyOptions | undefined;
tags?: { [key in pino.Level]?: string } | undefined;
allTags?: pino.Level | undefined;
serializers?: Serializers | undefined;
getChildBindings?:
| ((req: Request) => {
level?: pino.Level | string | undefined;
serializers?: Serializers | undefined;
[key: string]: any;
})
| undefined;
instance?: pino.Logger | undefined;
logEvents?: string[] | false | null | undefined;
mergeHapiLogData?: boolean | undefined;
ignorePaths?: string[] | undefined;
level?: pino.Level | undefined;
redact?: string[] | pino.redactOptions | undefined;
ignoreTags?: string[] | undefined;
ignoreFunc?: ((options: Options, request: Request) => boolean) | undefined;
ignoredEventTags?: object[] | undefined;
}
}

declare var HapiPino: Plugin<HapiPino.Options>;

export = HapiPino;
1 change: 1 addition & 0 deletions package.json
Expand Up @@ -3,6 +3,7 @@
"version": "9.0.0",
"description": "Hapi plugin for the Pino logger ",
"main": "index.js",
"types": "index.d.ts",
"scripts": {
"coverage": "lab test.js -c",
"coverage:lcov": "lab test.js -r lcov -o coverage/lcov.info",
Expand Down