Skip to content

Commit de39a4e

Browse files
MajoredMajored
committed
Update types
1 parent c4e9adc commit de39a4e

25 files changed

+68
-68
lines changed

‎src/Http.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ class Http {
2323
/** Schedules a GET request for a specific endpoint.
2424
*
2525
* @param {string} endpoint The path of the endpoint (incl. any path parameters).
26-
* @param {SortOption | undefined} sort The optional set of sort options.
26+
* @param {SortOptions | undefined} sort The optional set of sort options.
2727
*
2828
* @return {*} The response data on success.
2929
*/

‎types/Http.d.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@ export class Http {
1212
/** Schedules a GET request for a specific endpoint.
1313
*
1414
* @param {string} endpoint The path of the endpoint (incl. any path parameters).
15-
* @param {SortOptions} sort The optional set of sort options.
15+
* @param {SortOptions | undefined} sort The optional set of sort options.
1616
*
1717
* @return {*} The response data on success.
1818
*/
19-
get(endpoint: string, sort?: SortOptions): any;
19+
get(endpoint: string, sort?: SortOptions | undefined): any;
2020
/** Schedules a POST request for a specific endpoint.
2121
*
2222
* @param {string} endpoint The path of the endpoint (incl. any path parameters).
@@ -56,7 +56,7 @@ export class Http {
5656
*
5757
* @return {Array<object>} An array of raw objects.
5858
*/
59-
listUntil(endpoint: string, shouldContinue: (arg0: object) => boolean, sort?: SortOptions): Array<object>;
59+
listUntil(endpoint: string, shouldContinue: (arg0: object) => boolean, sort?: SortOptions | undefined): Array<object>;
6060
#private;
6161
}
6262
import { SortOptions } from "./SortOptions.js";

‎types/Http.d.ts.map

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎types/helpers/AlertsHelper.d.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,21 +21,21 @@ export class AlertsHelper {
2121
* @param {SortOptions | undefined} sort An optional set of sort options.
2222
* @return {Array<Alert>} An array of raw data objects.
2323
*/
24-
list(sort: SortOptions): Array<Alert>;
24+
list(sort: SortOptions | undefined): Array<Alert>;
2525
/** List all pages of unread alerts.
2626
*
2727
* @param {SortOptions | undefined} sort An optional set of sort options.
2828
* @return {Array<Alert>} An array of raw data objects.
2929
*/
30-
listAll(sort: SortOptions): Array<Alert>;
30+
listAll(sort: SortOptions | undefined): Array<Alert>;
3131
/** List multiple pages of unread alerts until a condition is no longer met.
3232
*
3333
* @param {function(Alert):boolean} shouldContinue A function which determines if further pages are requested.
3434
* @param {SortOptions | undefined} sort An optional set of sort options.
3535
*
3636
* @return {Array<Alert>} An array of raw data objects.
3737
*/
38-
listUntil(shouldContinue: (arg0: Alert) => boolean, sort: SortOptions): Array<Alert>;
38+
listUntil(shouldContinue: (arg0: Alert) => boolean, sort: SortOptions | undefined): Array<Alert>;
3939
/** Mark unread alerts as read. */
4040
markAsRead(): Promise<any>;
4141
#private;

‎types/helpers/AlertsHelper.d.ts.map

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎types/helpers/ConversationsHelper.d.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -42,13 +42,13 @@ export class ConversationsHelper {
4242
* @param {SortOptions | undefined} sort An optional set of sort options.
4343
* @return {Array<Conversation>} An array of raw data objects.
4444
*/
45-
list(sort: SortOptions): Array<Conversation>;
45+
list(sort: SortOptions | undefined): Array<Conversation>;
4646
/** List all pages of unread conversations.
4747
*
4848
* @param {SortOptions | undefined} sort An optional set of sort options.
4949
* @return {Array<Conversation>} An array of raw data objects.
5050
*/
51-
listAll(sort: SortOptions): Array<Conversation>;
51+
listAll(sort: SortOptions | undefined): Array<Conversation>;
5252
/** List multiple pages of unread conversations until a condition is no longer met.
5353
*
5454
* @param {function(Conversation):boolean} shouldContinue A function which determines if further pages are
@@ -57,7 +57,7 @@ export class ConversationsHelper {
5757
*
5858
* @return {Array<Conversation>} An array of raw data objects.
5959
*/
60-
listUntil(shouldContinue: (arg0: Conversation) => boolean, sort: SortOptions): Array<Conversation>;
60+
listUntil(shouldContinue: (arg0: Conversation) => boolean, sort: SortOptions | undefined): Array<Conversation>;
6161
/** Start a new conversation.
6262
*
6363
* @param {string} title The title of the conversation.
@@ -74,15 +74,15 @@ export class ConversationsHelper {
7474
*
7575
* @return {Array<Reply>} An array of raw data objects.
7676
*/
77-
listReplies(conversationId: number, sort: SortOptions): Array<Reply>;
77+
listReplies(conversationId: number, sort: SortOptions | undefined): Array<Reply>;
7878
/** List all pages of replies to an unread conversation.
7979
*
8080
* @param {number} conversationId The identifier of the unread conversation.
8181
* @param {SortOptions | undefined} sort An optional set of sort options.
8282
*
8383
* @return {Array<Reply>} An array of raw data objects.
8484
*/
85-
listRepliesAll(conversationId: number, sort: SortOptions): Array<Reply>;
85+
listRepliesAll(conversationId: number, sort: SortOptions | undefined): Array<Reply>;
8686
/** List multiple pages of replies to an unread conversation until a condition is no longer met.
8787
*
8888
* @param {number} conversationId The identifier of the unread conversation.
@@ -91,7 +91,7 @@ export class ConversationsHelper {
9191
*
9292
* @return {Array<Reply>} An array of raw data objects.
9393
*/
94-
listRepliesUntil(conversationId: number, shouldContinue: (arg0: Reply) => boolean, sort: SortOptions): Array<Reply>;
94+
listRepliesUntil(conversationId: number, shouldContinue: (arg0: Reply) => boolean, sort: SortOptions | undefined): Array<Reply>;
9595
/** Reply to an unread conversation
9696
*
9797
* @param {number} conversationId The identifier of the unread conversation.

‎types/helpers/ConversationsHelper.d.ts.map

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎types/helpers/ThreadsHelper.d.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -59,21 +59,21 @@ export class ThreadsHelper {
5959
* @param {SortOptions | undefined} sort An optional set of sort options.
6060
* @return {Array<BasicThread>} An array of raw data objects.
6161
*/
62-
list(sort: SortOptions): Array<BasicThread>;
62+
list(sort: SortOptions | undefined): Array<BasicThread>;
6363
/** List all pages of threads you own or collaborate on.
6464
*
6565
* @param {SortOptions | undefined} sort An optional set of sort options.
6666
* @return {Array<BasicThread>} An array of raw data objects.
6767
*/
68-
listAll(sort: SortOptions): Array<BasicThread>;
68+
listAll(sort: SortOptions | undefined): Array<BasicThread>;
6969
/** List multiple pages of threads you own or collaborate on until a condition is no longer met.
7070
*
7171
* @param {function(BasicThread):boolean} shouldContinue A function which determines if further pages are requested.
7272
* @param {SortOptions | undefined} sort An optional set of sort options.
7373
*
7474
* @return {Array<BasicThread>} An array of raw data objects.
7575
*/
76-
listUntil(shouldContinue: (arg0: BasicThread) => boolean, sort: SortOptions): Array<BasicThread>;
76+
listUntil(shouldContinue: (arg0: BasicThread) => boolean, sort: SortOptions | undefined): Array<BasicThread>;
7777
/** Fetch information about a thread you own or collaborate on.
7878
*
7979
* @param {number} threadId The identifier of the thread.
@@ -87,15 +87,15 @@ export class ThreadsHelper {
8787
*
8888
* @return {Array<Reply>} An array of raw data objects.
8989
*/
90-
listReplies(threadId: number, sort: SortOptions): Array<Reply>;
90+
listReplies(threadId: number, sort: SortOptions | undefined): Array<Reply>;
9191
/** List all pages of replies for a thread you own or collaborate on.
9292
*
9393
* @param {number} threadId The identifier of the thread.
9494
* @param {SortOptions | undefined} sort An optional set of sort options.
9595
*
9696
* @return {Array<Reply>} An array of raw data objects.
9797
*/
98-
listRepliesAll(threadId: number, sort: SortOptions): Array<Reply>;
98+
listRepliesAll(threadId: number, sort: SortOptions | undefined): Array<Reply>;
9999
/** List multiple pages of replies for a thread you own or collaborate on until a condition is no longer met.
100100
*
101101
* @param {number} threadId The identifier of the thread.
@@ -104,7 +104,7 @@ export class ThreadsHelper {
104104
*
105105
* @return {Array<Reply>} An array of raw data objects.
106106
*/
107-
listRepliesUntil(threadId: number, shouldContinue: (arg0: Reply) => boolean, sort: SortOptions): Array<Reply>;
107+
listRepliesUntil(threadId: number, shouldContinue: (arg0: Reply) => boolean, sort: SortOptions | undefined): Array<Reply>;
108108
/** Reply to a thread you own or collaborate on.
109109
*
110110
* @param {number} threadId The identifier of the thread.

‎types/helpers/ThreadsHelper.d.ts.map

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎types/helpers/members/ProfilePostsHelper.d.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,20 +21,20 @@ export class ProfilePostsHelper {
2121
* @param {SortOptions | undefined} sort An optional set of sort options.
2222
* @return {Array<ProfilePost>} An array of raw data objects.
2323
*/
24-
list(sort: SortOptions): Array<ProfilePost>;
24+
list(sort: SortOptions | undefined): Array<ProfilePost>;
2525
/** List all pages of profile posts on your profile.
2626
*
2727
* @param {SortOptions | undefined} sort An optional set of sort options.
2828
* @return {Array<ProfilePost>} An array of raw data objects.
2929
*/
30-
listAll(sort: SortOptions): Array<ProfilePost>;
30+
listAll(sort: SortOptions | undefined): Array<ProfilePost>;
3131
/** List multiple pages of profile posts on your profile until a condition is no longer met.
3232
*
3333
* @param {function(ProfilePost):boolean} shouldContinue A function which determines if further pages are requested.
3434
* @param {SortOptions | undefined} sort An optional set of sort options.
3535
* @return {Array<ProfilePost>} An array of raw data objects.
3636
*/
37-
listUntil(shouldContinue: (arg0: ProfilePost) => boolean, sort: SortOptions): Array<ProfilePost>;
37+
listUntil(shouldContinue: (arg0: ProfilePost) => boolean, sort: SortOptions | undefined): Array<ProfilePost>;
3838
/** Fetch information about a profile post on your profile.
3939
*
4040
* @param {number} profilePostId The identifier of the profile post to fetch.

0 commit comments

Comments
 (0)