Skip to content
This repository has been archived by the owner on Aug 3, 2021. It is now read-only.
Cedric Poon edited this page Jan 15, 2020 · 16 revisions

Overview

Ryaml is an immutable Object which wraps a YAML string as source reference.

The main usage of Ryaml is to transform the underlying YAML string into Rjson using .toRjson([profile = 'default']), while literal alteration on YAML is also supported via .patch(patcher => {}).

API

Instantiation

Every new instantiation should be carried out using new operator

const { Ryaml } = require('reyaml-core');
const yaml = "foo: bar";

const ryaml = new Ryaml(yaml);
Clone this wiki locally