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

adding types to the project #726

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,4 @@ yarn-error.log
# lockfiles
yarn.lock
package-lock.json
/.idea/
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -47,5 +47,6 @@
"xo": "^0.23.0"
},
"main": "./src/index.js",
"browser": "./src/browser.js"
"browser": "./src/browser.js",
"types": "./src/index.d.ts"
}
49 changes: 49 additions & 0 deletions src/browser.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
export=browser
declare namespace browser
{
/**
* Currently only WebKit-based Web Inspectors, Firefox >= v31,
* and the Firebug extension (any Firefox version) are known
* to support "%c" CSS customizations.
*
* TODO: add a `localStorage` variable to explicitly enable/disable colors
*/
function useColors(): boolean;

/**
* Colorize log arguments if enabled.
*
* @api public
*/
function formatArgs(args: string[]): void;

/**
* Save `namespaces`.
*
* @param {String} namespaces
* @api private
*/
function save(namespaces: string): void;

/**
* Load `namespaces`.
*
* @return {String} returns the previously persisted debug modes
* @api private
*/
function load(): string;

/**
* Localstorage attempts to return the localstorage.
*
* This is necessary because safari throws
* when a user disables cookies/localstorage
* and you attempt to access it.
*
* @return {LocalStorage}
* @api private
*/
function localstorage(): Storage;

const formatters: { j: (str:string) => string };
}
45 changes: 45 additions & 0 deletions src/common.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
type DebugNamespace = {
(...args: string[]): void;
namespace: string;
enabled: boolean;
useColors: boolean;
color: number | string;
destroy: () => boolean;
extend: (namespace: string, delimiter: string) => DebugNamespace;
};

type DebugType = {
(namespace: string): DebugNamespace;
debug: DebugType;
default: DebugNamespace;
coerce: <T>(val: T) => T;
disable: () => string;
enable: (namespaces: string) => void;
enabled: (name: string) => boolean;
humanize: (timeInMs:number)=>string;
/**
* Active `debug` instances.
*/
instances: DebugNamespace[];
/**
* The currently active debug mode names, and names to skip.
*/
names: string[];
skips: string[];
/**
* Map of special "%n" handling functions, for the debug "format" argument.
*
* Valid key names are a single, lower or upper-case letter, i.e. "n" and "N".
*/
formatters: {};
selectColor: (namespace: string) => number;
};

/**
* This is the common logic for both the Node.js and web browser
* implementations of `debug()`.
*/

import node = require("node");
import browser = require("browser");
declare function setup(env:typeof node|typeof browser ): DebugType;
9 changes: 9 additions & 0 deletions src/index.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
/**
* Detect Electron renderer / nwjs process, which is node, but we should
* treat as a browser.
*/
import node = require("node");
import browser = require("browser");
type isBrowser=typeof window;
type index=isBrowser extends Object? typeof browser: typeof node;
export=index;
45 changes: 45 additions & 0 deletions src/node.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
/**
* Module dependencies.
*/
import TTY=require("tty");
import Util=require("util");

declare const tty: typeof TTY;
declare const util: typeof Util;
/**
* Is stdout a TTY? Colored output is enabled when `true`.
*/
declare function useColors(): boolean;
/**
* Adds ANSI color escape codes if enabled.
*
* @api public
*/
declare function formatArgs(args: any): void;
declare function getDate(): string;
/**
* Invokes `util.format()` with the specified arguments and writes to stderr.
*/
declare function log(...args: any[]): boolean;
/**
* Save `namespaces`.
*
* @param {String} namespaces
* @api private
*/
declare function save(namespaces: string): void;
/**
* Load `namespaces`.
*
* @return {String} returns the previously persisted debug modes
* @api private
*/
declare function load(): string;
/**
* Init logic for `debug` instances.
*
* Create a new `inspectOpts` object in case `useColors` is set
* differently for a particular `debug` instance.
*/
declare function init(debug: any): void;
declare const formatters: {o:()=>string,O:()=>string};
63 changes: 63 additions & 0 deletions tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
{
"compilerOptions": {
/* Basic Options */
// "incremental": true, /* Enable incremental compilation */
"target": "es5", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
"module": "commonjs", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
// "lib": [], /* Specify library files to be included in the compilation. */
// "allowJs": true, /* Allow javascript files to be compiled. */
// "checkJs": true, /* Report errors in .js files. */
// "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
// "declaration": true, /* Generates corresponding '.d.ts' file. */
// "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */
// "sourceMap": true, /* Generates corresponding '.map' file. */
// "outFile": "./", /* Concatenate and emit output to single file. */
// "outDir": "./", /* Redirect output structure to the directory. */
// "rootDir": "./", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
// "composite": true, /* Enable project compilation */
// "tsBuildInfoFile": "./", /* Specify file to store incremental compilation information */
// "removeComments": true, /* Do not emit comments to output. */
// "noEmit": true, /* Do not emit outputs. */
// "importHelpers": true, /* Import emit helpers from 'tslib'. */
// "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
// "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */

/* Strict Type-Checking Options */
"strict": true, /* Enable all strict type-checking options. */
// "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */
// "strictNullChecks": true, /* Enable strict null checks. */
// "strictFunctionTypes": true, /* Enable strict checking of function types. */
// "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
// "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */
// "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */
// "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */

/* Additional Checks */
// "noUnusedLocals": true, /* Report errors on unused locals. */
// "noUnusedParameters": true, /* Report errors on unused parameters. */
// "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */
// "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */

/* Module Resolution Options */
// "moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
"baseUrl": "src", /* Base directory to resolve non-absolute module names. */
// "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
// "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */
"typeRoots": ["src/"], /* List of folders to include type definitions from. */
// "types": [], /* Type declaration files to be included in compilation. */
// "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
"esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
// "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */

/* Source Map Options */
// "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
// "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */
// "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */

/* Experimental Options */
// "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */
// "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */
}
}