-
Notifications
You must be signed in to change notification settings - Fork 19
Add TypeScript type declarations #21
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
Closed
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| import { BaseLevels, BaseLogger } from 'anylogger' | ||
|
|
||
| type ValueOf<T> = T[keyof T] | ||
|
|
||
| type LevelNames = BaseLevels & { | ||
| assert: 0 | ||
| dir: 0 | ||
| table: 0 | ||
| time: 0 | ||
| timeEnd: 0 | ||
| verbose: 4 | ||
| silly: 6 | ||
| } | ||
|
|
||
| interface LevelConstants { | ||
| NONE: 0 | ||
| ERROR: 1 | ||
| WARN: 2 | ||
| INFO: 3 | ||
| LOG: 4 | ||
| DEBUG: 5 | ||
| TRACE: 6 | ||
| } | ||
|
|
||
| export interface Logger extends BaseLogger<LevelNames>, LevelConstants { | ||
|
|
||
| readonly ulog: { version: string } | ||
|
|
||
| /** | ||
| * The log level of this logger. | ||
| */ | ||
| level: LogLevel | ||
|
|
||
| assert(...args: any[]): void | ||
| dir(...args: any[]): void | ||
| table(...args: any[]): void | ||
| time(...args: any[]): void | ||
| timeEnd(...args: any[]): void | ||
| verbose(message?: any, ...args: any[]): void | ||
| silly(message?: any, ...args: any[]): void | ||
| } | ||
|
|
||
| export type LogLevel = ValueOf<LevelConstants> | ||
|
|
||
| export type LogFormatter = (logger: Logger, method: keyof LevelNames, args: any[]) => void | ||
|
|
||
| export type LoggerExtender = (logger: Logger, parent: Logger) => void | ||
|
|
||
| export interface ULog extends LevelConstants { | ||
| /** | ||
| * Returns a logger with the specified name. If it doesn't exist yet, | ||
| * it will be created. | ||
| */ | ||
| (name: string): Logger | ||
|
|
||
| /** | ||
| * The default log level. | ||
| */ | ||
| level: LogLevel | ||
|
|
||
| /** | ||
| * Array of functions that will intercept calls to the logger functions to | ||
| * apply some formatting. | ||
| */ | ||
| formats: LogFormatter[] | ||
|
|
||
| /** | ||
| * Array of functions that will be called with each new logger. | ||
| */ | ||
| extends: LoggerExtender[] | ||
|
|
||
| /** | ||
| * Enables debug mode for the loggers listed in `names`. | ||
| */ | ||
| enable(names: string): void | ||
|
|
||
| /** | ||
| * Tests whether the named logger is currently in debug mode. | ||
| */ | ||
| enabled(name: string): true | undefined | ||
|
|
||
| /** | ||
| * Disables debug mode for all loggers. | ||
| */ | ||
| disable(): void | ||
| } | ||
|
|
||
| declare const ulog: ULog | ||
|
|
||
| export default ulog |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why peerDependencies? Wouldn't devDependencies be better suited since it's only useful for TS typings? Having it in peerDependencies wouldn't increase the overall size while not being actually useful for a production usage?