Skip to content

Latest commit

 

History

History
122 lines (72 loc) · 3.82 KB

CHANGELOG.md

File metadata and controls

122 lines (72 loc) · 3.82 KB

cleaners

0.3.17 (2024-09-09)

  • changed: When we receive an unexpected value, include the actual received value in the error message.

0.3.16 (2023-04-24)

  • fixed: Change the CommonJS file extension back to "js", to work better with bundlers like Metro.

0.3.15 (2023-04-18)

  • fixed: Update package.json to work with recent versions of Webpack, Rollup, and TypeScript.
  • fixed: Get Deno working again by adding file extensions to all import statements.

0.3.14 (2023-04-17)

  • added: Accept fallback functions for asOptional and asMaybe, to generate fresh fallback values each time there is a problem.

0.3.13 (2022-07-21)

  • changed: Add more variants to the asEither Flow type, up to 16 arguments.

0.3.12 (2021-09-20)

  • added: Add an asTuple cleaner for fixed-length arrays.

0.3.11 (2021-09-16)

  • changed: Use asValue to clean enum types, by allowing it to take multiple arguments.

0.3.10 (2021-09-16)

  • changed: Return any from uncleaners. This mirrors the idea that cleaners accept any.
  • fixed: Correct documentation typos.

0.3.9 (2021-04-08)

  • added: Add an asValue cleaner.
  • changed: Allow asEither to take any number of arguments.

0.3.8 (2021-03-23)

  • Expand the readme into an https://cleaners.js.org website.
  • Move the documentation comments into the .d.ts file so they can appear in tooltips.
  • Add the asCodec and uncleaner functions.

0.3.7 (2021-03-02)

  • Re-work the asObject cleaner.
    • When passed a single cleaner function, create a key-value cleaner like asMap.
    • When passed a shape object, also include a withRest method on the generated cleaner. This method cleans the object according to the shape, but also preserves unknown properties if present.
  • Deprecate asMap, since asObject handles this use-case now.

0.3.6 (2021-03-01)

  • Help Deno find the Typescript definitions correctly.
  • Upgrade build tooling.
  • Add readme section headers.

0.3.5 (2021-02-19)

  • Simplify the error location algorithm. Error object no longer receive a helper function, just a simple number property now.
  • Add the package to deno.land, in addition to NPM.

0.3.4 (2021-02-19)

  • Add an optional fallback to the asMaybe cleaner
  • Fix the asOptional Flow types to match the TypeScript ones, where the fallback and cleaner types must match.
  • Add package.json to the Node.js exports table, to fix warnings in the React Native bundler.

0.3.3 (2021-02-05)

  • Document the problem with exporting cleaners under Flow.
  • Export the ObjectCleaner type definition.

0.3.2 (2020-08-31)

  • Add an asMaybe cleaner, which turns invalid data into undefined.

0.3.1 (2020-08-31)

  • fixed: Stop the Node 14 module entry point from instantly erroring.
  • fixed: Adjust the object cleaner type definitions to give better tooltips & errors.

0.3.0 (2020-08-28)

  • Add an asJSON cleaner.
  • Expose the asObject input shape as a shape property on the returned cleaner.
  • Use an Error.addStep method to build up error locations, instead of fragile search & replace. Several cleaners now add a default addStep methods to Error objects do not have one.
  • Add a native module entry point for Node 14.

0.2.1 (2020-06-30)

  • Add an asUnknown cleaner.
  • Improve error handling.

0.2.0 (2020-04-11)

  • When a nested cleaner throws an error, add location information to the message.
  • The asOptional fallback type must match the main type (for TypeScript only).

0.1.4 (2020-02-25)

  • Fix the asOptional TypeScript definition broken in v0.1.3.
  • Test the type definitions so they won't break in the future.

0.1.3 (2020-02-24)

  • Add an asMap compound cleaner.

0.1.2 (2020-02-13)

  • Add missing package.json fields, so TypeScript can find our definitions.

0.1.1 (2020-02-13)

  • Export the correct Cleaner type in the Flow definitions.

0.1.0 (2020-02-13)

  • Initial release