vhad/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/gosticks/DefinitelyTyped.git synced 2026-10-04 06:47:03 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

[snoowrap] Fix typings for some Promise returning functions (#32505)

Browse Source 
* Fix typings for some Promise returning functions

* Add semicolon
This commit is contained in:
Igor Goldvekht
2019-01-28 15:20:14 -08:00
committed by Pranav Senthilnathan
parent 4a91c57f19
commit 42e879f222
6 changed files with 41 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files
types/snoowrap/dist/objects/LiveThread.d.ts
Vendored
+2 -2
View File
@@ -26,8 +26,8 @@ export default class LiveThread extends RedditContent<LiveThread> {
deleteUpdate(options: { id: string; }): Promise<this>;
editSettings(options: LiveThreadSettings): Promise<this>;
getContributors(): Promise<RedditUser[]>;
getDiscussions(options?: ListingOptions): Listing<Submission>;
getRecentUpdates(options?: ListingOptions): Listing<LiveUpdate>;
getDiscussions(options?: ListingOptions): Promise<Listing<Submission>>;
getRecentUpdates(options?: ListingOptions): Promise<Listing<LiveUpdate>>;
inviteContributor(options: { name: string; permissions: Permissions[]}): Promise<this>;
leaveContributor(): Promise<this>;
removeContributor(options: { name: string; }): Promise<this>;
types/snoowrap/dist/objects/RedditUser.d.ts
Vendored
+8 -8
View File
@@ -100,18 +100,18 @@ export default class RedditUser extends RedditContent<RedditUser> {
assignFlair(options: any): Promise<this>;
friend(options: any): Promise<this>;
getComments(options?: any): Listing<Comment>;
getDownvotedContent(options?: any): Listing<Comment | Submission>;
getComments(options?: any): Promise<Listing<Comment>>;
getDownvotedContent(options?: any): Promise<Listing<Comment | Submission>>;
getFriendInformation(): Promise<any>;
getGildedContent(options?: any): Listing<Comment | Submission>;
getHiddenContent(options?: any): Listing<Comment | Submission>;
getGildedContent(options?: any): Promise<Listing<Comment | Submission>>;
getHiddenContent(options?: any): Promise<Listing<Comment | Submission>>;
getMultireddit(name: string): MultiReddit;
getMultireddits(): Promise<MultiReddit[]>;
getOverview(options?: any): Listing<Comment | Submission>;
getSavedContent(options?: any): Listing<Comment | Submission>;
getSubmissions(options?: any): Listing<Submission>;
getOverview(options?: any): Promise<Listing<Comment | Submission>>;
getSavedContent(options?: any): Promise<Listing<Comment | Submission>>;
getSubmissions(options?: any): Promise<Listing<Submission>>;
getTrophies(): Promise<any>;
getUpvotedContent(options?: any): Listing<Comment | Submission>;
getUpvotedContent(options?: any): Promise<Listing<Comment | Submission>>;
giveGold(months: string): Promise<any>;
unfriend(): Promise<any>;
}
types/snoowrap/dist/objects/Submission.d.ts
Vendored
+2 -3
View File
@@ -1,8 +1,7 @@
import { Sort } from '../..';
import Comment from './Comment';
import Listing, { ListingOptions } from './Listing';
import RedditUser from './RedditUser';
import Subreddit, { FlairTemplate } from './Subreddit';
import { FlairTemplate } from './Subreddit';
import VoteableContent, { RichTextFlair } from './VoteableContent';
interface Media {
@@ -113,7 +112,7 @@ export default class Submission extends VoteableContent<Submission> {
assignFlair(options: { text: string; cssClass: string; }): Promise<this>;
disableContestMode(): Promise<this>;
enableContestMode(): Promise<this>;
getDuplicates(options?: ListingOptions): Listing<Submission>;
getDuplicates(options?: ListingOptions): Promise<Listing<Submission>>;
getLinkFlairTemplates(): Promise<FlairTemplate[]>;
/* @deprecated */ getRelated(options?: ListingOptions): Submission;
hide(): Promise<this>;
types/snoowrap/dist/objects/Subreddit.d.ts
Vendored
+23 -23
View File
@@ -1,12 +1,12 @@
import { Sort, ModAction, SubmitSelfPostOptions, SubmitLinkOptions, BaseSearchOptions } from '../..';
import { BaseSearchOptions, ModAction, Sort, SubmitLinkOptions, SubmitSelfPostOptions } from '../..';
import Comment from './Comment';
import Listing, { ListingOptions } from './Listing';
import PrivateMessage from './PrivateMessage';
import RedditContent from './RedditContent';
import RedditUser from './RedditUser';
import Submission from './Submission';
import WikiPage, { WikiPageRevision } from './WikiPage';
import { RichTextFlair } from './VoteableContent';
import WikiPage, { WikiPageRevision } from './WikiPage';
export default class Subreddit extends RedditContent<Subreddit> {
accounts_active_is_fuzzed: boolean;
@@ -108,40 +108,40 @@ export default class Subreddit extends RedditContent<Subreddit> {
deleteImage(options: { imageName: string; }): Promise<this>;
deleteUserFlair(name: string): Promise<this>;
editSettings(options: SubredditSettings): Promise<this>;
getBannedUsers(options?: ListingOptions & { name?: string }): Listing<BannedUser>;
getContributors(options?: ListingOptions & { name?: string }): Listing<Contributor>;
getControversial(options?: ListingOptions & { time?: string }): Listing<Submission>;
getEdited(options?: ListingOptions & { only?: 'links' | 'comments' }): Listing<Submission | Comment>;
getHot(options?: ListingOptions): Listing<Submission>;
getBannedUsers(options?: ListingOptions & { name?: string }): Promise<Listing<BannedUser>>;
getContributors(options?: ListingOptions & { name?: string }): Promise<Listing<Contributor>>;
getControversial(options?: ListingOptions & { time?: string }): Promise<Listing<Submission>>;
getEdited(options?: ListingOptions & { only?: 'links' | 'comments' }): Promise<Listing<Submission | Comment>>;
getHot(options?: ListingOptions): Promise<Listing<Submission>>;
getLinkFlairTemplates(linkId: string): Promise<FlairTemplate[]>;
getModerationLog(opts?: ListingOptions & { mods?: string[]; type?: ModActionType}): Listing<ModAction>;
getModerationLog(opts?: ListingOptions & { mods?: string[]; type?: ModActionType}): Promise<Listing<ModAction>>;
getModerators(options?: ListingOptions & { name?: string }): RedditUser[];
getModmail(options?: ListingOptions): Listing<PrivateMessage>;
getModqueue(options?: ListingOptions & { only?: 'links' | 'comments' }): Listing<Submission | Comment>;
getMutedUsers(options?: ListingOptions & { name?: string }): Listing<MutedUser>;
getModmail(options?: ListingOptions): Promise<Listing<PrivateMessage>>;
getModqueue(options?: ListingOptions & { only?: 'links' | 'comments' }): Promise<Listing<Submission | Comment>>;
getMutedUsers(options?: ListingOptions & { name?: string }): Promise<Listing<MutedUser>>;
getMyFlair(): Promise<FlairTemplate>;
getNew(options?: ListingOptions): Listing<Submission>;
getNewComments(options?: ListingOptions): Listing<Comment>;
getNew(options?: ListingOptions): Promise<Listing<Submission>>;
getNewComments(options?: ListingOptions): Promise<Listing<Comment>>;
getRandomSubmission(): Promise<Submission>;
getRecommendedSubreddits(options?: { omit?: string[]; }): Promise<Subreddit[]>;
getReports(options?: ListingOptions & { only?: 'links' | 'comments' }): Listing<Submission | Comment>;
getRising(options?: ListingOptions): Listing<Submission>;
getReports(options?: ListingOptions & { only?: 'links' | 'comments' }): Promise<Listing<Submission | Comment>>;
getRising(options?: ListingOptions): Promise<Listing<Submission>>;
getRules(): Promise<{ rules: Rule[]; site_rules: string[] }>;
getSettings(): Promise<SubredditSettings>;
getSpam(options?: ListingOptions & { only?: 'links' | 'comments' }): Listing<Submission | Comment>;
getSpam(options?: ListingOptions & { only?: 'links' | 'comments' }): Promise<Listing<Submission | Comment>>;
getSticky(options?: { num?: number }): Promise<Submission>;
getStylesheet(): Promise<string>;
getSubmitText(): Promise<string>;
getTop(options?: ListingOptions & { time?: Timespan }): Listing<Submission>;
getUnmoderated(options?: ListingOptions & { only?: 'links' | 'comments' }): Listing<Submission | Comment>;
getTop(options?: ListingOptions & { time?: Timespan }): Promise<Listing<Submission>>;
getUnmoderated(options?: ListingOptions & { only?: 'links' | 'comments' }): Promise<Listing<Submission | Comment>>;
getUserFlair(name: string): Promise<FlairTemplate>;
getUserFlairList(options?: ListingOptions & { name?: string; }): Listing<UserFlair>;
getUserFlairList(options?: ListingOptions & { name?: string; }): Promise<Listing<UserFlair>>;
getUserFlairTemplates(): Promise<FlairTemplate[]>;
getWikiBannedUsers(options?: ListingOptions & { name?: string }): Listing<BannedUser>;
getWikiContributors(options?: ListingOptions & { name?: string }): Listing<Contributor>;
getWikiBannedUsers(options?: ListingOptions & { name?: string }): Promise<Listing<BannedUser>>;
getWikiContributors(options?: ListingOptions & { name?: string }): Promise<Listing<Contributor>>;
getWikiPage(name: string): WikiPage;
getWikiPages(): Promise<WikiPage[]>;
getWikiRevisions(options?: ListingOptions): Listing<WikiPageRevision>;
getWikiRevisions(options?: ListingOptions): Promise<Listing<WikiPageRevision>>;
hideMyFlair(): Promise<this>;
inviteModerator(options: { name: string; permissions?: ModeratorPermission[]; }): Promise<this>;
leaveContributor(): Promise<this>;
@@ -151,7 +151,7 @@ export default class Subreddit extends RedditContent<Subreddit> {
removeModerator(options: { name: string; }): Promise<this>;
removeWikiContributor(options: { name: string; }): Promise<this>;
revokeModeratorInvite(options: { name: string; }): Promise<this>;
search(options: BaseSearchOptions): Listing<Submission>;
search(options: BaseSearchOptions): Promise<Listing<Submission>>;
selectMyFlair(options: { flair_template_id: string; text?: string; }): Promise<this>;
setModeratorPermissions(options: { name: string; permissions: ModeratorPermission; }): Promise<this>;
setMultipleUserFlairs(flairs: Array<{
types/snoowrap/dist/objects/WikiPage.d.ts
Vendored
+2 -2
View File
@@ -13,8 +13,8 @@ export default class WikiPage extends RedditContent<WikiPage> {
addEditor(options: { name: string; }): Promise<this>;
edit(options: EditOptions): Promise<this>;
editSettings(options: Settings): Promise<this>;
getDiscussions(options?: ListingOptions): Listing<Submission>;
getRevisions(options?: ListingOptions): Listing<WikiPageRevision>;
getDiscussions(options?: ListingOptions): Promise<Listing<Submission>>;
getRevisions(options?: ListingOptions): Promise<Listing<WikiPageRevision>>;
getSettings(): Promise<Settings>;
hideRevision(options: { id: string; }): Promise<this>;
removeEditor(options: { name: string; }): Promise<this>;
types/snoowrap/snoowrap-tests.ts
+4
View File
@@ -81,3 +81,7 @@ export function submissionSearch(query: string, subreddit: string): Promise<List
export function subredditSearch(query: string): Promise<Listing<Subreddit>> {
return r.searchSubreddits({ query });
}
export function getHotFromSubreddit(subreddit: string): Promise<Listing<Submission>> {
return r.getSubreddit(subreddit).getHot({ limit: 10 });
}