Skip to content

v2.0.0

Choose a tag to compare

@lsphillips lsphillips released this 24 Feb 09:11
· 116 commits to main since this release

Added

  • Introduced the bps.build() function that enables you to build an instruction set from a source and a desired target.
  • Introduced the bps.serialize() function that enables you to serialize an instruction set into a binary BPS buffer.
  • Introduced the create command in the CLI tool that enables you to create a BPS patch file from a source file and a desired target file.

Changed

  • The result of bps.parse() has been changed, it now has a different shape. Instead of this object structure:
    {
      sourceSize : 0,
      sourceChecksum : 0,
      targetSize : 0,
      targetChecksum : 0,
      actions : [],
      patchChecksum : 0
    }
    
    You will instead recieve an object with this structure:
    {
      instructions : {
        sourceSize : 0,
        sourceChecksum : 0,
        targetSize : 0,
        targetChecksum : 0,
        actions : []
      },
      checksum : 0
    }
    
  • The bps.patch() function no longer takes the entire patch previously returned by bps.parse() but instead just the instruction set.