mirror of
https://github.com/denoland/std.git
synced 2024-11-22 04:59:05 +00:00
39 lines
1.2 KiB
TypeScript
39 lines
1.2 KiB
TypeScript
// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
|
|
|
|
import { extractAndParse, type Parser } from "./_shared.ts";
|
|
import { parse } from "@std/toml/parse";
|
|
import type { Extract } from "./types.ts";
|
|
import { EXTRACT_TOML_REGEXP } from "./_formats.ts";
|
|
|
|
export type { Extract };
|
|
|
|
/**
|
|
* Extracts and parses {@link https://toml.io | TOML} from the metadata of
|
|
* front matter content.
|
|
*
|
|
* @example Extract TOML front matter
|
|
* ```ts
|
|
* import { extract } from "@std/front-matter/toml";
|
|
* import { assertEquals } from "@std/assert";
|
|
*
|
|
* const output = `---toml
|
|
* title = "Three dashes marks the spot"
|
|
* ---
|
|
* Hello, world!`;
|
|
* const result = extract(output);
|
|
*
|
|
* assertEquals(result, {
|
|
* frontMatter: 'title = "Three dashes marks the spot"',
|
|
* body: "Hello, world!",
|
|
* attrs: { title: "Three dashes marks the spot" },
|
|
* });
|
|
* ```
|
|
*
|
|
* @typeParam T The type of the parsed front matter.
|
|
* @param text The text to extract TOML front matter from.
|
|
* @returns The extracted TOML front matter and body content.
|
|
*/
|
|
export function extract<T>(text: string): Extract<T> {
|
|
return extractAndParse(text, EXTRACT_TOML_REGEXP, parse as Parser);
|
|
}
|