Skip to content

Interface: WriteJsonOptions

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

Options for writeJson.

Extends

Properties

configuration?

ts
optional configuration?: CssDocConfiguration;

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

The tag configuration to parse css with.

Inherited from

ModelInput.configuration


css?

ts
optional css?: string | string[];

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

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

Inherited from

ModelInput.css


entries?

ts
optional entries?: CssDocEntry[];

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

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

Inherited from

ModelInput.entries


outDir

ts
outDir: string;

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

The output directory (created if missing).


perRecord?

ts
optional perRecord?: boolean;

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

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


schema?

ts
optional schema?: boolean;

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

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

Released under the MIT License