Skip to content

v2.0.0

Compare
Choose a tag to compare
@Aaronius Aaronius released this 02 Dec 02:59
· 271 commits to master since this release

PenPal has been renamed to Penpal (notice the capitalization). For those using the npm package, the package name was and is still penpal so this shouldn't be a breaking change for you. For those using the UMD distribution, the global variable set on window is now Penpal instead of PenPal.

The connectToChild and connectToParent methods no longer return a promise. They instead return an object that has a promise property. In the case of connectToChild, the object also has iframe and destroy properties. The iframe and destroy properties were previously provided on the child object that came through the resolved promise once the connection was established. It turns out that it's important to be able to destroy/cancel the process of connecting to the child before the connection has been established. This was the driving force behind releasing a major version.