Environment Path

Manages the path to an environment property.

The path is a property name, a dot-separated set of property names or an array of property names that represents a path to get an environment value. Must be a sequence of ASCII characters that can contain letters a-zA-Z, $, _, and digits 0-9, but may not start with a digit.

Use cases

Table of Contents

1. isPath
2. overwritesPath
3. pathAsArray
4. pathAsString
5. prefixPath
6. suffixPath
7. Errors

isPath

isPath('a'); // true
isPath('a.a'); // true
isPath('a.a0'); // true
isPath('a.a$'); // true
isPath('a._a'); // true
isPath(['a', 'a']); // true
isPath(''); // false
isPath([]); // false
isPath('a.a-'); // false
isPath('2a'); // false
isPath(0); // false
isPath(['2a', 'a']); // false

overwritesPath

const environment = { a: { b: 0 } };
overwritesPath('a.b', environment); // true
overwritesPath('a.b.c.d', environment); // true

const environment = { a: { b: {} } };
overwritesPath('a', environment); // false
overwritesPath('a.b.c', environment); // false
overwritesPath('a.b.c.d', environment); // false

pathAsArray

pathAsArray('a.a'); // ['a','a']
pathAsArray(['a', 'a']); // ['a','a']

pathAsString

pathAsString('a.a'); // 'a.a'
pathAsString(['a', 'a']); // 'a.a'

prefixPath

prefixPath(['a', 'a'], ['b', 'b']); // ['b','b','a','a']
prefixPath(['a', 'a'], 'b.b'); // ['b','b','a','a']
prefixPath('a.a', 'b.b'); // 'b.b.a.a'
prefixPath('a.a', ['b', 'b']); // 'b.b.a.a'

suffixPath

suffixPath(['a', 'a'], ['b', 'b']); // ['a','a','b','b']
suffixPath(['a', 'a'], 'b.b'); // ['a','a','b','b']
suffixPath('a.a', 'b.b'); // 'a.a.b.b'
suffixPath('a.a', ['b', 'b']); // 'a.a.b.b'

Errors

new InvalidPathError('2a'); // The path "2a" is invalid
new PathDoesntExistError('a'); // The path "a" doesn't exist in the environment
new PathExistsError('a'); // The path "a" already exists in the environment