Skip to content
Permalink
master
Switch branches/tags
Go to file
 
 
Cannot retrieve contributors at this time

@squelette/core npm version

Provides Open API parser and basic types.

Breaking Changes ⚠️

Since v1.0.0, parse method behaves differently from the previous versions.

type parsedContent = ReturnType<typeof parse>

// parsedContent === { [tag: string]: IOperation[] } <- before v1.0.0
// parsedContent === IOperation[]                    <- after v1.0.0

Limitations

  • Currently, this package only accepts Open API 3.0 written in yaml.

Install

$ yarn add @squelette/core

How to use programmatically

import fs from "fs"
import YAML from "js-yaml"
import { parse } from '@squelette/core'

const file = fs.readFileSync(YOUR_FILE_PATH, 'utf-8')
const yaml = YAML.safeLoad(file)

// retrive abstract syntax tree
const parsedAST = parse(yaml)

License

MIT