Class SearchHandler

Hierarchy

SearchHandler

Index

Methods

autocomplete searchComments searchCommentsPaginated searchCommentsUnpaginated searchVideos searchVideosPaginated searchVideosUnpaginated

Methods

autocomplete

autocomplete(query, filter?): Promise<AutocompleteResponse[]>
Experimental
As of 1.1.0 Query the autocomplete API of Holodex, do not use unless absolutely necessary. This is an undocumented endpoint and may change or stop working at any time.
Parameters
- query: string
  
  What to search for
- Optional filter: "channel" | "topic"
  
  Filter out to a specific type
Returns Promise<AutocompleteResponse[]>
- Defined in client/search.ts:151

searchComments

searchComments(searchParams): Promise<PaginatedVideosWithChannelAndCommentData | VideoWithChannelAndComment[]>
Parameters
- searchParams: CommentSearchQuery
  
  object containing the query to search for
Returns Promise<PaginatedVideosWithChannelAndCommentData | VideoWithChannelAndComment[]>
- Defined in client/search.ts:138

searchCommentsPaginated

searchCommentsPaginated(searchParams): Promise<PaginatedVideosWithChannelAndCommentData>
Parameters
- searchParams: CommentSearchQuery
  
  object containing the query to search for
Returns Promise<PaginatedVideosWithChannelAndCommentData>
- Defined in client/search.ts:112

searchCommentsUnpaginated

searchCommentsUnpaginated(searchParams): Promise<VideoWithChannelAndComment[]>
Flexible endpoint to search for comments in videos fufilling multiple conditions. Descriptions with "any" implies an OR condition, and "all" implies a AND condition.
Parameters
- searchParams: CommentSearchQuery
  
  object containing the query to search for
Returns Promise<VideoWithChannelAndComment[]>
- Defined in client/search.ts:89

searchVideos

searchVideos(searchParams): Promise<VideoWithChannel[] | PaginatedVideosWithChannelData>
Parameters
- searchParams: VideoSearchQuery
  
  object containing the query to search for
Returns Promise<VideoWithChannel[] | PaginatedVideosWithChannelData>
- Defined in client/search.ts:79

searchVideosPaginated

searchVideosPaginated(searchParams): Promise<PaginatedVideosWithChannelData>
Parameters
- searchParams: VideoSearchQuery
  
  object containing the query to search for
Returns Promise<PaginatedVideosWithChannelData>
- Defined in client/search.ts:53

searchVideosUnpaginated

searchVideosUnpaginated(searchParams): Promise<VideoWithChannel[]>
Flexible endpoint to search for videos fufilling multiple conditions. Descriptions with "any" implies an OR condition, and "all" implies a AND condition. Searching for topics and clips is not supported, because clips do not contain topic_ids
Parameters
- searchParams: VideoSearchQuery
  
  object containing the query to search for
Returns Promise<VideoWithChannel[]>
- Defined in client/search.ts:30

Generated using TypeDoc