Skip to content

FacetConfig<Input, Output>

Unofficial

Configuration for defining a facet.

Import:

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

Signature:

export interface FacetConfig<Input, Output>

Properties

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

Methods

MethodReturnsDescription
combine(values)OutputCombine the input values into a single output value.
compare(a, b)booleanCompare two output values.
compareInput(a, b)booleanCompare two input values.