Interface: WriteJsonOptions

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

Options for writeJson.

Extends

• ModelInput

Properties

configuration?

optional configuration?: CssDocConfiguration;

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

The tag configuration to parse css with.

Inherited from

ModelInput.configuration

---

css?

optional 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?

optional 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?

optional entries?: CssDocEntry[];

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

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

Inherited from

ModelInput.entries

---

lang?

optional lang?: "css" | "html" | "js" | "markdown";

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

outDir: string;

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

The output directory (created if missing).

---

perRecord?

optional perRecord?: boolean;

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

Also write one file per record under records/, plus an index.json (default false).

---

schema?

optional schema?: boolean;

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

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