Cara menggunakan yaml editor javascript

This is an implementation of YAML, a human-friendly data serialization language. Started as PyYAML port, it was completely rewritten from scratch. Now it's very fast, and supports 1.2 spec.

Installation

YAML module for node.js

npm install js-yaml

CLI executable

If you want to inspect your YAML files from CLI, install js-yaml globally:

npm install -g js-yaml

Usage

usage: js-yaml [-h] [-v] [-c] [-t] file

Positional arguments:
  file           File with YAML document(s)

Optional arguments:
  -h, --help     Show this help message and exit.
  -v, --version  Show program's version number and exit.
  -c, --compact  Display errors in compact mode
  -t, --trace    Show stack trace on error

API

Here we cover the most 'useful' methods. If you need advanced details (creating your own tags), see examples for more info.

const yaml = require('js-yaml');
const fs   = require('fs');

// Get document, or throw exception on error
try {
  const doc = yaml.load(fs.readFileSync('/home/ixti/example.yml', 'utf8'));
  console.log(doc);
} catch (e) {
  console.log(e);
}

load (string [ , options ])

Parses

npm install -g js-yaml

npm install -g js-yaml

npm install -g js-yaml

npm install -g js-yaml

options:

• npm install -g js-yaml
  

  5 (default: null) - string to be used as a file path in error/warning messages.

• npm install -g js-yaml
  

  6 (default: null) - function to call on warning messages. Loader will call this function with an instance of

  npm install -g js-yaml
  

  4 for each warning.

• npm install -g js-yaml
  

  8 (default:

  npm install -g js-yaml
  

  9) - specifies a schema to use.

  • usage: js-yaml [-h] [-v] [-c] [-t] file
    
    Positional arguments:
      file           File with YAML document(s)
    
    Optional arguments:
      -h, --help     Show this help message and exit.
      -v, --version  Show program's version number and exit.
      -c, --compact  Display errors in compact mode
      -t, --trace    Show stack trace on error
    

    0 - only strings, arrays and plain objects:

  • usage: js-yaml [-h] [-v] [-c] [-t] file
    
    Positional arguments:
      file           File with YAML document(s)
    
    Optional arguments:
      -h, --help     Show this help message and exit.
      -v, --version  Show program's version number and exit.
      -c, --compact  Display errors in compact mode
      -t, --trace    Show stack trace on error
    

    1 - all JSON-supported types:

  • usage: js-yaml [-h] [-v] [-c] [-t] file
    
    Positional arguments:
      file           File with YAML document(s)
    
    Optional arguments:
      -h, --help     Show this help message and exit.
      -v, --version  Show program's version number and exit.
      -c, --compact  Display errors in compact mode
      -t, --trace    Show stack trace on error
    

    2 - same as

    usage: js-yaml [-h] [-v] [-c] [-t] file
    
    Positional arguments:
      file           File with YAML document(s)
    
    Optional arguments:
      -h, --help     Show this help message and exit.
      -v, --version  Show program's version number and exit.
      -c, --compact  Display errors in compact mode
      -t, --trace    Show stack trace on error
    

    1:

  • npm install -g js-yaml
    

    9 - all supported YAML types.

• usage: js-yaml [-h] [-v] [-c] [-t] file
  
  Positional arguments:
    file           File with YAML document(s)
  
  Optional arguments:
    -h, --help     Show this help message and exit.
    -v, --version  Show program's version number and exit.
    -c, --compact  Display errors in compact mode
    -t, --trace    Show stack trace on error
  

  5 (default: false) - compatibility with JSON.parse behaviour. If true, then duplicate keys in a mapping will override values rather than throwing an error.

NOTE: This function does not understand multi-document sources, it throws exception on those.

NOTE: JS-YAML does not support schema-specific tag resolution restrictions. So, the JSON schema is not as strictly defined in the YAML specification. It allows numbers in any notation, use

usage: js-yaml [-h] [-v] [-c] [-t] file

Positional arguments:
  file           File with YAML document(s)

Optional arguments:
  -h, --help     Show this help message and exit.
  -v, --version  Show program's version number and exit.
  -c, --compact  Display errors in compact mode
  -t, --trace    Show stack trace on error

