Function parseJSONFromMarkdownString

  • Parses JSON from a markdown string or plain JSON string

    Type Parameters

    • T = any

    Parameters

    • mdString: string

      The input string containing JSON (with or without markdown formatting)

    • options: ParseJSONOptions = ...

      Configuration options for parsing

    Returns T

    Parsed JSON object or default value if parsing fails

    Error if parsing fails and throwOnError is true

    // With type safety
    interface User {
    name: string;
    age: number;
    }

    // Basic usage
    const user = parseJSONFromMarkdownString<User>(\`
    \`\`\`json
    {
    "name": "John",
    "age": 30
    }
    \`\`\`
    \`);

    // With options
    const userWithFallback = parseJSONFromMarkdownString<User>(
    invalidJson,
    {
    throwOnError: false,
    defaultValue: { name: 'Unknown', age: 0 }
    }
    );

    // Direct JSON parsing
    const plainJsonUser = parseJSONFromMarkdownString<User>('{"name": "John", "age": 30}');