Interface RedditNodeParameters

Source
interface RedditNodeParameters {
    additionalFields?: {
        sort?:
            | "top"
            | "new"
            | "relevance"
            | "comments"
            | "hot";
    };
    commentId?: string;
    commentText?: string;
    content?: "about"
    | "rules";
    details?:
        | "comments"
        | "identity"
        | "blockedUsers"
        | "friends"
        | "karma"
        | "prefs"
        | "saved"
        | "trophies"
        | "about"
        | "gilded"
        | "overview"
        | "submitted";
    filters?: | { keyword?: string; trending?: boolean }
    | { category?: "top" | "new" | "hot" | "rising" };
    keyword?: string;
    kind?: "image" | "link" | "self";
    limit?: number;
    location?: "subreddit" | "allReddit";
    operation?:
        | "create"
        | "get"
        | "getAll"
        | "delete"
        | "search"
        | "reply";
    postId?: string;
    replyText?: string;
    resource?: | "user"
    | "post"
    | "profile"
    | "postComment"
    | "subreddit";
    resubmit?: boolean;
    returnAll?: boolean;
    subreddit?: string;
    text?: string;
    title?: string;
    url?: string;
    username?: string;
}

Properties§

§readonly additionalFields?: { ... }

Default: {}

§readonly commentId?: string

ID of the comment to remove. Found in the comment URL:/r/[subreddit_name]/comments/[post_id]/[post_title]/[comment_id]

§readonly commentText?: string

Text of the comment. Markdown supported.

§readonly content?: "about" | "rules"

Subreddit content to retrieve Default: "about"

§readonly details?:
    | "comments"
    | "identity"
    | "blockedUsers"
    | "friends"
    | "karma"
    | "prefs"
    | "saved"
    | "trophies"
    | "about"
    | "gilded"
    | "overview"
    | "submitted"

Details of my account to retrieve Default: "identity"

§readonly filters?:
    | { keyword?: string; trending?: boolean }
    | { category?: "top" | "new" | "hot" | "rising" }

Default: {}

§readonly keyword?: string

The keyword for the search

§readonly kind?: "image" | "link" | "self"

The kind of the post to create Default: "self"

§readonly limit?: number

Max number of results to return Default: 100 Type options: {"minValue":1,"maxValue":100}

§readonly location?: "subreddit" | "allReddit"

Location where to search for posts Default: "subreddit"

§readonly operation?: "create" | "get" | "getAll" | "delete" | "search" | "reply"

Default: "create"

§readonly postId?: string

ID of the post to write the comment to. Found in the post URL: /r/[subreddit_name]/comments/[post_id]/[post_title]

§readonly replyText?: string

Text of the reply. Markdown supported.

§readonly resource?: "user" | "post" | "profile" | "postComment" | "subreddit"

Default: "post"

§readonly resubmit?: boolean

Whether the URL will be posted even if it was already posted to the subreddit before. Otherwise, the re-posting will trigger an error.

§readonly returnAll?: boolean

Whether to return all results or only up to a given limit

§readonly subreddit?: string

The name of subreddit where the post is

§readonly text?: string

Text of the post. Markdown supported.

§readonly title?: string

Title of the post, up to 300 characters long

§readonly url?: string

URL of the post

§readonly username?: string

Reddit ID of the user to retrieve