Migration guide from v2 to v3

[hossammourad]

I'm working on a codebase that's on v2 of the package, and I want to upgrade to v3, is there any breaking changes between the two versions I should be aware of? any guide that I can use to facilitate the migration? I looked up the README and the existing issues but found nothing.

I'm currently using v2 as following:

asciinema.player.js.CreatePlayer(this.ref, this.props.src, this.props);
asciinema.player.js.UnmountPlayer(this.ref);

What's the equivalent of that in v3?

[ku1ik]

Right, v2-v3 migration doc would be nice indeed. Meanwhile translation would be as follows:

import * as AsciinemaPlayer from 'asciinema-player';
const player = AsciinemaPlayer.create(this.props.src, this.ref, this.props);
player.dispose();

[ku1ik]

I created the upgrade guide here: https://docs.asciinema.org/manual/player/upgrading/#upgrading-from-v2-to-v3