ObjectStackObjectStack

Identifiers schema — Shared Protocol reference

Identifiers schemas of the ObjectStack Shared Protocol: MetadataItemName and 2 more — each property with its type, default and a TypeScript example.

Source: packages/spec/src/shared/identifiers.zod.ts

TypeScript Usage

import { MetadataItemNameSchema, SnakeCaseIdentifierSchema, SystemIdentifierSchema } from '@objectstack/spec/shared';
import type { MetadataItemName, SnakeCaseIdentifier, SystemIdentifier } from '@objectstack/spec/shared';

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

MetadataItemName

Metadata item name (lowercase snake_case segments, optionally dot-qualified)

Type: string


SnakeCaseIdentifier

Snake case identifier (lowercase with underscores only)

Type: string


SystemIdentifier

System identifier (lowercase with underscores or dots)

Type: string


On this page