cssdoc

Appearance

Variable: cssDocSchema ​

ts
const cssDocSchema: object;

Defined in: emitters/json/src/schema.ts:128

JSON Schema (draft-07) for the whole model: a CssDocEntry[].

Type Declaration ​

$defs ​

ts
readonly $defs: object;

$defs.StructureNode ​

ts
readonly StructureNode: object;

$defs.StructureNode.additionalProperties ​

ts
readonly additionalProperties: false = false;

$defs.StructureNode.properties ​

ts
readonly properties: object;

$defs.StructureNode.properties.children ​

ts
readonly children: object;

$defs.StructureNode.properties.children.items ​

ts
readonly items: object;

$defs.StructureNode.properties.children.items.$ref ​

ts
readonly $ref: "#/$defs/StructureNode" = "#/$defs/StructureNode";

$defs.StructureNode.properties.children.type ​

ts
readonly type: "array" = "array";

$defs.StructureNode.properties.selector ​

ts
readonly selector: object;

$defs.StructureNode.properties.selector.type ​

ts
readonly type: "string" = "string";

$defs.StructureNode.required ​

ts
readonly required: readonly ["selector", "children"];

$defs.StructureNode.type ​

ts
readonly type: "object" = "object";

$id ​

ts
readonly $id: "https://cssdoc.dev/model.schema.json" = "https://cssdoc.dev/model.schema.json";

$schema ​

ts
readonly $schema: "http://json-schema.org/draft-07/schema#" = "http://json-schema.org/draft-07/schema#";

description ​

ts
readonly description: "The @cssdoc/core documentation model: one entry per documented CSS record." = "The @cssdoc/core documentation model: one entry per documented CSS record.";

items ​

ts
readonly items: object = cssDocEntrySchema;

items.additionalProperties ​

ts
readonly additionalProperties: false = false;

items.properties ​

ts
readonly properties: object;

items.properties.accessibility ​

ts
readonly accessibility: object;

items.properties.accessibility.type ​

ts
readonly type: "string" = "string";

items.properties.animations ​

ts
readonly animations: object;

items.properties.animations.items ​

ts
readonly items: object = named;

items.properties.animations.items.additionalProperties ​

ts
readonly additionalProperties: false = false;

items.properties.animations.items.properties ​

ts
readonly properties: object;

items.properties.animations.items.properties.description ​

ts
readonly description: object;

items.properties.animations.items.properties.description.type ​

ts
readonly type: "string" = "string";

items.properties.animations.items.properties.name ​

ts
readonly name: object;

items.properties.animations.items.properties.name.type ​

ts
readonly type: "string" = "string";

items.properties.animations.items.required ​

ts
readonly required: readonly ["name"];

items.properties.animations.items.type ​

ts
readonly type: "object" = "object";

items.properties.animations.type ​

ts
readonly type: "array" = "array";

items.properties.className ​

ts
readonly className: object;

items.properties.className.type ​

ts
readonly type: "string" = "string";

items.properties.conditions ​

ts
readonly conditions: object;

items.properties.conditions.items ​

ts
readonly items: object;

items.properties.conditions.items.additionalProperties ​

ts
readonly additionalProperties: false = false;

items.properties.conditions.items.properties ​

ts
readonly properties: object;

items.properties.conditions.items.properties.containerName ​

ts
readonly containerName: object;

items.properties.conditions.items.properties.containerName.type ​

ts
readonly type: "string" = "string";

items.properties.conditions.items.properties.description ​

ts
readonly description: object;

items.properties.conditions.items.properties.description.type ​

ts
readonly type: "string" = "string";

items.properties.conditions.items.properties.query ​

ts
readonly query: object;

items.properties.conditions.items.properties.query.type ​

ts
readonly type: "string" = "string";

items.properties.conditions.items.properties.type ​

ts
readonly type: object;

items.properties.conditions.items.properties.type.enum ​

ts
readonly enum: readonly ["container", "supports", "media"];

items.properties.conditions.items.required ​

ts
readonly required: readonly ["type", "query"];

items.properties.conditions.items.type ​

