fix: type PrismicDocument.*_publication_date
as TimestampField<"filled">
#304
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Types of changes
Description
This PR changes the following fields from
string
toTimestampField<"filled">
:PrismicDocument.first_publication_date
PrismicDocument.last_publication_date
Retyping the properties makes them compatible with
asDate()
when type-checked.Requested by @chamois-d-or
Discussion points
Will this have negative downstream effects?
Changing the types makes the properties more specific, which shouldn't affect user code that accepted one of the properties. It could, however, cause issues in edge cases where user code was overriding the properties.
Is there a better way to install
@prismicio/client
(i.e. itself) as@prismicio/mock
's peer dependency?@prismicio/mock
was updated with a peer dependency on@prismicio/client
. npm was installing the published version alongsidemock
, which did not include the updated types.Because this PR changes
PrismicDocument
types, it caused type incompatibilities between@prismicio/mock
andsrc/
version of@prismicio/client
.I was able to solve the issue by pointing the
@prismicio/client
dependency on itself via"@prismicio/client": "."
, which is a very odd setup.Checklist:
🦒