Skip to main content
Using Deno in production at your company? Earn free Deno merch.
Give us feedback
Module

x/actionify/src/deps/yaml.ts>DumpOptions

Create and manage your GitHub workflows with TypeScript and Deno.
Latest
interface DumpOptions
import { type DumpOptions } from "https://deno.land/x/actionify@0.3.0/src/deps/yaml.ts";

Properties

optional
indent: number

indentation width to use (in spaces).

optional
noArrayIndent: boolean

when true, will not add an indentation level to array elements

optional
skipInvalid: boolean

do not throw on invalid types (like function in the safe schema) and skip pairs and single values with such types.

optional
flowLevel: number

specifies level of nesting, when to switch from block to flow style for collections. -1 means block style everwhere

optional
styles: { [x: string]: any; }

Each tag may have own set of styles. - "tag" => "style" map.

optional
schema: Schema

specifies a schema to use.

optional
sortKeys: boolean | ((a: any, b: any) => number)

if true, sort keys when dumping YAML. If a function, use the function to sort the keys. (default: false)

optional
lineWidth: number

set max line width. (default: 80)

optional
noRefs: boolean

if true, don't convert duplicate objects into references (default: false)

optional
noCompatMode: boolean

if true don't try to be compatible with older yaml versions. Currently: don't quote "yes", "no" and so on, as required for YAML 1.1 (default: false)

optional
condenseFlow: boolean

if true flow sequences will be condensed, omitting the space between key: value or a, b. Eg. '[a,b]' or {a:{b:c}}. Can be useful when using yaml for pretty URL query params as spaces are %-encoded. (default: false).

optional
quotingType: "'" | "\""

strings will be quoted using this quoting style. If you specify single quotes, double quotes will still be used for non-printable characters. (default: ')

optional
forceQuotes: boolean

if true, all non-key strings will be quoted even if they normally don't need to. (default: false)

optional
replacer: (key: string, value: any) => any

callback function (key, value) called recursively on each key/value in source object (see replacer docs for JSON.stringify).