Skip to content

Adds type hints to support static analysis with Psalm
Compare
Choose a tag to compare
@mpdude mpdude released this 14 Jun 21:05
· 13 commits to master since this release
3.5.0
003564d
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode. 
Add type hints for static linting with Psalm (#10)

This PR adds type hints and docblocks to support static analysis of your custom mapper classes with Psalm.

Most notably, `SourceAdapter`, `DestinationAdapter` and `Mapper` implementations can make use of templated types in Psalm, which is a great help due to the generic (`object` based) approach in this package.

The types are:

* `Ts` type returned by the `SourceAdapter`
* `Tr` type returned by `DestinationAdapter::getObjectsOrderedById()`, `r` for "reading"
* `Tw` type used by the `DestinationAdapter` when writing back to the destination system.
Assets 2
Loading