Nerdy Programmers Mingling

    sponsorblock-api
    TypeScript icon, indicating that this package has built-in type declarations

    0.2.2 • Public • Published

    node-sponsorblock-api

    Node module wrapper for SponsorBlock web API.

    Now works with the browser's runtime.

    https://sponsor.ajay.app/

    Complete API documentation can be found here. Please review the attriution template to abide the license.

    This is a new library it will be updated frequently for small improvements. Function signatures may change due to API updates.

    Usage:
    JavaScript:
    const { SponsorBlock } = require('sponsorblock-api');
    const sponsorBlock = new SponsorBlock(userID); // userID should be a locally generated uuid, save the id for future tracking of stats
    
    sponsorBlock.getSegments(videoID, ['intro', 'outro']).then((segments) => {
    	console.log(segments);
    });
    TypeScript:
    import { SponsorBlock } from 'sponsorblock-api';
    const sponsorBlock = new SponsorBlock(userID); // userID should be a locally generated uuid, save the id for future tracking of stats
    
    sponsorBlock.getSegments(videoID, ['sponsor', 'selfpromo']).then((segments) => {
    	console.log(segments);
    });
    Notice:
    • userID should be a locally generated UUID, and should be saved for future requests for the API to keep track of stats of a person, treat like a password.
    • You may import SponsorBlockVIP or SponsorBlockAdmin for more functions, the added functions will only work if your userID has the permissions.
    Error handling:

    Every API call will throw an error if the response status is not 200, the error object will contain a status and message properties.

    JavaScript:
    try {
    	await sponsorBlock.getSegments('videoID that will not be found');
    } catch (e) {
    	if (e.name === 'ResponseError') {
    		// SponsorBlock error handling
    		console.log(e.status); // 404
    		console.log(e.message); // Not found
    	}
    }
    TypeScript:
    import { ResponseError } from 'sponsorblock-api'
    try {
    	await sponsorBlock.getSegments('videoID that will not be found');
    } catch (e) {
    	if (e instaceof ResponseError) {
    		// SponsorBlock error handling
    	}
    }

    Issues:

    Feel free to open an issue for suggestions or any unexpected behavior encountered.

    Install

    npm i sponsorblock-api

    DownloadsWeekly Downloads

    154

    Version

    0.2.2

    License

    MIT

    Unpacked Size

    47 kB

    Total Files

    53

    Last publish

    Collaborators

    • origeva