refactor(ytmusic): rename SearchFilters interface to MusicSearchFilters

This allows us to expose the types from the InnerTube class as there is another interface there named `SearchFilters`
This commit is contained in:
LuanRT
2023-03-15 19:24:17 -03:00
parent 20d84265b5
commit 7ca0607004
3 changed files with 5 additions and 4 deletions

View File

@@ -77,7 +77,7 @@ Searches on YouTube Music.
| Param | Type | Description |
| --- | --- | --- |
| query | `string` | Search query |
| filters? | `object` | Search filters |
| filters? | `MusicSearchFilters` | Search filters |
<details>
<summary>Search Filters</summary>

View File

@@ -28,9 +28,9 @@ import type { ObservedArray, YTNode } from '../parser/helpers.js';
import type Actions from './Actions.js';
import type Session from './Session.js';
export type SearchFilters = {
export interface MusicSearchFilters {
type?: 'all' | 'song' | 'video' | 'album' | 'playlist' | 'artist';
};
}
class Music {
#session: Session;
@@ -112,7 +112,7 @@ class Music {
* @param query - Search query.
* @param filters - Search filters.
*/
async search(query: string, filters: SearchFilters = {}): Promise<Search> {
async search(query: string, filters: MusicSearchFilters = {}): Promise<Search> {
throwIfMissing({ query });
const payload: {

View File

@@ -7,6 +7,7 @@ export { default as Proto } from '../proto/index.js';
export * as Types from '../types/index.js';
export * from '../utils/index.js';
export * from '../Innertube.js';
export { default as Innertube } from '../Innertube.js';
export default Innertube;