ts
readonly type: "object" = "object";

items.properties.conditions.type ​

ts
readonly type: "array" = "array";

items.properties.cssPropertiesConsumed ​

ts
readonly cssPropertiesConsumed: object;

items.properties.cssPropertiesConsumed.items ​

ts
readonly items: object;

items.properties.cssPropertiesConsumed.items.type ​

ts
readonly type: "string" = "string";

items.properties.cssPropertiesConsumed.type ​

ts
readonly type: "array" = "array";

items.properties.cssPropertiesDeclared ​

ts
readonly cssPropertiesDeclared: object;

items.properties.cssPropertiesDeclared.items ​

ts
readonly items: object;

items.properties.cssPropertiesDeclared.items.additionalProperties ​

ts
readonly additionalProperties: false = false;

items.properties.cssPropertiesDeclared.items.properties ​

ts
readonly properties: object;

items.properties.cssPropertiesDeclared.items.properties.defaultValue ​

ts
readonly defaultValue: object;

items.properties.cssPropertiesDeclared.items.properties.defaultValue.type ​

ts
readonly type: "string" = "string";

items.properties.cssPropertiesDeclared.items.properties.description ​

ts
readonly description: object;

items.properties.cssPropertiesDeclared.items.properties.description.type ​

ts
readonly type: "string" = "string";

items.properties.cssPropertiesDeclared.items.properties.inherits ​

ts
readonly inherits: object;

items.properties.cssPropertiesDeclared.items.properties.inherits.type ​

ts
readonly type: "boolean" = "boolean";

items.properties.cssPropertiesDeclared.items.properties.name ​

ts
readonly name: object;

items.properties.cssPropertiesDeclared.items.properties.name.type ​

ts
readonly type: "string" = "string";

items.properties.cssPropertiesDeclared.items.properties.syntax ​

ts
readonly syntax: object;

items.properties.cssPropertiesDeclared.items.properties.syntax.type ​

ts
readonly type: "string" = "string";

items.properties.cssPropertiesDeclared.items.required ​

ts
readonly required: readonly ["name"];

items.properties.cssPropertiesDeclared.items.type ​

ts
readonly type: "object" = "object";

items.properties.cssPropertiesDeclared.type ​

ts
readonly type: "array" = "array";

items.properties.customBlocks ​

ts
readonly customBlocks: object;

items.properties.customBlocks.additionalProperties ​

ts
readonly additionalProperties: object;

items.properties.customBlocks.additionalProperties.items ​

ts
readonly items: object;

items.properties.customBlocks.additionalProperties.items.type ​

ts
readonly type: "string" = "string";

items.properties.customBlocks.additionalProperties.type ​

ts
readonly type: "array" = "array";

items.properties.customBlocks.type ​

ts
readonly type: "object" = "object";

items.properties.demo ​

ts
readonly demo: object;

items.properties.demo.type ​

ts
readonly type: "string" = "string";

items.properties.deprecated ​

ts
readonly deprecated: object;

items.properties.deprecated.type ​

ts
readonly type: "string" = "string";

items.properties.examples ​

ts
readonly examples: object;

items.properties.examples.items ​

ts
readonly items: object;

items.properties.examples.items.type ​

ts
readonly type: "string" = "string";

items.properties.examples.type ​

ts
readonly type: "array" = "array";

items.properties.functions ​

ts
readonly functions: object;

items.properties.functions.items ​

ts
readonly items: object;

items.properties.functions.items.additionalProperties ​

ts
readonly additionalProperties: false = false;

items.properties.functions.items.properties ​

ts
readonly properties: object;

items.properties.functions.items.properties.description ​

ts
readonly description: object;

items.properties.functions.items.properties.description.type ​

ts
readonly type: "string" = "string";

items.properties.functions.items.properties.name ​

ts
readonly name: object;

items.properties.functions.items.properties.name.type ​

ts
readonly type: "string" = "string";

items.properties.functions.items.properties.parameters ​

ts
readonly parameters: object;

items.properties.functions.items.properties.parameters.items ​

ts
readonly items: object;

