Skip to content

Interface: WriteJsonOptions ​

Defined in: emitters/json/src/index.ts:60

Options for writeJson.

Extends ​

Properties ​

configuration? ​

ts
configuration?: CssDocConfiguration;

Defined in: emitters/json/src/index.ts:24

The tag configuration to parse css with.

Inherited from ​

ModelInput.configuration


css? ​

ts
css?: string | string[];

Defined in: emitters/json/src/index.ts:20

CSS source (one string or several concatenated) to parse.

Inherited from ​

ModelInput.css


dialect? ​

ts
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 ​

ModelInput.dialect


entries? ​

ts
entries?: CssDocEntry[];

Defined in: emitters/json/src/index.ts:22

An already-parsed model (takes precedence over css).

Inherited from ​

ModelInput.entries


includeInternal? ​

ts
includeInternal?: boolean;

Defined in: emitters/json/src/index.ts:68

Include records marked @visibility internal; defaults to false.


lang? ​

ts
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 ​

ModelInput.lang


outDir ​

ts
outDir: string;

Defined in: emitters/json/src/index.ts:62

The output directory (created if missing).


perRecord? ​

ts
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? ​

ts
schema?: boolean;

Defined in: emitters/json/src/index.ts:66

Also write the model JSON Schema as model.schema.json (default false).

Released under the MIT License