@apielements/apib-serializer

API Blueprint serializer for API Elements

Usage no npm install needed!

<script type="module">
  import apielementsApibSerializer from 'https://cdn.skypack.dev/@apielements/apib-serializer';
</script>

README

API Elements: API Blueprint Serializer

This adapter provides support for serializing API Blueprint in Fury.js from refract elements.

Install

$ npm install @apielements/apib-serializer

Usage

Async

import fury from 'fury';
import apibSerializer from '@apielements/apib-serializer';

fury.use(apibSerializer);

// Assume `api` is a Minim element instance, e.g. from `fury.parse(...)`
fury.serialize({ api }, (err, content) => {
  fs.write('serialized.apib', content, 'utf8');
});

Sync

import fury from 'fury';
import apibSerializer from '@apielements/apib-serializer';

fury.use(apibSerializer);

try {
  // Assume `api` is a Minim element instance, e.g. from `fury.parse(...)`
  const content = fury.serializeSync({ api });
  fs.write('serialized.apib', content, 'utf8');
} catch (error) {
  console.log(error);
}