Search Types

type SearchType = (typeof ExpectedTypes)[number];

// "any" | "video" | "channel" | "playlist" | "movie" | "live"

type SortType = (typeof ExpectedSorts)[number];

// "relevance" | "upload_date" | "view_count" | "rating"

interface SearchOptions {
  type?: SearchType;
  sort?: SortType;
  limit?: number;
}

interface SearchResultMeta {
  estimatedPages: number;
  estimatedResults: number;
  hasNextPage: boolean;
  ytPage: number;
  ytPageSize: number;
  userPage: number;
  userPageSize: number;
  searchType: SearchType;
  sortType: SortType;
  query: string;
  resultRange: [number, number];
}

interface SearchResult extends SearchResultBuffer {
  metadata: SearchResultMeta;
  nextPage: () => Promise<SearchResult | null>;
}