Getting Started

pnpm add parsium-media

import { parse } from 'parsium-media';

// Analyze a title
const result = parse("The.Matrix.1999.1080p.BluRay.x264-YTS");

console.log(result.title); // "The Matrix"
console.log(result.year); // 1999
console.log(result.resolution); // "1080p"

const result = parse('Movie.2024.1080p.mkv', { explain: true });
// result.explanation = [
//   { extractor: 'resolution', value: '1080p', confidence: 1.0, ... },
//   { extractor: 'year', value: 2024, confidence: 0.95, ... },
// ]

const result = parse('Movie.2024.1080p.mkv', { fieldConfidence: true });
// result.fieldConfidence = {
//   title: 0.8, contentType: 0.9, year: 0.95, resolution: 1.0
// }

# Parse a single filename
npx parsium-media "The.Matrix.1999.1080p.BluRay.x264-GROUP.mkv"

# With step-by-step extraction reasoning
npx parsium-media --explain "Movie.2024.1080p.BluRay.x265-GROUP.mkv"

# JSON output (truthy fields only)
npx parsium-media --json "Movie.2024.mkv"

# Parse from a file (one filename per line)
npx parsium-media --file torrents.txt --json --progress

import { createParser } from 'parsium-media';

const parser = createParser({
  plugins: [{
    name: 'tracker-tags',
    extractors: [{
      name: 'tracker-meta',
      priority: 8.5,
      extract(ctx) {
        const match = /\[(INTERNAL|FREELEECH)\]/i.exec(ctx.normalized);
        if (!match) return null;
        return {
          value: { trackerTag: match[1].toUpperCase() },
          consumed: [[match.index, match.index + match[0].length]],
          confidence: 1.0,
        };
      },
    }],
  }],
});

const result = parser.parse('[INTERNAL] Movie.2024.mkv');
// result.trackerTag === 'INTERNAL'

{
  "filename": "The.Boys.S05E02.1080p.WEB.H264-TyHD.mkv",
  "options": {
    "explain": false,
    "fieldConfidence": false
  }
}

{
  "success": true,
  "data": {
    "title": "The Boys",
    "contentType": "series",
    "seasons": [5],
    "episodes": [2],
    "resolution": "1080p",
    "codec": "H.264",
    "releaseGroup": "TyHD",
    "container": "mkv"
  },
  "meta": { "parseTimeMs": 0.6 }
}

{
  "filenames": [
    "Movie.2024.2160p.UHD.BluRay.x265-GROUP.mkv",
    "Anime.S01E01.1080p.WEB.H264-Sub.mkv"
  ]
}

import { createCachedParser } from 'parsium-media';

// LRU cache with 10,000 entries
const { parse, size, clear } = createCachedParser(10000);

const result = parse('Same.File.Again.mkv');
// Second call with same input is instant (cache hit)

import { parseBatch } from 'parsium-media';

const results = parseBatch(filenames, {
  onProgress: (completed, total) => {
    console.log(`${completed}/${total}`);
  },
});