Security News
Supply Chain Attack Detected in Solana's web3.js Library
A supply chain attack has been detected in versions 1.95.6 and 1.95.7 of the popular @solana/web3.js library.
@swagger-api/apidom-parser-adapter-asyncapi-yaml-2
Advanced tools
Parser adapter for parsing YAML documents into AsyncAPI 2.x.y namespace.
@swagger-api/apidom-parser-adapter-asyncapi-yaml-2
is a parser adapter for following AsyncAPI specification versions defined in YAML format:
Under the hood this adapter uses @swagger-api/apidom-parser-adapter-yaml-1-2 to parse a source string into generic ApiDOM in base ApiDOM namespace which is then refracted with AsyncApi 2.x.y Refractors.
After prerequisites for installing this package are satisfied, you can install it via npm CLI by running the following command:
$ npm install @swagger-api/@swagger-api/apidom-parser-adapter-asyncapi-yaml-2
This parser adapter is fully compatible with parser adapter interface required by @swagger-api/apidom-parser and implements all required properties.
Defines list of media types that this parser adapter recognizes.
[
'application/vnd.aai.asyncapi;version=2.0.0',
'application/vnd.aai.asyncapi;version=2.1.0',
'application/vnd.aai.asyncapi;version=2.2.0',
'application/vnd.aai.asyncapi;version=2.3.0',
'application/vnd.aai.asyncapi;version=2.4.0',
'application/vnd.aai.asyncapi;version=2.5.0',
'application/vnd.aai.asyncapi;version=2.6.0',
'application/vnd.aai.asyncapi+yaml;version=2.0.0',
'application/vnd.aai.asyncapi+yaml;version=2.1.0',
'application/vnd.aai.asyncapi+yaml;version=2.2.0',
'application/vnd.aai.asyncapi+yaml;version=2.3.0',
'application/vnd.aai.asyncapi+yaml;version=2.4.0',
'application/vnd.aai.asyncapi+yaml;version=2.5.0',
'application/vnd.aai.asyncapi+yaml;version=2.6.0',
]
Detection is based on a regular expression matching required AsyncApi 2.x.y specification symbols in YAML format.
This adapter exposes an instance of AsyncApi 2.x.y ApiDOM namespace.
parse
function consumes various options as a second argument. Here is a list of these options:
Option | Type | Default | Description |
---|---|---|---|
specObj | Object | Specification Object | This specification object drives the YAML AST transformation to AsyncAPI 2.x ApiDOM namespace. |
sourceMap | Boolean | false | Indicate whether to generate source maps. |
refractorOpts | Object | {} | Refractor options are passed to refractors during refracting phase. |
All unrecognized arbitrary options will be ignored.
This parser adapter can be used directly or indirectly via @swagger-api/apidom-parser.
During direct usage you don't need to provide mediaType
as the parse
function is already pre-bound
with supported media types.
import { parse, detect } from '@swagger-api/apidom-parser-adapter-asyncapi-yaml-2';
// detecting
await detect('asyncapi: 2.0.0'); // => true
await detect('asyncapi: 2.1.0'); // => true
await detect('asyncapi: 2.2.0'); // => true
await detect('asyncapi: 2.3.0'); // => true
await detect('asyncapi: 2.4.0'); // => true
await detect('asyncapi: 2.5.0'); // => true
await detect('asyncapi: 2.6.0'); // => true
await detect('test'); // => false
// parsing
const parseResult = await parse('asyncapi: 2.6.0', { sourceMap: true });
You can omit the mediaType
option here, but please read Word on detect vs mediaTypes before you do so.
import ApiDOMParser from '@swagger-api/apidom-parser';
import * as asyncApiYamlAdapter from '@swagger-api/apidom-parser-adapter-asyncapi-yaml-2';
const parser = new ApiDOMParser();
parser.use(asyncApiYamlAdapter);
const parseResult = await parser.parse('asyncapi: 2.6.0', { mediaType: asyncApiYamlAdapter.mediaTypes.latest('yaml') });
FAQs
Parser adapter for parsing YAML documents into AsyncAPI 2.x.y namespace.
The npm package @swagger-api/apidom-parser-adapter-asyncapi-yaml-2 receives a total of 389,087 weekly downloads. As such, @swagger-api/apidom-parser-adapter-asyncapi-yaml-2 popularity was classified as popular.
We found that @swagger-api/apidom-parser-adapter-asyncapi-yaml-2 demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
A supply chain attack has been detected in versions 1.95.6 and 1.95.7 of the popular @solana/web3.js library.
Research
Security News
A malicious npm package targets Solana developers, rerouting funds in 2% of transactions to a hardcoded address.
Security News
Research
Socket researchers have discovered malicious npm packages targeting crypto developers, stealing credentials and wallet data using spyware delivered through typosquats of popular cryptographic libraries.