Sign In with GitHub
Sign In with GitLabWorks with
•JSR Score52%•It is unknown whether this package works with Browsers, Deno, Node.js, Cloudflare Workers, Bun
Published2 years ago (0.215.0)
Examples
Example 1
Example 1
import { parse, stringify, } from "@std/yaml"; const data = parse(` foo: bar baz: - qux - quux `); console.log(data); // => { foo: "bar", baz: [ "qux", "quux" ] } const yaml = stringify({ foo: "bar", baz: ["qux", "quux"] }); console.log(yaml); // => // foo: bar // baz: // - qux // - quux
Classes
c
Type()
tag: string,
options?: TypeOptions
No documentation available
- construct: (data?: Any) => AnyNo documentation available
- defaultStyle: StyleVariantNo documentation available
- instanceOf: AnyNo documentation available
- kind: KindType | nullNo documentation available
- loadKind: KindTypeNo documentation available
- predicate: (data: Record<string, unknown>) => booleanNo documentation available
- represent: RepresentFn | ArrayObject<RepresentFn>No documentation available
- resolve: (data?: Any) => booleanNo documentation available
- styleAliases: ArrayObjectNo documentation available
- tag: stringNo documentation available
Functions
f
parse(): unknown
content: string,
options?: ParseOptions
Parses content as single YAML document.
f
parseAll(): unknown
content: string,
iterator?: CbFunction | ParseOptions,
options?: ParseOptions
2 overloads
Same as parse(), but understands multi-document sources.
Applies iterator to each document if specified, or returns array of documents.
f
stringify(): string
obj: Record<string, unknown>,
options?: DumpOptions
Serializes object as a YAML document.
Type Aliases
T
DumpOptions = DumperStateOptions
No documentation available
T
KindType = "sequence" | "scalar" | "mapping"
No documentation available
T
ParseOptions = LoaderStateOptions
No documentation available
T
RepresentFn = () => Any
data: Any,
style?: StyleVariant
No documentation available
T
StyleVariant = "lowercase" | "uppercase" | "camelcase" | "decimal"
No documentation available
Variables
v
CORE_SCHEMA: Schema
No documentation available
v
DEFAULT_SCHEMA: Schema
No documentation available
v
EXTENDED_SCHEMA: Schema
Extends JS-YAML default schema with additional JavaScript types It is not described in the YAML specification. Functions are no longer supported for security reasons.
v
FAILSAFE_SCHEMA: Schema
No documentation available
v
JSON_SCHEMA: Schema
No documentation available