fix(engines): remove unnecessary array for search method
#17
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
BREAKING CHANGE: player.search() returns a single search result or null instead of an array. BREAKING CHANGE: Changed type PlayerEngine and all pre-built engines (youtube, spotify and file) to return a single search result or null when calling search()
github-actions bot
pushed a commit
that referenced
this pull request
May 14, 2023
# [2.0.0-rc.1](v1.5.2...v2.0.0-rc.1) (2023-05-14) ### Bug Fixes * **engines:** remove unnecessary array for `search` method ([#17](#17)) ([503ab0b](503ab0b)) ### chore * migrate to pnpm ([#14](#14)) ([a5f7ec7](a5f7ec7)) ### Features * support both ESM and CommonJS ([#15](#15)) ([01218cf](01218cf)) * update example discord bot ([#19](#19)) ([480a0ea](480a0ea)) ### BREAKING CHANGES * **engines:** Changed type `PlayerEngine` and all pre-built engines (youtube, spotify and file) to return `SearchResult|null` instead of `SearchResult[]`. The previous return value just wrapped the search result into an array so its length was always 1. Thats why it has been changed. * **engines:** `player.search()` now returns `SearchResult|null` instead of `SearchResult[]` * bump min required version of `@discordjs/opus` from `0.5.1` to `0.8.0` * bump min required version of `discord.js` from `14.5.0` to `14.8.0` * add peerDependency `discord-api-types` with min version `0.37.0`
|
🎉 This PR is included in version 2.0.0-rc.1 🎉 The release is available on: Your semantic-release bot 📦🚀 |
github-actions bot
pushed a commit
that referenced
this pull request
Jun 13, 2023
# [2.0.0](v1.5.2...v2.0.0) (2023-06-13) ### Bug Fixes * downgrade music-metadata to support commonjs ([#23](#23)) ([039a29e](039a29e)) * **engines:** remove unnecessary array for `search` method ([#17](#17)) ([503ab0b](503ab0b)) ### chore * migrate to pnpm ([#14](#14)) ([a5f7ec7](a5f7ec7)) ### Features * support both ESM and CommonJS ([#15](#15)) ([01218cf](01218cf)) * update example discord bot ([#19](#19)) ([480a0ea](480a0ea)) ### BREAKING CHANGES * **engines:** Changed type `PlayerEngine` and all pre-built engines (youtube, spotify and file) to return `SearchResult|null` instead of `SearchResult[]`. The previous return value just wrapped the search result into an array so its length was always 1. Thats why it has been changed. * **engines:** `player.search()` now returns `SearchResult|null` instead of `SearchResult[]` * bump min required version of `@discordjs/opus` from `0.5.1` to `0.8.0` * bump min required version of `discord.js` from `14.5.0` to `14.8.0` * add peerDependency `discord-api-types` with min version `0.37.0`
|
🎉 This PR is included in version 2.0.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
BREAKING CHANGE: Changed type
PlayerEngineand all pre-built engines (youtube, spotify and file) to returnSearchResult|nullinstead ofSearchResult[]. The previous return value just wrapped the search result into an array so its length was always 1. Thats why it has been changed.BREAKING CHANGE:
player.search()now returnsSearchResult|nullinstead ofSearchResult[]