Notable changes to this project are documented in this file. The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

Breaking changes:

• Invert module dependency of Node.Buffer.Class (#51 by @JordanMartinez)

  The MonadBuffer type class was seemingly used to expose an API for both Buffer and STBuffer without duplicating FFI. Members of the class (e.g. size, toString, etc.) had type inference issues due to this class-based approach.

  Now, both Buffer and STBuffer expose the same API but with their type signatures hard-coded to Effect and ST, respectively, thereby improving type inference. MonadBuffer instances for both types were moved into the Node/Buffer/Class.purs file.

  One can migrate their code by either removing the usage of MonadClass in their code if it was only used to get the needed API for a given type (e.g. Buffer) or update their module imports from Node.Buffer/Node.Buffer.ST to Node.Buffer.Class.

• Encoding type - dropped encodings that are only aliases (#51 by @JordanMartinez)

  • Binary, an alias for Latin1 was dropped.
  • UCS2, an alias for UTF16LE was dropped.

• Encoding type - added Base64Url encoding (supported in Node 18) (#51 by @JordanMartinez)

New features:

• Added the following APIs

  • Buffer.alloc, Buffer.allocUnsafe, Buffer.allocUnsafeSlow
  • Buffer.poolSize, Buffer.setPoolSize
  • buffer.swap16, buffer.swap32, buffer.swap64
  • buffer.compare: https://nodejs.org/docs/latest-v18.x/api/buffer.html#bufcomparetarget-targetstart-targetend-sourcestart-sourceend
  • buffer.toString(encoding, start, end): https://nodejs.org/docs/latest-v18.x/api/buffer.html#buftostringencoding-start-end
  • constants:
    • INSPECT_MAX_BYTES: https://nodejs.org/docs/latest-v18.x/api/buffer.html#bufferinspect_max_bytes
    • MAX_LENGTH: https://nodejs.org/docs/latest-v18.x/api/buffer.html#bufferconstantsmax_length
    • MAX_STRING_LENGTH: https://nodejs.org/docs/latest-v18.x/api/buffer.html#bufferconstantsmax_string_length

Bugfixes:

Other improvements:

• Update all FFI to use uncurried functions (#51 by @JordanMartinez)
• Removal of the Internal.purs file (#51 by @JordanMartinez)

Breaking changes:

• Update project and deps to PureScript v0.15.0 (#46 by @sigma-andex and @JordanMartinez)

New features:

Bugfixes:

Other improvements:

Other improvements:

• Fix warnings revealed by v0.14.1 PS release (#44 by @JordanMartinez)

Breaking changes:

• Updated code for PureScript 0.14 and dropped the proxy dependency as the proxy library has been migrated into prelude (#39).

Other improvements:

• Removed primes from the concat' function in FFI in preparation for ES modules support (#36)
• Migrated CI to use GitHub Actions and updated installation instructions to use Spago (#38)
• Stopped returning empty objects in foreign implementations for functions which return Unit for a small performance benefit (#40)
• Added a CHANGELOG.md file and pull request template to the repository (#41)

• Add a MutableBuffer type class with instances for both Effect and ST, to allow mutating buffers in either monad, and potentially other monads too (#24, @Dretch)
• Remove the Show Buffer instance, as reading from a mutable buffer is effectful (@Dretch)
• Use Number for reading and writing with Buffers (#25, @hdgarrood)

• Updated for PureScript 0.12

• Added fromArrayBuffer (@matthewleon)

• Added toArrayBuffer (@matthewleon)

• Fixed an encoding issue in writeString (@justinwoo)

• Updated for 0.11 (@anilanar)

• Fixed getAtOffset FFI implementation (@rightfold)
• Fixed documentation typo (@rightfold)

• Updated dependencies (@nwolverson)
• Added latin1 encoding (@Risto-Stevcev)

• Compatibility with psc 0.9
• Better behaved Show instance, plus an encodingToNode function which is now recommended for use with node APIs instead of show.

• Fixed byteLength, which had a bad FFI declaration, so that it would throw an error every time it was called.

• No code changes, this tag was just for publishing to Pursuit.

• Major important fixes. This is a breaking change as type signatures have changed. (@hdgarrood)

• Fixed write, writeString, and fill, which used to immediately throw errors at runtime upon use.

• Support for compiler version 0.7
• Use Int instead of Number where appropriate (which happens to be everywhere)

• Initial versioned release