Note: There is a newer version (1.10.0) of this package available. Click here to view docs for the latest version.
Module os
ballerina/os Ballerina library
1.2.0
Overview
This module provides APIs to retrieve information about the environment variables and the current users of the Operating System.
The APIs are platform-independent, i.e., uniform across all operating systems.
For information on the operations, which you can perform with the os module, see the below Functions.
Functions
getEnv
Isolated Function
Returns the environment variable value associated with the provided name.
string port = os:getEnv("HTTP_PORT");
Parameters
- name string - Name of the environment variable
Return Type
- string - Environment variable value if it exists or else, an empty string
getUserHome
Isolated Function
function getUserHome() returns stringReturns the current user's home directory path.
string userHome = os:getUserHome();
Return Type
- string - Current user's home directory if it can be determined or else, an empty string
getUsername
Isolated Function
function getUsername() returns stringReturns the current user's name.
string username = os:getUsername();
Return Type
- string - Current user's name if it can be determined or else, an empty string