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

function test

import { test } from "https://dotland.deno.dev/std@0.219.0/front_matter/mod.ts";

test(str: string, formats?: (

| "yaml"

| "toml"

| "json"

| "unknown"

)[]): boolean

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

Parameters

str: string

String to test.

optional

formats: (

| "yaml"

| "toml"

| "json"

| "unknown"

)[]

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

import { test } from "https://deno.land/std@0.219.0/front_matter/mod.ts";
import { assert } from "https://deno.land/std@0.219.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", ["yaml"]));

Returns

boolean