@usine/config/yaml/writer

Classes

YamlEdit

One replacement in authored YAML, preserving the surrounding file.

Extends

• Schema.Class

Constructors

Constructor

new YamlEdit(…args): YamlEdit

Parameters

Parameter	Type
…args	[props: object, options?: MakeOptions]

Returns

YamlEdit

Properties

path

readonly path: readonly string[]

Path in file-key spelling, for example ["settings", "max_children"].

value

readonly value: Json

Variables

updateFrontmatter

const updateFrontmatter: (file, source, edit) => Effect.Effect<string, ConfigFileError, never>

Sets one YAML path in the frontmatter of a Markdown config file and returns the whole file.

Parameters

Parameter	Type
file	string & Brand
source	string
edit	YamlEdit

Returns

Effect.Effect<string, ConfigFileError, never>

---

updateYaml

const updateYaml: (file, source, edit) => Effect.Effect<string, ConfigFileError, never>

Sets one YAML path and returns the file with its comments, key order, and newline style intact.

Parameters

Parameter	Type
file	string & Brand
source	string
edit	YamlEdit

Returns

Effect.Effect<string, ConfigFileError, never>