Skip to content

Commit

Permalink
fix most of the jsdoc lints
Browse files Browse the repository at this point in the history
There are some left for missing docs in src/__tests__/utils/mockStation.ts
  • Loading branch information
SamB committed Aug 17, 2024
1 parent b613afb commit fcae1d9
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 14 deletions.
10 changes: 0 additions & 10 deletions src/constants.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
/**
* @public
*/
export const StationSearchOrder = {
name: 'name',
Expand All @@ -22,7 +21,6 @@ export const StationSearchOrder = {
} as const

/**
* @public
*/
export const StationSearchType = {
byUuid: 'byUuid',
Expand All @@ -42,7 +40,6 @@ export const StationSearchType = {
} as const

/**
* @public
*/
export type StationResponse = {
changeuuid: string
Expand Down Expand Up @@ -74,7 +71,6 @@ export type StationResponse = {
}

/**
* @public
*/
export type Station = {
changeId: string
Expand Down Expand Up @@ -106,7 +102,6 @@ export type Station = {
}

/**
* @public
*/
export type StationQuery = {
offset?: number
Expand All @@ -118,7 +113,6 @@ export type StationQuery = {
}

/**
* @public
*/
export type AdvancedStationQuery = {
name?: string
Expand All @@ -140,7 +134,6 @@ export type AdvancedStationQuery = {
} & StationQuery

/**
* @public
*/
export type Query = {
order?: 'name' | 'stationcount'
Expand All @@ -150,19 +143,16 @@ export type Query = {

// valid for country codes also
/**
* @public
*/
export type CountryResult = {
name: string
stationcount: number
}

/**
* @public
*/
export type TagResult = CountryResult
/**
* @public
*/
export type CountryStateResult = CountryResult & {
country: string
Expand Down
6 changes: 2 additions & 4 deletions src/radioBrowser.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ import {

/**
* Query the radio browser api.
* @public
*/
export class RadioBrowserApi {
static version = __VERSION__
Expand All @@ -38,8 +37,7 @@ export class RadioBrowserApi {

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

/**
* Gets all available languages
* @param language- Limit results to particular language
* @param language - Limit results to particular language
* @param query - Query
* @param fetchConfig - Fetch configuration
* @returns Array of language results
Expand Down

0 comments on commit fcae1d9

Please sign in to comment.