[doc] Add 3.0-version migration docs #337
Merged
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
kobawan
added
documentation
chore
kobawan
commented
Nov 8, 2019
docs/api/3.0-migration.md
Outdated
| @@ -215,3 +215,39 @@ Due to a bug where `originalUrl` was being assigned not as the root url, but the | |||
| * Parameter `originalUrl` from `resolveWrappers` has been correctly renamed to `previousUrl`: `resolveWrappers(ad, wrapperDepth, previousUrl)` | |||
| * `resolveAds` param `originalUrl` in `options` object has been renamed to `previousUrl`. It also can be passed `url` into `options`. For example: `resolveAds(ads = [], { url, previousUrl })` | |||
| * `options` parameter in `VASTParser` `parse` function now expects `previousUrl` instead of `originalUrl`. It also can be passed `url` into `options`. | |||
|
|
|||
| #### Improvement for vast parser to trigger warnings event logs | |||
There was a problem hiding this comment.
this isn't actually a breaking change, because it is in a util file not exported in the module
|
The fixes for Windows in #340 require node 10.12+ so perhaps you could add a word that min version of node is changed. |
dm-player
force-pushed
the
3.0-migration
branch
from
5212b0c
to
05b4f73
Compare
ZacharieTFR
changed the base branch from
3.0-version
to
3.0-documentation-update
clementFrancon
approved these changes
Sep 25, 2020
Co-authored-by: Françon Clément <clement.francon@dailymotion.com>
Co-authored-by: Françon Clément <clement.francon@dailymotion.com>
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.
Description
To help migrating from version 2 to version 3.
Type