justreddit/build/Post.d.ts

A simple package for getting random posts, random images, random SubReddits, and SubReddit info.

export interface RedditPost {
    kind: "t1" | "t3";
    data: {
        approved_at_utc: number | null;
        subreddit: string;
        selftext: string;
        user_reports: any[];
        saved: boolean;
        mod_reason_title: string | null;
        gilded: number;
        clicked: boolean;
        title: string;
        link_flair_richtext: {
            e: string;
            t: string;
        }[];
        subreddit_name_prefixed: string;
        hidden: boolean;
        pwls: number;
        link_flair_css_class: string;
        downs: number;
        thumbnail_height: number | null;
        top_awarded_type: string | null;
        hide_score: boolean;
        name: string;
        quarantine: boolean;
        link_flair_text_color: string;
        upvote_ratio: number;
        author_flair_background_color: string | null;
        subreddit_type: string;
        ups: number;
        total_awards_received: number;
        media_embed: Record<string, any>;
        thumbnail_width: number | null;
        author_flair_template_id: string | null;
        is_original_content: boolean;
        author_fullname: string;
        secure_media: any | null;
        is_reddit_media_domain: boolean;
        is_meta: boolean;
        category: string | null;
        secure_media_embed: Record<string, any>;
        link_flair_text: string;
        can_mod_post: boolean;
        score: number;
        approved_by: string | null;
        is_created_from_ads_ui: boolean;
        author_premium: boolean;
        thumbnail: string;
        edited: boolean;
        author_flair_css_class: string | null;
        author_flair_richtext: any[];
        gildings: Record<string, number>;
        content_categories: string[] | null;
        is_self: boolean;
        mod_note: string | null;
        created: number;
        link_flair_type: string;
        wls: number;
        removed_by_category: string | null;
        banned_by: string | null;
        author_flair_type: string;
        domain: string;
        allow_live_comments: boolean;
        selftext_html: string;
        likes: boolean | null;
        suggested_sort: string | null;
        banned_at_utc: number | null;
        view_count: number | null;
        archived: boolean;
        no_follow: boolean;
        is_crosspostable: boolean;
        pinned: boolean;
        over_18: boolean;
        all_awardings: any[];
        awarders: any[];
        media_only: boolean;
        link_flair_template_id: string;
        can_gild: boolean;
        spoiler: boolean;
        locked: boolean;
        author_flair_text: string | null;
        treatment_tags: string[];
        visited: boolean;
        removed_by: string | null;
        num_reports: number | null;
        distinguished: string | null;
        subreddit_id: string;
        author_is_blocked: boolean;
        mod_reason_by: string | null;
        removal_reason: string | null;
        link_flair_background_color: string;
        id: string;
        is_robot_indexable: boolean;
        num_duplicates: number;
        report_reasons: string[] | null;
        author: string;
        discussion_type: string | null;
        num_comments: number;
        send_replies: boolean;
        media: any | null;
        contest_mode: boolean;
        author_patreon_flair: boolean;
        author_flair_text_color: string | null;
        permalink: string;
        stickied: boolean;
        url: string;
        subreddit_subscribers: number;
        created_utc: number;
        num_crossposts: number;
        mod_reports: any[];
        is_video: boolean;
    };
}
export interface Post {
    subreddit: string;
    id: string;
    author: string;
    title: string;
    body: string;
    image: string | null;
    created: Date;
    likes: number;
    dislikes: number;
    over18: boolean;
    mediaOnly: boolean;
    pinned: boolean;
    locked: boolean;
    archived: boolean;
    edited: boolean;
    isOriginalContent: boolean;
}
export declare function post(subreddit: string, postID: string): Promise<Post>;
type SortingOption = "hot" | "new" | "top" | "rising";
export declare function randomPost(subreddit?: string, sortingOption?: SortingOption): Promise<Post>;
export {};