Skip to content

LocalBusiness builder

Creates a LocalBusiness with physical location metadata. The LocalBusiness builder injects @type, validates synchronously, and rejects unknown properties.

// Astro — shown first when Astro is selected
import { LocalBusiness } from '@unschema-graph/astro';
// Svelte 5
import { LocalBusiness } from '@unschema-graph/svelte';
// Core / Node.js
import { LocalBusiness } from '@unschema-graph/core';
import { LocalBusinessSchema } from '@unschema-graph/core';

The LocalBusinessSchema Zod schema is also exported for composition and advanced validation.

import {
LocalBusinessSchema,
type SchemaInput,
type SchemaOutput,
} from '@unschema-graph/core';
type LocalBusinessInput = SchemaInput<typeof LocalBusinessSchema>;
type LocalBusinessOutput = SchemaOutput<typeof LocalBusinessSchema, 'LocalBusiness'>;
Property Input type Required Default / constraints
@id string No non-empty
name string Yes non-empty
address string | PostalAddress | EntityReference Yes —
image string | ImageObject No non-empty
telephone string No —
priceRange string No —
url string No —
geo GeoCoordinates No —
openingHoursSpecification object | Array No —
currenciesAccepted string No —
paymentAccepted string No —
sameAs string | Array No —
servesCuisine string | Array No —
menu string No —

The aliases above remain the exact authority for nested object types. The builder also accepts a validation configuration as its second argument and always returns @type: 'LocalBusiness'.

import { LocalBusiness } from '@unschema-graph/core';
const entity = LocalBusiness({
"name": "Acme Paris",
"address": {
"streetAddress": "1 Rue de Rivoli",
"addressLocality": "Paris",
"postalCode": "75001",
"addressCountry": "FR"
}
});
{
"@type": "LocalBusiness",
"name": "Acme Paris",
"address": {
"streetAddress": "1 Rue de Rivoli",
"addressLocality": "Paris",
"postalCode": "75001",
"addressCountry": "FR"
}
}
  • Passing an unknown property to the strict builder.
  • Using source data that is missing a required property.
  • Assuming valid Schema.org guarantees a search appearance.

Use LocalBusiness.safeParse(input) for external data. If Schema.org supports a property that is not modeled yet, validate the entity first and then use withAdditionalProperties(). Never pass invented properties to the strict builder.