Packages
gleam_erlang
0.34.0
1.3.0
1.2.0
1.1.0
1.0.0
1.0.0-rc1
0.34.0
0.33.0
0.32.0
0.31.0
0.30.0
0.29.0
0.28.0
0.27.0
0.26.0
0.25.0
0.24.0
0.23.1
0.23.0
0.22.0
0.21.0
0.20.0
0.19.0
0.18.1
0.18.0
0.18.0-rc1
retired
0.17.1
0.17.0
0.16.0
0.15.0
0.14.0
0.13.0
0.12.0
0.11.0
0.10.0
0.9.3
0.9.2
0.9.1
0.9.0
0.8.0
0.7.0
0.6.0
0.5.0
0.4.0
0.3.0
0.2.0
0.1.0
Types and functions for programs running on Erlang!
Current section
Files
Jump to
Current section
Files
src/gleam@erlang@os.erl
-module(gleam@erlang@os).
-compile([no_auto_import, nowarn_unused_vars, nowarn_unused_function, nowarn_nomatch]).
-export([family/0]).
-export_type([os_family/0]).
-if(?OTP_RELEASE >= 27).
-define(MODULEDOC(Str), -moduledoc(Str)).
-define(DOC(Str), -doc(Str)).
-else.
-define(MODULEDOC(Str), -compile([])).
-define(DOC(Str), -compile([])).
-endif.
-type os_family() :: windows_nt | linux | darwin | free_bsd | {other, binary()}.
-file("/Users/louis/src/gleam/erlang/src/gleam/erlang/os.gleam", 36).
?DOC(
" Returns the kernel of the host operating system.\n"
"\n"
" Unknown kernels are reported as `Other(String)`; e.g. `Other(\"sunos\")`.\n"
"\n"
" ## Examples\n"
" ```gleam\n"
" family()\n"
" // -> Linux\n"
" ```\n"
" \n"
" ```gleam\n"
" family()\n"
" // -> Darwin\n"
" ```\n"
" \n"
" ```gleam\n"
" family()\n"
" // -> Other(\"sunos\")\n"
" ```\n"
).
-spec family() -> os_family().
family() ->
gleam_erlang_ffi:os_family().