[osenv] Add typing for osenv (#35230)

* Added typedefs for osenv

* Arrow funs
This commit is contained in:
Adam Zerella
2019-05-07 16:38:00 -07:00
committed by Jesse Trinity
parent bdff5c282f
commit 1bfb09c6f1
4 changed files with 100 additions and 0 deletions
+47
View File
@@ -0,0 +1,47 @@
// Type definitions for osenv 0.1
// Project: https://github.com/npm/osenv
// Definitions by: Adam Zerella <https://github.com/adamzerella>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
/**
* The machine name. Calls hostname if not found.
*/
export function hostname(cb?: (hostname: string, error?: string) => void): string;
/**
* The currently logged-in user. Calls whoami if not found.
*/
export function user(cb?: (user: string, error?: string) => void): string;
/**
* Either PS1 on unix, or PROMPT on Windows.
*/
export function prompt(cb?: (prompt: string, error?: string) => void): string;
/**
* The place where temporary files should be created.
*/
export function tmpdir(cb?: (tmpdir: string, error?: string) => void): string;
/**
* No place like it.
*/
export function home(cb?: (home: string, error?: string) => void): string;
/**
* An array of the places that the operating system will search for executables.
*/
export function path(cb?: (path: string, error?: string) => void): string;
/**
* Return the executable name of the editor program.
* This uses the EDITOR and VISUAL environment variables,
* and falls back to vi on Unix, or notepad.exe on Windows.
*/
export function editor(cb?: (editor: string, error?: string) => void): string;
/**
* The SHELL on Unix, which Windows calls the ComSpec.
* Defaults to 'bash' or 'cmd'.
*/
export function shell(cb?: (shell: string, error?: string) => void): string;
+25
View File
@@ -0,0 +1,25 @@
import osenv = require("osenv");
osenv.hostname();
osenv.hostname((er, hostname) => {});
osenv.home();
osenv.home((er, home) => {});
osenv.editor();
osenv.editor((er, editor) => {});
osenv.path();
osenv.path((er, path) => {});
osenv.prompt();
osenv.prompt((er, prompt) => {});
osenv.shell();
osenv.shell((er, shell) => {});
osenv.tmpdir();
osenv.tmpdir((er, tmpdir) => {});
osenv.user();
osenv.user((er, user) => {});
+25
View File
@@ -0,0 +1,25 @@
{
"compilerOptions": {
"module": "commonjs",
"lib": [
"es6"
],
"noImplicitAny": true,
"noImplicitThis": true,
"strictNullChecks": true,
"strictFunctionTypes": true,
"baseUrl": "../",
"typeRoots": [
"../"
],
"types": [
],
"noEmit": true,
"forceConsistentCasingInFileNames": true
},
"files": [
"index.d.ts",
"osenv-tests.ts"
]
}
+3
View File
@@ -0,0 +1,3 @@
{
"extends": "dtslint/dt.json"
}