gray-matter-es 0.1.1 → 0.1.3

package/README.md

@@ -1,10 +1,14 @@
 # gray-matter-es
 
+[![npm version](https://img.shields.io/npm/v/gray-matter-es?color=yellow)](https://npmjs.com/package/gray-matter-es)
+[![npm downloads](https://img.shields.io/npm/dm/gray-matter-es?color=yellow)](https://npmjs.com/package/gray-matter-es)
+
 ESM-only [gray-matter](https://github.com/jonschlinkert/gray-matter) implementation.
 
 ## Features
 
 - 🚀 ESM-only, no CommonJS
+- 🌐 Browser-compatible (no Node.js dependencies)
 - 📦 Zero runtime dependencies (YAML parser bundled from [@std/yaml](https://jsr.io/@std/yaml))
 - 🔷 Full TypeScript support with strict types
 - ✅ API compatible with gray-matter
@@ -36,9 +40,6 @@ const str = matter.stringify("content", { title: "Hello" });
 // ---
 // content
 
-// Read from file (Node.js)
-const fileFromDisk = matter.read("./post.md");
-
 // Test if string has front matter
 matter.test("---\ntitle: Hello\n---"); // true
 
@@ -75,11 +76,11 @@ console.log(file.excerpt); // 'excerpt\n'
 
 ### `matter(input, options?)`
 
-Parse front matter from a string or buffer.
+Parse front matter from a string or Uint8Array.
 
 **Parameters:**
 
-- `input` - String, Buffer, or object with `content` property
+- `input` - String, Uint8Array, or object with `content` property
 - `options` - Optional configuration
 
 **Returns:** `GrayMatterFile` object with:
@@ -87,7 +88,7 @@ Parse front matter from a string or buffer.
 - `data` - Parsed front matter data
 - `content` - Content after front matter
 - `excerpt` - Extracted excerpt (if enabled)
-- `orig` - Original input as Buffer
+- `orig` - Original input as Uint8Array
 - `language` - Detected/specified language
 - `matter` - Raw front matter string
 - `isEmpty` - True if front matter block was empty
@@ -97,10 +98,6 @@ Parse front matter from a string or buffer.
 
 Stringify data to front matter and append content.
 
-### `matter.read(filepath, options?)`
-
-Synchronously read and parse a file.
-
 ### `matter.test(str, options?)`
 
 Test if a string has front matter.
@@ -120,7 +117,9 @@ Detect the language specified after the opening delimiter.
 ## Differences from gray-matter
 
 - ESM-only (no CommonJS support)
+- Browser-compatible (no Node.js dependencies)
 - Uses [`@std/yaml`](https://jsr.io/@std/yaml) instead of `js-yaml`
+- Removed `matter.read()` (use your own file reading)
 - Removed JavaScript front matter engine (security: avoids `eval`)
 - Removed deprecated options (`lang`, `delims`, `parsers`)
 - Removed `section-matter` support

package/dist/index.d.mts

@@ -1,12 +1,93 @@
-import { Engine, GrayMatterFile, GrayMatterInput, GrayMatterOptions, MatterFunction, ResolvedOptions } from "./types.mjs";
-import { BuiltinLanguage } from "./engines.mjs";
-
+//#region src/types.d.ts
+/**
+* Engine interface for parsing and stringifying front matter
+*/
+interface Engine {
+  parse: (str: string) => Record<string, unknown>;
+  stringify?: (data: Record<string, unknown>) => string;
+}
+/**
+* Options for gray-matter
+*/
+interface GrayMatterOptions {
+  /** Language to use for parsing (default: 'yaml') */
+  language?: "yaml" | "json";
+  /** Delimiters for front matter (default: '---') */
+  delimiters?: string | [string, string];
+  /**
+  * Extract an excerpt from the content.
+  * - `true`: use the default delimiter
+  * - `string`: use this string as the delimiter
+  * - `function`: custom excerpt function
+  */
+  excerpt?: boolean | string | ((file: GrayMatterFile, options: GrayMatterOptions) => void);
+  /** Separator for excerpt in file.data */
+  excerpt_separator?: string;
+  /** Data to merge with parsed data */
+  data?: Record<string, unknown>;
+}
+/**
+* Resolved options with defaults applied
+*/
+interface ResolvedOptions extends GrayMatterOptions {
+  delimiters: [string, string];
+  language: "yaml" | "json";
+}
+/**
+* The file object returned by gray-matter
+*/
+interface GrayMatterFile {
+  /** The parsed front matter data */
+  data: Record<string, unknown>;
+  /** The content after front matter */
+  content: string;
+  /** The extracted excerpt (if enabled) */
+  excerpt: string;
+  /** The original input as a Uint8Array */
+  orig: Uint8Array;
+  /** The detected/specified language */
+  language: string;
+  /** The raw front matter string (without delimiters) */
+  matter: string;
+  /** True if front matter block was empty */
+  isEmpty: boolean;
+  /** The original content if isEmpty is true */
+  empty?: string;
+  /** Stringify the file back to a string */
+  stringify: (data?: Record<string, unknown>, options?: GrayMatterOptions) => string;
+}
+/**
+* Input that can be passed to gray-matter
+*/
+type GrayMatterInput = string | Uint8Array | {
+  content: string;
+  data?: Record<string, unknown>;
+};
+/**
+* The matter function interface with static methods
+*/
+interface MatterFunction {
+  (input: GrayMatterInput, options?: GrayMatterOptions): GrayMatterFile;
+  stringify: (file: GrayMatterFile | string, data?: Record<string, unknown>, options?: GrayMatterOptions) => string;
+  test: (str: string, options?: GrayMatterOptions) => boolean;
+  language: (str: string, options?: GrayMatterOptions) => {
+    raw: string;
+    name: string;
+  };
+  clearCache: () => void;
+  cache: Map<string, GrayMatterFile>;
+}
+//#endregion
+//#region src/engines.d.ts
+/**
+* Built-in language names
+*/
+type BuiltinLanguage = "yaml" | "json";
+//#endregion
 //#region src/index.d.ts
-
 /**
 * The matter function with all static methods
 */
 declare const matter: MatterFunction;
 //#endregion
-export { type BuiltinLanguage, type Engine, type GrayMatterFile, type GrayMatterInput, type GrayMatterOptions, type MatterFunction, type ResolvedOptions, matter as default, matter };
-//# sourceMappingURL=index.d.mts.map
+export { type BuiltinLanguage, type Engine, type GrayMatterFile, type GrayMatterInput, type GrayMatterOptions, type MatterFunction, type ResolvedOptions, matter as default, matter };