Skip to content

feat(types): add generic type support to TransformableInfo #345

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.

Sign up for GitHub

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

Open
Baptiste-hero wants to merge 1 commit into
base: master
Choose a base branch
from
+4 −4
Open

feat(types): add generic type support to TransformableInfo #345

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@
// TypeScript Version: 2.2
import {LEVEL, MESSAGE, SPLAT} from 'triple-beam'

export interface TransformableInfo {
export type TransformableInfo<TCustom = {}> = TCustom & {
level: string;
message: unknown;
[LEVEL]?: string;
[MESSAGE]?: unknown;
[SPLAT]?: unknown;
[key: string | symbol]: unknown;
}
};

export type TransformFunction = (info: TransformableInfo, opts?: unknown) => TransformableInfo | boolean;
export type Colors = { [key: string]: string | string[] }; // tslint:disable-line interface-over-type-literal
Expand Down Expand Up @@ -50,7 +50,7 @@ export namespace format {
function ms(): Format;
function padLevels(opts?: PadLevelsOptions): Format;
function prettyPrint(opts?: PrettyPrintOptions): Format;
function printf(templateFunction: (info: TransformableInfo) => string): Format;
function printf<TCustom = {}>(templateFunction: (info: TransformableInfo<TCustom>) => string): Format;
function simple(): Format;
function splat(): Format;
function timestamp(opts?: TimestampOptions): Format;
Expand Down Expand Up @@ -107,7 +107,7 @@ export interface JsonOptions {
/**
* If `true`, guarantee a deterministic key order instead of relying on the insertion order.
* Set to `false` to keep original insertion order.
* Or provide an array comparator function that determines the order of the elements.
* Or provide an array comparator function that determines the order of the elements.
* @default true
*/
deterministic?: boolean | ((a: string, b: string) => number),
Expand Down