Skip to content

Commit fcae1d9

Browse files
committed
fix most of the jsdoc lints
There are some left for missing docs in src/__tests__/utils/mockStation.ts
1 parent b613afb commit fcae1d9

File tree

2 files changed

+2
-14
lines changed

2 files changed

+2
-14
lines changed

src/constants.ts

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
/**
2-
* @public
32
*/
43
export const StationSearchOrder = {
54
name: 'name',
@@ -22,7 +21,6 @@ export const StationSearchOrder = {
2221
} as const
2322

2423
/**
25-
* @public
2624
*/
2725
export const StationSearchType = {
2826
byUuid: 'byUuid',
@@ -42,7 +40,6 @@ export const StationSearchType = {
4240
} as const
4341

4442
/**
45-
* @public
4643
*/
4744
export type StationResponse = {
4845
changeuuid: string
@@ -74,7 +71,6 @@ export type StationResponse = {
7471
}
7572

7673
/**
77-
* @public
7874
*/
7975
export type Station = {
8076
changeId: string
@@ -106,7 +102,6 @@ export type Station = {
106102
}
107103

108104
/**
109-
* @public
110105
*/
111106
export type StationQuery = {
112107
offset?: number
@@ -118,7 +113,6 @@ export type StationQuery = {
118113
}
119114

120115
/**
121-
* @public
122116
*/
123117
export type AdvancedStationQuery = {
124118
name?: string
@@ -140,7 +134,6 @@ export type AdvancedStationQuery = {
140134
} & StationQuery
141135

142136
/**
143-
* @public
144137
*/
145138
export type Query = {
146139
order?: 'name' | 'stationcount'
@@ -150,19 +143,16 @@ export type Query = {
150143

151144
// valid for country codes also
152145
/**
153-
* @public
154146
*/
155147
export type CountryResult = {
156148
name: string
157149
stationcount: number
158150
}
159151

160152
/**
161-
* @public
162153
*/
163154
export type TagResult = CountryResult
164155
/**
165-
* @public
166156
*/
167157
export type CountryStateResult = CountryResult & {
168158
country: string

src/radioBrowser.ts

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ import {
1212

1313
/**
1414
* Query the radio browser api.
15-
* @public
1615
*/
1716
export class RadioBrowserApi {
1817
static version = __VERSION__
@@ -38,8 +37,7 @@ export class RadioBrowserApi {
3837

3938
/**
4039
* Resolves API base url this will be the default for all class instances.
41-
* @param autoSet - Automatically set first resolved base url
42-
* @param config- Fetch configuration
40+
* @param config - Fetch configuration
4341
* @returns Array of objects with the ip and name of the api server
4442
*/
4543
async resolveBaseUrl(
@@ -154,7 +152,7 @@ export class RadioBrowserApi {
154152

155153
/**
156154
* Gets all available languages
157-
* @param language- Limit results to particular language
155+
* @param language - Limit results to particular language
158156
* @param query - Query
159157
* @param fetchConfig - Fetch configuration
160158
* @returns Array of language results

0 commit comments

Comments
 (0)