usage: js-yaml [-h] [-v] [-c] [-t] file

Positional arguments:
  file           File with YAML document(s)

Optional arguments:
  -h, --help     Show this help message and exit.
  -v, --version  Show program's version number and exit.
  -c, --compact  Display errors in compact mode
  -t, --trace    Show stack trace on error

npm install -g js-yaml

loadAll (string [, iterator] [, options ])

Same as

usage: js-yaml [-h] [-v] [-c] [-t] file

Positional arguments:
  file           File with YAML document(s)

Optional arguments:
  -h, --help     Show this help message and exit.
  -v, --version  Show program's version number and exit.
  -c, --compact  Display errors in compact mode
  -t, --trace    Show stack trace on error

const yaml = require('js-yaml');
const fs   = require('fs');

// Get document, or throw exception on error
try {
  const doc = yaml.load(fs.readFileSync('/home/ixti/example.yml', 'utf8'));
  console.log(doc);
} catch (e) {
  console.log(e);
}

const yaml = require('js-yaml');

yaml.loadAll(data, function (doc) {
  console.log(doc);
});

dump (object [ , options ])

Serializes

const yaml = require('js-yaml');
const fs   = require('fs');

// Get document, or throw exception on error
try {
  const doc = yaml.load(fs.readFileSync('/home/ixti/example.yml', 'utf8'));
  console.log(doc);
} catch (e) {
  console.log(e);
}

npm install -g js-yaml

const yaml = require('js-yaml');
const fs   = require('fs');

// Get document, or throw exception on error
try {
  const doc = yaml.load(fs.readFileSync('/home/ixti/example.yml', 'utf8'));
  console.log(doc);
} catch (e) {
  console.log(e);
}

const yaml = require('js-yaml');
const fs   = require('fs');

// Get document, or throw exception on error
try {
  const doc = yaml.load(fs.readFileSync('/home/ixti/example.yml', 'utf8'));
  console.log(doc);
} catch (e) {
  console.log(e);
}

options:

• const yaml = require('js-yaml');
  const fs   = require('fs');
  
  // Get document, or throw exception on error
  try {
    const doc = yaml.load(fs.readFileSync('/home/ixti/example.yml', 'utf8'));
    console.log(doc);
  } catch (e) {
    console.log(e);
  }

  5 (default: 2) - indentation width to use (in spaces).

• const yaml = require('js-yaml');
  const fs   = require('fs');
  
  // Get document, or throw exception on error
  try {
    const doc = yaml.load(fs.readFileSync('/home/ixti/example.yml', 'utf8'));
    console.log(doc);
  } catch (e) {
    console.log(e);
  }

  6 (default: false) - when true, will not add an indentation level to array elements

• const yaml = require('js-yaml');
  const fs   = require('fs');
  
  // Get document, or throw exception on error
  try {
    const doc = yaml.load(fs.readFileSync('/home/ixti/example.yml', 'utf8'));
    console.log(doc);
  } catch (e) {
    console.log(e);
  }

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

• const yaml = require('js-yaml');
  const fs   = require('fs');
  
  // Get document, or throw exception on error
  try {
    const doc = yaml.load(fs.readFileSync('/home/ixti/example.yml', 'utf8'));
    console.log(doc);
  } catch (e) {
    console.log(e);
  }

  8 (default: -1) - specifies level of nesting, when to switch from block to flow style for collections. -1 means block style everwhere

• const yaml = require('js-yaml');
  const fs   = require('fs');
  
  // Get document, or throw exception on error
  try {
    const doc = yaml.load(fs.readFileSync('/home/ixti/example.yml', 'utf8'));
    console.log(doc);
  } catch (e) {
    console.log(e);
  }

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

• npm install -g js-yaml
  

  8 (default:

  npm install -g js-yaml
  

  9) specifies a schema to use.

• const yaml = require('js-yaml');
  
  yaml.loadAll(data, function (doc) {
    console.log(doc);
  });

  2 (default:

  const yaml = require('js-yaml');
  
  yaml.loadAll(data, function (doc) {
    console.log(doc);
  });

  3) - if

  const yaml = require('js-yaml');
  const fs   = require('fs');
  
  // Get document, or throw exception on error
  try {
    const doc = yaml.load(fs.readFileSync('/home/ixti/example.yml', 'utf8'));
    console.log(doc);
  } catch (e) {
    console.log(e);
  }

  4, sort keys when dumping YAML. If a function, use the function to sort the keys.

