Användning av TypeScript

Användning av TypeScript underlättar utvecklingen genom att erbjuda automatisk syntaxmarkering för metoder och egenskaper, samt typparning:

Vi rekommenderar att du använder editorn Visual Studio Code för att skapa och redigera scrapers

Installera A-Parser typbibliotek:

cd files/
npm install a-parser-types

A-Parser skapar automatiskt en grundläggande konfigurationsfil för TypeScript om den saknas:

files/tsconfig.json

{
    "compilerOptions": {
        "target": "esnext",
        "moduleResolution": "node",
        "module": "commonjs",
        "sourceMap": true,
        "baseUrl": ".",
        "paths": {
            "*": ["node_modules/*", "../dist/nodejs/node_modules/*"]
        }
    },
    "include": ["**/*.ts"]
}

Skapa en scraper-fil:

mkdir files/parsers/Awesome-Parser/
touch files/parsers/Awesome-Parser/Awesome-Parser.ts

Använd denna mall för att påbörja utvecklingen:

files/parsers/Awesome-Parser/Awesome-Parser.ts

import { BaseParser } from 'a-parser-types';

export class JS_Awesome_Parser extends BaseParser {
    static defaultConf: typeof BaseParser.defaultConf = {
        version: '0.0.1',
        results: {
            flat: [
                ['title', 'Title'],
            ],
            arrays: {
            }
        },
        results_format: "Title: $title\n",
    };

    static editableConf: typeof BaseParser.editableConf = [
    ];

    async parse(set, results) {
        ...

        return results;
    }
}

anteckning

• Generatorer har ersatts av async/await

Skillnader från API v1

• Generatorer har ersatts av async/await
• Fälten defaultConf och editableConf har blivit static
• Scraper-klassen måste ärva från BaseParser
• TypeScript kan användas valfritt, vi rekommenderar att använda det som standard för syntaxmarkering av tillgängliga metoder och parametrar