Skip to content

FacetConfig<Input, Output>

Unofficial

Configuration for defining a facet.

Import:

import type { FacetConfig } from '@obsidian-typings/obsidian-catalyst-latest';

Signature:

export interface FacetConfig<Input, Output>

Properties

Property Type Description
enables? ((self: Facet<Input, Output>) => Extension) | Extension Extensions or a function producing extensions to enable when this facet is provided.
static? boolean Whether this facet's value is static (cannot be changed by transactions).

Methods

Method Returns Description
combine(values) Output Combine the input values into a single output value.
compare(a, b) boolean Compare two output values.
compareInput(a, b) boolean Compare two input values.