test | /front_matter/mod.ts | std@0.221.0

function test

import { test } from "https://deno.land/std@0.221.0/front_matter/mod.ts";

test(str: string, formats?: Format[]): boolean

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 } from "https://deno.land/std@0.221.0/front_matter/test.ts";

test("---\ntitle: Three dashes marks the spot\n---\n"); // true
test("---toml\ntitle = 'Three dashes followed by format marks the spot'\n---\n"); // true
test("---json\n{\"title\": \"Three dashes followed by format marks the spot\"}\n---\n"); // true
test("---json\n{\"title\": \"Three dashes followed by format marks the spot\"}\n---\n", ["yaml"]); // false

Returns

boolean