Type alias CreateNodeOptions

CreateNodeOptions: {
    aliasDuplicateObjects?: boolean;
    anchorPrefix?: string;
    flow?: boolean;
    keepUndefined?: boolean | null;
    onTagObj?: ((tagObj) => void);
    tag?: string;
}

Type declaration

  • Optional aliasDuplicateObjects?: boolean

    During node construction, use anchors and aliases to keep strictly equal non-null objects as equivalent in YAML.

    Default: true

  • Optional anchorPrefix?: string

    Default prefix for anchors.

    Default: 'a', resulting in anchors a1, a2, etc.

  • Optional flow?: boolean

    Force the top-level collection node to use flow style.

  • Optional keepUndefined?: boolean | null

    Keep undefined object values when creating mappings, rather than discarding them.

    Default: false

  • Optional onTagObj?: ((tagObj) => void)
  • Optional tag?: string

    Specify the top-level collection type, e.g. "!!omap". Note that this requires the corresponding tag to be available in this document's schema.

Settings

Member Visibility

Theme

Generated using TypeDoc