@types/osenv
TypeScript icon, indicating that this package has built-in type declarations

0.1.3 • Public • Published

Installation

npm install --save @types/osenv

Summary

This package contains type definitions for osenv (https://github.com/npm/osenv).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/osenv.

index.d.ts

/**
 * 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;

Additional Details

  • Last updated: Tue, 07 Nov 2023 09:09:39 GMT
  • Dependencies: none

Credits

These definitions were written by .

Versions

Current Tags

Version History

  • Version
    Downloads (Last 7 Days)
    • Published
  • 0.1.3
    3,070
  • 0.1.2
    4
  • 0.1.1
    340
  • 0.1.0
    137

Package Sidebar

Install

npm i @types/osenv

Weekly Downloads

2,885

Version

0.1.3

License

MIT

Unpacked Size

4.82 kB

Total Files

5

Last publish

Collaborators

  • types