Skip to content

getObsidianNameTokens

Splits a name into the canonical word tokens the index keys it by.

Import:

import { getObsidianNameTokens } from '@mnaoumov/obsidian-lib/obsidian-word-characters';

Signature:

function getObsidianNameTokens(name: string): string[] | null

Parameters:

Parameter Type Description
name string A basename or an alias.

Returns: string[] | null — The tokens, or null when the name cannot be indexed: it has no word character, or it holds a character whose case folding crosses between word and non-word characters.