Interface: WriteJsonOptions
Defined in: emitters/json/src/index.ts:60
Options for writeJson.
Extends
Properties
configuration?
configuration?: CssDocConfiguration;Defined in: emitters/json/src/index.ts:24
The tag configuration to parse css with.
Inherited from
css?
css?: string | string[];Defined in: emitters/json/src/index.ts:20
CSS source (one string or several concatenated) to parse.
Inherited from
dialect?
dialect?: CssDialect;Defined in: emitters/json/src/index.ts:28
The stylesheet dialect of css (scss/less pick a dialect parser). Default css.
Inherited from
entries?
entries?: CssDocEntry[];Defined in: emitters/json/src/index.ts:22
An already-parsed model (takes precedence over css).
Inherited from
includeInternal?
includeInternal?: boolean;Defined in: emitters/json/src/index.ts:68
Include records marked @visibility internal; defaults to false.
lang?
lang?: "css" | "markdown" | "html" | "js";Defined in: emitters/json/src/index.ts:26
The host language css is written in. Non-css values extract embedded CSS first. Default css.
Inherited from
outDir
outDir: string;Defined in: emitters/json/src/index.ts:62
The output directory (created if missing).
perRecord?
perRecord?: boolean;Defined in: emitters/json/src/index.ts:64
Also write one file per record under records/, plus an index.json (default false).
schema?
schema?: boolean;Defined in: emitters/json/src/index.ts:66
Also write the model JSON Schema as model.schema.json (default false).