Menu
io arcio arc
🌜
🌞
io arcio arc
  • Getting Started
  • Select languages and frameworks
  • Configuration
    • Overview
    • Site Settings
    • Build Settings
    • Extending the webpack
  • Build
    • Overview
    • HTML
    • CSS
    • JavaScript
  • Plugins
    • Overview
    • Tasks
      • browser-sync
      • clean
      • copy
      • manifest
      • service-worker
      • webp-converter
      • webpack-babel
      • webpack-css
      • webpack-html
      • webpack-pug
      • webpack-sass
      • webpack-stylus
      • webpack-typescript
      • webpack-vue
      • webpack-vue-typescript
      • yaml2json
    • Modules
      • env
        • Overview
        • Constants
          • Common
          • Site Information
          • HTML
          • CSS
          • JavaScript
          • Images
          • Static
          • YAML2JSON
      • file-list
      • logger
      • output-dir-diff
      • path-build
      • read-yaml
      • types
      • utils
      • webp-converter
      • webpack-loaders-image
      • webpack-loaders-js
      • webpack-loaders-pug-linter
      • webpack-plugins-task-message
      • webpack-settings
      • yaml2json

@io-arc/read-yaml

Transpile YAML to JSON.
Using to js-yaml.

Usage#

$ npm i @io-arc/read-yaml
index.ts
import ReadYaml from '@io-arc/read-yaml'
const json = ReadYaml('foo', ['data'])
// -> read to data/foo.yml

Functions#

ReadYaml(filename, dir)#

Return: JSON

Parameters

paramstypedefaultdescription
filenamestring-Read YAML filename
dirstring[]-Directory name array
Previous
« @io-arc/path-build
Next
@io-arc/types »
  • Usage
  • Functions
    • ReadYaml(filename, dir)
Copyright © 2022 io arc project.