# publish-state.ts **[Source](https://github.com/ubugeeei-prod/ox-content/blob/main/npm/vite-plugin-ox-content/src/publish-state.ts)** > 8 documented symbols. Read the signatures first, then expand each item for parameters, return types, and examples.
8 symbols 5 functions 2 interfaces 1 modules 9 parameters 6 members 5 returns
## Reference
fnclassifyPublishState(frontmatter: Record<string, unknown>, options: ResolvedPublishStateOptions | undefined): { output: boolean; listed: boolean }Classifies one frontmatter object. Never throws.2 paramsreturns object

Classifies one frontmatter object. Never throws.

Signature

export function classifyPublishState(frontmatter: Record<string, unknown>, options: ResolvedPublishStateOptions | undefined): { output: boolean; listed: boolean }

View source

Parameters

Returns

object
listed
listed: boolean;
output
output: boolean;
fnfilterNavGroups<T extends NavGroupLike>(groups: T[], hidden: ReadonlySet<string>): T[]Drops nav items that resolve to hidden (unpublished or unlisted) pages.2 paramsreturns T[]

Drops nav items that resolve to hidden (unpublished or unlisted) pages.

Signature

export function filterNavGroups<T extends NavGroupLike>(groups: T[], hidden: ReadonlySet<string>): T[]

View source

Parameters

  • groups T[]
  • hidden ReadonlySet<string>

Returns

T[]
fnhiddenNavKeys(pages: readonly PublishStatePage[], listed: readonly PublishStatePage[]): Set<string>Keys used to match a page against generated nav items.2 paramsreturns Set<string>

Keys used to match a page against generated nav items.

Signature

export function hiddenNavKeys(pages: readonly PublishStatePage[], listed: readonly PublishStatePage[]): Set<string>

View source

Parameters

Returns

Set<string>
interfacePartitionedPages<T>Split pages into production output vs listing surfaces.2 members

Split pages into production output vs listing surfaces.

Signature

export interface PartitionedPages<T>

View source

Members

Properties
NameTypeDescription
listed T[]
output T[]
fnpartitionPublishedPages<T extends { frontmatter: Record<string, unknown> }>(pages: readonly T[], options: ResolvedPublishStateOptions | undefined): PartitionedPages<T>Splits pages into those that write HTML and those that appear in listings.2 paramsreturns PartitionedPages<T>

Splits pages into those that write HTML and those that appear in listings.

Signature

export function partitionPublishedPages<T extends { frontmatter: Record<string, unknown> }>(pages: readonly T[], options: ResolvedPublishStateOptions | undefined): PartitionedPages<T>

View source

Parameters

Returns

PartitionedPages<T>
modulepublish-stateOpt-in draft / unlisted / scheduled page classification.

Opt-in draft / unlisted / scheduled page classification.

View source

interfacePublishStatePageOne page considered for publish-state filtering.4 members

One page considered for publish-state filtering.

Signature

export interface PublishStatePage

View source

Members

Properties
NameTypeDescription
frontmatter Record<string, unknown>
inputPath string
routePaths { href: string; urlPath: string }
title string
fnresolvePublishStateOptions(value: boolean | PublishStateOptions | undefined): ResolvedPublishStateOptionsResolves publishState with defaults. false / omitted stays off. true enables pr…1 paramreturns ResolvedPublishStateOptions

Resolves publishState with defaults.

false / omitted stays off. true enables production filtering. An object enables the feature and overrides only the fields the site set.

Signature

export function resolvePublishStateOptions(value: boolean | PublishStateOptions | undefined): ResolvedPublishStateOptions

View source

Parameters

Returns

ResolvedPublishStateOptions