Skip to content

Commit 5ca12f2

Browse files
JoshuaKGoldbergJoshuaKGoldberg
committed
chore: ran eslint-plugin-jsdoc/check-tag-names autofixer on assorted types
1 parent 7bf71be commit 5ca12f2

154 files changed

Lines changed: 1631 additions & 3392 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎types/angular-ui-bootstrap/index.d.ts‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -510,15 +510,13 @@ declare module 'angular' {
510510
/**
511511
* Sets the `aria-describedby` property on the modal.
512512
* The string should be an id (without the leading '#') pointing to the element that describes your modal.
513-
* @type {string}
514513
* @memberOf IModalSettings
515514
*/
516515
ariaDescribedBy?: string | undefined;
517516

518517
/**
519518
* Sets the `aria-labelledby` property on the modal.
520519
* The string should be an id (without the leading '#') pointing to the element that labels your modal.
521-
* @type {string}
522520
* @memberOf IModalSettings
523521
*/
524522
ariaLabelledBy?: string | undefined;

‎types/app-root-path/index.d.ts‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ interface RootPath {
77

88
/**
99
* Application root directory absolute path
10-
* @type {string}
1110
*/
1211
path: string;
1312

‎types/asana/index.d.ts‎

Lines changed: 1 addition & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@ declare namespace asana {
1717
* Constructs a Client with instances of all the resources using the dispatcher.
1818
* It also keeps a reference to the dispatcher so that way the end user can have
1919
* access to it.
20-
* @class
2120
* @classdesc A wrapper for the Asana API which is authenticated for one user
2221
* @param {Dispatcher} dispatcher The request dispatcher to use
2322
* @param {Object} options Options to configure the client
@@ -89,77 +88,62 @@ declare namespace asana {
8988
* The internal dispatcher. This is mostly used by the resources but provided
9089
* for custom requests to the API or API features that have not yet been added
9190
* to the client.
92-
* @type {Dispatcher}
9391
*/
9492
dispatcher: Dispatcher;
9593
/**
9694
* An instance of the Attachments resource.
97-
* @type {Attachments}
9895
*/
9996
attachments: resources.Attachments;
10097
/**
10198
* An instance of the CustomFields resource.
102-
* @type {CustomFields}
10399
*/
104100
customFields: resources.CustomFields;
105101
/**
106102
* An instance of the Events resource.
107-
* @type {Events}
108103
*/
109104
events: resources.Events;
110105
/**
111106
* An instance of the Projects resource.
112-
* @type {Projects}
113107
*/
114108
projects: resources.Projects;
115109
/**
116110
* An instance of the Sections resource.
117-
* @type {Sections}
118111
*/
119112
sections: resources.Sections;
120113
/**
121114
* An instance of the Stories resource.
122-
* @type {Stories}
123115
*/
124116
stories: resources.Stories;
125117
/**
126118
* An instance of the Tags resource.
127-
* @type {Tags}
128119
*/
129120
tags: resources.Tags;
130121
/**
131122
* An instance of the Tasks resource.
132-
* @type {Tasks}
133123
*/
134124
tasks: resources.Tasks;
135125
/**
136126
* An instance of the UserTaskLists resource.
137-
* @type {UserTaskLists}
138127
*/
139128
userTaskLists: resources.UserTaskLists;
140129
/**
141130
* An instance of the Teams resource.
142-
* @type {Teams}
143131
*/
144132
teams: resources.Teams;
145133
/**
146134
* An instance of the Users resource.
147-
* @type {Users}
148135
*/
149136
users: resources.Users;
150137
/**
151138
* An instance of the Typeahead resource.
152-
* @type {Typeahead}
153139
*/
154140
typeahead: resources.Typeahead;
155141
/**
156142
* An instance of the Workspaces resource.
157-
* @type {Workspaces}
158143
*/
159144
workspaces: resources.Workspaces;
160145
/**
161146
* An instance of the Webhooks resource.
162-
* @type {Webhooks}
163147
*/
164148
webhooks: resources.Webhooks;
165149
/**
@@ -174,7 +158,6 @@ declare namespace asana {
174158
/**
175159
* Creates a dispatcher which will act as a basic wrapper for making HTTP
176160
* requests to the API, and handle authentication.
177-
* @class
178161
* @classdesc A HTTP wrapper for the Asana API
179162
* @param {Object} options for default behavior of the Dispatcher
180163
* @option {Authenticator} [authenticator] Object to use for authentication.
@@ -201,7 +184,6 @@ declare namespace asana {
201184

202185
/**
203186
* The relative API path for the current version of the Asana API.
204-
* @type {String}
205187
*/
206188
API_PATH: string;
207189
}
@@ -314,27 +296,23 @@ declare namespace asana {
314296

315297
/**
316298
* The base URL for Asana
317-
* @type {String}
318299
*/
319300
asanaBaseUrl: string;
320301

321302
/**
322303
* Whether requests should be automatically retried if rate limited.
323-
* @type {Boolean}
324304
*/
325305
retryOnRateLimit: boolean;
326306

327307
/**
328308
* Handler for unauthorized requests which may seek reauthorization.
329309
* Default behavior is available if configured with an Oauth authenticator
330310
* that has a refresh token, and will refresh the current access token.
331-
* @type {Function}
332311
*/
333312
handleUnauthorized: () => boolean | Promise<boolean>;
334313

335314
/**
336315
* The amount of time in milliseconds to wait for a request to finish.
337-
* @type {Number}
338316
*/
339317
requestTimeout: number;
340318
}
@@ -382,7 +360,6 @@ declare namespace asana {
382360
* be either the object returned from an access token request (which
383361
* contains the token and some other metadata) or just the `access_token`
384362
* field.
385-
* @constructor
386363
*/
387364
new (options: OauthAuthenticatorOptions): OauthAuthenticator;
388365
}
@@ -422,7 +399,6 @@ declare namespace asana {
422399
* A layer to abstract the differences between using different types of
423400
* authentication (Oauth vs. Basic). The Authenticator is responsible for
424401
* establishing credentials and applying them to outgoing requests.
425-
* @constructor
426402
*/
427403
interface Authenticator {
428404
/**
@@ -457,7 +433,6 @@ declare namespace asana {
457433
* @option {String} [redirectUri] The default redirect URI
458434
* @option {String} [scope] Scope to use, supports `default` and `scim`
459435
* @option {String} [asanaBaseUrl] Base URL to use for Asana, for debugging
460-
* @constructor
461436
*/
462437
new (options: AppOptions): App;
463438
}
@@ -535,7 +510,6 @@ declare namespace asana {
535510
* @option {String} error The string code identifying the error.
536511
* @option {String} [error_uri] A link to help and information about the error.
537512
* @option {String} [error_description] A description of the error.
538-
* @constructor
539513
*/
540514
new (options: OauthErrorOptions): OauthError;
541515
}
@@ -567,7 +541,6 @@ declare namespace asana {
567541
* redirecting to an authorization page on Asana, and redirecting back with
568542
* the credentials.
569543
* @param {Object} options See `BaseBrowserFlow` for options.
570-
* @constructor
571544
*/
572545
new (options: any): RedirectFlow;
573546
}
@@ -581,7 +554,6 @@ declare namespace asana {
581554
* An Oauth flow that runs in the browser and requests user authorization by
582555
* popping up a window and prompting the user.
583556
* @param {Object} options See `BaseBrowserFlow` for options.
584-
* @constructor
585557
*/
586558
new (options: any): PopupFlow;
587559
}
@@ -608,7 +580,6 @@ declare namespace asana {
608580
* instructions to output to the user. Passed the authorize url.
609581
* @option {String function()} [prompt] String to output immediately before
610582
* waiting for a line from stdin.
611-
* @constructor
612583
*/
613584
new (options: any): NativeFlow;
614585
}
@@ -653,7 +624,6 @@ declare namespace asana {
653624
* directory of the extension to the receiver page. This is an HTML file
654625
* that has been made web-accessible, and that calls the receiver method
655626
* `Asana.auth.ChromeExtensionFlow.runReceiver();`.
656-
* @constructor
657627
*/
658628
new (options: any): ChromeExtensionFlow;
659629
}
@@ -676,7 +646,6 @@ declare namespace asana {
676646
* @option {String} [redirectUri] The URL that Asana should redirect to once
677647
* user authorization is complete. Defaults to the URL configured in
678648
* the app, and if none then the current page URL.
679-
* @constructor
680649
*/
681650
new (options: any): BaseBrowserFlow;
682651
}
@@ -826,7 +795,6 @@ declare namespace asana {
826795
* An _attachment_ object represents any file attached to a task in Asana,
827796
* whether it's an uploaded file or one associated via a third-party service
828797
* such as Dropbox or Google Drive.
829-
* @class
830798
* @param {Dispatcher} dispatcher The API dispatcher
831799
*/
832800
interface Attachments extends TopLevelResource {
@@ -935,7 +903,6 @@ declare namespace asana {
935903
*
936904
* Sync tokens always expire after 24 hours, but may expire sooner, depending on
937905
* load on the service.
938-
* @class
939906
* @param {Dispatcher} dispatcher The API dispatcher
940907
*/
941908
interface Events extends TopLevelResource {
@@ -1022,7 +989,6 @@ declare namespace asana {
1022989
* change the team of a project via the API. Non-organization workspaces do not
1023990
* have teams and so you should not specify the team of project in a
1024991
* regular workspace.
1025-
* @class
1026992
* @param {Dispatcher} dispatcher The API dispatcher
1027993
*/
1028994
interface Projects extends TopLevelResource {
@@ -1421,7 +1387,6 @@ declare namespace asana {
14211387
*
14221388
* Stories are a form of history in the system, and as such they are read-only.
14231389
* Once generated, it is not possible to modify a story.
1424-
* @class
14251390
* @param {Dispatcher} dispatcher The API dispatcher
14261391
*/
14271392
interface Stories extends TopLevelResource {
@@ -1510,7 +1475,6 @@ declare namespace asana {
15101475
* simplify them in the future so it is not encouraged to rely too heavily on it.
15111476
* Unlike projects, tags do not provide any ordering on the tasks they
15121477
* are associated with.
1513-
* @class
15141478
* @param {Dispatcher} dispatcher The API dispatcher
15151479
*/
15161480
interface Tags extends TopLevelResource {
@@ -1810,7 +1774,6 @@ declare namespace asana {
18101774
* centered. In the Asana application, multiple tasks populate the middle pane
18111775
* according to some view parameters, and the set of selected tasks determines
18121776
* the more detailed information presented in the details pane.
1813-
* @class
18141777
* @param {Dispatcher} dispatcher The API dispatcher
18151778
*/
18161779
interface Tasks extends TopLevelResource {
@@ -2301,7 +2264,6 @@ declare namespace asana {
23012264
/**
23022265
* A _team_ is used to group related projects and people together within an
23032266
* organization. Each project in an organization is associated with a team.
2304-
* @class
23052267
* @param {Dispatcher} dispatcher The API dispatcher
23062268
*/
23072269
interface Teams extends TopLevelResource {
@@ -2417,7 +2379,6 @@ declare namespace asana {
24172379
* Like other objects in the system, users are referred to by numerical IDs.
24182380
* However, the special string identifier `me` can be used anywhere
24192381
* a user ID is accepted, to refer to the current authenticated user.
2420-
* @class
24212382
* @param {Dispatcher} dispatcher The API dispatcher
24222383
*/
24232384
interface Users extends TopLevelResource {
@@ -2555,7 +2516,6 @@ declare namespace asana {
25552516
*
25562517
* Webhooks themselves contain only the information necessary to deliver the
25572518
* events to the desired target as they are generated.
2558-
* @class
25592519
* @param {Dispatcher} dispatcher The API dispatcher
25602520
*/
25612521
interface Webhooks extends TopLevelResource {
@@ -2671,7 +2631,6 @@ declare namespace asana {
26712631
* using workspace-based APIs for organizations. Currently, and until after
26722632
* some reasonable grace period following any further announcements, you can
26732633
* still reference organizations in any `workspace` parameter.
2674-
* @class
26752634
* @param {Dispatcher} dispatcher The API dispatcher
26762635
*/
26772636
interface Workspaces extends TopLevelResource {
@@ -2829,7 +2788,6 @@ declare namespace asana {
28292788
* when they can address them. When building an integration it’s worth noting that tasks with due dates
28302789
* will automatically move through assignee_status states as their due dates approach; read up on task
28312790
* auto-promotion, https://asana.com/guide/help/fundamentals/my-tasks#gl-auto-promote, for more information
2832-
* @class
28332791
* @param {Dispatcher} dispatcher The API dispatcher
28342792
*/
28352793
interface UserTaskLists extends TopLevelResource {
@@ -2897,7 +2855,7 @@ declare namespace asana {
28972855
new (dispatcher: Dispatcher): Resource;
28982856

28992857
/**
2900-
* @type {number} Default number of items to get per page.
2858+
* Default number of items to get per page.
29012859
*/
29022860
DEFAULT_PAGE_LIMIT: number;
29032861

@@ -2934,7 +2892,6 @@ declare namespace asana {
29342892
* Base class for a resource accessible via the API. Uses a `Dispatcher` to
29352893
* access the resources.
29362894
* @param {Dispatcher} dispatcher
2937-
* @constructor
29382895
*/
29392896
interface TopLevelResource {
29402897
/**

0 commit comments

Comments
 (0)