diff --git a/types/logger/index.d.ts b/types/logger/index.d.ts new file mode 100644 index 0000000000..f961839f8b --- /dev/null +++ b/types/logger/index.d.ts @@ -0,0 +1,25 @@ +// Type definitions for logger 0.0 +// Project: http://github.com/quirkey/node-logger +// Definitions by: Max Wan +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +export function createLogger(logFilePath?: string): Logger; + +export type LogLevel = 'fatal' | 'error' | 'warn' | 'info' | 'debug'; +export type Args = (...args: string[]) => string | false; + +export class Logger { + constructor(logFilePath?: string); + format: (level: LogLevel, data: string, message: string) => string; + setLevel: (level: LogLevel) => number | false; + log: (level: LogLevel, ...args: string[]) => string | false; + fatal: Args; + error: Args; + warn: Args; + info: Args; + debug: Args; +} + +export namespace Logger { + const levels: ['fatal', 'error', 'warn', 'info', 'debug']; +} diff --git a/types/logger/logger-tests.ts b/types/logger/logger-tests.ts new file mode 100644 index 0000000000..96ffdd8d1d --- /dev/null +++ b/types/logger/logger-tests.ts @@ -0,0 +1,22 @@ +import { Logger, createLogger } from 'logger'; + +const logToSTDOUT = createLogger(); // $ExpectType Logger +logToSTDOUT.format('debug', 'date', 'message'); // $ExpectType string +logToSTDOUT.setLevel('fatal'); // $ExpectType number | false +logToSTDOUT.log('info', 'text1', 'text2', 'text3'); // $ExpectType string | false +logToSTDOUT.fatal('fatal', 'text1', 'text2', 'text3', 'text4', 'text5'); // $ExpectType string | false +logToSTDOUT.error('error', 'text1', 'text2', 'text3', 'text4'); // $ExpectType string | false +logToSTDOUT.warn('warn', 'text1', 'text2', 'text3'); // $ExpectType string | false +logToSTDOUT.info('info', 'text1', 'text2'); // $ExpectType string | false +logToSTDOUT.debug('debug', 'text1'); // $ExpectType string | false + +createLogger('test.log'); // $ExpectType Logger + +new Logger(); // $ExpectType Logger +new Logger('test.log'); // $ExpectType Logger + +Logger.levels[0]; // $ExpectType "fatal" +Logger.levels[1]; // $ExpectType "error" +Logger.levels[2]; // $ExpectType "warn" +Logger.levels[3]; // $ExpectType "info" +Logger.levels[4]; // $ExpectType "debug" diff --git a/types/logger/tsconfig.json b/types/logger/tsconfig.json new file mode 100644 index 0000000000..6565be22dd --- /dev/null +++ b/types/logger/tsconfig.json @@ -0,0 +1,23 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictFunctionTypes": true, + "strictNullChecks": true, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "logger-tests.ts" + ] +} diff --git a/types/logger/tslint.json b/types/logger/tslint.json new file mode 100644 index 0000000000..3db14f85ea --- /dev/null +++ b/types/logger/tslint.json @@ -0,0 +1 @@ +{ "extends": "dtslint/dt.json" }