Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/ter/deps/std.ts>fmTest

A tiny wiki-style site generator with Zettelkasten flavor.
Go to Latest
function fmTest
import { fmTest } from "https://deno.land/x/ter@0.15.46/deps/std.ts";

Tests if a string has valid front matter. Supports YAML, TOML and JSON.

Parameters

str: string

String to test.

optional
formats: Format[]

A list of formats to test for. Defaults to all supported formats.

import { test, Format } from "https://deno.land/std@0.224.0/front_matter/mod.ts";
import { assert } from "https://deno.land/std@0.224.0/assert/assert.ts";

assert(test("---\ntitle: Three dashes marks the spot\n---\n"));
assert(test("---toml\ntitle = 'Three dashes followed by format marks the spot'\n---\n"));
assert(test("---json\n{\"title\": \"Three dashes followed by format marks the spot\"}\n---\n"));

assert(!test("---json\n{\"title\": \"Three dashes followed by format marks the spot\"}\n---\n", [Format.YAML]));

Returns

boolean