Skip to content

Commit eb13902

Browse files
chore(deps-dev): bump eslint-plugin-jsdoc from 60.4.1 to 60.7.0 (#11394)
* chore(deps-dev): bump eslint-plugin-jsdoc from 60.4.1 to 60.7.0 Bumps [eslint-plugin-jsdoc](https://github.com/gajus/eslint-plugin-jsdoc) from 60.4.1 to 60.7.0. - [Release notes](https://github.com/gajus/eslint-plugin-jsdoc/releases) - [Changelog](https://github.com/gajus/eslint-plugin-jsdoc/blob/main/.releaserc) - [Commits](gajus/eslint-plugin-jsdoc@v60.4.1...v60.7.0) --- updated-dependencies: - dependency-name: eslint-plugin-jsdoc dependency-version: 60.7.0 dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> * fix(lint): remove module filepath for same file - replace with import() for external module file --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: jNullj <[email protected]>
1 parent 7118ebf commit eb13902

File tree

10 files changed

+48
-48
lines changed

10 files changed

+48
-48
lines changed

badge-maker/lib/xml.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ export class XmlElement {
3131
* @param {object} attrs Refer to individual attrs
3232
* @param {string} attrs.name
3333
* Name of the XML tag
34-
* @param {Array.<string|module:badge-maker/lib/xml~XmlElement>} [attrs.content=[]]
34+
* @param {Array.<string|XmlElement>} [attrs.content=[]]
3535
* Array of objects to render inside the tag. content may contain a mix of
3636
* string and XmlElement objects. If content is `[]` or omitted the
3737
* element will be rendered as a self-closing element.

core/base-service/base.js

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ class BaseService {
9191
* Route to mount this service on
9292
*
9393
* @abstract
94-
* @type {module:core/base-service/base~Route}
94+
* @type {Route}
9595
*/
9696
static get route() {
9797
throw new Error(`Route not defined for ${this.name}`)
@@ -133,7 +133,7 @@ class BaseService {
133133
* this._request(this.authHelper.withBasicAuth({ url, schema, options }))
134134
*
135135
* @abstract
136-
* @type {module:core/base-service/base~Auth}
136+
* @type {Auth}
137137
*/
138138
static auth = undefined
139139

@@ -143,7 +143,7 @@ class BaseService {
143143
*
144144
* @abstract
145145
* @see https://swagger.io/specification/#paths-object
146-
* @type {module:core/base-service/service-definitions~openApiSchema}
146+
* @type {import('./service-definitions').openApiSchema}
147147
*/
148148
static openApi = {}
149149

@@ -171,7 +171,7 @@ class BaseService {
171171
* These defaults are used if the value is neither included in the service data
172172
* from the handler nor overridden by the user via query parameters.
173173
*
174-
* @type {module:core/base-service/base~DefaultBadgeData}
174+
* @type {DefaultBadgeData}
175175
*/
176176
static defaultBadgeData = {}
177177

@@ -320,7 +320,7 @@ class BaseService {
320320
* @param {object} namedParams Params parsed from route pattern
321321
* defined in this.route.pattern or this.route.capture
322322
* @param {object} queryParams Params parsed from the query string
323-
* @returns {module:core/base-service/base~Badge}
323+
* @returns {Badge}
324324
* badge Object validated against serviceDataSchema
325325
*/
326326
async handle(namedParams, queryParams) {

core/base-service/errors.js

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ class ShieldsRuntimeError extends Error {
3232
}
3333

3434
/**
35-
* @param {module:core/base-service/errors~RuntimeErrorProps} props
35+
* @param {RuntimeErrorProps} props
3636
* Refer to individual attrs
3737
* @param {string} message Exception message for debug purposes
3838
*/
@@ -61,7 +61,7 @@ class NotFound extends ShieldsRuntimeError {
6161
}
6262

6363
/**
64-
* @param {module:core/base-service/errors~RuntimeErrorProps} props
64+
* @param {RuntimeErrorProps} props
6565
* Refer to individual attrs
6666
*/
6767
constructor(props = {}) {
@@ -88,7 +88,7 @@ class InvalidResponse extends ShieldsRuntimeError {
8888
}
8989

9090
/**
91-
* @param {module:core/base-service/errors~RuntimeErrorProps} props
91+
* @param {RuntimeErrorProps} props
9292
* Refer to individual attrs
9393
*/
9494
constructor(props = {}) {
@@ -114,7 +114,7 @@ class Inaccessible extends ShieldsRuntimeError {
114114
}
115115

116116
/**
117-
* @param {module:core/base-service/errors~RuntimeErrorProps} props
117+
* @param {RuntimeErrorProps} props
118118
* Refer to individual attrs
119119
*/
120120
constructor(props = {}) {
@@ -139,7 +139,7 @@ class ImproperlyConfigured extends ShieldsRuntimeError {
139139
}
140140

141141
/**
142-
* @param {module:core/base-service/errors~RuntimeErrorProps} props
142+
* @param {RuntimeErrorProps} props
143143
* Refer to individual attrs
144144
*/
145145
constructor(props = {}) {
@@ -165,7 +165,7 @@ class InvalidParameter extends ShieldsRuntimeError {
165165
}
166166

167167
/**
168-
* @param {module:core/base-service/errors~RuntimeErrorProps} props
168+
* @param {RuntimeErrorProps} props
169169
* Refer to individual attrs
170170
*/
171171
constructor(props = {}) {
@@ -190,7 +190,7 @@ class Deprecated extends ShieldsRuntimeError {
190190
}
191191

192192
/**
193-
* @param {module:core/base-service/errors~RuntimeErrorProps} props
193+
* @param {RuntimeErrorProps} props
194194
* Refer to individual attrs
195195
*/
196196
constructor(props) {

core/base-service/openapi.js

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -223,8 +223,8 @@ function category2openapi({ category, services, sort = false }) {
223223
/**
224224
* Helper function for assembling an OpenAPI path parameter object
225225
*
226-
* @param {module:core/base-service/openapi~PathParamInput} param Input param
227-
* @returns {module:core/base-service/openapi~OpenApiParam} OpenAPI Parameter Object
226+
* @param {PathParamInput} param Input param
227+
* @returns {OpenApiParam} OpenAPI Parameter Object
228228
* @see https://swagger.io/specification/#parameter-object
229229
*/
230230
function pathParam({
@@ -253,9 +253,9 @@ function pathParam({
253253
* ]
254254
* ```
255255
*
256-
* @param {...module:core/base-service/openapi~PathParamInput} params Input params
257-
* @returns {Array.<module:core/base-service/openapi~OpenApiParam>} Array of OpenAPI Parameter Objects
258-
* @see {@link module:core/base-service/openapi~pathParam}
256+
* @param {...PathParamInput} params Input params
257+
* @returns {Array.<OpenApiParam>} Array of OpenAPI Parameter Objects
258+
* @see {@link pathParam}
259259
*/
260260
function pathParams(...params) {
261261
return params.map(param => pathParam(param))
@@ -264,8 +264,8 @@ function pathParams(...params) {
264264
/**
265265
* Helper function for assembling an OpenAPI query parameter object
266266
*
267-
* @param {module:core/base-service/openapi~QueryParamInput} param Input param
268-
* @returns {module:core/base-service/openapi~OpenApiParam} OpenAPI Parameter Object
267+
* @param {QueryParamInput} param Input param
268+
* @returns {OpenApiParam} OpenAPI Parameter Object
269269
* @see https://swagger.io/specification/#parameter-object
270270
*/
271271
function queryParam({
@@ -299,9 +299,9 @@ function queryParam({
299299
* ]
300300
* ```
301301
*
302-
* @param {...module:core/base-service/openapi~QueryParamInput} params Input params
303-
* @returns {Array.<module:core/base-service/openapi~OpenApiParam>} Array of OpenAPI Parameter Objects
304-
* @see {@link module:core/base-service/openapi~queryParam}
302+
* @param {...QueryParamInput} params Input params
303+
* @returns {Array.<OpenApiParam>} Array of OpenAPI Parameter Objects
304+
* @see {@link queryParam}
305305
*/
306306
function queryParams(...params) {
307307
return params.map(param => queryParam(param))

core/service-test-runner/create-service-tester.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ import ServiceTester from './service-tester.js'
1515
* This can't be used for `.service.js` files which export more than one
1616
* service.
1717
*
18-
* @returns {module:core/service-test-runner/service-tester~ServiceTester}
18+
* @returns {ServiceTester}
1919
* ServiceTester instance
2020
*/
2121
async function createServiceTester() {

core/service-test-runner/service-tester.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ class ServiceTester {
4646
*
4747
* @param {Function} ServiceClass
4848
* A class that extends base-service/base.BaseService
49-
* @returns {module:core/service-test-runner/service-tester~ServiceTester}
49+
* @returns {ServiceTester}
5050
* ServiceTester for ServiceClass
5151
*/
5252
static forServiceClass(ServiceClass) {

core/token-pooling/token-pool.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -195,9 +195,9 @@ class TokenPool {
195195
/**
196196
* compareTokens
197197
*
198-
* @param {module:core/token-pooling/token-pool~Token} first first token to compare
199-
* @param {module:core/token-pooling/token-pool~Token} second second token to compare
200-
* @returns {module:core/token-pooling/token-pool~Token} The token whose current rate allotment is expiring soonest.
198+
* @param {Token} first first token to compare
199+
* @param {Token} second second token to compare
200+
* @returns {Token} The token whose current rate allotment is expiring soonest.
201201
*/
202202
static compareTokens(first, second) {
203203
return second.nextReset - first.nextReset
@@ -295,7 +295,7 @@ class TokenPool {
295295
* new use-remaining count and next-reset time. Invoke `invalidate()` to
296296
* indicate it should not be reused.
297297
*
298-
* @returns {module:core/token-pooling/token-pool~Token} token
298+
* @returns {Token} token
299299
*/
300300
next() {
301301
let token = this.currentBatch.token

package-lock.json

Lines changed: 17 additions & 17 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@
173173
"eslint-plugin-cypress": "5.1.1",
174174
"eslint-plugin-icedfrisby": "0.2.0",
175175
"eslint-plugin-import": "2.32.0",
176-
"eslint-plugin-jsdoc": "60.4.1",
176+
"eslint-plugin-jsdoc": "60.7.0",
177177
"eslint-plugin-mocha": "11.1.0",
178178
"eslint-plugin-prettier": "5.5.4",
179179
"eslint-plugin-promise": "7.2.1",

services/website-status.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ const queryParamSchema = Joi.object({
2525
* up_message, down_message, up_color and down_color
2626
* query params
2727
*
28-
* @type {Array.<module:core/base-service/openapi~OpenApiParam>}
28+
* @type {Array.<import('../base-service/openapi').OpenApiParam>}
2929
*/
3030
const queryParams = qP(
3131
{ name: 'up_message', example: 'online' },

0 commit comments

Comments
 (0)