parseFrontMatterStringArray

Official

Parses a frontmatter string array from the frontmatter object.

Import:

import { parseFrontMatterStringArray } from 'obsidian';

Example:

console.log(parseFrontMatterStringArray({ foo: ['bar', 'baz'] }, 'foo')); // ['bar', 'baz']
console.log(parseFrontMatterStringArray({ foo: 'bar,baz' }, 'foo')); // ['bar', 'baz']
console.log(parseFrontMatterStringArray({ foo: 'bar\nbaz' }, 'foo')); // ['bar', 'baz']
console.log(parseFrontMatterStringArray({ foo: 'bar baz' }, 'foo')); // ['bar baz']
console.log(parseFrontMatterStringArray({ foo: 'bar baz' }, 'foo')); // ['bar baz']
console.log(parseFrontMatterStringArray({ foo: 'bar baz' }, 'foo')); // ['bar', 'baz']
console.log(parseFrontMatterStringArray({ foo: ['bar', 'baz'] }, /fo./)); // ['bar', 'baz']

Signature:

function parseFrontMatterStringArray(frontmatter: unknown, key: string | RegExp): string[] | null

Parameters:

Parameter	Type	Description
frontmatter	unknown	The frontmatter object.
key	string | RegExp	The key to parse.

Returns: string[] | null — The parsed entry or null if the key is not found.

Example:

console.log(parseFrontMatterStringArray({ foo: ['bar', 'baz'] }, 'foo')); // ['bar', 'baz']
console.log(parseFrontMatterStringArray({ foo: 'bar,baz' }, 'foo')); // ['bar', 'baz']
console.log(parseFrontMatterStringArray({ foo: 'bar\nbaz' }, 'foo')); // ['bar', 'baz']
console.log(parseFrontMatterStringArray({ foo: 'bar baz' }, 'foo')); // ['bar baz']
console.log(parseFrontMatterStringArray({ foo: 'bar baz' }, 'foo')); // ['bar baz']
console.log(parseFrontMatterStringArray({ foo: 'bar baz' }, 'foo')); // ['bar', 'baz']
console.log(parseFrontMatterStringArray({ foo: ['bar', 'baz'] }, /fo./)); // ['bar', 'baz']