• const yaml = require('js-yaml');
  
  yaml.loadAll(data, function (doc) {
    console.log(doc);
  });

  5 (default:

  const yaml = require('js-yaml');
  
  yaml.loadAll(data, function (doc) {
    console.log(doc);
  });

  6) - set max line width. Set

  const yaml = require('js-yaml');
  
  yaml.loadAll(data, function (doc) {
    console.log(doc);
  });

  7 for unlimited width.

• const yaml = require('js-yaml');
  
  yaml.loadAll(data, function (doc) {
    console.log(doc);
  });

  8 (default:

  const yaml = require('js-yaml');
  
  yaml.loadAll(data, function (doc) {
    console.log(doc);
  });

  3) - if

  const yaml = require('js-yaml');
  const fs   = require('fs');
  
  // Get document, or throw exception on error
  try {
    const doc = yaml.load(fs.readFileSync('/home/ixti/example.yml', 'utf8'));
    console.log(doc);
  } catch (e) {
    console.log(e);
  }

  4, don't convert duplicate objects into references

• !!null
    "canonical"   -> "~"
    "lowercase"   => "null"
    "uppercase"   -> "NULL"
    "camelcase"   -> "Null"
    "empty"       -> ""
  
  !!int
    "binary"      -> "0b1", "0b101010", "0b1110001111010"
    "octal"       -> "0o1", "0o52", "0o16172"
    "decimal"     => "1", "42", "7290"
    "hexadecimal" -> "0x1", "0x2A", "0x1C7A"
  
  !!bool
    "lowercase"   => "true", "false"
    "uppercase"   -> "TRUE", "FALSE"
    "camelcase"   -> "True", "False"
  
  !!float
    "lowercase"   => ".nan", '.inf'
    "uppercase"   -> ".NAN", '.INF'
    "camelcase"   -> ".NaN", '.Inf'
  

  1 (default:

  const yaml = require('js-yaml');
  
  yaml.loadAll(data, function (doc) {
    console.log(doc);
  });

  3) - if

  const yaml = require('js-yaml');
  const fs   = require('fs');
  
  // Get document, or throw exception on error
  try {
    const doc = yaml.load(fs.readFileSync('/home/ixti/example.yml', 'utf8'));
    console.log(doc);
  } catch (e) {
    console.log(e);
  }

  4 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

