@speclynx/apidom-parser-adapter-overlay-json-1

@speclynx/apidom-parser-adapter-overlay-json-1 is a parser adapter for the Overlay 1.1.0 specification in JSON format. Under the hood this adapter uses apidom-parser-adapter-json to parse a source string into generic ApiDOM in base ApiDOM namespace which is then refracted with Overlay 1.x.y Refractors.

Installation

You can install @speclynx/apidom-parser-adapter-overlay-json-1 via npm CLI by running the following command:

 $ npm install @speclynx/apidom-parser-adapter-overlay-json-1

Parser adapter API

This parser adapter is fully compatible with parser adapter interface required by @speclynx/apidom-parser and implements all required properties.

mediaTypes

Defines list of media types that this parser adapter recognizes.

[
  'application/vnd.oai.overlay;version=1.0.0',
  'application/vnd.oai.overlay+json;version=1.0.0',
  'application/vnd.oai.overlay;version=1.1.0',
  'application/vnd.oai.overlay+json;version=1.1.0',
]

detect

Detection is based on a regular expression matching required Overlay 1.1.0 specification symbols in JSON format.

namespace

This adapter exposes an instance of Overlay 1.x.y ApiDOM namespace.

parse

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 JSON AST transformation to Overlay 1.x.y ApiDOM namespace. | | sourceMap | Boolean | false | Indicate whether to generate source maps. | | refractorOpts | Object | {} | Refractor options are passed to refractors during the refracting phase. |

All unrecognized arbitrary options will be ignored.

Usage

This parser adapter can be used directly or indirectly via @speclynx/apidom-parser.

Direct usage

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 '@speclynx/apidom-parser-adapter-overlay-json-1';

// detecting
await detect('{"overlay": "1.1.0"}'); // => true
await detect('test'); // => false

// parsing
const parseResult = await parse('{"overlay": "1.1.0"}', { sourceMap: true });

Indirect usage

You can omit the mediaType option here, but please read Word on detect vs mediaTypes before you do so.

import ApiDOMParser from '@speclynx/apidom-parser';
import * as overlayJsonAdapter from '@speclynx/apidom-parser-adapter-overlay-json-1';

const parser = new ApiDOMParser();

parser.use(overlayJsonAdapter);

const parseResult = await parser.parse('{"overlay": "1.1.0"}', { mediaType: overlayJsonAdapter.mediaTypes.latest('json') });