Function parse

parse(
content: string,
source: string,
): { title: string; content: string; type: string }
Parse
Parameters
- content: string
  Raw example content from the
- source: string
  Source metadata containing type and title information
Returns { title: string; content: string; type: string }
Object containing title, content, and type, or null if no content
Api Example
tag to extract example code with metadata

Processes

Api Example
tags to extract example code snippets with optional type and title information. Supports various formats including JSON, XML, cURL commands, and other code examples.

Api Example
tag
Example: Basic JSON example
```
// Input: "@apiExample {json} Request
//          {
//            "name": "John"
//          }"
// Output: { title: "Request", content: "{\n  \"name\": \"John\"\n}", type: "json" }
```
Example: cURL example
```
// Input: "@apiExample {curl} Example usage
//          curl -X GET http://api.example.com/users"
// Output: { title: "Example usage", content: "curl -X GET http://api.example.com/users", type: "curl" }
```
Example: Example without type (defaults to json)
```
// Input: "@apiExample Simple example
//          { "status": "ok" }"
// Output: { title: "Simple example", content: "{ \"status\": \"ok\" }", type: "json" }
```
Since
4.0.0

Public
- Defined in core/parsers/api_example.ts:47