Skip to main content

areVersionsCompatible

@a16njs/models

@a16njs/models / areVersionsCompatible

Function: areVersionsCompatible()

areVersionsCompatible(readerVersion, fileVersion): boolean

Defined in: version.ts:83

Check if two IR versions are compatible.

Compatibility rules (forward compatibility guarantee):

  1. Major versions must match
  2. Stability must match (alpha != beta != stable)
  3. Reader revision >= file revision (newer reader can read older files)

Parameters​

readerVersion​

string

The version of the reader (current a16n version)

fileVersion​

string

The version found in the IR file

Returns​

boolean

true if compatible, false otherwise

Example​

areVersionsCompatible('v1beta2', 'v1beta1') // true (reader newer)
areVersionsCompatible('v1beta1', 'v1beta2') // false (file too new)
areVersionsCompatible('v2beta1', 'v1beta1') // false (major mismatch)
areVersionsCompatible('v1stable1', 'v1beta1') // false (stability mismatch)