Logo for jsDocs.io

@types/osenv

  • Version 0.1.3
  • Published
  • 4.82 kB
  • No dependencies
  • MIT license

Install

npm i @types/osenv
yarn add @types/osenv
pnpm add @types/osenv

Overview

TypeScript definitions for osenv

Index

Functions

Functions

function editor

editor: (cb?: (editor: 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.

function home

home: (cb?: (home: string, error?: string) => void) => string;

  • No place like it.

function hostname

hostname: (cb?: (hostname: string, error?: string) => void) => string;

  • The machine name. Calls hostname if not found.

function path

path: (cb?: (path: string, error?: string) => void) => string;

  • An array of the places that the operating system will search for executables.

function prompt

prompt: (cb?: (prompt: string, error?: string) => void) => string;

  • Either PS1 on unix, or PROMPT on Windows.

function shell

shell: (cb?: (shell: string, error?: string) => void) => string;

  • The SHELL on Unix, which Windows calls the ComSpec. Defaults to 'bash' or 'cmd'.

function tmpdir

tmpdir: (cb?: (tmpdir: string, error?: string) => void) => string;

  • The place where temporary files should be created.

function user

user: (cb?: (user: string, error?: string) => void) => string;

  • The currently logged-in user. Calls whoami if not found.

Package Files (1)

Dependencies (0)

No dependencies.

Dev Dependencies (0)

No dev dependencies.

Peer Dependencies (0)

No peer dependencies.

Badge

To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@types/osenv.

  • Markdown
    [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@types/osenv)
  • HTML
    <a href="https://www.jsdocs.io/package/@types/osenv"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>