Skip to content

v3.0.0

Latest
Compare
Choose a tag to compare
@jacob-shuman jacob-shuman released this 26 Sep 17:32

❓ What's Changed

v3.0.0 adds some quality of life updates to documentation, auto publishing, and search/lookup options.

  • πŸ”§ added a github action workflow (publish.yml) to automate publishing upon changes to package.json (tests are run prior to publishing.
  • ✨ add search options based on updated itunes documentation (callback, attributes, etc). Type hints should work much better for search media/entity/attribute (ie movie entity will show type hints for movie attributes and vice versa). If you know of values for attribute, entity, etc you can use the override key to force unknown values and disregard type safety for known values.
  • ✨ search and lookup functions were cleaned up and are a bit more readable and predictable.
  • ✨ search and lookup options allow unknown keys without the need for an extras key. If you need to use values outside of whats used in the search/lookup option objects (e.g. if you need to use an entity not in the ItunesEntity type) you can set them in with the override?: Record<string, string | string[]>; key.
  • ✨ export missing types from module.
  • πŸ”§ ItunesResult.collectionName is now possibly undefined as it should have originally been.
  • πŸ”§ entities and attributes have individual types for each entity but also umbrella types for all of them (ItunesEntities & ItunesAttributes).
  • πŸ“¦ bundle size should be reduced after adding a few options to the tsup build command.
  • πŸ“ add jsdoc comments to all major types (more are coming in a patch ✨).
  • πŸ”§ fix failing test errors.
  • πŸ“ fix README examples and a few grammatical issues.

Full Changelog: v2.0.0...v3.0.0