• !!null
    "canonical"   -> "~"
    "lowercase"   => "null"
    "uppercase"   -> "NULL"
    "camelcase"   -> "Null"
    "empty"       -> ""
  
  !!int
    "binary"      -> "0b1", "0b101010", "0b1110001111010"
    "octal"       -> "0o1", "0o52", "0o16172"
    "decimal"     => "1", "42", "7290"
    "hexadecimal" -> "0x1", "0x2A", "0x1C7A"
  
  !!bool
    "lowercase"   => "true", "false"
    "uppercase"   -> "TRUE", "FALSE"
    "camelcase"   -> "True", "False"
  
  !!float
    "lowercase"   => ".nan", '.inf'
    "uppercase"   -> ".NAN", '.INF'
    "camelcase"   -> ".NaN", '.Inf'
  

  4 (default:

  const yaml = require('js-yaml');
  
  yaml.loadAll(data, function (doc) {
    console.log(doc);
  });

  3) - if

  const yaml = require('js-yaml');
  const fs   = require('fs');
  
  // Get document, or throw exception on error
  try {
    const doc = yaml.load(fs.readFileSync('/home/ixti/example.yml', 'utf8'));
    console.log(doc);
  } catch (e) {
    console.log(e);
  }

  4 flow sequences will be condensed, omitting the space between

  !!null
    "canonical"   -> "~"
    "lowercase"   => "null"
    "uppercase"   -> "NULL"
    "camelcase"   -> "Null"
    "empty"       -> ""
  
  !!int
    "binary"      -> "0b1", "0b101010", "0b1110001111010"
    "octal"       -> "0o1", "0o52", "0o16172"
    "decimal"     => "1", "42", "7290"
    "hexadecimal" -> "0x1", "0x2A", "0x1C7A"
  
  !!bool
    "lowercase"   => "true", "false"
    "uppercase"   -> "TRUE", "FALSE"
    "camelcase"   -> "True", "False"
  
  !!float
    "lowercase"   => ".nan", '.inf'
    "uppercase"   -> ".NAN", '.INF'
    "camelcase"   -> ".NaN", '.Inf'
  

  7. Eg.

  !!null
    "canonical"   -> "~"
    "lowercase"   => "null"
    "uppercase"   -> "NULL"
    "camelcase"   -> "Null"
    "empty"       -> ""
  
  !!int
    "binary"      -> "0b1", "0b101010", "0b1110001111010"
    "octal"       -> "0o1", "0o52", "0o16172"
    "decimal"     => "1", "42", "7290"
    "hexadecimal" -> "0x1", "0x2A", "0x1C7A"
  
  !!bool
    "lowercase"   => "true", "false"
    "uppercase"   -> "TRUE", "FALSE"
    "camelcase"   -> "True", "False"
  
  !!float
    "lowercase"   => ".nan", '.inf'
    "uppercase"   -> ".NAN", '.INF'
    "camelcase"   -> ".NaN", '.Inf'
  

  8, and omitting the space between

  !!null
    "canonical"   -> "~"
    "lowercase"   => "null"
    "uppercase"   -> "NULL"
    "camelcase"   -> "Null"
    "empty"       -> ""
  
  !!int
    "binary"      -> "0b1", "0b101010", "0b1110001111010"
    "octal"       -> "0o1", "0o52", "0o16172"
    "decimal"     => "1", "42", "7290"
    "hexadecimal" -> "0x1", "0x2A", "0x1C7A"
  
  !!bool
    "lowercase"   => "true", "false"
    "uppercase"   -> "TRUE", "FALSE"
    "camelcase"   -> "True", "False"
  
  !!float
    "lowercase"   => ".nan", '.inf'
    "uppercase"   -> ".NAN", '.INF'
    "camelcase"   -> ".NaN", '.Inf'
  

  9 and quoting the key. Eg.

  dump(object, {
    'styles': {
      '!!null': 'canonical' // dump null as ~
    },
    'sortKeys': true        // sort object keys
  });

  0 Can be useful when using yaml for pretty URL query params as spaces are %-encoded.