items.properties.functions.items.properties.parameters.items.type ​

ts
readonly type: "string" = "string";

items.properties.functions.items.properties.parameters.type ​

ts
readonly type: "array" = "array";

items.properties.functions.items.properties.result ​

ts
readonly result: object;

items.properties.functions.items.properties.result.type ​

ts
readonly type: "string" = "string";

items.properties.functions.items.required ​

ts
readonly required: readonly ["name", "parameters"];

items.properties.functions.items.type ​

ts
readonly type: "object" = "object";

items.properties.functions.type ​

ts
readonly type: "array" = "array";

items.properties.group ​

ts
readonly group: object;

items.properties.group.type ​

ts
readonly type: "string" = "string";

items.properties.kind ​

ts
readonly kind: object;

items.properties.kind.enum ​

ts
readonly enum: readonly ["component", "utility", "rule", "declaration"];

items.properties.layers ​

ts
readonly layers: object;

items.properties.layers.items ​

ts
readonly items: object = named;

items.properties.layers.items.additionalProperties ​

ts
readonly additionalProperties: false = false;

items.properties.layers.items.properties ​

ts
readonly properties: object;

items.properties.layers.items.properties.description ​

ts
readonly description: object;

items.properties.layers.items.properties.description.type ​

ts
readonly type: "string" = "string";

items.properties.layers.items.properties.name ​

ts
readonly name: object;

items.properties.layers.items.properties.name.type ​

ts
readonly type: "string" = "string";

items.properties.layers.items.required ​

ts
readonly required: readonly ["name"];

items.properties.layers.items.type ​

ts
readonly type: "object" = "object";

items.properties.layers.type ​

ts
readonly type: "array" = "array";

items.properties.modifiers ​

ts
readonly modifiers: object;

items.properties.modifiers.items ​

ts
readonly items: object;

items.properties.modifiers.items.additionalProperties ​

ts
readonly additionalProperties: false = false;

items.properties.modifiers.items.properties ​

ts
readonly properties: object;

items.properties.modifiers.items.properties.deprecated ​

ts
readonly deprecated: object;

items.properties.modifiers.items.properties.deprecated.additionalProperties ​

ts
readonly additionalProperties: false = false;

items.properties.modifiers.items.properties.deprecated.properties ​

ts
readonly properties: object;

items.properties.modifiers.items.properties.deprecated.properties.canonical ​

ts
readonly canonical: object;

items.properties.modifiers.items.properties.deprecated.properties.canonical.type ​

ts
readonly type: "string" = "string";

items.properties.modifiers.items.properties.deprecated.properties.note ​

ts
readonly note: object;

items.properties.modifiers.items.properties.deprecated.properties.note.type ​

ts
readonly type: "string" = "string";

items.properties.modifiers.items.properties.deprecated.type ​

ts
readonly type: "object" = "object";

items.properties.modifiers.items.properties.description ​

ts
readonly description: object;

items.properties.modifiers.items.properties.description.type ​

ts
readonly type: "string" = "string";

items.properties.modifiers.items.properties.name ​

ts
readonly name: object;

items.properties.modifiers.items.properties.name.type ​

ts
readonly type: "string" = "string";

items.properties.modifiers.items.properties.prop ​

ts
readonly prop: object;

items.properties.modifiers.items.properties.prop.type ​

ts
readonly type: "string" = "string";

items.properties.modifiers.items.properties.value ​

ts
readonly value: object;

items.properties.modifiers.items.properties.value.type ​

ts
readonly type: "string" = "string";

items.properties.modifiers.items.required ​

ts
readonly required: readonly ["name", "prop"];

items.properties.modifiers.items.type ​

ts
readonly type: "object" = "object";

items.properties.modifiers.type ​

ts
readonly type: "array" = "array";

items.properties.name ​

ts
readonly name: object;

items.properties.name.type ​

ts
readonly type: "string" = "string";

items.properties.parts ​

ts
readonly parts: object;

items.properties.parts.items ​

ts
readonly items: object = named;

items.properties.parts.items.additionalProperties ​

ts
readonly additionalProperties: false = false;

items.properties.parts.items.properties ​

ts
readonly properties: object;

items.properties.parts.items.properties.description ​

ts
readonly description: object;

items.properties.parts.items.properties.description.type ​

ts
readonly type: "string" = "string";

items.properties.parts.items.properties.name ​

ts
readonly name: object;

items.properties.parts.items.properties.name.type ​

ts
readonly type: "string" = "string";

items.properties.parts.items.required ​

ts
readonly required: readonly ["name"];

items.properties.parts.items.type ​

ts
readonly type: "object" = "object";

items.properties.parts.type ​

ts
readonly type: "array" = "array";

items.properties.privateRemarks ​

ts
readonly privateRemarks: object;

items.properties.privateRemarks.type ​

ts
readonly type: "string" = "string";

items.properties.releaseStage ​

ts
readonly releaseStage: object;

items.properties.releaseStage.enum ​

ts
readonly enum: readonly ["alpha", "beta", "experimental", "internal", "public"];

items.properties.remarks ​

ts
readonly remarks: object;

items.properties.remarks.type ​

ts
readonly type: "string" = "string";

items.properties.see ​

ts
readonly see: object;

items.properties.see.items ​

ts
readonly items: object;

items.properties.see.items.type ​

ts
readonly type: "string" = "string";

items.properties.see.type ​

ts
readonly type: "array" = "array";

items.properties.since ​

ts
readonly since: object;

items.properties.since.type ​

ts
readonly type: "string" = "string";

items.properties.slots ​

ts
readonly slots: object;

items.properties.slots.items ​

ts
readonly items: object = named;

items.properties.slots.items.additionalProperties ​

ts
readonly additionalProperties: false = false;

items.properties.slots.items.properties ​

ts
readonly properties: object;

items.properties.slots.items.properties.description ​

ts
readonly description: object;

items.properties.slots.items.properties.description.type ​

ts
readonly type: "string" = "string";

items.properties.slots.items.properties.name ​

ts
readonly name: object;

items.properties.slots.items.properties.name.type ​

ts
readonly type: "string" = "string";

items.properties.slots.items.required ​

ts
readonly required: readonly ["name"];

items.properties.slots.items.type ​

ts
readonly type: "object" = "object";

items.properties.slots.type ​

ts
readonly type: "array" = "array";

items.properties.states ​

ts
readonly states: object;

items.properties.states.items ​

ts
readonly items: object = named;

items.properties.states.items.additionalProperties ​

ts
readonly additionalProperties: false = false;

items.properties.states.items.properties ​

ts
readonly properties: object;

items.properties.states.items.properties.description ​

ts
readonly description: object;

items.properties.states.items.properties.description.type ​

ts
readonly type: "string" = "string";

items.properties.states.items.properties.name ​

ts
readonly name: object;

items.properties.states.items.properties.name.type ​

ts
readonly type: "string" = "string";

items.properties.states.items.required ​

ts
readonly required: readonly ["name"];

items.properties.states.items.type ​

ts
readonly type: "object" = "object";

items.properties.states.type ​

ts
readonly type: "array" = "array";

items.properties.structure ​

ts
readonly structure: object;

items.properties.structure.items ​

ts
readonly items: object;

items.properties.structure.items.$ref ​

ts
readonly $ref: "#/$defs/StructureNode" = "#/$defs/StructureNode";

items.properties.structure.type ​

ts
readonly type: "array" = "array";

items.properties.summary ​

ts
readonly summary: object;

items.properties.summary.type ​

ts
readonly type: "string" = "string";

items.required ​

ts
readonly required: readonly ["name", "kind", "className", "modifiers", "parts", "states", "slots", "cssPropertiesConsumed", "cssPropertiesDeclared", "functions", "animations", "layers", "conditions", "examples", "see"];

items.type ​

ts
readonly type: "object" = "object";

title ​

ts
readonly title: "cssdoc model" = "cssdoc model";

type ​

ts
readonly type: "array" = "array";

Released under the MIT License

Copyright © 2026-present iyWahl