gleam/erlang/os

Access to the shell’s environment variables

Types

Represents operating system kernels

pub type OsFamily {
  WindowsNt
  Linux
  Darwin
  FreeBsd
  Other(String)
}

</>

pub fn family() -> OsFamily

Returns the kernel of the host operating system.

Unknown kernels are reported as Other(String); e.g. Other("sunos").

family()
// -> Linux

family()
// -> Darwin

family()
// -> Other("sunos")

</>

pub fn get_all_env() -> Dict(String, String)

Deprecated: Please use the envoy package instead

Returns the list of all available environment variables as a list of key, tuples.

get_all_env()
// -> dict.from_list([
//  #("SHELL", "/bin/bash"),
//  #("PWD", "/home/j3rn"),
//  ...
// ])

</>

pub fn get_env(name name: String) -> Result(String, Nil)

Deprecated: Please use the envoy package instead

Returns the value associated with the given environment variable name.

get_env("SHELL")
// -> "/bin/bash"

get_env(name: "PWD")
// -> "/home/j3rn"

</>

pub fn set_env(name name: String, value value: String) -> Nil

Deprecated: Please use the envoy package instead

Associates the given value with the given environment variable name.

set_env("MYVAR", "MYVALUE")
// -> Nil
get_env("MYVAR")
// -> "MYVALUE"

set_env(value: "MYVALUE", name: "MYVAR")
// -> Nil
get_env("MYVAR")
// -> "MYVALUE"

</>

pub fn unset_env(name name: String) -> Nil

Deprecated: Please use the envoy package instead

Removes the environment variable with the given name.

Returns Nil regardless of whether the variable ever existed.

get_env("MYVAR")
// -> Ok("MYVALUE")
unset_env("MYVAR")
// -> Nil
get_env("MYVAR")
// -> Error(Nil)

unset_env(name: "MYVAR")
// ->  Nil
get_env("MYVAR")
// -> Error(Nil)