yaml-doc-query

lookup values along with their position in yaml documents

install

1npm i yaml-doc-query
2# yarn add yaml-doc-query

use

1import { parseDocument } from 'yaml';
2import { yamlDocQuery } from 'yaml-doc-query';
3
4const yamlSource = `
5one: 1
6two:
7 - three: 4
8 - five: 5
9`;
10const document = parseDocument(yamlSource);
11const $doc = yamlDocQuery(document);
12
13/* use object access syntax to navigate into the document
14   and end your query with () to get value and range from that node */
15expect($doc.two[1].five()).toEqual({ value: 5, range: [34, 35, 36] });
16
17/* pass source to get position instead of range */
18expect(yamlDocQuery(document, yamlSource).two[0]()).toEqual({
19  value: { three: 4 },
20  position: { start: { line: 4, column: 3 }, end: { line: 5, column: 0 } },
21});
22
23/* receive undefined for non-existent nodes */
24expect($doc.this.does.not.exist()).toEqual(undefined);