parseFrontMatterAliases

Official

Parses the frontmatter aliases from the frontmatter object.

Import:

import { parseFrontMatterAliases } from 'obsidian';

Example:

console.log(parseFrontMatterAliases({ aliases: ['foo', 'bar'] })); // ['foo', 'bar']
console.log(parseFrontMatterAliases({ alias: ['foo', 'bar'] })); // ['foo', 'bar']
console.log(parseFrontMatterAliases({ aliases: 'baz' })); // ['baz']

Signature:

function parseFrontMatterAliases(frontmatter: unknown): string[] | null

Parameters:

Parameter	Type	Description
frontmatter	unknown	The frontmatter object.

Returns: string[] | null — The aliases of the note or null if no aliases are found.

Example:

console.log(parseFrontMatterAliases({ aliases: ['foo', 'bar'] })); // ['foo', 'bar']
console.log(parseFrontMatterAliases({ alias: ['foo', 'bar'] })); // ['foo', 'bar']
console.log(parseFrontMatterAliases({ aliases: 'baz' })); // ['baz']