• dump(object, {
    'styles': {
      '!!null': 'canonical' // dump null as ~
    },
    'sortKeys': true        // sort object keys
  });

  1 (

  dump(object, {
    'styles': {
      '!!null': 'canonical' // dump null as ~
    },
    'sortKeys': true        // sort object keys
  });

  2 or

  dump(object, {
    'styles': {
      '!!null': 'canonical' // dump null as ~
    },
    'sortKeys': true        // sort object keys
  });

  3, default:

  dump(object, {
    'styles': {
      '!!null': 'canonical' // dump null as ~
    },
    'sortKeys': true        // sort object keys
  });

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

• dump(object, {
    'styles': {
      '!!null': 'canonical' // dump null as ~
    },
    'sortKeys': true        // sort object keys
  });

  5 (default:

  const yaml = require('js-yaml');
  
  yaml.loadAll(data, function (doc) {
    console.log(doc);
  });

  3) - if

  const yaml = require('js-yaml');
  const fs   = require('fs');
  
  // Get document, or throw exception on error
  try {
    const doc = yaml.load(fs.readFileSync('/home/ixti/example.yml', 'utf8'));
    console.log(doc);
  } catch (e) {
    console.log(e);
  }

  4, all non-key strings will be quoted even if they normally don't need to.

• dump(object, {
    'styles': {
      '!!null': 'canonical' // dump null as ~
    },
    'sortKeys': true        // sort object keys
  });

  8 - callback

  dump(object, {
    'styles': {
      '!!null': 'canonical' // dump null as ~
    },
    'sortKeys': true        // sort object keys
  });

  9 called recursively on each key/value in source object (see

  dump(object, {
    'styles': {
      '!!null': 'canonical' // dump null as ~
    },
    'sortKeys': true        // sort object keys
  });

  8 docs for

  !!null ''                   # null
  !!bool 'yes'                # bool
  !!int '3...'                # number
  !!float '3.14...'           # number
  !!binary '...base64...'     # buffer
  !!timestamp 'YYYY-...'      # date
  !!omap [ ... ]              # array of key-value pairs
  !!pairs [ ... ]             # array or array pairs
  !!set { ... }               # array of objects with given keys and null values
  !!str '...'                 # string
  !!seq [ ... ]               # array
  !!map { ... }               # object
  

  1).

The following table show availlable styles (e.g. "canonical", "binary"...) available for each tag (.e.g. !!null, !!int ...). Yaml output is shown on the right side after

!!null ''                   # null
!!bool 'yes'                # bool
!!int '3...'                # number
!!float '3.14...'           # number
!!binary '...base64...'     # buffer
!!timestamp 'YYYY-...'      # date
!!omap [ ... ]              # array of key-value pairs
!!pairs [ ... ]             # array or array pairs
!!set { ... }               # array of objects with given keys and null values
!!str '...'                 # string
!!seq [ ... ]               # array
!!map { ... }               # object

!!null ''                   # null
!!bool 'yes'                # bool
!!int '3...'                # number
!!float '3.14...'           # number
!!binary '...base64...'     # buffer
!!timestamp 'YYYY-...'      # date
!!omap [ ... ]              # array of key-value pairs
!!pairs [ ... ]             # array or array pairs
!!set { ... }               # array of objects with given keys and null values
!!str '...'                 # string
!!seq [ ... ]               # array
!!map { ... }               # object

!!null
  "canonical"   -> "~"
  "lowercase"   => "null"
  "uppercase"   -> "NULL"
  "camelcase"   -> "Null"
  "empty"       -> ""

!!int
  "binary"      -> "0b1", "0b101010", "0b1110001111010"
  "octal"       -> "0o1", "0o52", "0o16172"
  "decimal"     => "1", "42", "7290"
  "hexadecimal" -> "0x1", "0x2A", "0x1C7A"

!!bool
  "lowercase"   => "true", "false"
  "uppercase"   -> "TRUE", "FALSE"
  "camelcase"   -> "True", "False"

!!float
  "lowercase"   => ".nan", '.inf'
  "uppercase"   -> ".NAN", '.INF'
  "camelcase"   -> ".NaN", '.Inf'

Example:

dump(object, {
  'styles': {
    '!!null': 'canonical' // dump null as ~
  },
  'sortKeys': true        // sort object keys
});

Supported YAML types

The list of standard YAML tags and corresponding JavaScript types. See also YAML tag discussion and YAML types repository.

!!null ''                   # null
!!bool 'yes'                # bool
!!int '3...'                # number
!!float '3.14...'           # number
!!binary '...base64...'     # buffer
!!timestamp 'YYYY-...'      # date
!!omap [ ... ]              # array of key-value pairs
!!pairs [ ... ]             # array or array pairs
!!set { ... }               # array of objects with given keys and null values
!!str '...'                 # string
!!seq [ ... ]               # array
!!map { ... }               # object

JavaScript-specific tags

See js-yaml-js-types for extra types.

Caveats

Note, that you use arrays or objects as key in JS-YAML. JS does not allow objects or arrays as keys, and stringifies (by calling

!!null ''                   # null
!!bool 'yes'                # bool
!!int '3...'                # number
!!float '3.14...'           # number
!!binary '...base64...'     # buffer
!!timestamp 'YYYY-...'      # date
!!omap [ ... ]              # array of key-value pairs
!!pairs [ ... ]             # array or array pairs
!!set { ... }               # array of objects with given keys and null values
!!str '...'                 # string
!!seq [ ... ]               # array
!!map { ... }               # object

---
? [ foo, bar ]
: - baz
? { foo: bar }
: - baz
  - baz

{ "foo,bar": ["baz"], "[object Object]": ["baz", "baz"] }

Also, reading of properties on implicit block mapping keys is not supported yet. So, the following YAML document cannot be loaded.

npm install -g js-yaml

js-yaml for enterprise

Available as part of the Tidelift Subscription

The maintainers of js-yaml and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. Learn more.