Skip to content

.unwrap() method has incorrect / out of date return type in documentation #487

@mknowlton89

Description

@mknowlton89

In the README, the documentation states the unwrap function will return a typed Payload, but looking at the source code, the unwrap function returns a generic Object type.

It would be ideal if this Payload type was defined instead of the generic Object as it will improve type safety and developer experience.

I do see there is an open PR that adds a comprehensive WebhookEvent type here that appears to resolve this issue.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions