ObjectStackObjectStack

Metadata Types

Metadata Types protocol schemas

Supported metadata file formats

Source: packages/spec/src/shared/metadata-types.zod.ts

TypeScript Usage

import { BaseMetadataRecord } from '@objectstack/spec/shared';
import type { BaseMetadataRecord } from '@objectstack/spec/shared';

// Validate data
const result = BaseMetadataRecord.parse(data);

BaseMetadataRecord

Base metadata record fields shared across kernel and system

Properties

PropertyTypeRequiredDescription
idstringUnique metadata record identifier
typestringMetadata type (e.g. "object", "view", "flow")
namestringMachine name (snake_case)
formatEnum<'yaml' | 'json' | 'typescript' | 'javascript'>optionalSource file format

On this page