@types/instafeed.js

Installation

npm install --save @types/instafeed.js

Summary

This package contains type definitions for instafeed.js (https://instafeedjs.com).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/instafeed.js.

index.d.ts

export as namespace Instafeed;

export = Instafeed;

declare class Instafeed<T = Instafeed.InstafeedDefaultItem> {
    constructor(options: Instafeed.InstafeedOptions<T>);

    run(): boolean;
    hasNext(): boolean;
    next(): void;
}

declare namespace Instafeed {
    interface InstafeedOptions<T = Instafeed.InstafeedDefaultItem> {
        accessToken: string | ((accessTokenReceiver: (err: unknown, value: string) => void) => void);
        accessTokenTimeout?: number;
        after?: () => void;
        apiTimeout?: number;
        apiLimit?: number;
        before?: () => void;
        debug?: boolean;
        error?: (err: unknown) => any;
        filter?: (item: InstagramDataItem) => boolean;
        limit?: number;
        mock?: boolean;
        render?: (item: T, options: Instafeed.InstafeedOptions) => string;
        sort?: (a: T, b: T) => number;
        success?: (data: InstagramResponseData) => void;
        target?: string | Element;
        template?: string;
        templateBoundaries?: string[];
        transform?: (item: InstagramDataItem) => Record<string, unknown>;
    }

    interface InstafeedDefaultItem {
        caption: string;
        tags: string[];
        id: string;
        image: string;
        link: string;
        model: InstagramDataItem;
        timestamp: string;
        type: string;
        username: string;
    }

    interface InstagramDataItem {
        caption: string;
        id: string;
        media_type: string;
        media_url: string;
        permalink: string;
        timestamp: string;
        username: string;
    }

    interface InstagramPaging {
        cursors: {
            after?: string;
            before?: string;
        };
        next?: string;
        previous?: string;
    }

    interface InstagramResponseData {
        data: InstagramDataItem[];
        paging: InstagramPaging;
    }
}

Additional Details

• Last updated: Mon, 26 Feb 2024 20:07:44 GMT
• Dependencies: none

Credits

These definitions were written by Luis Sousa.