Skip to content

Latest commit

 

History

History
28 lines (26 loc) · 2.41 KB

README.md

File metadata and controls

28 lines (26 loc) · 2.41 KB
Raw

docs/

All technical documents for this library.

Table of content

  1. Migration guide for v9 to v10 major breaking change upgrade
    • This details how to migrate from v9 to v10 to handle the breaking API change, and explores the motivation behind the new API.
  2. Migration guide for v8 to v9 major breaking change upgrade
    • This details how to migrate from v8 to v9 to handle the breaking API change, and explores the motivation behind the new API.
  3. Migration guide for v7 to v8 major breaking change upgrade - This details how to migrate from v7 and earlier to v8 to handle the breaking API change, and explores the motivation behind the new API.
  4. Errors vs Exceptions
    • Explores the difference between Errors and Exceptions, to lay the context for the doc on Exception handling.
  5. Exceptions handling
    • Explores how this library handles Exceptions and how it makes life easier for users with less code than most other libraries.
  6. Runtime response validation (these docs explore how to use various methods to do response validation at runtime to ensure that they match the types defined at compile time)
    1. Hand written validation
      • Explores how to use hand written validation functions for response validation.
      • Although possible, this is not the recommended approach, see validation with Zod instead.
    2. Response validation with Zod
      • Explores how to use Zod for response validation using the exported parser adapter function.
  7. firebase auth
    • Documentation on integrating firebase auth with this library.
  8. Why is fetch not exposed
    • Explores the reason why fetch is not exposed by the library unlike other HTTP client libraries.
  9. return this
    • Explores the reasoning for including return this and return ClassName in most methods.
  10. archive/
    • Archive folder for old documentations that might still be referenced. For any details on the latest version of the library, this can be safely ignored.