Update fn docs and readability.

This commit is contained in:
Kevin Baensch 2024-11-30 18:34:41 +01:00
parent 923bddbc94
commit b6b22c2c22
Signed by: derped
GPG key ID: C0F1D326C7626543

30
fn.nix
View file

@ -2,10 +2,34 @@
with builtins;
with lib;
rec {
/**
Shorthand for "if condition then a else b"
# Type
```
ifelse :: Bool -> Any -> Any -> Any
```
# Arguments
- [condition] A condition evaluating to a boolean
- [a] Result if condition evaluates to true
- [b] Result if condition evaluates to false
# Example
```nix
let
myData = { val = "custom"; };
in ifelse (myData ? val) myData.val "default"
=> "custom"
```
*/
ifelse =
a: b: c:
if a then b else c;
fileContentsOr = a: b: (ifelse (pathIsRegularFile a) a b);
condition: a: b:
if condition then a else b;
/**
Value of PWD environment variable at evaluation time
*/
cwd = builtins.getEnv "PWD";
# lst (string PATH) (string FILETYPE) (bool RETURNFULLPATH)