ecmarkup
- Version 20.0.0
- Published
- 778 kB
- 16 dependencies
- MIT license
Install
npm i ecmarkup
yarn add ecmarkup
pnpm add ecmarkup
Overview
Custom element definitions and core utilities for markup that specifies ECMAScript and related technologies.
Index
Functions
Classes
Interfaces
Type Aliases
Functions
function build
build: ( path: string, fetch: (path: string, token: CancellationToken) => PromiseLike<string>, opts?: Options, token?: CancellationToken) => Promise<Spec>;
Classes
class Boilerplate
class Boilerplate {}
class Spec
class Spec {}
constructor
constructor( rootPath: string, fetch: (file: string, token: CancellationToken) => PromiseLike<string>, dom: JSDOM, opts: Options, sourceText: string, token?: CancellationToken);
property generatedFiles
generatedFiles: Map<string, any>;
property log
readonly log: (msg: string) => void;
property namespace
namespace: string;
property opts
opts: Options;
property rootDir
rootDir: string;
property rootPath
rootPath: string;
property spec
spec: Spec;
property warn
readonly warn: (err: Warning) => void | undefined;
method exportBiblio
exportBiblio: () => ExportedBiblio | null;
Interfaces
interface Options
interface Options {}
property assets
assets?: 'none' | 'inline' | 'external';
property assetsDir
assetsDir?: string;
property boilerplate
boilerplate?: Boilerplate;
property contributors
contributors?: string;
property copyright
copyright?: boolean;
property cssOut
cssOut?: never;
property date
date?: Date;
property description
description?: string;
property extraBiblios
extraBiblios?: ExportedBiblio[];
property jsOut
jsOut?: never;
property lintSpec
lintSpec?: boolean;
property location
location?: string;
property log
log?: (msg: string) => void;
property markEffects
markEffects?: boolean;
property multipage
multipage?: boolean;
property oldToc
oldToc?: boolean;
property outfile
outfile?: string;
property shortname
shortname?: string;
property stage
stage?: string | null;
property status
status?: 'proposal' | 'draft' | 'standard';
property title
title?: string;
property toc
toc?: boolean;
property version
version?: string;
property warn
warn?: (err: EcmarkupError) => void;
Type Aliases
type BiblioEntry
type BiblioEntry = | AlgorithmBiblioEntry | ProductionBiblioEntry | ClauseBiblioEntry | TermBiblioEntry | FigureBiblioEntry | StepBiblioEntry;
type EcmarkupError
type EcmarkupError = { ruleId: string; message: string; file?: string; source?: string; line?: number; column?: number; nodeType?: string;};
Package Files (3)
Dependencies (16)
Dev Dependencies (15)
Peer Dependencies (0)
No peer dependencies.
Badge
To add a badge like this oneto your package's README, use the codes available below.
You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/ecmarkup
.
- Markdown[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/ecmarkup)
- HTML<a href="https://www.jsdocs.io/package/ecmarkup"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>
- Updated .
Package analyzed in 3996 ms. - Missing or incorrect documentation? Open an issue for this package.