JSPM – @asyncapi/parser@0.18.2

Package Exports

@asyncapi/parser

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@asyncapi/parser) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

JS Parser

Parse and validate AsyncAPI documents

📢 ATTENTION:

This package is under development and it has not reached version 1.0.0 yet, what means its API might change without prior notice. Once it reaches its first stable version, we'll follow semantic versioning.

Use this package to parse and validate AsyncAPI documents —either YAML or JSON— in your Node.js or browser application. Updated bundle for the browser is always attached to the GitHub Release.

This package doesn't support AsyncAPI 1.x.

Install

npm install @asyncapi/parser

API

Check out the API page.

Examples

Example passing inline AsyncAPI

const parser = require('@asyncapi/parser');

const doc = await parser.parse(`
  asyncapi: '2.0.0'
  info:
    title: Example
    version: '0.1.0'
  channels:
    example-channel:
      subscribe:
        message:
          payload:
            type: object
            properties:
              exampleField:
                type: string
              exampleNumber:
                type: number
              exampleDate:
                type: string
                format: date-time
`);

console.log(doc.info().title());
// => Example

Example passing a URL

const parser = require('@asyncapi/parser');

const doc = await parser.parseUrl('https://my.server.com/example-asyncapi.yaml');

console.log(doc.info().title());
// => Example

Example using OpenAPI schemas

Head over to asyncapi/openapi-schema-parser for more information.

Example using RAML data types

Head over to asyncapi/raml-dt-schema-parser for more information.

Error types

This package throws a bunch of different error types. All errors contain a type (prefixed by this repo URL) and a title field. The following table describes all the errors and the extra fields they include:

Type	Extra Fields	Description
`null-or-falsey-document`	None	The AsyncAPI document is null or a JS "falsey" value.
`invalid-document-type`	None	The AsyncAPI document is not a string nor a JS object.
`invalid-json`	`detail`, `location`	The AsyncAPI document is not valid JSON.
`invalid-yaml`	`detail`, `location`	The AsyncAPI document is not valid YAML.
`impossible-to-convert-to-json`	`detail`	Internally, this parser only handles JSON so it tries to immediately convert the YAML to JSON. This error means this process failed.
`missing-asyncapi-field`	`parsedJSON`	The AsyncAPI document doesn't have the mandatory `asyncapi` field.
`unsupported-version`	`detail`, `parsedJSON`, `validationErrors`	The version of the `asyncapi` field is not supported. Typically, this means that you're using a version below 2.0.0.
`dereference-error`	`parsedJSON`, `refs`	This means the parser tried to resolve and dereference $ref's and the process failed. Typically, this means the $ref it's pointing to doesn't exist.
`unexpected-error`	`parsedJSON`	We have our code covered with try/catch blocks and you should never see this error. If you see it, please open an issue to let us know.
`validation-errors`	`parsedJSON`, `validationErrors`	The AsyncAPI document contains errors. See `validationErrors` for more information.

For more information about the ParserError class, check out the documentation.

Develop

Run tests with npm test
Write code and tests.
Make sure all tests pass npm test

Release regenerates API documentation and browser bundle, so you do not have to regenerate it manually with npm run docs and npm run prepublishOnly.

Contributing

Read CONTRIBUTING guide.