Skip to content

Latest commit

 

History

History
41 lines (29 loc) · 1.72 KB

MIGRATION_INK.md

File metadata and controls

41 lines (29 loc) · 1.72 KB

Migration INK

Versioning with ink + inkjs is complicated.

Ink 1.2.0

Ink 1.0, new version inkjs

Ink 0.9 -> Ink 1.0

First version of this lib was using:

New version is for:

Design choice on supporting 0.9

The problem is the schema of the ink JSON state changed.
It's fine, this is internal to ink and they just have to be careful with the API.
But at the same time, it was very nice getting everything out of the state.
Version 1.0 is now using the JS API to get its data (but it is still possible to use the JSON state if needed).

In this inkjs v2.0.0 version, variablesState is not showing the unchanged internal values.
But can still be used to inject data from the outside.

By naming convention, Ink v1.0 should be more stable than Ink v0.9 (and then also inkjs). I decided I will not support the ink state struct for Ink v0.9.
If it changes again in the future, I will think of supporting multiple version.