@types/osenv

TypeScript definitions for osenv

  • Types
  • ESM
  • CJS
License
MIT
Deps
0
Install Size
4.8 kB
Vulns
0
Published

Get started

$npm install @types/osenv
$pnpm add @types/osenv
$yarn add @types/osenv
$bun add @types/osenv
$deno add npm:@types/osenv
$vlt install @types/osenv
$vp add @types/osenv
# Usually installed as a dev dependency
$npm install -D @types/osenv
$pnpm add -D @types/osenv
$yarn add -D @types/osenv
$bun add -d @types/osenv
$deno add -D npm:@types/osenv
$vlt install -D @types/osenv
$vp add -D @types/osenv

Weekly DownloadsAcross all versions

Versions

View all versions
0.1.3
latestts4.5ts4.6ts4.7ts4.8ts4.9ts5.0ts5.1ts5.2ts5.3ts5.4ts5.5ts5.6ts5.7ts5.8ts5.9ts6.0
0.1.1
ts3.8ts3.9ts4.0ts4.1ts4.2ts4.3ts4.4
0.1.0
ts2.0ts2.1ts2.2ts2.3ts2.4ts2.5ts2.6ts2.7ts2.8ts2.9ts3.0ts3.1ts3.2ts3.3ts3.4ts3.5ts3.6ts3.7

Readme

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 .